Skip to content

List Attributes

ecs_list_attributes R Documentation

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

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 to list attributes with.

attributeName

The name of the attribute to filter the results with.

attributeValue

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

nextToken

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

maxResults

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

Value

A list with the following syntax: 

list(
  attributes = list(
    list(
      name = "string",
      value = "string",
      targetType = "container-instance",
      targetId = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

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