resourcegroupstaggingapi

package
v0.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 2, 2019 License: Apache-2.0 Imports: 6 Imported by: 210

Documentation

Overview

Package resourcegroupstaggingapi provides the client and types for making API requests to AWS 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.

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

  • Tag and untag supported resources located in the specified region for the AWS account

  • Use tag-based filters to search for resources located in the specified region for the AWS account

  • List all existing tag keys in the specified region for the AWS account

  • List all existing values for the specified key in the specified region for the AWS account

To use resource groups tagging API operations, you must add the following permissions to your IAM policy:

  • tag:GetResources

  • tag:TagResources

  • tag:UntagResources

  • tag:GetTagKeys

  • tag:GetTagValues

You'll also need permissions to access the resources of individual services so that you can tag and untag those resources.

For more information on IAM policies, see Managing IAM Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html) in the IAM User Guide.

You can use the Resource Groups Tagging API to tag resources for the following AWS services.

  • Alexa for Business (a4b)

  • API Gateway

  • AWS AppStream

  • AWS AppSync

  • AWS App Mesh

  • Amazon Athena

  • Amazon Aurora

  • AWS Backup

  • AWS Certificate Manager

  • AWS Certificate Manager Private CA

  • Amazon Cloud Directory

  • AWS CloudFormation

  • Amazon CloudFront

  • AWS CloudHSM

  • AWS CloudTrail

  • Amazon CloudWatch (alarms only)

  • Amazon CloudWatch Events

  • Amazon CloudWatch Logs

  • AWS CodeBuild

  • AWS CodeCommit

  • AWS CodePipeline

  • AWS CodeStar

  • Amazon Cognito Identity

  • Amazon Cognito User Pools

  • Amazon Comprehend

  • AWS Config

  • AWS Data Pipeline

  • AWS Database Migration Service

  • AWS Datasync

  • AWS Direct Connect

  • AWS Directory Service

  • Amazon DynamoDB

  • Amazon EBS

  • Amazon EC2

  • Amazon ECR

  • Amazon ECS

  • AWS Elastic Beanstalk

  • Amazon Elastic File System

  • Elastic Load Balancing

  • Amazon ElastiCache

  • Amazon Elasticsearch Service

  • AWS Elemental MediaLive

  • AWS Elemental MediaPackage

  • AWS Elemental MediaTailor

  • Amazon EMR

  • Amazon FSx

  • Amazon Glacier

  • AWS Glue

  • Amazon Inspector

  • AWS IoT Analytics

  • AWS IoT Core

  • AWS IoT Device Defender

  • AWS IoT Device Management

  • AWS IoT Greengrass

  • AWS Key Management Service

  • Amazon Kinesis

  • Amazon Kinesis Data Analytics

  • Amazon Kinesis Data Firehose

  • AWS Lambda

  • AWS License Manager

  • Amazon Machine Learning

  • Amazon MQ

  • Amazon MSK

  • Amazon Neptune

  • AWS OpsWorks

  • Amazon RDS

  • Amazon Redshift

  • AWS Resource Access Manager

  • AWS Resource Groups

  • AWS RoboMaker

  • Amazon Route 53

  • Amazon Route 53 Resolver

  • Amazon S3 (buckets only)

  • Amazon SageMaker

  • AWS Secrets Manager

  • AWS Service Catalog

  • Amazon Simple Notification Service (SNS)

  • Amazon Simple Queue Service (SQS)

  • AWS Simple System Manager (SSM)

  • AWS Step Functions

  • AWS Storage Gateway

  • AWS Transfer for SFTP

  • Amazon VPC

  • Amazon WorkSpaces

See https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26 for more information on this service.

See resourcegroupstaggingapi package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/resourcegroupstaggingapi/

Using the Client

