ecs_list_attributes {aws.ecx}

List Attributes

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(
  maxResults = NULL,
  nextToken = NULL,
  cluster = NULL,
  targetType = NULL,
  attributeName = NULL,
  attributeValue = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

maxResults

Character. Pagination limit[optional]

nextToken

Characters. The token for the next page of results[optional]

cluster

Character. The short name or full Amazon Resource Name (ARN) of the cluster to list attributes.

targetType

Character. The type of the target with which to list attributes.

attributeName

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

attributeValue

Character. The value of the attribute with which to filter results.

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

maxResults

Pagination limit

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

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.