Skip to content

ListAttributesRequest

Source code in docs_src/capo_ecs/types/list_attributes_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class ListAttributesRequest(TypedDict, closed=True):
    cluster: NotRequired["capo_ecs.types.string.String"]
    """<p>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.</p>"""
    target_type: "capo_ecs.types.target_type.TargetType"
    """<p>The type of the target to list attributes with.</p>"""
    attribute_name: NotRequired["capo_ecs.types.string.String"]
    """<p>The name of the attribute to filter the results with. </p>"""
    attribute_value: NotRequired["capo_ecs.types.string.String"]
    """<p>The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.</p>"""
    next_token: NotRequired["capo_ecs.types.string.String"]
    """<p>The <code>nextToken</code> value returned from a <code>ListAttributes</code> request indicating that more results are available to fulfill the request and further calls are needed. If <code>maxResults</code> was provided, it's possible the number of results to be fewer than <code>maxResults</code>.</p> <note> <p>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.</p> </note>"""
    max_results: NotRequired["capo_ecs.types.boxed_integer.BoxedInteger"]
    """<p>The maximum number of cluster results that <code>ListAttributes</code> returned in paginated output. When this parameter is used, <code>ListAttributes</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListAttributes</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>ListAttributes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"""

attribute_name instance-attribute 

attribute_name: NotRequired[String]

The name of the attribute to filter the results with.

attribute_value instance-attribute 

attribute_value: NotRequired[String]

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

cluster instance-attribute 

cluster: NotRequired[String]

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.

max_results instance-attribute 

max_results: NotRequired[BoxedInteger]

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.

next_token instance-attribute 

next_token: NotRequired[String]

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.

target_type instance-attribute 

target_type: TargetType

The type of the target to list attributes with.