To use AWS Resource Groups Tagging API with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Resource Groups Tagging API client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/resourcegroupstaggingapi/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS Resource Groups Tagging API" // Service's name
	ServiceID   = "ResourceGroupsTaggingAPI"        // Service's identifier
	EndpointsID = "tagging"                         // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeInternalServiceException for service response error code
	// "InternalServiceException".
	//
	// The request processing failed because of an unknown error, exception, or
	// failure. You can retry the request.
	ErrCodeInternalServiceException = "InternalServiceException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// A parameter is missing or a malformed string or invalid or out-of-range value
	// was supplied for the request parameter.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodePaginationTokenExpiredException for service response error code
	// "PaginationTokenExpiredException".
	//
	// A PaginationToken is valid for a maximum of 15 minutes. Your request was
	// denied because the specified PaginationToken has expired.
	ErrCodePaginationTokenExpiredException = "PaginationTokenExpiredException"

	// ErrCodeThrottledException for service response error code
	// "ThrottledException".
	//
	// The request was denied to limit the frequency of submitted requests.
	ErrCodeThrottledException = "ThrottledException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS Resource Groups Tagging API. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := resourcegroupstaggingapi.New(myConfig)

func (*Client) GetResourcesRequest added in v0.9.0 

func (c *Client) GetResourcesRequest(input *GetResourcesInput) GetResourcesRequest

GetResourcesRequest returns a request value for making API operation for AWS Resource Groups Tagging API.

Returns all the tagged or previously tagged resources that are located in the specified region for the AWS account. You can optionally specify filters (tags and resource types) in your request, depending on what information you want returned. The response includes all tags that are associated with the requested resources.

You can check the PaginationToken response parameter to determine if a query completed. Queries can occasionally return fewer results on a page than allowed. The PaginationToken response parameter value is null only when there are no more results to display. 

// Example sending a request using GetResourcesRequest.
req := client.GetResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetResources

func (*Client) GetTagKeysRequest added in v0.9.0 

func (c *Client) GetTagKeysRequest(input *GetTagKeysInput) GetTagKeysRequest

GetTagKeysRequest returns a request value for making API operation for AWS Resource Groups Tagging API.

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

// Example sending a request using GetTagKeysRequest.
req := client.GetTagKeysRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagKeys

func (*Client) GetTagValuesRequest added in v0.9.0 

func (c *Client) GetTagValuesRequest(input *GetTagValuesInput) GetTagValuesRequest

GetTagValuesRequest returns a request value for making API operation for AWS Resource Groups Tagging API.

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

// Example sending a request using GetTagValuesRequest.
req := client.GetTagValuesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagValues

func (*Client) TagResourcesRequest added in v0.9.0 

func (c *Client) TagResourcesRequest(input *TagResourcesInput) TagResourcesRequest

TagResourcesRequest returns a request value for making API operation for AWS Resource Groups Tagging API.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/TagResources

func (*Client) UntagResourcesRequest added in v0.9.0 

func (c *Client) UntagResourcesRequest(input *UntagResourcesInput) UntagResourcesRequest

