libZSservicesZSamazonka-ecsZSamazonka-ecs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ECS.ListAttributes

Description

Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).

This operation returns paginated results.

Synopsis

Creating a Request

data ListAttributes Source #

See: newListAttributes smart constructor.

Constructors

ListAttributes' 

Fields

  • attributeValue :: Maybe Text

    The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

  • cluster :: Maybe Text

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

  • nextToken :: Maybe Text

    The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is 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.

  • attributeName :: Maybe Text

    The name of the attribute with which to filter the results.

  • maxResults :: Maybe Int

    The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes 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 ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

  • targetType :: TargetType

    The type of the target with which to list attributes.

Instances

Instances details
Eq ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

Read ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

Show ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

Generic ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

Associated Types

type Rep ListAttributes :: Type -> Type #

NFData ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

Methods

rnf :: ListAttributes -> () #

Hashable ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

ToJSON ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

AWSPager ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

AWSRequest ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

Associated Types

type AWSResponse ListAttributes #

ToHeaders ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

ToPath ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

ToQuery ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

type Rep ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

type Rep ListAttributes = D1 ('MetaData "ListAttributes" "Amazonka.ECS.ListAttributes" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "ListAttributes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "attributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "targetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TargetType)))))
type AWSResponse ListAttributes Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

newListAttributes Source #

Create a value of ListAttributes 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:attributeValue:ListAttributes', listAttributes_attributeValue - The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

$sel:cluster:ListAttributes', listAttributes_cluster - The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

$sel:nextToken:ListAttributes', listAttributes_nextToken - The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is 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.

$sel:attributeName:ListAttributes', listAttributes_attributeName - The name of the attribute with which to filter the results.

$sel:maxResults:ListAttributes', listAttributes_maxResults - The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes 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 ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

$sel:targetType:ListAttributes', listAttributes_targetType - The type of the target with which to list attributes.

Request Lenses

listAttributes_attributeValue :: Lens' ListAttributes (Maybe Text) Source #

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

listAttributes_cluster :: Lens' ListAttributes (Maybe Text) Source #

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

listAttributes_nextToken :: Lens' ListAttributes (Maybe Text) Source #

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is 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.

listAttributes_attributeName :: Lens' ListAttributes (Maybe Text) Source #

The name of the attribute with which to filter the results.

listAttributes_maxResults :: Lens' ListAttributes (Maybe Int) Source #

The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes 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 ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

listAttributes_targetType :: Lens' ListAttributes TargetType Source #

The type of the target with which to list attributes.

Destructuring the Response

data ListAttributesResponse Source #

See: newListAttributesResponse smart constructor.

Constructors

ListAttributesResponse' 

Fields

  • nextToken :: Maybe Text

    The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes 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.

  • attributes :: Maybe [Attribute]

    A list of attribute objects that meet the criteria of the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListAttributesResponse Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

Read ListAttributesResponse Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

Show ListAttributesResponse Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

Generic ListAttributesResponse Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

Associated Types

type Rep ListAttributesResponse :: Type -> Type #

NFData ListAttributesResponse Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

Methods

rnf :: ListAttributesResponse -> () #

type Rep ListAttributesResponse Source # 
Instance details

Defined in Amazonka.ECS.ListAttributes

type Rep ListAttributesResponse = D1 ('MetaData "ListAttributesResponse" "Amazonka.ECS.ListAttributes" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "ListAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attribute])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAttributesResponse Source #

Create a value of ListAttributesResponse 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:nextToken:ListAttributes', listAttributesResponse_nextToken - The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes 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:attributes:ListAttributesResponse', listAttributesResponse_attributes - A list of attribute objects that meet the criteria of the request.

$sel:httpStatus:ListAttributesResponse', listAttributesResponse_httpStatus - The response's http status code.

Response Lenses

listAttributesResponse_nextToken :: Lens' ListAttributesResponse (Maybe Text) Source #

The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes 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.

listAttributesResponse_attributes :: Lens' ListAttributesResponse (Maybe [Attribute]) Source #

A list of attribute objects that meet the criteria of the request.