SecurityLake / Client / tag_resource

tag_resource#

SecurityLake.Client.tag_resource(**kwargs)#

Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region. A tag is a label that you can define and associate with Amazon Web Services resources. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor for a tag key. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters:
  • resourceArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the Amazon Security Lake resource to add or update the tags for.

  • tags (list) –

    [REQUIRED]

    An array of objects, one for each tag (key and value) to associate with the Amazon Security Lake resource. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.

    • (dict) –

      A tag is a label that you can define and associate with Amazon Web Services resources, including certain types of Amazon Security Lake resources. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. You can associate tags with the following types of Security Lake resources: subscribers, and the data lake configuration for your Amazon Web Services account in individual Amazon Web Services Regions.

      A resource can have up to 50 tags. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. Each tag key must be unique and it can have only one tag value. A tag value acts as a descriptor for a tag key. Tag keys and values are case sensitive. They can contain letters, numbers, spaces, or the following symbols: _ . : / = + @ -

      For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide.

      • key (string) – [REQUIRED]

        The name of the tag. This is a general label that acts as a category for a more specific tag value ( value).

      • value (string) – [REQUIRED]

        The value that’s associated with the specified tag key ( key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • SecurityLake.Client.exceptions.BadRequestException

  • SecurityLake.Client.exceptions.ResourceNotFoundException

  • SecurityLake.Client.exceptions.InternalServerException

  • SecurityLake.Client.exceptions.AccessDeniedException

  • SecurityLake.Client.exceptions.ConflictException

  • SecurityLake.Client.exceptions.ThrottlingException