UntagResourcesRequest returns a request value for making API operation for AWS Resource Groups Tagging API.

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 (http://docs.aws.amazon.com/ARG/latest/userguide/obtaining-permissions-for-tagging.html) in the AWS Resource Groups User Guide.

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

    // Example sending a request using UntagResourcesRequest. req := client.UntagResourcesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/UntagResources

type ErrorCode 

type ErrorCode string
const (
	ErrorCodeInternalServiceException  ErrorCode = "InternalServiceException"
	ErrorCodeInvalidParameterException ErrorCode = "InvalidParameterException"
)

Enum values for ErrorCode

func (ErrorCode) MarshalValue added in v0.3.0 

func (enum ErrorCode) MarshalValue() (string, error)

func (ErrorCode) MarshalValueBuf added in v0.3.0 

func (enum ErrorCode) MarshalValueBuf(b []byte) ([]byte, error)

type FailureInfo 

type FailureInfo struct {

	// The code of the common error. Valid values include InternalServiceException,
	// InvalidParameterException, and any valid error code returned by the AWS service
	// that hosts the resource that you want to tag.
	ErrorCode ErrorCode `type:"string" enum:"true"`

	// The message of the common error.
	ErrorMessage *string `type:"string"`

	// The HTTP status code of the common error.
	StatusCode *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Details of the common errors that all actions return.

func (FailureInfo) String 

func (s FailureInfo) String() string

String returns the string representation

type GetResourcesInput 

type GetResourcesInput struct {

	// 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.
	PaginationToken *string `type:"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 Amazon EC2 resources (which includes 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:
	//
	//    * For a list of service name strings, see AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces).
	//
	//    * For resource type strings, see Example ARNs (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax).
	//
	//    * For more information about ARNs, see Amazon Resource Names (ARNs) and
	//    AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	//
	// You can specify multiple resource types by using an array. The array can
	// include up to 100 items. Note that the length constraint requirement applies
	// to each resource type filter.
	ResourceTypeFilters []string `type:"list"`

	// 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 100 items.
	ResourcesPerPage *int64 `type:"integer"`

	// A list of TagFilters (keys and values). Each TagFilter specified must contain
	// a key with values as optional. A request can include up to 50 keys, and each
	// key can include up to 20 values.
	//
	// Note the following when deciding how to use TagFilters:
	//
	//    * If you do specify a TagFilter, the response returns only those resources
	//    that are currently associated with the specified tag.
	//
	//    * If you don't specify a TagFilter, the response includes all resources
	//    that were ever associated with tags. Resources that currently don't have
	//    associated tags are shown with an empty tag set, like this: "Tags": [].
	//
	//    * If you specify more than one filter in a single request, the response
	//    returns only those resources that satisfy all specified filters.
	//
	//    * If you specify a filter that contains more than one value for a key,
	//    the response returns resources that match any of the specified values
	//    for that key.
	//
	//    * If you don't specify any values for a key, the response returns resources
	//    that are tagged with that key irrespective of the value. For example,
	//    for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}}
	//    , filter3 = {key3}: GetResources( {filter1} ) returns resources tagged
	//    with key1=value1 GetResources( {filter2} ) returns resources tagged with
	//    key2=value2 or key2=value3 or key2=value4 GetResources( {filter3} ) returns
	//    resources tagged with any tag containing key3 as its tag key, irrespective
	//    of its value GetResources( {filter1,filter2,filter3} ) returns resources
	//    tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4)
	//    and (key3, irrespective of the value)
	TagFilters []TagFilter `type:"list"`

	// 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.
	TagsPerPage *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (GetResourcesInput) String 

func (s GetResourcesInput) String() string

String returns the string representation

func (*GetResourcesInput) Validate 

func (s *GetResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetResourcesOutput 

type GetResourcesOutput struct {

	// A string that indicates that the response contains more data than can be
	// returned in a single response. To receive additional data, specify this string
	// for the PaginationToken value in a subsequent request.
	PaginationToken *string `type:"string"`

	// A list of resource ARNs and the tags (keys and values) associated with each.
	ResourceTagMappingList []ResourceTagMapping `type:"list"`
	// contains filtered or unexported fields
}

func (GetResourcesOutput) String 

func (s GetResourcesOutput) String() string

String returns the string representation

type GetResourcesPaginator added in v0.9.0 

type GetResourcesPaginator struct {
	aws.Pager
}

GetResourcesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetResourcesPaginator added in v0.9.0 

func NewGetResourcesPaginator(req GetResourcesRequest) GetResourcesPaginator

NewGetResourcesRequestPaginator returns a paginator for GetResources. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetResourcesRequest(input)
p := resourcegroupstaggingapi.NewGetResourcesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetResourcesPaginator) CurrentPage added in v0.9.0 

func (p *GetResourcesPaginator) CurrentPage() *GetResourcesOutput

type GetResourcesRequest 

type GetResourcesRequest struct {
	*aws.Request
	Input *GetResourcesInput
	Copy  func(*GetResourcesInput) GetResourcesRequest
}

GetResourcesRequest is the request type for the GetResources API operation.

func (GetResourcesRequest) Send 

func (r GetResourcesRequest) Send(ctx context.Context) (*GetResourcesResponse, error)

Send marshals and sends the GetResources API request.

type GetResourcesResponse added in v0.9.0 

type GetResourcesResponse struct {
	*GetResourcesOutput
	// contains filtered or unexported fields
}

GetResourcesResponse is the response type for the GetResources API operation.

func (*GetResourcesResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetResources request.

type GetTagKeysInput 

type GetTagKeysInput struct {

	// 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.
	PaginationToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetTagKeysInput) String 

func (s GetTagKeysInput) String() string

String returns the string representation

type GetTagKeysOutput 

type GetTagKeysOutput struct {

	// A string that indicates that the response contains more data than can be
	// returned in a single response. To receive additional data, specify this string
	// for the PaginationToken value in a subsequent request.
	PaginationToken *string `type:"string"`

	// A list of all tag keys in the AWS account.
	TagKeys []string `type:"list"`
	// contains filtered or unexported fields
}

func (GetTagKeysOutput) String 

func (s GetTagKeysOutput) String() string

String returns the string representation

type GetTagKeysPaginator added in v0.9.0 

type GetTagKeysPaginator struct {
	aws.Pager
}

GetTagKeysPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetTagKeysPaginator added in v0.9.0 

func NewGetTagKeysPaginator(req GetTagKeysRequest) GetTagKeysPaginator

NewGetTagKeysRequestPaginator returns a paginator for GetTagKeys. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetTagKeysRequest(input)
p := resourcegroupstaggingapi.NewGetTagKeysRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetTagKeysPaginator) CurrentPage added in v0.9.0 

func (p *GetTagKeysPaginator) CurrentPage() *GetTagKeysOutput

type GetTagKeysRequest 

type GetTagKeysRequest struct {
	*aws.Request
	Input *GetTagKeysInput
	Copy  func(*GetTagKeysInput) GetTagKeysRequest
}

GetTagKeysRequest is the request type for the GetTagKeys API operation.

func (GetTagKeysRequest) Send 

func (r GetTagKeysRequest) Send(ctx context.Context) (*GetTagKeysResponse, error)

Send marshals and sends the GetTagKeys API request.

type GetTagKeysResponse added in v0.9.0 

type GetTagKeysResponse struct {
	*GetTagKeysOutput
	// contains filtered or unexported fields
}

GetTagKeysResponse is the response type for the GetTagKeys API operation.

func (*GetTagKeysResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetTagKeysResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetTagKeys request.

type GetTagValuesInput 

type GetTagValuesInput struct {

	// The key for which you want to list all existing values in the specified region
	// for the AWS account.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// 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.
	PaginationToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetTagValuesInput) String 

func (s GetTagValuesInput) String() string

String returns the string representation

func (*GetTagValuesInput) Validate 

func (s *GetTagValuesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetTagValuesOutput 

type GetTagValuesOutput struct {

	// A string that indicates that the response contains more data than can be
	// returned in a single response. To receive additional data, specify this string
	// for the PaginationToken value in a subsequent request.
	PaginationToken *string `type:"string"`

	// A list of all tag values for the specified key in the AWS account.
	TagValues []string `type:"list"`
	// contains filtered or unexported fields
}

func (GetTagValuesOutput) String 

func (s GetTagValuesOutput) String() string

String returns the string representation

type GetTagValuesPaginator added in v0.9.0 

type GetTagValuesPaginator struct {
	aws.Pager
}

GetTagValuesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetTagValuesPaginator added in v0.9.0 

func NewGetTagValuesPaginator(req GetTagValuesRequest) GetTagValuesPaginator

NewGetTagValuesRequestPaginator returns a paginator for GetTagValues. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetTagValuesRequest(input)
p := resourcegroupstaggingapi.NewGetTagValuesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetTagValuesPaginator) CurrentPage added in v0.9.0 

func (p *GetTagValuesPaginator) CurrentPage() *GetTagValuesOutput

type GetTagValuesRequest 

type GetTagValuesRequest struct {
	*aws.Request
	Input *GetTagValuesInput
	Copy  func(*GetTagValuesInput) GetTagValuesRequest
}

GetTagValuesRequest is the request type for the GetTagValues API operation.

func (GetTagValuesRequest) Send 

func (r GetTagValuesRequest) Send(ctx context.Context) (*GetTagValuesResponse, error)

Send marshals and sends the GetTagValues API request.

type GetTagValuesResponse added in v0.9.0 

type GetTagValuesResponse struct {
	*GetTagValuesOutput
	// contains filtered or unexported fields
}

GetTagValuesResponse is the response type for the GetTagValues API operation.

func (*GetTagValuesResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetTagValuesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetTagValues request.

type ResourceTagMapping 

type ResourceTagMapping struct {

	// The ARN of the resource.
	ResourceARN *string `min:"1" type:"string"`

	// The tags that have been applied to one or more AWS resources.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

A list of resource ARNs and the tags (keys and values) that are associated with each.

func (ResourceTagMapping) String 

func (s ResourceTagMapping) String() string

String returns the string representation

type Tag 

type Tag struct {

	// One part of a key-value pair that make up a tag. A key is a general label
	// that acts like a category for more specific tag values.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The optional part of a key-value pair that make up a tag. A value acts as
	// a descriptor within a tag category (key).
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The metadata that you apply to AWS resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information, see Tag Basics (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-basics) in the Amazon EC2 User Guide for Linux Instances.

func (Tag) String 

func (s Tag) String() string

String returns the string representation

type TagFilter 

type TagFilter struct {

	// One part of a key-value pair that make up a tag. A key is a general label
	// that acts like a category for more specific tag values.
	Key *string `min:"1" type:"string"`

	// The optional part of a key-value pair that make up a tag. A value acts as
	// a descriptor within a tag category (key).
	Values []string `type:"list"`
	// contains filtered or unexported fields
}

A list of tags (keys and values) that are used to specify the associated resources.

func (TagFilter) String 

func (s TagFilter) String() string

String returns the string representation

func (*TagFilter) Validate 

func (s *TagFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourcesInput 

type TagResourcesInput struct {

	// 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 (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the AWS General Reference.
	//
	// ResourceARNList is a required field
	ResourceARNList []string `min:"1" type:"list" required:"true"`

	// The tags that you want to add to the specified resources. A tag consists
	// of a key and a value that you define.
	//
	// Tags is a required field
	Tags map[string]string `min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourcesInput) String 

func (s TagResourcesInput) String() string

String returns the string representation

func (*TagResourcesInput) Validate 

func (s *TagResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourcesOutput 

type TagResourcesOutput struct {

	// Details of resources that could not be tagged. An error code, status code,
	// and error message are returned for each failed item.
	FailedResourcesMap map[string]FailureInfo `type:"map"`
	// contains filtered or unexported fields
}

func (TagResourcesOutput) String 

func (s TagResourcesOutput) String() string

String returns the string representation

type TagResourcesRequest 

type TagResourcesRequest struct {
	*aws.Request
	Input *TagResourcesInput
	Copy  func(*TagResourcesInput) TagResourcesRequest
}

TagResourcesRequest is the request type for the TagResources API operation.

func (TagResourcesRequest) Send 

func (r TagResourcesRequest) Send(ctx context.Context) (*TagResourcesResponse, error)

Send marshals and sends the TagResources API request.

type TagResourcesResponse added in v0.9.0 

type TagResourcesResponse struct {
	*TagResourcesOutput
	// contains filtered or unexported fields
}

TagResourcesResponse is the response type for the TagResources API operation.

func (*TagResourcesResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResources request.

type UntagResourcesInput 

type UntagResourcesInput struct {

	// 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 (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the AWS General Reference.
	//
	// ResourceARNList is a required field
	ResourceARNList []string `min:"1" type:"list" required:"true"`

	// A list of the tag keys that you want to remove from the specified resources.
	//
	// TagKeys is a required field
	TagKeys []string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourcesInput) String 

func (s UntagResourcesInput) String() string

String returns the string representation

func (*UntagResourcesInput) Validate 

func (s *UntagResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourcesOutput 

type UntagResourcesOutput struct {

	// Details of resources that could not be untagged. An error code, status code,
	// and error message are returned for each failed item.
	FailedResourcesMap map[string]FailureInfo `type:"map"`
	// contains filtered or unexported fields
}

func (UntagResourcesOutput) String 

func (s UntagResourcesOutput) String() string

String returns the string representation

type UntagResourcesRequest 

type UntagResourcesRequest struct {
	*aws.Request
	Input *UntagResourcesInput
	Copy  func(*UntagResourcesInput) UntagResourcesRequest
}

UntagResourcesRequest is the request type for the UntagResources API operation.

func (UntagResourcesRequest) Send 

func (r UntagResourcesRequest) Send(ctx context.Context) (*UntagResourcesResponse, error)

Send marshals and sends the UntagResources API request.

type UntagResourcesResponse added in v0.9.0 

type UntagResourcesResponse struct {
	*UntagResourcesOutput
	// contains filtered or unexported fields
}

UntagResourcesResponse is the response type for the UntagResources API operation.

func (*UntagResourcesResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResources request.

Source Files

View all Source files

Directories

Path Synopsis
Package resourcegroupstaggingapiiface provides an interface to enable mocking the AWS Resource Groups Tagging API service client for testing your code.
 Package resourcegroupstaggingapiiface provides an interface to enable mocking the AWS Resource Groups Tagging API service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.