describe_tags¶
Operation¶
describe_tags
¶
describe_tags(request: DescribeTagsInput | DescribeTagsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTagsInputDict]) -> DescribeTagsOutput
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
Warning
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Note: The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeTagsInput | DescribeTagsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeTagsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeTagsOutput
|
An instance of |
describe_tags
async
¶
describe_tags(request: DescribeTagsInput | DescribeTagsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTagsInputDict]) -> DescribeTagsOutput
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
Warning
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Note: The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeTagsInput | DescribeTagsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeTagsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeTagsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeTagsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeTagsInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
The filters.
-
key- The tag key. -
resource-id- The ID of the resource. -
resource-type- The resource type. For a list of possible values, see TagSpecification. -
tag:<key>- The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA". -
value- The tag value.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
DescribeTagsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeTagsInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
filters
class-attribute
instance-attribute
¶
The filters.
-
key- The tag key. -
resource-id- The ID of the resource. -
resource-type- The resource type. For a list of possible values, see TagSpecification. -
tag:<key>- The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA". -
value- The tag value.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Output¶
DescribeTagsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeTagsOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to include in another request to get the next page of items.
This value is null when there are no more items to return.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.