paws.compute (version 0.1.0)

ecs_list_attributes: Lists the attributes for Amazon ECS resources within a specified target type and cluster

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

Usage

ecs_list_attributes(cluster, targetType, attributeName, attributeValue,
  nextToken, maxResults)

Arguments

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.

targetType

[required] The type of the target with which to list attributes.

attributeName

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

attributeValue

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

nextToken

The nextToken value returned from a previous paginated ListAttributes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

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.

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.

Request syntax

svc$list_attributes(
  cluster = "string",
  targetType = "container-instance",
  attributeName = "string",
  attributeValue = "string",
  nextToken = "string",
  maxResults = 123
)