Amazonka.ECS.ListAttributes

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. You can do this, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).

This operation returns paginated results.

Creating a Request

data ListAttributes

See: newListAttributes smart constructor.

Constructors

ListAttributes'

Fields

• attributeName :: Maybe Text

  The name of the attribute to filter the results with.

• attributeValue :: Maybe Text

  The value of the attribute to filter results with. 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.

• maxResults :: Maybe Int

  The maximum number of cluster results that ListAttributes returned 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 isn't used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

• nextToken :: Maybe Text

  The nextToken value returned from a ListAttributes 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.

• targetType :: TargetType

  The type of the target to list attributes with.

Instances

ToJSON ListAttributes

Defined in Amazonka.ECS.ListAttributes

Methods

toJSON :: ListAttributes -> Value

toEncoding :: ListAttributes -> Encoding

toJSONList :: [ListAttributes] -> Value

toEncodingList :: [ListAttributes] -> Encoding

ToHeaders ListAttributes

Defined in Amazonka.ECS.ListAttributes

Methods

toHeaders :: ListAttributes -> [Header]

ToPath ListAttributes

Defined in Amazonka.ECS.ListAttributes

Methods

toPath :: ListAttributes -> ByteString

ToQuery ListAttributes

Defined in Amazonka.ECS.ListAttributes

Methods

toQuery :: ListAttributes -> QueryString

AWSPager ListAttributes

Defined in Amazonka.ECS.ListAttributes

Methods

page :: ListAttributes -> AWSResponse ListAttributes -> Maybe ListAttributes

AWSRequest ListAttributes

Defined in Amazonka.ECS.ListAttributes

Associated Types

type AWSResponse ListAttributes

Methods

request :: (Service -> Service) -> ListAttributes -> Request ListAttributes

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAttributes)))

Generic ListAttributes

Defined in Amazonka.ECS.ListAttributes

Associated Types

type Rep ListAttributes :: Type -> Type

Methods

from :: ListAttributes -> Rep ListAttributes x

to :: Rep ListAttributes x -> ListAttributes

Read ListAttributes

Defined in Amazonka.ECS.ListAttributes

Methods

readsPrec :: Int -> ReadS ListAttributes

readList :: ReadS [ListAttributes]

readPrec :: ReadPrec ListAttributes

readListPrec :: ReadPrec [ListAttributes]

Show ListAttributes

Defined in Amazonka.ECS.ListAttributes

Methods

showsPrec :: Int -> ListAttributes -> ShowS

show :: ListAttributes -> String

showList :: [ListAttributes] -> ShowS

NFData ListAttributes

Defined in Amazonka.ECS.ListAttributes

Methods

rnf :: ListAttributes -> ()

Eq ListAttributes

Defined in Amazonka.ECS.ListAttributes

Methods

(==) :: ListAttributes -> ListAttributes -> Bool

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

Hashable ListAttributes

Defined in Amazonka.ECS.ListAttributes

Methods

hashWithSalt :: Int -> ListAttributes -> Int

hash :: ListAttributes -> Int

type AWSResponse ListAttributes

Defined in Amazonka.ECS.ListAttributes

type AWSResponse ListAttributes = ListAttributesResponse

type Rep ListAttributes

Defined in Amazonka.ECS.ListAttributes

type Rep ListAttributes = D1 ('MetaData "ListAttributes" "Amazonka.ECS.ListAttributes" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ListAttributes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "attributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cluster") '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 "targetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TargetType)))))

newListAttributes

Arguments

:: TargetType

ListAttributes

-> ListAttributes

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:attributeName:ListAttributes', listAttributes_attributeName - The name of the attribute to filter the results with.

$sel:attributeValue:ListAttributes', listAttributes_attributeValue - The value of the attribute to filter results with. 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:maxResults:ListAttributes', listAttributes_maxResults - The maximum number of cluster results that ListAttributes returned 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 isn't used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

ListAttributes, listAttributes_nextToken - The nextToken value returned from a ListAttributes 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.

ListAttributes, listAttributes_targetType - The type of the target to list attributes with.

Request Lenses

listAttributes_attributeName :: Lens' ListAttributes (Maybe Text)

The name of the attribute to filter the results with.

listAttributes_attributeValue :: Lens' ListAttributes (Maybe Text)

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

listAttributes_cluster :: Lens' ListAttributes (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.

listAttributes_maxResults :: Lens' ListAttributes (Maybe Int)

The maximum number of cluster results that ListAttributes returned 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 isn't used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

listAttributes_nextToken :: Lens' ListAttributes (Maybe Text)

The nextToken value returned from a ListAttributes 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.

listAttributes_targetType :: Lens' ListAttributes TargetType

The type of the target to list attributes with.

Destructuring the Response

data ListAttributesResponse

See: newListAttributesResponse smart constructor.

Constructors

ListAttributesResponse'

Fields

• attributes :: Maybe [Attribute]

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

• 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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListAttributesResponse

Defined in Amazonka.ECS.ListAttributes

Associated Types

type Rep ListAttributesResponse :: Type -> Type

Methods

from :: ListAttributesResponse -> Rep ListAttributesResponse x

to :: Rep ListAttributesResponse x -> ListAttributesResponse

Read ListAttributesResponse

Defined in Amazonka.ECS.ListAttributes

Methods

readsPrec :: Int -> ReadS ListAttributesResponse

readList :: ReadS [ListAttributesResponse]

readPrec :: ReadPrec ListAttributesResponse

readListPrec :: ReadPrec [ListAttributesResponse]

Show ListAttributesResponse

Defined in Amazonka.ECS.ListAttributes

Methods

showsPrec :: Int -> ListAttributesResponse -> ShowS

show :: ListAttributesResponse -> String

showList :: [ListAttributesResponse] -> ShowS

NFData ListAttributesResponse

Defined in Amazonka.ECS.ListAttributes

Methods

rnf :: ListAttributesResponse -> ()

Eq ListAttributesResponse

Defined in Amazonka.ECS.ListAttributes

Methods

(==) :: ListAttributesResponse -> ListAttributesResponse -> Bool

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

type Rep ListAttributesResponse

Defined in Amazonka.ECS.ListAttributes

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

newListAttributesResponse

Arguments

:: Int

$sel:httpStatus:ListAttributesResponse'

-> ListAttributesResponse

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:

ListAttributesResponse, listAttributesResponse_attributes - A list of attribute objects that meet the criteria of the request.

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:httpStatus:ListAttributesResponse', listAttributesResponse_httpStatus - The response's http status code.

Response Lenses

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

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

listAttributesResponse_nextToken :: Lens' ListAttributesResponse (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.

listAttributesResponse_httpStatus :: Lens' ListAttributesResponse Int

The response's http status code.