AWSSDK.ResourceGroupsTaggingAPI.jl

AWSSDK.ResourceGroupsTaggingAPI

Resource Groups Tagging API

This guide describes the API operations for the resource groups tagging.

A tag is a label that you assign to an AWS resource. A tag consists of a key and a value, both of which you define. For example, if you have two Amazon EC2 instances, you might assign both a tag key of "Stack." But the value of "Stack" might be "Testing" for one and "Production" for the other.

Tagging can help you organize your resources and enables you to simplify resource management, access management and cost allocation. For more information about tagging, see Working with Tag Editor and Working with Resource Groups. For more information about permissions you need to use the resource groups tagging APIs, see Obtaining Permissions for Resource Groups and Obtaining Permissions for Tagging .

You can use the resource groups tagging APIs to complete the following tasks:

Not all resources can have tags. For a lists of resources that you can tag, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide.

To make full use of the resource groups tagging APIs, you might need additional IAM permissions, including permission to access the resources of individual services as well as permission to view and apply tags to those resources. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.

This document is generated from apis/resourcegroupstaggingapi-2017-01-26.normal.json. See JuliaCloud/AWSCore.jl.

AWSSDK.ResourceGroupsTaggingAPI.get_resources — Function.
using AWSSDK.ResourceGroupsTaggingAPI.get_resources
get_resources([::AWSConfig], arguments::Dict)
get_resources([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.resourcegroupstaggingapi
resourcegroupstaggingapi([::AWSConfig], "GetResources", arguments::Dict)
resourcegroupstaggingapi([::AWSConfig], "GetResources", <keyword arguments>)

GetResources Operation

Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.

Arguments

PaginationToken = ::String

A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

TagFilters = [[ ... ], ...]

A list of tags (keys and values). A request can include up to 50 keys, and each key can include up to 20 values.

If you specify multiple filters connected by an AND operator in a single request, the response returns only those resources that are associated with every specified filter.

If you specify multiple filters connected by an OR operator in a single request, the response returns all resources that are associated with at least one or possibly more of the specified filters.

 TagFilters = [[
        "Key" =>  ::String,
        "Values" =>  [::String, ...]
    ], ...]

ResourcesPerPage = ::Int

A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 50 items.

TagsPerPage = ::Int

A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.

ResourceTypeFilters = [::String, ...]

The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all tagged Amazon EC2 resources (which includes tagged EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the following:

Returns

GetResourcesOutput

Exceptions

InvalidParameterException, ThrottledException, InternalServiceException or PaginationTokenExpiredException.

See also: AWS API Documentation

AWSSDK.ResourceGroupsTaggingAPI.get_tag_keys — Function.
using AWSSDK.ResourceGroupsTaggingAPI.get_tag_keys
get_tag_keys([::AWSConfig], arguments::Dict)
get_tag_keys([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.resourcegroupstaggingapi
resourcegroupstaggingapi([::AWSConfig], "GetTagKeys", arguments::Dict)
resourcegroupstaggingapi([::AWSConfig], "GetTagKeys", <keyword arguments>)

GetTagKeys Operation

Returns all tag keys in the specified region for the AWS account.

Arguments

PaginationToken = ::String

A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

Returns

GetTagKeysOutput

Exceptions

InvalidParameterException, ThrottledException, InternalServiceException or PaginationTokenExpiredException.

See also: AWS API Documentation

AWSSDK.ResourceGroupsTaggingAPI.get_tag_values — Function.
using AWSSDK.ResourceGroupsTaggingAPI.get_tag_values
get_tag_values([::AWSConfig], arguments::Dict)
get_tag_values([::AWSConfig]; Key=, <keyword arguments>)

using AWSCore.Services.resourcegroupstaggingapi
resourcegroupstaggingapi([::AWSConfig], "GetTagValues", arguments::Dict)
resourcegroupstaggingapi([::AWSConfig], "GetTagValues", Key=, <keyword arguments>)

GetTagValues Operation

Returns all tag values for the specified key in the specified region for the AWS account.

Arguments

PaginationToken = ::String

A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

Key = ::String – Required

The key for which you want to list all existing values in the specified region for the AWS account.

Returns

GetTagValuesOutput

Exceptions

InvalidParameterException, ThrottledException, InternalServiceException or PaginationTokenExpiredException.

See also: AWS API Documentation

AWSSDK.ResourceGroupsTaggingAPI.tag_resources — Function.
using AWSSDK.ResourceGroupsTaggingAPI.tag_resources
tag_resources([::AWSConfig], arguments::Dict)
tag_resources([::AWSConfig]; ResourceARNList=, Tags=)

using AWSCore.Services.resourcegroupstaggingapi
resourcegroupstaggingapi([::AWSConfig], "TagResources", arguments::Dict)
resourcegroupstaggingapi([::AWSConfig], "TagResources", ResourceARNList=, Tags=)

TagResources Operation

Applies one or more tags to the specified resources. Note the following:

  • Not all resources can have tags. For a list of resources that support tagging, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide.

  • Each resource can have up to 50 tags. For other limits, see Tag Restrictions in the Amazon EC2 User Guide for Linux Instances.

  • You can only tag resources that are located in the specified region for the AWS account.

  • To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.

Arguments

ResourceARNList = [::String, ...] – Required

A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to tag. An ARN can be set to a maximum of 1600 characters. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Tags = ::Dict{String,String} – Required

The tags that you want to add to the specified resources. A tag consists of a key and a value that you define.

Returns

TagResourcesOutput

Exceptions

InvalidParameterException, ThrottledException or InternalServiceException.

See also: AWS API Documentation

AWSSDK.ResourceGroupsTaggingAPI.untag_resources — Function.
using AWSSDK.ResourceGroupsTaggingAPI.untag_resources
untag_resources([::AWSConfig], arguments::Dict)
untag_resources([::AWSConfig]; ResourceARNList=, TagKeys=)

using AWSCore.Services.resourcegroupstaggingapi
resourcegroupstaggingapi([::AWSConfig], "UntagResources", arguments::Dict)
resourcegroupstaggingapi([::AWSConfig], "UntagResources", ResourceARNList=, TagKeys=)

UntagResources Operation

Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:

  • To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.

  • You can only tag resources that are located in the specified region for the AWS account.

Arguments

ResourceARNList = [::String, ...] – Required

A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to untag. An ARN can be set to a maximum of 1600 characters. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

TagKeys = [::String, ...] – Required

A list of the tag keys that you want to remove from the specified resources.

Returns

UntagResourcesOutput

Exceptions

InvalidParameterException, ThrottledException or InternalServiceException.

See also: AWS API Documentation