ListAttributesRequest Class | AWS SDK for .NET V3

Container for the parameters to the ListAttributes operation. 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).

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ECS.AmazonECSRequest
      Amazon.ECS.Model.ListAttributesRequest

Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

public class ListAttributesRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The ListAttributesRequest type exposes the following members

Constructors

	Name	Description
	ListAttributesRequest()

Properties

Name	Type	Description
AttributeName	System.String	Gets and sets the property AttributeName. The name of the attribute to filter the results with.
AttributeValue	System.String	Gets and sets the property AttributeValue. The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.
Cluster	System.String	Gets and sets the property 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.
MaxResults	System.Int32	Gets and sets the property 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.
NextToken	System.String	Gets and sets the property 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.
TargetType	Amazon.ECS.TargetType	Gets and sets the property TargetType. The type of the target to list attributes with.

Examples

This example lists attributes for a container instance with the attribute "stack" equal to the value "production".

To list container instances that have a specific attribute


var client = new AmazonECSClient();
var response = client.ListAttributes(new ListAttributesRequest 
{
    AttributeName = "stack",
    AttributeValue = "production",
    Cluster = "MyCluster",
    TargetType = "container-instance"
});

List<Attribute> attributes = response.Attributes;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5