S3Control / Client / tag_resource

tag_resource

S3Control.Client.tag_resource(**kwargs)

Creates a new Amazon Web Services resource tag or updates an existing resource tag. You can add up to 50 Amazon Web Services resource tags for each S3 resource.

To use this operation, you must have the permission to perform the s3:TagResource action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.

Note

This operation is only supported for S3 Storage Lens groups.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    AccountId='string',
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• AccountId (string) –

  [REQUIRED]

  The Amazon Web Services account ID that created the S3 resource that you’re trying to add tags to.

• ResourceArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the S3 resource that you’re trying to add tags to.

• Tags (list) –

  [REQUIRED]

  The Amazon Web Services resource tags that you want to add to the specified S3 resource.

  • (dict) –

    An Amazon Web Services resource tag that’s associated with your S3 resource. You can add tags to new objects when you upload them, or you can add object tags to existing objects.

    Note

    This data type is only supported for S3 Storage Lens groups.

    • Key (string) – [REQUIRED]

      The tag key for your Amazon Web Services resource. A tag key can be up to 128 Unicode characters in length and is case-sensitive. System created tags that begin with aws: aren’t supported.

    • Value (string) – [REQUIRED]

      The tag value for your Amazon Web Services resource. A tag value can be up to 256 Unicode characters in length and is case-sensitive.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –