tag_mfa_device¶
Operation¶
tag_mfa_device
¶
tag_mfa_device(request: TagMFADeviceInput | TagMFADeviceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[TagMFADeviceInputDict]) -> TagMFADeviceOutput
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
-
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
-
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Note
-
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
-
Amazon Web Services always interprets the tag
Valueas a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
TagMFADeviceInput | TagMFADeviceInputDict | 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[TagMFADeviceInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
TagMFADeviceOutput
|
An instance of |
tag_mfa_device
async
¶
tag_mfa_device(request: TagMFADeviceInput | TagMFADeviceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[TagMFADeviceInputDict]) -> TagMFADeviceOutput
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
-
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
-
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Note
-
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
-
Amazon Web Services always interprets the tag
Valueas a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
TagMFADeviceInput | TagMFADeviceInputDict | 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[TagMFADeviceInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
TagMFADeviceOutput
|
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.
TagMFADeviceInputDict
¶
Bases: TypedDict
Dictionary form of TagMFADeviceInput.
Attributes¶
serial_number
instance-attribute
¶
The unique identifier for the IAM virtual MFA device to which you want to add tags. For virtual MFA devices, the serial number is the same as the ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
TagMFADeviceInput
dataclass
¶
Bases: _SerdeShape
Dataclass for TagMFADeviceInput structure.
Attributes¶
serial_number
class-attribute
instance-attribute
¶
serial_number: str | None = ...
The unique identifier for the IAM virtual MFA device to which you want to add tags. For virtual MFA devices, the serial number is the same as the ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
Output¶
TagMFADeviceOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for TagMFADeviceOutput structure.