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

Amazonka.ECS.ListContainerInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

This operation returns paginated results.

Synopsis

data ListContainerInstances = ListContainerInstances' {
- cluster :: Maybe Text
- filter' :: Maybe Text
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- status :: Maybe ContainerInstanceStatus
}
newListContainerInstances :: ListContainerInstances
listContainerInstances_cluster :: Lens' ListContainerInstances (Maybe Text)
listContainerInstances_filter :: Lens' ListContainerInstances (Maybe Text)
listContainerInstances_maxResults :: Lens' ListContainerInstances (Maybe Int)
listContainerInstances_nextToken :: Lens' ListContainerInstances (Maybe Text)
listContainerInstances_status :: Lens' ListContainerInstances (Maybe ContainerInstanceStatus)
data ListContainerInstancesResponse = ListContainerInstancesResponse' {
- containerInstanceArns :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListContainerInstancesResponse :: Int -> ListContainerInstancesResponse
listContainerInstancesResponse_containerInstanceArns :: Lens' ListContainerInstancesResponse (Maybe [Text])
listContainerInstancesResponse_nextToken :: Lens' ListContainerInstancesResponse (Maybe Text)
listContainerInstancesResponse_httpStatus :: Lens' ListContainerInstancesResponse Int

Creating a Request

data ListContainerInstances Source #

See: newListContainerInstances smart constructor.

Constructors

ListContainerInstances'

Fields

cluster :: Maybe Text
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
filter' :: Maybe Text
You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
maxResults :: Maybe Int
The maximum number of container instance results that ListContainerInstances returned in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.
nextToken :: Maybe Text
The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
status :: Maybe ContainerInstanceStatus
Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.

Instances

Instances details

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

newListContainerInstances :: ListContainerInstances Source #

Create a value of ListContainerInstances 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:cluster:ListContainerInstances', listContainerInstances_cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

$sel:filter':ListContainerInstances', listContainerInstances_filter - You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

$sel:maxResults:ListContainerInstances', listContainerInstances_maxResults - The maximum number of container instance results that ListContainerInstances returned in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

ListContainerInstances, listContainerInstances_nextToken - The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

ListContainerInstances, listContainerInstances_status - Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.

Request Lenses

listContainerInstances_cluster :: Lens' ListContainerInstances (Maybe Text) Source #

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

listContainerInstances_filter :: Lens' ListContainerInstances (Maybe Text) Source #

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

listContainerInstances_maxResults :: Lens' ListContainerInstances (Maybe Int) Source #

The maximum number of container instance results that ListContainerInstances returned in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

listContainerInstances_nextToken :: Lens' ListContainerInstances (Maybe Text) Source #

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listContainerInstances_status :: Lens' ListContainerInstances (Maybe ContainerInstanceStatus) Source #

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.

Destructuring the Response

data ListContainerInstancesResponse Source #

See: newListContainerInstancesResponse smart constructor.

Constructors

ListContainerInstancesResponse'

Fields

containerInstanceArns :: Maybe [Text]
The list of container instances with full ARN entries for each container instance associated with the specified cluster.
nextToken :: Maybe Text
The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListContainerInstancesResponse Source #
Instance details Defined in Amazonka.ECS.ListContainerInstances Associated Types type Rep ListContainerInstancesResponse :: Type -> Type # Methods from :: ListContainerInstancesResponse -> Rep ListContainerInstancesResponse x # to :: Rep ListContainerInstancesResponse x -> ListContainerInstancesResponse #
Read ListContainerInstancesResponse Source #
Instance details Defined in Amazonka.ECS.ListContainerInstances Methods readsPrec :: Int -> ReadS ListContainerInstancesResponse # readList :: ReadS [ListContainerInstancesResponse] # readPrec :: ReadPrec ListContainerInstancesResponse # readListPrec :: ReadPrec [ListContainerInstancesResponse] #
Show ListContainerInstancesResponse Source #
Instance details Defined in Amazonka.ECS.ListContainerInstances Methods showsPrec :: Int -> ListContainerInstancesResponse -> ShowS # show :: ListContainerInstancesResponse -> String # showList :: [ListContainerInstancesResponse] -> ShowS #
NFData ListContainerInstancesResponse Source #
Instance details Defined in Amazonka.ECS.ListContainerInstances Methods rnf :: ListContainerInstancesResponse -> () #
Eq ListContainerInstancesResponse Source #
Instance details Defined in Amazonka.ECS.ListContainerInstances Methods (==) :: ListContainerInstancesResponse -> ListContainerInstancesResponse -> Bool # (/=) :: ListContainerInstancesResponse -> ListContainerInstancesResponse -> Bool #
type Rep ListContainerInstancesResponse Source #
Instance details Defined in Amazonka.ECS.ListContainerInstances type Rep ListContainerInstancesResponse = D1 ('MetaData "ListContainerInstancesResponse" "Amazonka.ECS.ListContainerInstances" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ListContainerInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerInstanceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListContainerInstancesResponse Source #

Arguments

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

Create a value of ListContainerInstancesResponse 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:containerInstanceArns:ListContainerInstancesResponse', listContainerInstancesResponse_containerInstanceArns - The list of container instances with full ARN entries for each container instance associated with the specified cluster.

ListContainerInstances, listContainerInstancesResponse_nextToken - The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:ListContainerInstancesResponse', listContainerInstancesResponse_httpStatus - The response's http status code.

Response Lenses

listContainerInstancesResponse_containerInstanceArns :: Lens' ListContainerInstancesResponse (Maybe [Text]) Source #

The list of container instances with full ARN entries for each container instance associated with the specified cluster.

listContainerInstancesResponse_nextToken :: Lens' ListContainerInstancesResponse (Maybe Text) Source #

The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

listContainerInstancesResponse_httpStatus :: Lens' ListContainerInstancesResponse Int Source #

The response's http status code.