types

type ComplianceDetails ¶

type ComplianceDetails struct {

	// Whether a resource is compliant with the effective tag policy.
	ComplianceStatus *bool

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

	// These tag keys on the resource are noncompliant with the effective tag policy.
	NoncompliantKeys []string
	// 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.

type ConcurrentModificationException ¶

type ConcurrentModificationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (e *ConcurrentModificationException) Error() string

func (e *ConcurrentModificationException) ErrorCode() string

func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault

func (e *ConcurrentModificationException) ErrorMessage() string

type ConstraintViolationException ¶

type ConstraintViolationException struct {
	Message *string

	ErrorCodeOverride *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.

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

func (e *ConstraintViolationException) Error() string

func (e *ConstraintViolationException) ErrorCode() string

func (e *ConstraintViolationException) ErrorFault() smithy.ErrorFault

func (e *ConstraintViolationException) ErrorMessage() string

type ErrorCode ¶

type ErrorCode string

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

func (ErrorCode) Values() []ErrorCode

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 ErrorCode

	// The message of the common error.
	ErrorMessage *string

	// The HTTP status code of the common error.
	StatusCode int32
	// 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:

• InternalServiceException – This can mean that the Resource Groups Tagging API didn't receive a response from another Amazon Web Services service. It can also mean that the resource type in the request is not supported by the Resource Groups Tagging API. In these cases, it's safe to retry the request and then call GetResources (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html) to verify the changes.
• AccessDeniedException – This can mean that you need permission to call the tagging operations in the Amazon Web Services service that contains the resource. For example, to use the Resource Groups Tagging API to tag a Amazon CloudWatch alarm resource, you need permission to call both TagResources (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html) and TagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html) in the CloudWatch API.

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

type GroupByAttribute ¶

type GroupByAttribute string

const (
	GroupByAttributeTargetId     GroupByAttribute = "TARGET_ID"
	GroupByAttributeRegion       GroupByAttribute = "REGION"
	GroupByAttributeResourceType GroupByAttribute = "RESOURCE_TYPE"
)

func (GroupByAttribute) Values() []GroupByAttribute

type InternalServiceException ¶

type InternalServiceException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (e *InternalServiceException) Error() string

func (e *InternalServiceException) ErrorCode() string

func (e *InternalServiceException) ErrorFault() smithy.ErrorFault

func (e *InternalServiceException) ErrorMessage() string

type InvalidParameterException ¶

type InvalidParameterException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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.

func (e *InvalidParameterException) Error() string

func (e *InvalidParameterException) ErrorCode() string

func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault

func (e *InvalidParameterException) ErrorMessage() string

type PaginationTokenExpiredException ¶

type PaginationTokenExpiredException struct {
	Message *string

	ErrorCodeOverride *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 (e *PaginationTokenExpiredException) Error() string

func (e *PaginationTokenExpiredException) ErrorCode() string

func (e *PaginationTokenExpiredException) ErrorFault() smithy.ErrorFault

func (e *PaginationTokenExpiredException) ErrorMessage() string

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

	// The ARN of the resource.
	ResourceARN *string

	// The tags that have been applied to one or more Amazon Web Services resources.
	Tags []Tag
	// contains filtered or unexported fields
}

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

type Summary ¶

type Summary struct {

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

	// The count of noncompliant resources.
	NonCompliantResources int64

	// The Amazon Web Services Region that the summary applies to.
	Region *string

	// The Amazon Web Services resource type.
	ResourceType *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

	// Whether the target is an account, an OU, or the organization root.
	TargetIdType TargetIdType
	// contains filtered or unexported fields
}

A count of noncompliant resources.

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.
	//
	// This member is required.
	Key *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.
	//
	// This member is required.
	Value *string
	// 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.

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

	// 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
	// contains filtered or unexported fields
}

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

type TargetIdType ¶

type TargetIdType string

const (
	TargetIdTypeAccount TargetIdType = "ACCOUNT"
	TargetIdTypeOu      TargetIdType = "OU"
	TargetIdTypeRoot    TargetIdType = "ROOT"
)

func (TargetIdType) Values() []TargetIdType

type ThrottledException ¶

type ThrottledException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (e *ThrottledException) Error() string

func (e *ThrottledException) ErrorCode() string

func (e *ThrottledException) ErrorFault() smithy.ErrorFault

func (e *ThrottledException) ErrorMessage() string