resourcegroupstaggingapi

package
v1.45.22 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2023 License: Apache-2.0 Imports: 9 Imported by: 231

Documentation

Overview

Package resourcegroupstaggingapi provides the client and types for making API requests to AWS Resource Groups Tagging API.

Resource Groups Tagging API

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 contact 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 ResourceGroupsTaggingAPI 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 (
	// ErrorCodeInternalServiceException is a ErrorCode enum value
	ErrorCodeInternalServiceException = "InternalServiceException"

	// ErrorCodeInvalidParameterException is a ErrorCode enum value
	ErrorCodeInvalidParameterException = "InvalidParameterException"
)
View Source 
const (
	// GroupByAttributeTargetId is a GroupByAttribute enum value
	GroupByAttributeTargetId = "TARGET_ID"

	// GroupByAttributeRegion is a GroupByAttribute enum value
	GroupByAttributeRegion = "REGION"

	// GroupByAttributeResourceType is a GroupByAttribute enum value
	GroupByAttributeResourceType = "RESOURCE_TYPE"
)
View Source 
const (
	// TargetIdTypeAccount is a TargetIdType enum value
	TargetIdTypeAccount = "ACCOUNT"

	// TargetIdTypeOu is a TargetIdType enum value
	TargetIdTypeOu = "OU"

	// TargetIdTypeRoot is a TargetIdType enum value
	TargetIdTypeRoot = "ROOT"
)
View Source 
const (

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// The target of the operation is currently being modified by a different request.
	// Try again later.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeConstraintViolationException for service response error code
	// "ConstraintViolationException".
	//
	// The request was denied because performing this operation violates a constraint.
	//
	// Some of the reasons in the following list might not apply to this specific
	// operation.
	//
	//    * You must meet the prerequisites for using tag policies. For information,
	//    see Prerequisites and Permissions for Using Tag Policies (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html)
	//    in the Organizations User Guide.
	//
	//    * You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com)
	//    to integrate with Organizations For information, see EnableAWSServiceAccess
	//    (https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html).
	//
	//    * You must have a tag policy attached to the organization root, an OU,
	//    or an account.
	ErrCodeConstraintViolationException = "ConstraintViolationException"

	// 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".
	//
	// This error indicates one of the following:
	//
	//    * A parameter is missing.
	//
	//    * A malformed string was supplied for the request parameter.
	//
	//    * An out-of-range value was supplied for the request parameter.
	//
	//    * The target ID is invalid, unsupported, or doesn't exist.
	//
	//    * You can't access the Amazon S3 bucket for report storage. For more information,
	//    see Additional Requirements for Organization-wide Tag Compliance Reports
	//    (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html#bucket-policies-org-report)
	//    in the Organizations User Guide.
	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"
)
View Source 
const (
	ServiceName = "tagging"                     // Name of service.
	EndpointsID = ServiceName                   // ID to lookup a service endpoint with.
	ServiceID   = "Resource Groups Tagging API" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ErrorCode_Values added in v1.34.3 

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func GroupByAttribute_Values added in v1.34.3 

func GroupByAttribute_Values() []string

GroupByAttribute_Values returns all elements of the GroupByAttribute enum

func TargetIdType_Values added in v1.34.3 

func TargetIdType_Values() []string

TargetIdType_Values returns all elements of the TargetIdType enum

Types

type ComplianceDetails added in v1.20.3 

type ComplianceDetails struct {

	// Whether a resource is compliant with the effective tag policy.
	ComplianceStatus *bool `type:"boolean"`

	// These are keys defined in the effective policy that are on the resource with
	// either incorrect case treatment or noncompliant values.
	KeysWithNoncompliantValues []*string `type:"list"`

	// These tag keys on the resource are noncompliant with the effective tag policy.
	NoncompliantKeys []*string `type:"list"`
	// contains filtered or unexported fields
}

Information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.

func (ComplianceDetails) GoString added in v1.20.3 

func (s ComplianceDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComplianceDetails) SetComplianceStatus added in v1.20.3 

func (s *ComplianceDetails) SetComplianceStatus(v bool) *ComplianceDetails

SetComplianceStatus sets the ComplianceStatus field's value.

func (*ComplianceDetails) SetKeysWithNoncompliantValues added in v1.25.43 

func (s *ComplianceDetails) SetKeysWithNoncompliantValues(v []*string) *ComplianceDetails

SetKeysWithNoncompliantValues sets the KeysWithNoncompliantValues field's value.

func (*ComplianceDetails) SetNoncompliantKeys added in v1.25.43 

func (s *ComplianceDetails) SetNoncompliantKeys(v []*string) *ComplianceDetails

SetNoncompliantKeys sets the NoncompliantKeys field's value.

func (ComplianceDetails) String added in v1.20.3 

func (s ComplianceDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConcurrentModificationException added in v1.28.0 

type ConcurrentModificationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The target of the operation is currently being modified by a different request. Try again later.

func (*ConcurrentModificationException) Code added in v1.28.0 

func (s *ConcurrentModificationException) Code() string

Code returns the exception type name.

func (*ConcurrentModificationException) Error added in v1.28.0 

func (s *ConcurrentModificationException) Error() string

func (ConcurrentModificationException) GoString added in v1.28.0 

func (s ConcurrentModificationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConcurrentModificationException) Message added in v1.28.0 

func (s *ConcurrentModificationException) Message() string

Message returns the exception's message.

func (*ConcurrentModificationException) OrigErr added in v1.28.0 

func (s *ConcurrentModificationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentModificationException) RequestID added in v1.28.0 

func (s *ConcurrentModificationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentModificationException) StatusCode added in v1.28.0 

func (s *ConcurrentModificationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentModificationException) String added in v1.28.0 

func (s ConcurrentModificationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConstraintViolationException added in v1.28.0 

type ConstraintViolationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request was denied because performing this operation violates a constraint.

Some of the reasons in the following list might not apply to this specific operation.

func (*ConstraintViolationException) Code added in v1.28.0 

func (s *ConstraintViolationException) Code() string

Code returns the exception type name.

func (*ConstraintViolationException) Error added in v1.28.0 

func (s *ConstraintViolationException) Error() string

func (ConstraintViolationException) GoString added in v1.28.0 

func (s ConstraintViolationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConstraintViolationException) Message added in v1.28.0 

func (s *ConstraintViolationException) Message() string

Message returns the exception's message.

func (*ConstraintViolationException) OrigErr added in v1.28.0 

func (s *ConstraintViolationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConstraintViolationException) RequestID added in v1.28.0 

func (s *ConstraintViolationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConstraintViolationException) StatusCode added in v1.28.0 

func (s *ConstraintViolationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConstraintViolationException) String added in v1.28.0 

func (s ConstraintViolationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeReportCreationInput added in v1.20.3 

type DescribeReportCreationInput struct {
	// contains filtered or unexported fields
}

func (DescribeReportCreationInput) GoString added in v1.20.3 

func (s DescribeReportCreationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeReportCreationInput) String added in v1.20.3 

func (s DescribeReportCreationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeReportCreationOutput added in v1.20.3 

type DescribeReportCreationOutput struct {

	// Details of the common errors that all operations return.
	ErrorMessage *string `type:"string"`

	// The path to the Amazon S3 bucket where the report was stored on creation.
	S3Location *string `type:"string"`

	// Reports the status of the operation.
	//
	// The operation status can be one of the following:
	//
	//    * RUNNING - Report creation is in progress.
	//
	//    * SUCCEEDED - Report creation is complete. You can open the report from
	//    the Amazon S3 bucket that you specified when you ran StartReportCreation.
	//
	//    * FAILED - Report creation timed out or the Amazon S3 bucket is not accessible.
	//
	//    * NO REPORT - No report was generated in the last 90 days.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeReportCreationOutput) GoString added in v1.20.3 

func (s DescribeReportCreationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReportCreationOutput) SetErrorMessage added in v1.20.3 

func (s *DescribeReportCreationOutput) SetErrorMessage(v string) *DescribeReportCreationOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeReportCreationOutput) SetS3Location added in v1.20.3 

func (s *DescribeReportCreationOutput) SetS3Location(v string) *DescribeReportCreationOutput

SetS3Location sets the S3Location field's value.

func (*DescribeReportCreationOutput) SetStatus added in v1.20.3 

func (s *DescribeReportCreationOutput) SetStatus(v string) *DescribeReportCreationOutput

SetStatus sets the Status field's value.

func (DescribeReportCreationOutput) String added in v1.20.3 

func (s DescribeReportCreationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailureInfo 

type FailureInfo struct {

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

	// 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
}

Information about the errors that are returned for each failed resource. This information can include InternalServiceException and InvalidParameterException errors. It can also include any valid error code returned by the Amazon Web Services service that hosts the resource that the ARN key represents.

The following are common error codes that you might receive from other Amazon Web Services services:

For more information on errors that are generated from other Amazon Web Services services, see the documentation for that service.

func (FailureInfo) GoString 

func (s FailureInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailureInfo) SetErrorCode 

func (s *FailureInfo) SetErrorCode(v string) *FailureInfo

SetErrorCode sets the ErrorCode field's value.

func (*FailureInfo) SetErrorMessage 

func (s *FailureInfo) SetErrorMessage(v string) *FailureInfo

SetErrorMessage sets the ErrorMessage field's value.

func (*FailureInfo) SetStatusCode 

func (s *FailureInfo) SetStatusCode(v int64) *FailureInfo

SetStatusCode sets the StatusCode field's value.

func (FailureInfo) String 

func (s FailureInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetComplianceSummaryInput added in v1.20.3 

type GetComplianceSummaryInput struct {

	// Specifies a list of attributes to group the counts of noncompliant resources
	// by. If supplied, the counts are sorted by those attributes.
	GroupBy []*string `type:"list" enum:"GroupByAttribute"`

	// Specifies the maximum number of results to be returned in each page. A query
	// can return fewer than this maximum, even if there are more results still
	// to return. You should always check the PaginationToken response value to
	// see if there are more results. You can specify a minimum of 1 and a maximum
	// value of 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Specifies a PaginationToken response value from a previous request to indicate
	// that you want the next page of results. Leave this parameter empty in your
	// initial request.
	PaginationToken *string `type:"string"`

	// Specifies a list of Amazon Web Services Regions to limit the output to. If
	// you use this parameter, the count of returned noncompliant resources includes
	// only resources in the specified Regions.
	RegionFilters []*string `min:"1" type:"list"`

	// Specifies that you want the response to include information for only resources
	// of the specified types. 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 Amazon Web Services
	// General Reference (https://docs.aws.amazon.com/general/latest/gr/) for the
	// following:
	//
	//    * For a list of service name strings, see Amazon Web Services Service
	//    Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces).
	//
	//    * For resource type strings, see Example ARNs (https://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
	//    Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	//
	// You can specify multiple resource types by using a comma separated 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"`

	// Specifies that you want the response to include information for only resources
	// that have tags with the specified tag keys. If you use this parameter, the
	// count of returned noncompliant resources includes only resources that have
	// the specified tag keys.
	TagKeyFilters []*string `min:"1" type:"list"`

	// Specifies target identifiers (usually, specific account IDs) to limit the
	// output by. If you use this parameter, the count of returned noncompliant
	// resources includes only resources with the specified target IDs.
	TargetIdFilters []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (GetComplianceSummaryInput) GoString added in v1.20.3 

func (s GetComplianceSummaryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComplianceSummaryInput) SetGroupBy added in v1.20.3 

func (s *GetComplianceSummaryInput) SetGroupBy(v []*string) *GetComplianceSummaryInput

SetGroupBy sets the GroupBy field's value.

func (*GetComplianceSummaryInput) SetMaxResults added in v1.20.3 

func (s *GetComplianceSummaryInput) SetMaxResults(v int64) *GetComplianceSummaryInput

SetMaxResults sets the MaxResults field's value.

func (*GetComplianceSummaryInput) SetPaginationToken added in v1.20.3 

func (s *GetComplianceSummaryInput) SetPaginationToken(v string) *GetComplianceSummaryInput

SetPaginationToken sets the PaginationToken field's value.

func (*GetComplianceSummaryInput) SetRegionFilters added in v1.20.3 

func (s *GetComplianceSummaryInput) SetRegionFilters(v []*string) *GetComplianceSummaryInput

SetRegionFilters sets the RegionFilters field's value.

func (*GetComplianceSummaryInput) SetResourceTypeFilters added in v1.20.3 

func (s *GetComplianceSummaryInput) SetResourceTypeFilters(v []*string) *GetComplianceSummaryInput

SetResourceTypeFilters sets the ResourceTypeFilters field's value.

func (*GetComplianceSummaryInput) SetTagKeyFilters added in v1.20.3 

func (s *GetComplianceSummaryInput) SetTagKeyFilters(v []*string) *GetComplianceSummaryInput

SetTagKeyFilters sets the TagKeyFilters field's value.

func (*GetComplianceSummaryInput) SetTargetIdFilters added in v1.20.3 

func (s *GetComplianceSummaryInput) SetTargetIdFilters(v []*string) *GetComplianceSummaryInput

SetTargetIdFilters sets the TargetIdFilters field's value.

func (GetComplianceSummaryInput) String added in v1.20.3 

func (s GetComplianceSummaryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComplianceSummaryInput) Validate added in v1.20.3 

func (s *GetComplianceSummaryInput) Validate() error

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

type GetComplianceSummaryOutput added in v1.20.3 

type GetComplianceSummaryOutput struct {

	// A string that indicates that there is more data available than this response
	// contains. To receive the next part of the response, specify this response
	// value as the PaginationToken value in the request for the next page.
	PaginationToken *string `type:"string"`

	// A table that shows counts of noncompliant resources.
	SummaryList []*Summary `type:"list"`
	// contains filtered or unexported fields
}

func (GetComplianceSummaryOutput) GoString added in v1.20.3 

func (s GetComplianceSummaryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComplianceSummaryOutput) SetPaginationToken added in v1.20.3 

func (s *GetComplianceSummaryOutput) SetPaginationToken(v string) *GetComplianceSummaryOutput

SetPaginationToken sets the PaginationToken field's value.

func (*GetComplianceSummaryOutput) SetSummaryList added in v1.20.3 

func (s *GetComplianceSummaryOutput) SetSummaryList(v []*Summary) *GetComplianceSummaryOutput

SetSummaryList sets the SummaryList field's value.

func (GetComplianceSummaryOutput) String added in v1.20.3 

func (s GetComplianceSummaryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetResourcesInput 

type GetResourcesInput struct {

	// Specifies whether to exclude resources that are compliant with the tag policy.
	// Set this to true if you are interested in retrieving information on noncompliant
	// resources only.
	//
	// You can use this parameter only if the IncludeComplianceDetails parameter
	// is also set to true.
	ExcludeCompliantResources *bool `type:"boolean"`

	// Specifies whether to include details regarding the compliance with the effective
	// tag policy. Set this to true to determine whether resources are compliant
	// with the tag policy and to get details.
	IncludeComplianceDetails *bool `type:"boolean"`

	// Specifies a PaginationToken response value from a previous request to indicate
	// that you want the next page of results. Leave this parameter empty in your
	// initial request.
	PaginationToken *string `type:"string"`

	// Specifies a list of ARNs of resources for which you want to retrieve tag
	// data. You can't specify both this parameter and any of the pagination parameters
	// (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If
	// you specify both, you get an Invalid Parameter exception.
	//
	// If a resource specified by this parameter doesn't exist, it doesn't generate
	// an error; it simply isn't included in the response.
	//
	// An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,
	// see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces
	// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	ResourceARNList []*string `min:"1" type:"list"`

	// Specifies the resource types that you want included in the response. 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). For the list of services whose
	// resources you can use in this parameter, see Services that support the Resource
	// Groups Tagging API (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.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. For example, the following string would limit
	// the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit
	// Manager resource:
	//
	// ec2:instance,s3:bucket,auditmanager
	ResourceTypeFilters []*string `type:"list"`

	// Specifies the maximum number of results to be returned in each page. A query
	// can return fewer than this maximum, even if there are more results still
	// to return. You should always check the PaginationToken response value to
	// see if there are more results. You can specify a minimum of 1 and a maximum
	// value of 100.
	ResourcesPerPage *int64 `type:"integer"`

	// Specifies a list of TagFilters (keys and values) to restrict the output to
	// only those resources that have tags with the specified keys and, if included,
	// the specified values. Each TagFilter must contain a key with values 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 don't specify a TagFilter, the response includes all resources
	//    that are currently tagged or ever had a tag. Resources that currently
	//    don't have 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 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 a value for a key, the response returns all resources
	//    that are tagged with that key, with any or no value. For example, for
	//    the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}},
	//    filter3= {keyC}: 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 with the key key3, and with any or no value GetResources({filter1,filter2,filter3})
	//    returns resources tagged with (key1=value1) and (key2=value2 or key2=value3
	//    or key2=value4) and (key3, any or no value)
	TagFilters []*TagFilter `type:"list"`

	// Amazon Web Services recommends using ResourcesPerPage instead of this parameter.
	//
	// 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
	// three pages. The first page displays the first 10 resources, each with its
	// 10 tags. The second page displays the next 10 resources, each with its 10
	// tags. The third page displays the remaining 2 resources, each with its 10
	// tags.
	//
	// You can set TagsPerPage to a minimum of 100 items up to a maximum of 500
	// items.
	TagsPerPage *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (GetResourcesInput) GoString 

func (s GetResourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetResourcesInput) SetExcludeCompliantResources added in v1.20.3 

func (s *GetResourcesInput) SetExcludeCompliantResources(v bool) *GetResourcesInput

SetExcludeCompliantResources sets the ExcludeCompliantResources field's value.

func (*GetResourcesInput) SetIncludeComplianceDetails added in v1.20.3 

func (s *GetResourcesInput) SetIncludeComplianceDetails(v bool) *GetResourcesInput

SetIncludeComplianceDetails sets the IncludeComplianceDetails field's value.

func (*GetResourcesInput) SetPaginationToken 

func (s *GetResourcesInput) SetPaginationToken(v string) *GetResourcesInput

SetPaginationToken sets the PaginationToken field's value.

func (*GetResourcesInput) SetResourceARNList added in v1.36.30 

func (s *GetResourcesInput) SetResourceARNList(v []*string) *GetResourcesInput

SetResourceARNList sets the ResourceARNList field's value.

func (*GetResourcesInput) SetResourceTypeFilters 

func (s *GetResourcesInput) SetResourceTypeFilters(v []*string) *GetResourcesInput

SetResourceTypeFilters sets the ResourceTypeFilters field's value.

func (*GetResourcesInput) SetResourcesPerPage added in v1.8.27 

func (s *GetResourcesInput) SetResourcesPerPage(v int64) *GetResourcesInput

SetResourcesPerPage sets the ResourcesPerPage field's value.

func (*GetResourcesInput) SetTagFilters 

func (s *GetResourcesInput) SetTagFilters(v []*TagFilter) *GetResourcesInput

SetTagFilters sets the TagFilters field's value.

func (*GetResourcesInput) SetTagsPerPage 

func (s *GetResourcesInput) SetTagsPerPage(v int64) *GetResourcesInput

SetTagsPerPage sets the TagsPerPage field's value.

func (GetResourcesInput) String 

func (s GetResourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 there is more data available than this response
	// contains. To receive the next part of the response, specify this response
	// value as the PaginationToken value in the request for the next page.
	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) GoString 

func (s GetResourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetResourcesOutput) SetPaginationToken 

func (s *GetResourcesOutput) SetPaginationToken(v string) *GetResourcesOutput

SetPaginationToken sets the PaginationToken field's value.

func (*GetResourcesOutput) SetResourceTagMappingList 

func (s *GetResourcesOutput) SetResourceTagMappingList(v []*ResourceTagMapping) *GetResourcesOutput

SetResourceTagMappingList sets the ResourceTagMappingList field's value.

func (GetResourcesOutput) String 

func (s GetResourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetTagKeysInput 

type GetTagKeysInput struct {

	// Specifies a PaginationToken response value from a previous request to indicate
	// that you want the next page of results. Leave this parameter empty in your
	// initial request.
	PaginationToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetTagKeysInput) GoString 

func (s GetTagKeysInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTagKeysInput) SetPaginationToken 

func (s *GetTagKeysInput) SetPaginationToken(v string) *GetTagKeysInput

SetPaginationToken sets the PaginationToken field's value.

func (GetTagKeysInput) String 

func (s GetTagKeysInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetTagKeysOutput 

type GetTagKeysOutput struct {

	// A string that indicates that there is more data available than this response
	// contains. To receive the next part of the response, specify this response
	// value as the PaginationToken value in the request for the next page.
	PaginationToken *string `type:"string"`

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

func (GetTagKeysOutput) GoString 

func (s GetTagKeysOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTagKeysOutput) SetPaginationToken 

func (s *GetTagKeysOutput) SetPaginationToken(v string) *GetTagKeysOutput

SetPaginationToken sets the PaginationToken field's value.

func (*GetTagKeysOutput) SetTagKeys 

func (s *GetTagKeysOutput) SetTagKeys(v []*string) *GetTagKeysOutput

SetTagKeys sets the TagKeys field's value.

func (GetTagKeysOutput) String 

func (s GetTagKeysOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetTagValuesInput 

type GetTagValuesInput struct {

	// Specifies the tag key for which you want to list all existing values that
	// are currently used in the specified Amazon Web Services Region for the calling
	// account.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// Specifies a PaginationToken response value from a previous request to indicate
	// that you want the next page of results. Leave this parameter empty in your
	// initial request.
	PaginationToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetTagValuesInput) GoString 

func (s GetTagValuesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTagValuesInput) SetKey 

func (s *GetTagValuesInput) SetKey(v string) *GetTagValuesInput

SetKey sets the Key field's value.

func (*GetTagValuesInput) SetPaginationToken 

func (s *GetTagValuesInput) SetPaginationToken(v string) *GetTagValuesInput

SetPaginationToken sets the PaginationToken field's value.

func (GetTagValuesInput) String 

func (s GetTagValuesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 there is more data available than this response
	// contains. To receive the next part of the response, specify this response
	// value as the PaginationToken value in the request for the next page.
	PaginationToken *string `type:"string"`

	// A list of all tag values for the specified key currently used in the specified
	// Amazon Web Services Region for the calling account.
	TagValues []*string `type:"list"`
	// contains filtered or unexported fields
}

func (GetTagValuesOutput) GoString 

func (s GetTagValuesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTagValuesOutput) SetPaginationToken 

func (s *GetTagValuesOutput) SetPaginationToken(v string) *GetTagValuesOutput

SetPaginationToken sets the PaginationToken field's value.

func (*GetTagValuesOutput) SetTagValues 

func (s *GetTagValuesOutput) SetTagValues(v []*string) *GetTagValuesOutput

SetTagValues sets the TagValues field's value.

func (GetTagValuesOutput) String 

func (s GetTagValuesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServiceException added in v1.28.0 

type InternalServiceException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request processing failed because of an unknown error, exception, or failure. You can retry the request.

func (*InternalServiceException) Code added in v1.28.0 

func (s *InternalServiceException) Code() string

Code returns the exception type name.

func (*InternalServiceException) Error added in v1.28.0 

func (s *InternalServiceException) Error() string

func (InternalServiceException) GoString added in v1.28.0 

func (s InternalServiceException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServiceException) Message added in v1.28.0 

func (s *InternalServiceException) Message() string

Message returns the exception's message.

func (*InternalServiceException) OrigErr added in v1.28.0 

func (s *InternalServiceException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceException) RequestID added in v1.28.0 

func (s *InternalServiceException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceException) StatusCode added in v1.28.0 

func (s *InternalServiceException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServiceException) String added in v1.28.0 

func (s InternalServiceException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidParameterException added in v1.28.0 

type InvalidParameterException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

This error indicates one of the following:

func (*InvalidParameterException) Code added in v1.28.0 

func (s *InvalidParameterException) Code() string

Code returns the exception type name.

func (*InvalidParameterException) Error added in v1.28.0 

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString added in v1.28.0 

func (s InvalidParameterException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidParameterException) Message added in v1.28.0 

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr added in v1.28.0 

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID added in v1.28.0 

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode added in v1.28.0 

func (s *InvalidParameterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterException) String added in v1.28.0 

func (s InvalidParameterException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PaginationTokenExpiredException added in v1.28.0 

type PaginationTokenExpiredException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

A PaginationToken is valid for a maximum of 15 minutes. Your request was denied because the specified PaginationToken has expired.

func (*PaginationTokenExpiredException) Code added in v1.28.0 

func (s *PaginationTokenExpiredException) Code() string

Code returns the exception type name.

func (*PaginationTokenExpiredException) Error added in v1.28.0 

func (s *PaginationTokenExpiredException) Error() string

func (PaginationTokenExpiredException) GoString added in v1.28.0 

func (s PaginationTokenExpiredException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PaginationTokenExpiredException) Message added in v1.28.0 

func (s *PaginationTokenExpiredException) Message() string

Message returns the exception's message.

func (*PaginationTokenExpiredException) OrigErr added in v1.28.0 

func (s *PaginationTokenExpiredException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PaginationTokenExpiredException) RequestID added in v1.28.0 

func (s *PaginationTokenExpiredException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PaginationTokenExpiredException) StatusCode added in v1.28.0 

func (s *PaginationTokenExpiredException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (PaginationTokenExpiredException) String added in v1.28.0 

func (s PaginationTokenExpiredException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceGroupsTaggingAPI 

type ResourceGroupsTaggingAPI struct {
	*client.Client
}

ResourceGroupsTaggingAPI 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.

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ResourceGroupsTaggingAPI

New creates a new instance of the ResourceGroupsTaggingAPI client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a ResourceGroupsTaggingAPI client from just a session.
svc := resourcegroupstaggingapi.New(mySession)

// Create a ResourceGroupsTaggingAPI client with additional configuration
svc := resourcegroupstaggingapi.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ResourceGroupsTaggingAPI) DescribeReportCreation added in v1.20.3 

func (c *ResourceGroupsTaggingAPI) DescribeReportCreation(input *DescribeReportCreationInput) (*DescribeReportCreationOutput, error)

DescribeReportCreation API operation for AWS Resource Groups Tagging API.

Describes the status of the StartReportCreation operation.

You can call this operation only from the organization's management account and from the us-east-1 Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Resource Groups Tagging API's API operation DescribeReportCreation for usage and error information.

Returned Error Types:

See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/DescribeReportCreation

func (*ResourceGroupsTaggingAPI) DescribeReportCreationRequest added in v1.20.3 

func (c *ResourceGroupsTaggingAPI) DescribeReportCreationRequest(input *DescribeReportCreationInput) (req *request.Request, output *DescribeReportCreationOutput)

DescribeReportCreationRequest generates a "aws/request.Request" representing the client's request for the DescribeReportCreation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeReportCreation for more information on using the DescribeReportCreation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeReportCreationRequest method.
req, resp := client.DescribeReportCreationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/DescribeReportCreation

func (*ResourceGroupsTaggingAPI) DescribeReportCreationWithContext added in v1.20.3 

func (c *ResourceGroupsTaggingAPI) DescribeReportCreationWithContext(ctx aws.Context, input *DescribeReportCreationInput, opts ...request.Option) (*DescribeReportCreationOutput, error)

DescribeReportCreationWithContext is the same as DescribeReportCreation with the addition of the ability to pass a context and additional request options.

See DescribeReportCreation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ResourceGroupsTaggingAPI) GetComplianceSummary added in v1.20.3 

func (c *ResourceGroupsTaggingAPI) GetComplianceSummary(input *GetComplianceSummaryInput) (*GetComplianceSummaryOutput, error)

GetComplianceSummary API operation for AWS Resource Groups Tagging API.

Returns a table that shows counts of resources that are noncompliant with their tag policies.

For more information on tag policies, see Tag Policies (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) in the Organizations User Guide.

You can call this operation only from the organization's management account and from the us-east-1 Region.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Resource Groups Tagging API's API operation GetComplianceSummary for usage and error information.

Returned Error Types:

See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetComplianceSummary

func (*ResourceGroupsTaggingAPI) GetComplianceSummaryPages added in v1.20.3 

func (c *ResourceGroupsTaggingAPI) GetComplianceSummaryPages(input *GetComplianceSummaryInput, fn func(*GetComplianceSummaryOutput, bool) bool) error

GetComplianceSummaryPages iterates over the pages of a GetComplianceSummary operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetComplianceSummary method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a GetComplianceSummary operation.
pageNum := 0
err := client.GetComplianceSummaryPages(params,
    func(page *resourcegroupstaggingapi.GetComplianceSummaryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ResourceGroupsTaggingAPI) GetComplianceSummaryPagesWithContext added in v1.20.3 

func (c *ResourceGroupsTaggingAPI) GetComplianceSummaryPagesWithContext(ctx aws.Context, input *GetComplianceSummaryInput, fn func(*GetComplianceSummaryOutput, bool) bool, opts ...request.Option) error

GetComplianceSummaryPagesWithContext same as GetComplianceSummaryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ResourceGroupsTaggingAPI) GetComplianceSummaryRequest added in v1.20.3 

func (c *ResourceGroupsTaggingAPI) GetComplianceSummaryRequest(input *GetComplianceSummaryInput) (req *request.Request, output *GetComplianceSummaryOutput)

GetComplianceSummaryRequest generates a "aws/request.Request" representing the client's request for the GetComplianceSummary operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetComplianceSummary for more information on using the GetComplianceSummary API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetComplianceSummaryRequest method.
req, resp := client.GetComplianceSummaryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetComplianceSummary

func (*ResourceGroupsTaggingAPI) GetComplianceSummaryWithContext added in v1.20.3 

func (c *ResourceGroupsTaggingAPI) GetComplianceSummaryWithContext(ctx aws.Context, input *GetComplianceSummaryInput, opts ...request.Option) (*GetComplianceSummaryOutput, error)

GetComplianceSummaryWithContext is the same as GetComplianceSummary with the addition of the ability to pass a context and additional request options.

See GetComplianceSummary for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ResourceGroupsTaggingAPI) GetResources 

func (c *ResourceGroupsTaggingAPI) GetResources(input *GetResourcesInput) (*GetResourcesOutput, error)

GetResources API operation for AWS Resource Groups Tagging API.

Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account.

Depending on what information you want returned, you can also specify the following:

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Resource Groups Tagging API's API operation GetResources for usage and error information.

Returned Error Types:

  • InvalidParameterException This error indicates one of the following:

  • A parameter is missing.

  • A malformed string was supplied for the request parameter.

  • An out-of-range value was supplied for the request parameter.

  • The target ID is invalid, unsupported, or doesn't exist.

  • You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html#bucket-policies-org-report) in the Organizations User Guide.

  • ThrottledException The request was denied to limit the frequency of submitted requests.

  • InternalServiceException The request processing failed because of an unknown error, exception, or failure. You can retry the request.

  • PaginationTokenExpiredException A PaginationToken is valid for a maximum of 15 minutes. Your request was denied because the specified PaginationToken has expired.

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

func (*ResourceGroupsTaggingAPI) GetResourcesPages added in v1.8.27 

func (c *ResourceGroupsTaggingAPI) GetResourcesPages(input *GetResourcesInput, fn func(*GetResourcesOutput, bool) bool) error

GetResourcesPages iterates over the pages of a GetResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetResources method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a GetResources operation.
pageNum := 0
err := client.GetResourcesPages(params,
    func(page *resourcegroupstaggingapi.GetResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ResourceGroupsTaggingAPI) GetResourcesPagesWithContext added in v1.8.27 

func (c *ResourceGroupsTaggingAPI) GetResourcesPagesWithContext(ctx aws.Context, input *GetResourcesInput, fn func(*GetResourcesOutput, bool) bool, opts ...request.Option) error

GetResourcesPagesWithContext same as GetResourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ResourceGroupsTaggingAPI) GetResourcesRequest 

func (c *ResourceGroupsTaggingAPI) GetResourcesRequest(input *GetResourcesInput) (req *request.Request, output *GetResourcesOutput)

GetResourcesRequest generates a "aws/request.Request" representing the client's request for the GetResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetResources for more information on using the GetResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetResourcesRequest method.
req, resp := client.GetResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ResourceGroupsTaggingAPI) GetResourcesWithContext 

func (c *ResourceGroupsTaggingAPI) GetResourcesWithContext(ctx aws.Context, input *GetResourcesInput, opts ...request.Option) (*GetResourcesOutput, error)

GetResourcesWithContext is the same as GetResources with the addition of the ability to pass a context and additional request options.

See GetResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ResourceGroupsTaggingAPI) GetTagKeys 

func (c *ResourceGroupsTaggingAPI) GetTagKeys(input *GetTagKeysInput) (*GetTagKeysOutput, error)

GetTagKeys API operation for AWS Resource Groups Tagging API.

Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling account.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Resource Groups Tagging API's API operation GetTagKeys for usage and error information.

Returned Error Types:

  • InvalidParameterException This error indicates one of the following:

  • A parameter is missing.

  • A malformed string was supplied for the request parameter.

  • An out-of-range value was supplied for the request parameter.

  • The target ID is invalid, unsupported, or doesn't exist.

  • You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html#bucket-policies-org-report) in the Organizations User Guide.

  • ThrottledException The request was denied to limit the frequency of submitted requests.

  • InternalServiceException The request processing failed because of an unknown error, exception, or failure. You can retry the request.

  • PaginationTokenExpiredException A PaginationToken is valid for a maximum of 15 minutes. Your request was denied because the specified PaginationToken has expired.

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

func (*ResourceGroupsTaggingAPI) GetTagKeysPages added in v1.8.27 

func (c *ResourceGroupsTaggingAPI) GetTagKeysPages(input *GetTagKeysInput, fn func(*GetTagKeysOutput, bool) bool) error

GetTagKeysPages iterates over the pages of a GetTagKeys operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetTagKeys method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a GetTagKeys operation.
pageNum := 0
err := client.GetTagKeysPages(params,
    func(page *resourcegroupstaggingapi.GetTagKeysOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ResourceGroupsTaggingAPI) GetTagKeysPagesWithContext added in v1.8.27 

func (c *ResourceGroupsTaggingAPI) GetTagKeysPagesWithContext(ctx aws.Context, input *GetTagKeysInput, fn func(*GetTagKeysOutput, bool) bool, opts ...request.Option) error

GetTagKeysPagesWithContext same as GetTagKeysPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ResourceGroupsTaggingAPI) GetTagKeysRequest 

func (c *ResourceGroupsTaggingAPI) GetTagKeysRequest(input *GetTagKeysInput) (req *request.Request, output *GetTagKeysOutput)

GetTagKeysRequest generates a "aws/request.Request" representing the client's request for the GetTagKeys operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetTagKeys for more information on using the GetTagKeys API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetTagKeysRequest method.
req, resp := client.GetTagKeysRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ResourceGroupsTaggingAPI) GetTagKeysWithContext 

func (c *ResourceGroupsTaggingAPI) GetTagKeysWithContext(ctx aws.Context, input *GetTagKeysInput, opts ...request.Option) (*GetTagKeysOutput, error)

GetTagKeysWithContext is the same as GetTagKeys with the addition of the ability to pass a context and additional request options.

See GetTagKeys for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ResourceGroupsTaggingAPI) GetTagValues 

func (c *ResourceGroupsTaggingAPI) GetTagValues(input *GetTagValuesInput) (*GetTagValuesOutput, error)

GetTagValues API operation for AWS Resource Groups Tagging API.

Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Resource Groups Tagging API's API operation GetTagValues for usage and error information.

Returned Error Types:

  • InvalidParameterException This error indicates one of the following:

  • A parameter is missing.

  • A malformed string was supplied for the request parameter.

  • An out-of-range value was supplied for the request parameter.

  • The target ID is invalid, unsupported, or doesn't exist.

  • You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html#bucket-policies-org-report) in the Organizations User Guide.

  • ThrottledException The request was denied to limit the frequency of submitted requests.

  • InternalServiceException The request processing failed because of an unknown error, exception, or failure. You can retry the request.

  • PaginationTokenExpiredException A PaginationToken is valid for a maximum of 15 minutes. Your request was denied because the specified PaginationToken has expired.

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

func (*ResourceGroupsTaggingAPI) GetTagValuesPages added in v1.8.27 

func (c *ResourceGroupsTaggingAPI) GetTagValuesPages(input *GetTagValuesInput, fn func(*GetTagValuesOutput, bool) bool) error

GetTagValuesPages iterates over the pages of a GetTagValues operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetTagValues method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a GetTagValues operation.
pageNum := 0
err := client.GetTagValuesPages(params,
    func(page *resourcegroupstaggingapi.GetTagValuesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ResourceGroupsTaggingAPI) GetTagValuesPagesWithContext added in v1.8.27 

func (c *ResourceGroupsTaggingAPI) GetTagValuesPagesWithContext(ctx aws.Context, input *GetTagValuesInput, fn func(*GetTagValuesOutput, bool) bool, opts ...request.Option) error

GetTagValuesPagesWithContext same as GetTagValuesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ResourceGroupsTaggingAPI) GetTagValuesRequest 

func (c *ResourceGroupsTaggingAPI) GetTagValuesRequest(input *GetTagValuesInput) (req *request.Request, output *GetTagValuesOutput)

GetTagValuesRequest generates a "aws/request.Request" representing the client's request for the GetTagValues operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetTagValues for more information on using the GetTagValues API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetTagValuesRequest method.
req, resp := client.GetTagValuesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ResourceGroupsTaggingAPI) GetTagValuesWithContext 

func (c *ResourceGroupsTaggingAPI) GetTagValuesWithContext(ctx aws.Context, input *GetTagValuesInput, opts ...request.Option) (*GetTagValuesOutput, error)

GetTagValuesWithContext is the same as GetTagValues with the addition of the ability to pass a context and additional request options.

See GetTagValues for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ResourceGroupsTaggingAPI) StartReportCreation added in v1.20.3 

func (c *ResourceGroupsTaggingAPI) StartReportCreation(input *StartReportCreationInput) (*StartReportCreationOutput, error)

StartReportCreation API operation for AWS Resource Groups Tagging API.

Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously.

The generated report is saved to the following location:

s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv

You can call this operation only from the organization's management account and from the us-east-1 Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Resource Groups Tagging API's API operation StartReportCreation for usage and error information.

Returned Error Types:

  • ConcurrentModificationException The target of the operation is currently being modified by a different request. Try again later.

  • ConstraintViolationException The request was denied because performing this operation violates a constraint.

    Some of the reasons in the following list might not apply to this specific operation.

  • You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html) in the Organizations User Guide.

  • You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com) to integrate with Organizations For information, see EnableAWSServiceAccess (https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html).

  • You must have a tag policy attached to the organization root, an OU, or an account.

  • InternalServiceException The request processing failed because of an unknown error, exception, or failure. You can retry the request.

  • InvalidParameterException This error indicates one of the following:

  • A parameter is missing.

  • A malformed string was supplied for the request parameter.

  • An out-of-range value was supplied for the request parameter.

  • The target ID is invalid, unsupported, or doesn't exist.

  • You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html#bucket-policies-org-report) in the Organizations User Guide.

  • ThrottledException The request was denied to limit the frequency of submitted requests.

See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/StartReportCreation

func (*ResourceGroupsTaggingAPI) StartReportCreationRequest added in v1.20.3 

func (c *ResourceGroupsTaggingAPI) StartReportCreationRequest(input *StartReportCreationInput) (req *request.Request, output *StartReportCreationOutput)

StartReportCreationRequest generates a "aws/request.Request" representing the client's request for the StartReportCreation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartReportCreation for more information on using the StartReportCreation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartReportCreationRequest method.
req, resp := client.StartReportCreationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/StartReportCreation

func (*ResourceGroupsTaggingAPI) StartReportCreationWithContext added in v1.20.3 

func (c *ResourceGroupsTaggingAPI) StartReportCreationWithContext(ctx aws.Context, input *StartReportCreationInput, opts ...request.Option) (*StartReportCreationOutput, error)

StartReportCreationWithContext is the same as StartReportCreation with the addition of the ability to pass a context and additional request options.

See StartReportCreation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ResourceGroupsTaggingAPI) TagResources 

func (c *ResourceGroupsTaggingAPI) TagResources(input *TagResourcesInput) (*TagResourcesOutput, error)

TagResources API operation for AWS Resource Groups Tagging API.

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

  • Not all resources can have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html). If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service.

  • Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions) in the Amazon Web Services General Reference.

  • You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services 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 the documentation for each service.

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

Minimum permissions

In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag an Amazon EC2 instance using the TagResources operation, you must have both of the following permissions:

  • tag:TagResource

  • ec2:CreateTags

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Resource Groups Tagging API's API operation TagResources for usage and error information.

Returned Error Types:

  • InvalidParameterException This error indicates one of the following:

  • A parameter is missing.

  • A malformed string was supplied for the request parameter.

  • An out-of-range value was supplied for the request parameter.

  • The target ID is invalid, unsupported, or doesn't exist.

  • You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html#bucket-policies-org-report) in the Organizations User Guide.

  • ThrottledException The request was denied to limit the frequency of submitted requests.

  • InternalServiceException The request processing failed because of an unknown error, exception, or failure. You can retry the request.

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

func (*ResourceGroupsTaggingAPI) TagResourcesRequest 

func (c *ResourceGroupsTaggingAPI) TagResourcesRequest(input *TagResourcesInput) (req *request.Request, output *TagResourcesOutput)

TagResourcesRequest generates a "aws/request.Request" representing the client's request for the TagResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResources for more information on using the TagResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourcesRequest method.
req, resp := client.TagResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ResourceGroupsTaggingAPI) TagResourcesWithContext 

func (c *ResourceGroupsTaggingAPI) TagResourcesWithContext(ctx aws.Context, input *TagResourcesInput, opts ...request.Option) (*TagResourcesOutput, error)

TagResourcesWithContext is the same as TagResources with the addition of the ability to pass a context and additional request options.

See TagResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ResourceGroupsTaggingAPI) UntagResources 

func (c *ResourceGroupsTaggingAPI) UntagResources(input *UntagResourcesInput) (*UntagResourcesOutput, error)

UntagResources 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 the documentation for the service whose resource you want to untag.

  • You can only tag resources that are located in the specified Amazon Web Services Region for the calling Amazon Web Services account.

Minimum permissions

In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions:

  • tag:UntagResource

  • ec2:DeleteTags

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Resource Groups Tagging API's API operation UntagResources for usage and error information.

Returned Error Types:

  • InvalidParameterException This error indicates one of the following:

  • A parameter is missing.

  • A malformed string was supplied for the request parameter.

  • An out-of-range value was supplied for the request parameter.

  • The target ID is invalid, unsupported, or doesn't exist.

  • You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html#bucket-policies-org-report) in the Organizations User Guide.

  • ThrottledException The request was denied to limit the frequency of submitted requests.

  • InternalServiceException The request processing failed because of an unknown error, exception, or failure. You can retry the request.

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

func (*ResourceGroupsTaggingAPI) UntagResourcesRequest 

func (c *ResourceGroupsTaggingAPI) UntagResourcesRequest(input *UntagResourcesInput) (req *request.Request, output *UntagResourcesOutput)

UntagResourcesRequest generates a "aws/request.Request" representing the client's request for the UntagResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResources for more information on using the UntagResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourcesRequest method.
req, resp := client.UntagResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ResourceGroupsTaggingAPI) UntagResourcesWithContext 

func (c *ResourceGroupsTaggingAPI) UntagResourcesWithContext(ctx aws.Context, input *UntagResourcesInput, opts ...request.Option) (*UntagResourcesOutput, error)

UntagResourcesWithContext is the same as UntagResources with the addition of the ability to pass a context and additional request options.

See UntagResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ResourceTagMapping 

type ResourceTagMapping struct {

	// Information that shows whether a resource is compliant with the effective
	// tag policy, including details on any noncompliant tag keys.
	ComplianceDetails *ComplianceDetails `type:"structure"`

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

	// The tags that have been applied to one or more Amazon Web Services 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) GoString 

func (s ResourceTagMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceTagMapping) SetComplianceDetails added in v1.20.3 

func (s *ResourceTagMapping) SetComplianceDetails(v *ComplianceDetails) *ResourceTagMapping

SetComplianceDetails sets the ComplianceDetails field's value.

func (*ResourceTagMapping) SetResourceARN 

func (s *ResourceTagMapping) SetResourceARN(v string) *ResourceTagMapping

SetResourceARN sets the ResourceARN field's value.

func (*ResourceTagMapping) SetTags 

func (s *ResourceTagMapping) SetTags(v []*Tag) *ResourceTagMapping

SetTags sets the Tags field's value.

func (ResourceTagMapping) String 

func (s ResourceTagMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartReportCreationInput added in v1.20.3 

type StartReportCreationInput struct {

	// The name of the Amazon S3 bucket where the report will be stored; for example:
	//
	// awsexamplebucket
	//
	// For more information on S3 bucket requirements, including an example bucket
	// policy, see the example S3 bucket policy on this page.
	//
	// S3Bucket is a required field
	S3Bucket *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartReportCreationInput) GoString added in v1.20.3 

func (s StartReportCreationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartReportCreationInput) SetS3Bucket added in v1.20.3 

func (s *StartReportCreationInput) SetS3Bucket(v string) *StartReportCreationInput

SetS3Bucket sets the S3Bucket field's value.

func (StartReportCreationInput) String added in v1.20.3 

func (s StartReportCreationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartReportCreationInput) Validate added in v1.20.3 

func (s *StartReportCreationInput) Validate() error

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

type StartReportCreationOutput added in v1.20.3 

type StartReportCreationOutput struct {
	// contains filtered or unexported fields
}

func (StartReportCreationOutput) GoString added in v1.20.3 

func (s StartReportCreationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StartReportCreationOutput) String added in v1.20.3 

func (s StartReportCreationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Summary added in v1.20.3 

type Summary struct {

	// The timestamp that shows when this summary was generated in this Region.
	LastUpdated *string `type:"string"`

	// The count of noncompliant resources.
	NonCompliantResources *int64 `type:"long"`

	// The Amazon Web Services Region that the summary applies to.
	Region *string `min:"1" type:"string"`

	// The Amazon Web Services resource type.
	ResourceType *string `type:"string"`

	// The account identifier or the root identifier of the organization. If you
	// don't know the root ID, you can call the Organizations ListRoots (https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html)
	// API.
	TargetId *string `min:"6" type:"string"`

	// Whether the target is an account, an OU, or the organization root.
	TargetIdType *string `type:"string" enum:"TargetIdType"`
	// contains filtered or unexported fields
}

A count of noncompliant resources.

func (Summary) GoString added in v1.20.3 

func (s Summary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Summary) SetLastUpdated added in v1.20.3 

func (s *Summary) SetLastUpdated(v string) *Summary

SetLastUpdated sets the LastUpdated field's value.

func (*Summary) SetNonCompliantResources added in v1.20.3 

func (s *Summary) SetNonCompliantResources(v int64) *Summary

SetNonCompliantResources sets the NonCompliantResources field's value.

func (*Summary) SetRegion added in v1.20.3 

func (s *Summary) SetRegion(v string) *Summary

SetRegion sets the Region field's value.

func (*Summary) SetResourceType added in v1.20.3 

func (s *Summary) SetResourceType(v string) *Summary

SetResourceType sets the ResourceType field's value.

func (*Summary) SetTargetId added in v1.20.3 

func (s *Summary) SetTargetId(v string) *Summary

SetTargetId sets the TargetId field's value.

func (*Summary) SetTargetIdType added in v1.25.43 

func (s *Summary) SetTargetIdType(v string) *Summary

SetTargetIdType sets the TargetIdType field's value.

func (Summary) String added in v1.20.3 

func (s Summary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag 

type Tag struct {

	// One part of a key-value pair that makes 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"`

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

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference.

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagFilter 

type TagFilter struct {

	// One part of a key-value pair that makes 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"`

	// One part of a key-value pair that make up a tag. A value acts as a descriptor
	// within a tag category (key). The value can be empty or null.
	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) GoString 

func (s TagFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagFilter) SetKey 

func (s *TagFilter) SetKey(v string) *TagFilter

SetKey sets the Key field's value.

func (*TagFilter) SetValues 

func (s *TagFilter) SetValues(v []*string) *TagFilter

SetValues sets the Values field's value.

func (TagFilter) String 

func (s TagFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// Specifies the list of ARNs of the resources that you want to apply tags to.
	//
	// An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,
	// see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces
	// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	//
	// ResourceARNList is a required field
	ResourceARNList []*string `min:"1" type:"list" required:"true"`

	// Specifies a list of 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) GoString 

func (s TagResourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourcesInput) SetResourceARNList 

func (s *TagResourcesInput) SetResourceARNList(v []*string) *TagResourcesInput

SetResourceARNList sets the ResourceARNList field's value.

func (*TagResourcesInput) SetTags 

func (s *TagResourcesInput) SetTags(v map[string]*string) *TagResourcesInput

SetTags sets the Tags field's value.

func (TagResourcesInput) String 

func (s TagResourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A map containing a key-value pair for each failed item that couldn't be tagged.
	// The key is the ARN of the failed resource. The value is a FailureInfo object
	// that contains an error code, a status code, and an error message. If there
	// are no errors, the FailedResourcesMap is empty.
	FailedResourcesMap map[string]*FailureInfo `type:"map"`
	// contains filtered or unexported fields
}

func (TagResourcesOutput) GoString 

func (s TagResourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourcesOutput) SetFailedResourcesMap 

func (s *TagResourcesOutput) SetFailedResourcesMap(v map[string]*FailureInfo) *TagResourcesOutput

SetFailedResourcesMap sets the FailedResourcesMap field's value.

func (TagResourcesOutput) String 

func (s TagResourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottledException added in v1.28.0 

type ThrottledException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request was denied to limit the frequency of submitted requests.

func (*ThrottledException) Code added in v1.28.0 

func (s *ThrottledException) Code() string

Code returns the exception type name.

func (*ThrottledException) Error added in v1.28.0 

func (s *ThrottledException) Error() string

func (ThrottledException) GoString added in v1.28.0 

func (s ThrottledException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottledException) Message added in v1.28.0 

func (s *ThrottledException) Message() string

Message returns the exception's message.

func (*ThrottledException) OrigErr added in v1.28.0 

func (s *ThrottledException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottledException) RequestID added in v1.28.0 

func (s *ThrottledException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottledException) StatusCode added in v1.28.0 

func (s *ThrottledException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottledException) String added in v1.28.0 

func (s ThrottledException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourcesInput 

type UntagResourcesInput struct {

	// Specifies a list of ARNs of the resources that you want to remove tags from.
	//
	// An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,
	// see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces
	// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	//
	// ResourceARNList is a required field
	ResourceARNList []*string `min:"1" type:"list" required:"true"`

	// Specifies a list of 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) GoString 

func (s UntagResourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourcesInput) SetResourceARNList 

func (s *UntagResourcesInput) SetResourceARNList(v []*string) *UntagResourcesInput

SetResourceARNList sets the ResourceARNList field's value.

func (*UntagResourcesInput) SetTagKeys 

func (s *UntagResourcesInput) SetTagKeys(v []*string) *UntagResourcesInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourcesInput) String 

func (s UntagResourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A map containing a key-value pair for each failed item that couldn't be untagged.
	// The key is the ARN of the failed resource. The value is a FailureInfo object
	// that contains an error code, a status code, and an error message. If there
	// are no errors, the FailedResourcesMap is empty.
	FailedResourcesMap map[string]*FailureInfo `type:"map"`
	// contains filtered or unexported fields
}

func (UntagResourcesOutput) GoString 

func (s UntagResourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourcesOutput) SetFailedResourcesMap 

func (s *UntagResourcesOutput) SetFailedResourcesMap(v map[string]*FailureInfo) *UntagResourcesOutput

SetFailedResourcesMap sets the FailedResourcesMap field's value.

func (UntagResourcesOutput) String 

func (s UntagResourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.