tag_server_certificate¶
Operation¶
tag_server_certificate
¶
tag_server_certificate(request: TagServerCertificateInput | TagServerCertificateInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[TagServerCertificateInputDict]) -> TagServerCertificateOutput
Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.
Note
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
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 a server certificate 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.
-
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
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
|
TagServerCertificateInput | TagServerCertificateInputDict | 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[TagServerCertificateInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
TagServerCertificateOutput
|
An instance of |
tag_server_certificate
async
¶
tag_server_certificate(request: TagServerCertificateInput | TagServerCertificateInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[TagServerCertificateInputDict]) -> TagServerCertificateOutput
Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.
Note
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
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 a server certificate 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.
-
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
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
|
TagServerCertificateInput | TagServerCertificateInputDict | 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[TagServerCertificateInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
TagServerCertificateOutput
|
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.
TagServerCertificateInputDict
¶
Bases: TypedDict
Dictionary form of TagServerCertificateInput.
Attributes¶
server_certificate_name
instance-attribute
¶
The name of the IAM server certificate to which you want to add tags.
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: _+=,.@-
TagServerCertificateInput
dataclass
¶
Bases: _SerdeShape
Dataclass for TagServerCertificateInput structure.
Attributes¶
server_certificate_name
class-attribute
instance-attribute
¶
server_certificate_name: str | None = ...
The name of the IAM server certificate to which you want to add tags.
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¶
TagServerCertificateOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for TagServerCertificateOutput structure.