resourcegroups

package
v1.44.15 Latest Latest
Warning

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

 Go to latest Published: May 16, 2022 License: Apache-2.0 Imports: 9 Imported by: 64

Documentation

Overview

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

AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances, Amazon Relational Database Service databases, and Amazon S3 buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource Groups enable you to automate management tasks, such as those in AWS Systems Manager Automation documents, on tag-related resources in AWS Systems Manager. Groups of tagged resources also let you quickly view a custom console in AWS Systems Manager that shows AWS Config compliance and other monitoring data about member resources.

To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.

For more information about Resource Groups, see the AWS Resource Groups User Guide (https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html).

AWS Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.

  • Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities

  • Applying, editing, and removing tags from resource groups

  • Resolving resource group member ARNs so they can be returned as search results

  • Getting data about resources that are members of a group

  • Searching AWS resources based on a resource query

See https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27 for more information on this service.

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

Using the Client

To contact AWS Resource Groups 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 client ResourceGroups for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/resourcegroups/#New

Index

Constants

View Source 
const (
	// GroupConfigurationStatusUpdating is a GroupConfigurationStatus enum value
	GroupConfigurationStatusUpdating = "UPDATING"

	// GroupConfigurationStatusUpdateComplete is a GroupConfigurationStatus enum value
	GroupConfigurationStatusUpdateComplete = "UPDATE_COMPLETE"

	// GroupConfigurationStatusUpdateFailed is a GroupConfigurationStatus enum value
	GroupConfigurationStatusUpdateFailed = "UPDATE_FAILED"
)
View Source 
const (
	// GroupFilterNameResourceType is a GroupFilterName enum value
	GroupFilterNameResourceType = "resource-type"

	// GroupFilterNameConfigurationType is a GroupFilterName enum value
	GroupFilterNameConfigurationType = "configuration-type"
)
View Source 
const (
	// QueryErrorCodeCloudformationStackInactive is a QueryErrorCode enum value
	QueryErrorCodeCloudformationStackInactive = "CLOUDFORMATION_STACK_INACTIVE"

	// QueryErrorCodeCloudformationStackNotExisting is a QueryErrorCode enum value
	QueryErrorCodeCloudformationStackNotExisting = "CLOUDFORMATION_STACK_NOT_EXISTING"
)
View Source 
const (
	// QueryTypeTagFilters10 is a QueryType enum value
	QueryTypeTagFilters10 = "TAG_FILTERS_1_0"

	// QueryTypeCloudformationStack10 is a QueryType enum value
	QueryTypeCloudformationStack10 = "CLOUDFORMATION_STACK_1_0"
)
View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// The request includes one or more parameters that violate validation rules.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// The caller isn't authorized to make the request. Check permissions.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeInternalServerErrorException for service response error code
	// "InternalServerErrorException".
	//
	// An internal error occurred while processing the request. Try again later.
	ErrCodeInternalServerErrorException = "InternalServerErrorException"

	// ErrCodeMethodNotAllowedException for service response error code
	// "MethodNotAllowedException".
	//
	// The request uses an HTTP method that isn't allowed for the specified resource.
	ErrCodeMethodNotAllowedException = "MethodNotAllowedException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// One or more of the specified resources don't exist.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// You've exceeded throttling limits by making too many requests in a period
	// of time.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// The request was rejected because it doesn't have valid credentials for the
	// target resource.
	ErrCodeUnauthorizedException = "UnauthorizedException"
)
View Source 
const (
	ServiceName = "resource-groups" // Name of service.
	EndpointsID = ServiceName       // ID to lookup a service endpoint with.
	ServiceID   = "Resource Groups" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// ResourceFilterNameResourceType is a ResourceFilterName enum value
	ResourceFilterNameResourceType = "resource-type"
)
View Source 
const (
	// ResourceStatusValuePending is a ResourceStatusValue enum value
	ResourceStatusValuePending = "PENDING"
)

Variables

This section is empty.

Functions

func GroupConfigurationStatus_Values added in v1.34.3 

func GroupConfigurationStatus_Values() []string

GroupConfigurationStatus_Values returns all elements of the GroupConfigurationStatus enum

func GroupFilterName_Values added in v1.34.3 

func GroupFilterName_Values() []string

GroupFilterName_Values returns all elements of the GroupFilterName enum

func QueryErrorCode_Values added in v1.34.3 

func QueryErrorCode_Values() []string

QueryErrorCode_Values returns all elements of the QueryErrorCode enum

func QueryType_Values added in v1.34.3 

func QueryType_Values() []string

QueryType_Values returns all elements of the QueryType enum

func ResourceFilterName_Values added in v1.34.3 

func ResourceFilterName_Values() []string

ResourceFilterName_Values returns all elements of the ResourceFilterName enum

func ResourceStatusValue_Values added in v1.36.15 

func ResourceStatusValue_Values() []string

ResourceStatusValue_Values returns all elements of the ResourceStatusValue enum

Types

type BadRequestException added in v1.28.0 

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

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

The request includes one or more parameters that violate validation rules.

func (*BadRequestException) Code added in v1.28.0 

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error added in v1.28.0 

func (s *BadRequestException) Error() string

func (BadRequestException) GoString added in v1.28.0 

func (s BadRequestException) 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 (*BadRequestException) Message added in v1.28.0 

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr added in v1.28.0 

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID added in v1.28.0 

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode added in v1.28.0 

func (s *BadRequestException) StatusCode() int

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

func (BadRequestException) String added in v1.28.0 

func (s BadRequestException) 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 CreateGroupInput 

type CreateGroupInput struct {

	// A configuration associates the resource group with an AWS service and specifies
	// how the service can interact with the resources in the group. A configuration
	// is an array of GroupConfigurationItem elements. For details about the syntax
	// of service configurations, see Service configurations for resource groups
	// (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).
	//
	// A resource group can contain either a Configuration or a ResourceQuery, but
	// not both.
	Configuration []*GroupConfigurationItem `type:"list"`

	// The description of the resource group. Descriptions can consist of letters,
	// numbers, hyphens, underscores, periods, and spaces.
	Description *string `type:"string"`

	// The name of the group, which is the identifier of the group in other operations.
	// You can't change the name of a resource group after you create it. A resource
	// group name can consist of letters, numbers, hyphens, periods, and underscores.
	// The name cannot start with AWS or aws; these are reserved. A resource group
	// name must be unique within each AWS Region in your AWS account.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The resource query that determines which AWS resources are members of this
	// group. For more information about resource queries, see Create a tag-based
	// group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag).
	//
	// A resource group can contain either a ResourceQuery or a Configuration, but
	// not both.
	ResourceQuery *ResourceQuery `type:"structure"`

	// The tags to add to the group. A tag is key-value pair string.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (CreateGroupInput) GoString 

func (s CreateGroupInput) 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 (*CreateGroupInput) SetConfiguration added in v1.33.15 

func (s *CreateGroupInput) SetConfiguration(v []*GroupConfigurationItem) *CreateGroupInput

SetConfiguration sets the Configuration field's value.

func (*CreateGroupInput) SetDescription 

func (s *CreateGroupInput) SetDescription(v string) *CreateGroupInput

SetDescription sets the Description field's value.

func (*CreateGroupInput) SetName 

func (s *CreateGroupInput) SetName(v string) *CreateGroupInput

SetName sets the Name field's value.

func (*CreateGroupInput) SetResourceQuery 

func (s *CreateGroupInput) SetResourceQuery(v *ResourceQuery) *CreateGroupInput

SetResourceQuery sets the ResourceQuery field's value.

func (*CreateGroupInput) SetTags 

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

SetTags sets the Tags field's value.

func (CreateGroupInput) String 

func (s CreateGroupInput) 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 (*CreateGroupInput) Validate 

func (s *CreateGroupInput) Validate() error

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

type CreateGroupOutput 

type CreateGroupOutput struct {

	// The description of the resource group.
	Group *Group `type:"structure"`

	// The service configuration associated with the resource group. For details
	// about the syntax of a service configuration, see Service configurations for
	// resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).
	GroupConfiguration *GroupConfiguration `type:"structure"`

	// The resource query associated with the group. For more information about
	// resource queries, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag).
	ResourceQuery *ResourceQuery `type:"structure"`

	// The tags associated with the group.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (CreateGroupOutput) GoString 

func (s CreateGroupOutput) 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 (*CreateGroupOutput) SetGroup 

func (s *CreateGroupOutput) SetGroup(v *Group) *CreateGroupOutput

SetGroup sets the Group field's value.

func (*CreateGroupOutput) SetGroupConfiguration added in v1.33.15 

func (s *CreateGroupOutput) SetGroupConfiguration(v *GroupConfiguration) *CreateGroupOutput

SetGroupConfiguration sets the GroupConfiguration field's value.

func (*CreateGroupOutput) SetResourceQuery 

func (s *CreateGroupOutput) SetResourceQuery(v *ResourceQuery) *CreateGroupOutput

SetResourceQuery sets the ResourceQuery field's value.

func (*CreateGroupOutput) SetTags 

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

SetTags sets the Tags field's value.

func (CreateGroupOutput) String 

func (s CreateGroupOutput) 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 DeleteGroupInput 

type DeleteGroupInput struct {

	// The name or the ARN of the resource group to delete.
	Group *string `min:"1" type:"string"`

	// Deprecated - don't use this parameter. Use Group instead.
	//
	// Deprecated: This field is deprecated, use Group instead.
	GroupName *string `min:"1" deprecated:"true" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteGroupInput) GoString 

func (s DeleteGroupInput) 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 (*DeleteGroupInput) SetGroup added in v1.33.15 

func (s *DeleteGroupInput) SetGroup(v string) *DeleteGroupInput

SetGroup sets the Group field's value.

func (*DeleteGroupInput) SetGroupName 

func (s *DeleteGroupInput) SetGroupName(v string) *DeleteGroupInput

SetGroupName sets the GroupName field's value.

func (DeleteGroupInput) String 

func (s DeleteGroupInput) 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 (*DeleteGroupInput) Validate 

func (s *DeleteGroupInput) Validate() error

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

type DeleteGroupOutput 

type DeleteGroupOutput struct {

	// A full description of the deleted resource group.
	Group *Group `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteGroupOutput) GoString 

func (s DeleteGroupOutput) 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 (*DeleteGroupOutput) SetGroup 

func (s *DeleteGroupOutput) SetGroup(v *Group) *DeleteGroupOutput

SetGroup sets the Group field's value.

func (DeleteGroupOutput) String 

func (s DeleteGroupOutput) 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 FailedResource added in v1.33.15 

type FailedResource struct {

	// The error code associated with the failure.
	ErrorCode *string `min:"1" type:"string"`

	// The error message text associated with the failure.
	ErrorMessage *string `min:"1" type:"string"`

	// The ARN of the resource that failed to be added or removed.
	ResourceArn *string `type:"string"`
	// contains filtered or unexported fields
}

A resource that failed to be added to or removed from a group.

func (FailedResource) GoString added in v1.33.15 

func (s FailedResource) 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 (*FailedResource) SetErrorCode added in v1.33.15 

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

SetErrorCode sets the ErrorCode field's value.

func (*FailedResource) SetErrorMessage added in v1.33.15 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*FailedResource) SetResourceArn added in v1.33.15 

func (s *FailedResource) SetResourceArn(v string) *FailedResource

SetResourceArn sets the ResourceArn field's value.

func (FailedResource) String added in v1.33.15 

func (s FailedResource) 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 ForbiddenException added in v1.28.0 

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

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

The caller isn't authorized to make the request. Check permissions.

func (*ForbiddenException) Code added in v1.28.0 

func (s *ForbiddenException) Code() string

Code returns the exception type name.

func (*ForbiddenException) Error added in v1.28.0 

func (s *ForbiddenException) Error() string

func (ForbiddenException) GoString added in v1.28.0 

func (s ForbiddenException) 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 (*ForbiddenException) Message added in v1.28.0 

func (s *ForbiddenException) Message() string

Message returns the exception's message.

func (*ForbiddenException) OrigErr added in v1.28.0 

func (s *ForbiddenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ForbiddenException) RequestID added in v1.28.0 

func (s *ForbiddenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ForbiddenException) StatusCode added in v1.28.0 

func (s *ForbiddenException) StatusCode() int

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

func (ForbiddenException) String added in v1.28.0 

func (s ForbiddenException) 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 GetGroupConfigurationInput added in v1.33.15 

type GetGroupConfigurationInput struct {

	// The name or the ARN of the resource group.
	Group *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetGroupConfigurationInput) GoString added in v1.33.15 

func (s GetGroupConfigurationInput) 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 (*GetGroupConfigurationInput) SetGroup added in v1.33.15 

func (s *GetGroupConfigurationInput) SetGroup(v string) *GetGroupConfigurationInput

SetGroup sets the Group field's value.

func (GetGroupConfigurationInput) String added in v1.33.15 

func (s GetGroupConfigurationInput) 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 (*GetGroupConfigurationInput) Validate added in v1.33.15 

func (s *GetGroupConfigurationInput) Validate() error

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

type GetGroupConfigurationOutput added in v1.33.15 

type GetGroupConfigurationOutput struct {

	// The service configuration associated with the specified group. For details
	// about the service configuration syntax, see Service configurations for resource
	// groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).
	GroupConfiguration *GroupConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetGroupConfigurationOutput) GoString added in v1.33.15 

func (s GetGroupConfigurationOutput) 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 (*GetGroupConfigurationOutput) SetGroupConfiguration added in v1.33.15 

func (s *GetGroupConfigurationOutput) SetGroupConfiguration(v *GroupConfiguration) *GetGroupConfigurationOutput

SetGroupConfiguration sets the GroupConfiguration field's value.

func (GetGroupConfigurationOutput) String added in v1.33.15 

func (s GetGroupConfigurationOutput) 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 GetGroupInput 

type GetGroupInput struct {

	// The name or the ARN of the resource group to retrieve.
	Group *string `min:"1" type:"string"`

	// Deprecated - don't use this parameter. Use Group instead.
	//
	// Deprecated: This field is deprecated, use Group instead.
	GroupName *string `min:"1" deprecated:"true" type:"string"`
	// contains filtered or unexported fields
}

func (GetGroupInput) GoString 

func (s GetGroupInput) 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 (*GetGroupInput) SetGroup added in v1.33.15 

func (s *GetGroupInput) SetGroup(v string) *GetGroupInput

SetGroup sets the Group field's value.

func (*GetGroupInput) SetGroupName 

func (s *GetGroupInput) SetGroupName(v string) *GetGroupInput

SetGroupName sets the GroupName field's value.

func (GetGroupInput) String 

func (s GetGroupInput) 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 (*GetGroupInput) Validate 

func (s *GetGroupInput) Validate() error

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

type GetGroupOutput 

type GetGroupOutput struct {

	// A full description of the resource group.
	Group *Group `type:"structure"`
	// contains filtered or unexported fields
}

func (GetGroupOutput) GoString 

func (s GetGroupOutput) 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 (*GetGroupOutput) SetGroup 

func (s *GetGroupOutput) SetGroup(v *Group) *GetGroupOutput

SetGroup sets the Group field's value.

func (GetGroupOutput) String 

func (s GetGroupOutput) 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 GetGroupQueryInput 

type GetGroupQueryInput struct {

	// The name or the ARN of the resource group to query.
	Group *string `min:"1" type:"string"`

	// Don't use this parameter. Use Group instead.
	//
	// Deprecated: This field is deprecated, use Group instead.
	GroupName *string `min:"1" deprecated:"true" type:"string"`
	// contains filtered or unexported fields
}

func (GetGroupQueryInput) GoString 

func (s GetGroupQueryInput) 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 (*GetGroupQueryInput) SetGroup added in v1.33.15 

func (s *GetGroupQueryInput) SetGroup(v string) *GetGroupQueryInput

SetGroup sets the Group field's value.

func (*GetGroupQueryInput) SetGroupName 

func (s *GetGroupQueryInput) SetGroupName(v string) *GetGroupQueryInput

SetGroupName sets the GroupName field's value.

func (GetGroupQueryInput) String 

func (s GetGroupQueryInput) 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 (*GetGroupQueryInput) Validate 

func (s *GetGroupQueryInput) Validate() error

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

type GetGroupQueryOutput 

type GetGroupQueryOutput struct {

	// The resource query associated with the specified group. For more information
	// about resource queries, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag).
	GroupQuery *GroupQuery `type:"structure"`
	// contains filtered or unexported fields
}

func (GetGroupQueryOutput) GoString 

func (s GetGroupQueryOutput) 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 (*GetGroupQueryOutput) SetGroupQuery 

func (s *GetGroupQueryOutput) SetGroupQuery(v *GroupQuery) *GetGroupQueryOutput

SetGroupQuery sets the GroupQuery field's value.

func (GetGroupQueryOutput) String 

func (s GetGroupQueryOutput) 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 GetTagsInput 

type GetTagsInput struct {

	// The ARN of the resource group whose tags you want to retrieve.
	//
	// Arn is a required field
	Arn *string `location:"uri" locationName:"Arn" min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetTagsInput) GoString 

func (s GetTagsInput) 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 (*GetTagsInput) SetArn 

func (s *GetTagsInput) SetArn(v string) *GetTagsInput

SetArn sets the Arn field's value.

func (GetTagsInput) String 

func (s GetTagsInput) 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 (*GetTagsInput) Validate 

func (s *GetTagsInput) Validate() error

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

type GetTagsOutput 

type GetTagsOutput struct {

	// The ARN of the tagged resource group.
	Arn *string `min:"12" type:"string"`

	// The tags associated with the specified resource group.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (GetTagsOutput) GoString 

func (s GetTagsOutput) 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 (*GetTagsOutput) SetArn 

func (s *GetTagsOutput) SetArn(v string) *GetTagsOutput

SetArn sets the Arn field's value.

func (*GetTagsOutput) SetTags 

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

SetTags sets the Tags field's value.

func (GetTagsOutput) String 

func (s GetTagsOutput) 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 Group 

type Group struct {

	// The description of the resource group.
	Description *string `type:"string"`

	// The ARN of the resource group.
	//
	// GroupArn is a required field
	GroupArn *string `min:"12" type:"string" required:"true"`

	// The name of the resource group.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A resource group that contains AWS resources. You can assign resources to the group by associating either of the following elements with the group:

  • ResourceQuery - Use a resource query to specify a set of tag keys and values. All resources in the same AWS Region and AWS account that have those keys with the same values are included in the group. You can add a resource query when you create the group, or later by using the PutGroupConfiguration operation.

  • GroupConfiguration - Use a service configuration to associate the group with an AWS service. The configuration specifies which resource types can be included in the group.

func (Group) GoString 

func (s Group) 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 (*Group) SetDescription 

func (s *Group) SetDescription(v string) *Group

SetDescription sets the Description field's value.

func (*Group) SetGroupArn 

func (s *Group) SetGroupArn(v string) *Group

SetGroupArn sets the GroupArn field's value.

func (*Group) SetName 

func (s *Group) SetName(v string) *Group

SetName sets the Name field's value.

func (Group) String 

func (s Group) 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 GroupConfiguration added in v1.33.15 

type GroupConfiguration struct {

	// The configuration currently associated with the group and in effect.
	Configuration []*GroupConfigurationItem `type:"list"`

	// If present, the reason why a request to update the group configuration failed.
	FailureReason *string `type:"string"`

	// If present, the new configuration that is in the process of being applied
	// to the group.
	ProposedConfiguration []*GroupConfigurationItem `type:"list"`

	// The current status of an attempt to update the group configuration.
	Status *string `type:"string" enum:"GroupConfigurationStatus"`
	// contains filtered or unexported fields
}

A service configuration associated with a resource group. The configuration options are determined by the AWS service that defines the Type, and specifies which resources can be included in the group. You can add a service configuration when you create the group by using CreateGroup, or later by using the PutGroupConfiguration operation. For details about group service configuration syntax, see Service configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).

func (GroupConfiguration) GoString added in v1.33.15 

func (s GroupConfiguration) 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 (*GroupConfiguration) SetConfiguration added in v1.33.15 

func (s *GroupConfiguration) SetConfiguration(v []*GroupConfigurationItem) *GroupConfiguration

SetConfiguration sets the Configuration field's value.

func (*GroupConfiguration) SetFailureReason added in v1.33.15 

func (s *GroupConfiguration) SetFailureReason(v string) *GroupConfiguration

SetFailureReason sets the FailureReason field's value.

func (*GroupConfiguration) SetProposedConfiguration added in v1.33.15 

func (s *GroupConfiguration) SetProposedConfiguration(v []*GroupConfigurationItem) *GroupConfiguration

SetProposedConfiguration sets the ProposedConfiguration field's value.

func (*GroupConfiguration) SetStatus added in v1.33.15 

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

SetStatus sets the Status field's value.

func (GroupConfiguration) String added in v1.33.15 

func (s GroupConfiguration) 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 GroupConfigurationItem added in v1.33.15 

type GroupConfigurationItem struct {

	// A collection of parameters for this group configuration item. For the list
	// of parameters that you can use with each configuration item type, see Supported
	// resource types and parameters (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types).
	Parameters []*GroupConfigurationParameter `type:"list"`

	// Specifies the type of group configuration item. Each item must have a unique
	// value for type. For the list of types that you can specify for a configuration
	// item, see Supported resource types and parameters (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types).
	//
	// Type is a required field
	Type *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An item in a group configuration. A group service configuration can have one or more items. For details about group service configuration syntax, see Service configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).

func (GroupConfigurationItem) GoString added in v1.33.15 

func (s GroupConfigurationItem) 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 (*GroupConfigurationItem) SetParameters added in v1.33.15 

func (s *GroupConfigurationItem) SetParameters(v []*GroupConfigurationParameter) *GroupConfigurationItem

SetParameters sets the Parameters field's value.

func (*GroupConfigurationItem) SetType added in v1.33.15 

func (s *GroupConfigurationItem) SetType(v string) *GroupConfigurationItem

SetType sets the Type field's value.

func (GroupConfigurationItem) String added in v1.33.15 

func (s GroupConfigurationItem) 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 (*GroupConfigurationItem) Validate added in v1.33.15 

func (s *GroupConfigurationItem) Validate() error

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

type GroupConfigurationParameter added in v1.33.15 

type GroupConfigurationParameter struct {

	// The name of the group configuration parameter. For the list of parameters
	// that you can use with each configuration item type, see Supported resource
	// types and parameters (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types).
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The value or values to be used for the specified parameter. For the list
	// of values you can use with each parameter, see Supported resource types and
	// parameters (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types).
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).

func (GroupConfigurationParameter) GoString added in v1.33.15 

func (s GroupConfigurationParameter) 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 (*GroupConfigurationParameter) SetName added in v1.33.15 

func (s *GroupConfigurationParameter) SetName(v string) *GroupConfigurationParameter

SetName sets the Name field's value.

func (*GroupConfigurationParameter) SetValues added in v1.33.15 

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

SetValues sets the Values field's value.

func (GroupConfigurationParameter) String added in v1.33.15 

func (s GroupConfigurationParameter) 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 (*GroupConfigurationParameter) Validate added in v1.33.15 

func (s *GroupConfigurationParameter) Validate() error

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

type GroupFilter added in v1.15.56 

type GroupFilter struct {

	// The name of the filter. Filter names are case-sensitive.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"GroupFilterName"`

	// One or more filter values. Allowed filter values vary by group filter name,
	// and are case-sensitive.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A filter collection that you can use to restrict the results from a List operation to only those you want to include.

func (GroupFilter) GoString added in v1.15.56 

func (s GroupFilter) 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 (*GroupFilter) SetName added in v1.15.56 

func (s *GroupFilter) SetName(v string) *GroupFilter

SetName sets the Name field's value.

func (*GroupFilter) SetValues added in v1.15.56 

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

SetValues sets the Values field's value.

func (GroupFilter) String added in v1.15.56 

func (s GroupFilter) 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 (*GroupFilter) Validate added in v1.15.56 

func (s *GroupFilter) Validate() error

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

type GroupIdentifier added in v1.15.56 

type GroupIdentifier struct {

	// The ARN of the resource group.
	GroupArn *string `min:"12" type:"string"`

	// The name of the resource group.
	GroupName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The unique identifiers for a resource group.

func (GroupIdentifier) GoString added in v1.15.56 

func (s GroupIdentifier) 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 (*GroupIdentifier) SetGroupArn added in v1.15.56 

func (s *GroupIdentifier) SetGroupArn(v string) *GroupIdentifier

SetGroupArn sets the GroupArn field's value.

func (*GroupIdentifier) SetGroupName added in v1.15.56 

func (s *GroupIdentifier) SetGroupName(v string) *GroupIdentifier

SetGroupName sets the GroupName field's value.

func (GroupIdentifier) String added in v1.15.56 

func (s GroupIdentifier) 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 GroupQuery 

type GroupQuery struct {

	// The name of the resource group that is associated with the specified resource
	// query.
	//
	// GroupName is a required field
	GroupName *string `min:"1" type:"string" required:"true"`

	// The resource query that determines which AWS resources are members of the
	// associated resource group.
	//
	// ResourceQuery is a required field
	ResourceQuery *ResourceQuery `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A mapping of a query attached to a resource group that determines the AWS resources that are members of the group.

func (GroupQuery) GoString 

func (s GroupQuery) 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 (*GroupQuery) SetGroupName 

func (s *GroupQuery) SetGroupName(v string) *GroupQuery

SetGroupName sets the GroupName field's value.

func (*GroupQuery) SetResourceQuery 

func (s *GroupQuery) SetResourceQuery(v *ResourceQuery) *GroupQuery

SetResourceQuery sets the ResourceQuery field's value.

func (GroupQuery) String 

func (s GroupQuery) 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 GroupResourcesInput added in v1.33.15 

type GroupResourcesInput struct {

	// The name or the ARN of the resource group to add resources to.
	//
	// Group is a required field
	Group *string `min:"1" type:"string" required:"true"`

	// The list of ARNs for resources to be added to the group.
	//
	// ResourceArns is a required field
	ResourceArns []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (GroupResourcesInput) GoString added in v1.33.15 

func (s GroupResourcesInput) 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 (*GroupResourcesInput) SetGroup added in v1.33.15 

func (s *GroupResourcesInput) SetGroup(v string) *GroupResourcesInput

SetGroup sets the Group field's value.

func (*GroupResourcesInput) SetResourceArns added in v1.33.15 

func (s *GroupResourcesInput) SetResourceArns(v []*string) *GroupResourcesInput

SetResourceArns sets the ResourceArns field's value.

func (GroupResourcesInput) String added in v1.33.15 

func (s GroupResourcesInput) 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 (*GroupResourcesInput) Validate added in v1.33.15 

func (s *GroupResourcesInput) Validate() error

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

type GroupResourcesOutput added in v1.33.15 

type GroupResourcesOutput struct {

	// A list of ARNs of any resources that failed to be added to the group by this
	// operation.
	Failed []*FailedResource `type:"list"`

	// A list of ARNs of any resources that are still in the process of being added
	// to the group by this operation. These pending additions continue asynchronously.
	// You can check the status of pending additions by using the ListGroupResources
	// operation, and checking the Resources array in the response and the Status
	// field of each object in that array.
	Pending []*PendingResource `type:"list"`

	// A list of ARNs of resources that were successfully added to the group by
	// this operation.
	Succeeded []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (GroupResourcesOutput) GoString added in v1.33.15 

func (s GroupResourcesOutput) 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 (*GroupResourcesOutput) SetFailed added in v1.33.15 

func (s *GroupResourcesOutput) SetFailed(v []*FailedResource) *GroupResourcesOutput

SetFailed sets the Failed field's value.

func (*GroupResourcesOutput) SetPending added in v1.36.15 

func (s *GroupResourcesOutput) SetPending(v []*PendingResource) *GroupResourcesOutput

SetPending sets the Pending field's value.

func (*GroupResourcesOutput) SetSucceeded added in v1.33.15 

func (s *GroupResourcesOutput) SetSucceeded(v []*string) *GroupResourcesOutput

SetSucceeded sets the Succeeded field's value.

func (GroupResourcesOutput) String added in v1.33.15 

func (s GroupResourcesOutput) 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 InternalServerErrorException added in v1.28.0 

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

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

An internal error occurred while processing the request. Try again later.

func (*InternalServerErrorException) Code added in v1.28.0 

func (s *InternalServerErrorException) Code() string

Code returns the exception type name.

func (*InternalServerErrorException) Error added in v1.28.0 

func (s *InternalServerErrorException) Error() string

func (InternalServerErrorException) GoString added in v1.28.0 

func (s InternalServerErrorException) 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 (*InternalServerErrorException) Message added in v1.28.0 

func (s *InternalServerErrorException) Message() string

Message returns the exception's message.

func (*InternalServerErrorException) OrigErr added in v1.28.0 

func (s *InternalServerErrorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerErrorException) RequestID added in v1.28.0 

func (s *InternalServerErrorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerErrorException) StatusCode added in v1.28.0 

func (s *InternalServerErrorException) StatusCode() int

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

func (InternalServerErrorException) String added in v1.28.0 

func (s InternalServerErrorException) 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 ListGroupResourcesInput 

type ListGroupResourcesInput struct {

	// Filters, formatted as ResourceFilter objects, that you want to apply to a
	// ListGroupResources operation. Filters the results to include only those of
	// the specified resource types.
	//
	//    * resource-type - Filter resources by their type. Specify up to five resource
	//    types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance,
	//    or AWS::S3::Bucket.
	//
	// When you specify a resource-type filter for ListGroupResources, AWS Resource
	// Groups validates your filter resource types against the types that are defined
	// in the query associated with the group. For example, if a group contains
	// only S3 buckets because its query specifies only that resource type, but
	// your resource-type filter includes EC2 instances, AWS Resource Groups does
	// not filter for EC2 instances. In this case, a ListGroupResources request
	// returns a BadRequestException error with a message similar to the following:
	//
	// The resource types specified as filters in the request are not valid.
	//
	// The error includes a list of resource types that failed the validation because
	// they are not part of the query associated with the group. This validation
	// doesn't occur when the group query specifies AWS::AllSupported, because a
	// group based on such a query can contain any of the allowed resource types
	// for the query type (tag-based or AWS CloudFormation stack-based queries).
	Filters []*ResourceFilter `type:"list"`

	// The name or the ARN of the resource group
	Group *string `min:"1" type:"string"`

	//
	//  Deprecated - don't use this parameter. Use the Group request field instead.
	//
	// Deprecated: This field is deprecated, use Group instead.
	GroupName *string `min:"1" deprecated:"true" type:"string"`

	// The total number of results that you want included on each page of the response.
	// If you do not include this parameter, it defaults to a value that is specific
	// to the operation. If additional items exist beyond the maximum you specify,
	// the NextToken response element is present and has a value (is not null).
	// Include that value as the NextToken request parameter in the next call to
	// the operation to get the next part of the results. Note that the service
	// might return fewer results than the maximum even when there are more results
	// available. You should check NextToken after every operation to ensure that
	// you receive all of the results.
	MaxResults *int64 `min:"1" type:"integer"`

	// The parameter for receiving additional results if you receive a NextToken
	// response in a previous request. A NextToken response indicates that more
	// output is available. Set this parameter to the value provided by a previous
	// call's NextToken response to indicate where the output should continue from.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListGroupResourcesInput) GoString 

func (s ListGroupResourcesInput) 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 (*ListGroupResourcesInput) SetFilters added in v1.15.4 

func (s *ListGroupResourcesInput) SetFilters(v []*ResourceFilter) *ListGroupResourcesInput

SetFilters sets the Filters field's value.

func (*ListGroupResourcesInput) SetGroup added in v1.33.15 

func (s *ListGroupResourcesInput) SetGroup(v string) *ListGroupResourcesInput

SetGroup sets the Group field's value.

func (*ListGroupResourcesInput) SetGroupName 

func (s *ListGroupResourcesInput) SetGroupName(v string) *ListGroupResourcesInput

SetGroupName sets the GroupName field's value.

func (*ListGroupResourcesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListGroupResourcesInput) SetNextToken 

func (s *ListGroupResourcesInput) SetNextToken(v string) *ListGroupResourcesInput

SetNextToken sets the NextToken field's value.

func (ListGroupResourcesInput) String 

func (s ListGroupResourcesInput) 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 (*ListGroupResourcesInput) Validate 

func (s *ListGroupResourcesInput) Validate() error

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

type ListGroupResourcesItem added in v1.36.15 

type ListGroupResourcesItem struct {

	// A structure that contains the ARN of a resource and its resource type.
	Identifier *ResourceIdentifier `type:"structure"`

	// A structure that contains the status of this resource's membership in the
	// group.
	//
	// This field is present in the response only if the group is of type AWS::EC2::HostManagement.
	Status *ResourceStatus `type:"structure"`
	// contains filtered or unexported fields
}

A structure returned by the ListGroupResources operation that contains identity and group membership status information for one of the resources in the group.

func (ListGroupResourcesItem) GoString added in v1.36.15 

func (s ListGroupResourcesItem) 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 (*ListGroupResourcesItem) SetIdentifier added in v1.36.15 

func (s *ListGroupResourcesItem) SetIdentifier(v *ResourceIdentifier) *ListGroupResourcesItem

SetIdentifier sets the Identifier field's value.

func (*ListGroupResourcesItem) SetStatus added in v1.36.15 

func (s *ListGroupResourcesItem) SetStatus(v *ResourceStatus) *ListGroupResourcesItem

SetStatus sets the Status field's value.

func (ListGroupResourcesItem) String added in v1.36.15 

func (s ListGroupResourcesItem) 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 ListGroupResourcesOutput 

type ListGroupResourcesOutput struct {

	// If present, indicates that more output is available than is included in the
	// current response. Use this value in the NextToken request parameter in a
	// subsequent call to the operation to get the next part of the output. You
	// should repeat this until the NextToken response element comes back as null.
	NextToken *string `type:"string"`

	// A list of QueryError objects. Each error is an object that contains ErrorCode
	// and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE
	// and CLOUDFORMATION_STACK_NOT_EXISTING.
	QueryErrors []*QueryError `type:"list"`

	//
	//  Deprecated - don't use this parameter. Use the Resources response field
	//  instead.
	//
	// Deprecated: This field is deprecated, use Resources instead.
	ResourceIdentifiers []*ResourceIdentifier `deprecated:"true" type:"list"`

	// An array of resources from which you can determine each resource's identity,
	// type, and group membership status.
	Resources []*ListGroupResourcesItem `type:"list"`
	// contains filtered or unexported fields
}

func (ListGroupResourcesOutput) GoString 

func (s ListGroupResourcesOutput) 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 (*ListGroupResourcesOutput) SetNextToken 

func (s *ListGroupResourcesOutput) SetNextToken(v string) *ListGroupResourcesOutput

SetNextToken sets the NextToken field's value.

func (*ListGroupResourcesOutput) SetQueryErrors added in v1.15.76 

func (s *ListGroupResourcesOutput) SetQueryErrors(v []*QueryError) *ListGroupResourcesOutput

SetQueryErrors sets the QueryErrors field's value.

func (*ListGroupResourcesOutput) SetResourceIdentifiers 

func (s *ListGroupResourcesOutput) SetResourceIdentifiers(v []*ResourceIdentifier) *ListGroupResourcesOutput

SetResourceIdentifiers sets the ResourceIdentifiers field's value.

func (*ListGroupResourcesOutput) SetResources added in v1.36.15 

func (s *ListGroupResourcesOutput) SetResources(v []*ListGroupResourcesItem) *ListGroupResourcesOutput

SetResources sets the Resources field's value.

func (ListGroupResourcesOutput) String 

func (s ListGroupResourcesOutput) 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 ListGroupsInput 

type ListGroupsInput struct {

	// Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups
	// operation.
	//
	//    * resource-type - Filter the results to include only those of the specified
	//    resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType
	//    . For example, AWS::EC2::Instance, or AWS::S3::Bucket.
	//
	//    * configuration-type - Filter the results to include only those groups
	//    that have the specified configuration types attached. The current supported
	//    values are: AWS:EC2::CapacityReservationPool AWS:EC2::HostManagement
	Filters []*GroupFilter `type:"list"`

	// The total number of results that you want included on each page of the response.
	// If you do not include this parameter, it defaults to a value that is specific
	// to the operation. If additional items exist beyond the maximum you specify,
	// the NextToken response element is present and has a value (is not null).
	// Include that value as the NextToken request parameter in the next call to
	// the operation to get the next part of the results. Note that the service
	// might return fewer results than the maximum even when there are more results
	// available. You should check NextToken after every operation to ensure that
	// you receive all of the results.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The parameter for receiving additional results if you receive a NextToken
	// response in a previous request. A NextToken response indicates that more
	// output is available. Set this parameter to the value provided by a previous
	// call's NextToken response to indicate where the output should continue from.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListGroupsInput) GoString 

func (s ListGroupsInput) 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 (*ListGroupsInput) SetFilters added in v1.15.56 

func (s *ListGroupsInput) SetFilters(v []*GroupFilter) *ListGroupsInput

SetFilters sets the Filters field's value.

func (*ListGroupsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListGroupsInput) SetNextToken 

func (s *ListGroupsInput) SetNextToken(v string) *ListGroupsInput

SetNextToken sets the NextToken field's value.

func (ListGroupsInput) String 

func (s ListGroupsInput) 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 (*ListGroupsInput) Validate 

func (s *ListGroupsInput) Validate() error

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

type ListGroupsOutput 

type ListGroupsOutput struct {

	// A list of GroupIdentifier objects. Each identifier is an object that contains
	// both the Name and the GroupArn.
	GroupIdentifiers []*GroupIdentifier `type:"list"`

	//
	//  Deprecated - don't use this field. Use the GroupIdentifiers response field
	//  instead.
	//
	// Deprecated: This field is deprecated, use GroupIdentifiers instead.
	Groups []*Group `deprecated:"true" type:"list"`

	// If present, indicates that more output is available than is included in the
	// current response. Use this value in the NextToken request parameter in a
	// subsequent call to the operation to get the next part of the output. You
	// should repeat this until the NextToken response element comes back as null.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListGroupsOutput) GoString 

func (s ListGroupsOutput) 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 (*ListGroupsOutput) SetGroupIdentifiers added in v1.15.56 

func (s *ListGroupsOutput) SetGroupIdentifiers(v []*GroupIdentifier) *ListGroupsOutput

SetGroupIdentifiers sets the GroupIdentifiers field's value.

func (*ListGroupsOutput) SetGroups 

func (s *ListGroupsOutput) SetGroups(v []*Group) *ListGroupsOutput

SetGroups sets the Groups field's value.

func (*ListGroupsOutput) SetNextToken 

func (s *ListGroupsOutput) SetNextToken(v string) *ListGroupsOutput

SetNextToken sets the NextToken field's value.

func (ListGroupsOutput) String 

func (s ListGroupsOutput) 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 MethodNotAllowedException added in v1.28.0 

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

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

The request uses an HTTP method that isn't allowed for the specified resource.

func (*MethodNotAllowedException) Code added in v1.28.0 

func (s *MethodNotAllowedException) Code() string

Code returns the exception type name.

func (*MethodNotAllowedException) Error added in v1.28.0 

func (s *MethodNotAllowedException) Error() string

func (MethodNotAllowedException) GoString added in v1.28.0 

func (s MethodNotAllowedException) 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 (*MethodNotAllowedException) Message added in v1.28.0 

func (s *MethodNotAllowedException) Message() string

Message returns the exception's message.

func (*MethodNotAllowedException) OrigErr added in v1.28.0 

func (s *MethodNotAllowedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MethodNotAllowedException) RequestID added in v1.28.0 

func (s *MethodNotAllowedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MethodNotAllowedException) StatusCode added in v1.28.0 

func (s *MethodNotAllowedException) StatusCode() int

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

func (MethodNotAllowedException) String added in v1.28.0 

func (s MethodNotAllowedException) 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 NotFoundException added in v1.28.0 

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

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

One or more of the specified resources don't exist.

func (*NotFoundException) Code added in v1.28.0 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0 

func (s NotFoundException) 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 (*NotFoundException) Message added in v1.28.0 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0 

func (s *NotFoundException) StatusCode() int

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

func (NotFoundException) String added in v1.28.0 

func (s NotFoundException) 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 PendingResource added in v1.36.15 

type PendingResource struct {

	// The Amazon resource name (ARN) of the resource that's in a pending state.
	ResourceArn *string `type:"string"`
	// contains filtered or unexported fields
}

A structure that identifies a resource that is currently pending addition to the group as a member. Adding a resource to a resource group happens asynchronously as a background task and this one isn't completed yet.

func (PendingResource) GoString added in v1.36.15 

func (s PendingResource) 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 (*PendingResource) SetResourceArn added in v1.36.15 

func (s *PendingResource) SetResourceArn(v string) *PendingResource

SetResourceArn sets the ResourceArn field's value.

func (PendingResource) String added in v1.36.15 

func (s PendingResource) 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 PutGroupConfigurationInput added in v1.36.15 

type PutGroupConfigurationInput struct {

	// The new configuration to associate with the specified group. A configuration
	// associates the resource group with an AWS service and specifies how the service
	// can interact with the resources in the group. A configuration is an array
	// of GroupConfigurationItem elements.
	//
	// For information about the syntax of a service configuration, see Service
	// configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).
	//
	// A resource group can contain either a Configuration or a ResourceQuery, but
	// not both.
	Configuration []*GroupConfigurationItem `type:"list"`

	// The name or ARN of the resource group with the configuration that you want
	// to update.
	Group *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutGroupConfigurationInput) GoString added in v1.36.15 

func (s PutGroupConfigurationInput) 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 (*PutGroupConfigurationInput) SetConfiguration added in v1.36.15 

func (s *PutGroupConfigurationInput) SetConfiguration(v []*GroupConfigurationItem) *PutGroupConfigurationInput

SetConfiguration sets the Configuration field's value.

func (*PutGroupConfigurationInput) SetGroup added in v1.36.15 

func (s *PutGroupConfigurationInput) SetGroup(v string) *PutGroupConfigurationInput

SetGroup sets the Group field's value.

func (PutGroupConfigurationInput) String added in v1.36.15 

func (s PutGroupConfigurationInput) 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 (*PutGroupConfigurationInput) Validate added in v1.36.15 

func (s *PutGroupConfigurationInput) Validate() error

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

type PutGroupConfigurationOutput added in v1.36.15 

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

func (PutGroupConfigurationOutput) GoString added in v1.36.15 

func (s PutGroupConfigurationOutput) 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 (PutGroupConfigurationOutput) String added in v1.36.15 

func (s PutGroupConfigurationOutput) 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 QueryError added in v1.15.76 

type QueryError struct {

	// Possible values are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.
	ErrorCode *string `type:"string" enum:"QueryErrorCode"`

	// A message that explains the ErrorCode value. Messages might state that the
	// specified CloudFormation stack does not exist (or no longer exists). For
	// CLOUDFORMATION_STACK_INACTIVE, the message typically states that the CloudFormation
	// stack has a status that is not (or no longer) active, such as CREATE_FAILED.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

A two-part error structure that can occur in ListGroupResources or SearchResources operations on CloudFormation stack-based queries. The error occurs if the CloudFormation stack on which the query is based either does not exist, or has a status that renders the stack inactive. A QueryError occurrence does not necessarily mean that AWS Resource Groups could not complete the operation, but the resulting group might have no member resources.

func (QueryError) GoString added in v1.15.76 

func (s QueryError) 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 (*QueryError) SetErrorCode added in v1.15.76 

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

SetErrorCode sets the ErrorCode field's value.

func (*QueryError) SetMessage added in v1.15.76 

func (s *QueryError) SetMessage(v string) *QueryError

SetMessage sets the Message field's value.

func (QueryError) String added in v1.15.76 

func (s QueryError) 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 ResourceFilter added in v1.15.4 

type ResourceFilter struct {

	// The name of the filter. Filter names are case-sensitive.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"ResourceFilterName"`

	// One or more filter values. Allowed filter values vary by resource filter
	// name, and are case-sensitive.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A filter name and value pair that is used to obtain more specific results from a list of resources.

func (ResourceFilter) GoString added in v1.15.4 

func (s ResourceFilter) 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 (*ResourceFilter) SetName added in v1.15.4 

func (s *ResourceFilter) SetName(v string) *ResourceFilter

SetName sets the Name field's value.

func (*ResourceFilter) SetValues added in v1.15.4 

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

SetValues sets the Values field's value.

func (ResourceFilter) String added in v1.15.4 

func (s ResourceFilter) 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 (*ResourceFilter) Validate added in v1.15.4 

func (s *ResourceFilter) Validate() error

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

type ResourceGroups 

type ResourceGroups struct {
	*client.Client
}

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

ResourceGroups 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) *ResourceGroups

New creates a new instance of the ResourceGroups 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 ResourceGroups client from just a session.
svc := resourcegroups.New(mySession)

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

func (*ResourceGroups) CreateGroup 

func (c *ResourceGroups) CreateGroup(input *CreateGroupInput) (*CreateGroupOutput, error)

CreateGroup API operation for AWS Resource Groups.

Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration. For more information about constructing a resource query, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag). For more information about service configurations, see Service configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:CreateGroup

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's API operation CreateGroup for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroup

func (*ResourceGroups) CreateGroupRequest 

func (c *ResourceGroups) CreateGroupRequest(input *CreateGroupInput) (req *request.Request, output *CreateGroupOutput)

CreateGroupRequest generates a "aws/request.Request" representing the client's request for the CreateGroup 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 CreateGroup for more information on using the CreateGroup 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 CreateGroupRequest method.
req, resp := client.CreateGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroup

func (*ResourceGroups) CreateGroupWithContext 

func (c *ResourceGroups) CreateGroupWithContext(ctx aws.Context, input *CreateGroupInput, opts ...request.Option) (*CreateGroupOutput, error)

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

See CreateGroup 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 (*ResourceGroups) DeleteGroup 

func (c *ResourceGroups) DeleteGroup(input *DeleteGroupInput) (*DeleteGroupOutput, error)

DeleteGroup API operation for AWS Resource Groups.

Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:DeleteGroup

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's API operation DeleteGroup for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/DeleteGroup

func (*ResourceGroups) DeleteGroupRequest 

func (c *ResourceGroups) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Request, output *DeleteGroupOutput)

DeleteGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteGroup 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 DeleteGroup for more information on using the DeleteGroup 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 DeleteGroupRequest method.
req, resp := client.DeleteGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/DeleteGroup

func (*ResourceGroups) DeleteGroupWithContext 

func (c *ResourceGroups) DeleteGroupWithContext(ctx aws.Context, input *DeleteGroupInput, opts ...request.Option) (*DeleteGroupOutput, error)

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

See DeleteGroup 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 (*ResourceGroups) GetGroup 

func (c *ResourceGroups) GetGroup(input *GetGroupInput) (*GetGroupOutput, error)

GetGroup API operation for AWS Resource Groups.

Returns information about a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroup

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's API operation GetGroup for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroup

func (*ResourceGroups) GetGroupConfiguration added in v1.33.15 

func (c *ResourceGroups) GetGroupConfiguration(input *GetGroupConfigurationInput) (*GetGroupConfigurationOutput, error)

GetGroupConfiguration API operation for AWS Resource Groups.

Returns the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroupConfiguration

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's API operation GetGroupConfiguration for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupConfiguration

func (*ResourceGroups) GetGroupConfigurationRequest added in v1.33.15 

func (c *ResourceGroups) GetGroupConfigurationRequest(input *GetGroupConfigurationInput) (req *request.Request, output *GetGroupConfigurationOutput)

GetGroupConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetGroupConfiguration 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 GetGroupConfiguration for more information on using the GetGroupConfiguration 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 GetGroupConfigurationRequest method.
req, resp := client.GetGroupConfigurationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupConfiguration

func (*ResourceGroups) GetGroupConfigurationWithContext added in v1.33.15 

func (c *ResourceGroups) GetGroupConfigurationWithContext(ctx aws.Context, input *GetGroupConfigurationInput, opts ...request.Option) (*GetGroupConfigurationOutput, error)

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

See GetGroupConfiguration 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 (*ResourceGroups) GetGroupQuery 

func (c *ResourceGroups) GetGroupQuery(input *GetGroupQueryInput) (*GetGroupQueryOutput, error)

GetGroupQuery API operation for AWS Resource Groups.

Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag).

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroupQuery

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's API operation GetGroupQuery for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupQuery

func (*ResourceGroups) GetGroupQueryRequest 

func (c *ResourceGroups) GetGroupQueryRequest(input *GetGroupQueryInput) (req *request.Request, output *GetGroupQueryOutput)

GetGroupQueryRequest generates a "aws/request.Request" representing the client's request for the GetGroupQuery 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 GetGroupQuery for more information on using the GetGroupQuery 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 GetGroupQueryRequest method.
req, resp := client.GetGroupQueryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupQuery

func (*ResourceGroups) GetGroupQueryWithContext 

func (c *ResourceGroups) GetGroupQueryWithContext(ctx aws.Context, input *GetGroupQueryInput, opts ...request.Option) (*GetGroupQueryOutput, error)

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

See GetGroupQuery 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 (*ResourceGroups) GetGroupRequest 

func (c *ResourceGroups) GetGroupRequest(input *GetGroupInput) (req *request.Request, output *GetGroupOutput)

GetGroupRequest generates a "aws/request.Request" representing the client's request for the GetGroup 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 GetGroup for more information on using the GetGroup 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 GetGroupRequest method.
req, resp := client.GetGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroup

func (*ResourceGroups) GetGroupWithContext 

func (c *ResourceGroups) GetGroupWithContext(ctx aws.Context, input *GetGroupInput, opts ...request.Option) (*GetGroupOutput, error)

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

See GetGroup 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 (*ResourceGroups) GetTags 

func (c *ResourceGroups) GetTags(input *GetTagsInput) (*GetTagsOutput, error)

GetTags API operation for AWS Resource Groups.

Returns a list of tags that are associated with a resource group, specified by an ARN.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetTags

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's API operation GetTags for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetTags

func (*ResourceGroups) GetTagsRequest 

func (c *ResourceGroups) GetTagsRequest(input *GetTagsInput) (req *request.Request, output *GetTagsOutput)

GetTagsRequest generates a "aws/request.Request" representing the client's request for the GetTags 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 GetTags for more information on using the GetTags 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 GetTagsRequest method.
req, resp := client.GetTagsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetTags

func (*ResourceGroups) GetTagsWithContext 

func (c *ResourceGroups) GetTagsWithContext(ctx aws.Context, input *GetTagsInput, opts ...request.Option) (*GetTagsOutput, error)

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

See GetTags 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 (*ResourceGroups) GroupResources added in v1.33.15 

func (c *ResourceGroups) GroupResources(input *GroupResourcesInput) (*GroupResourcesOutput, error)

GroupResources API operation for AWS Resource Groups.

Adds the specified resources to the specified group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GroupResources

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's API operation GroupResources for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResources

func (*ResourceGroups) GroupResourcesRequest added in v1.33.15 

func (c *ResourceGroups) GroupResourcesRequest(input *GroupResourcesInput) (req *request.Request, output *GroupResourcesOutput)

GroupResourcesRequest generates a "aws/request.Request" representing the client's request for the GroupResources 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 GroupResources for more information on using the GroupResources 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 GroupResourcesRequest method.
req, resp := client.GroupResourcesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResources

func (*ResourceGroups) GroupResourcesWithContext added in v1.33.15 

func (c *ResourceGroups) GroupResourcesWithContext(ctx aws.Context, input *GroupResourcesInput, opts ...request.Option) (*GroupResourcesOutput, error)

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

See GroupResources 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 (*ResourceGroups) ListGroupResources 

func (c *ResourceGroups) ListGroupResources(input *ListGroupResourcesInput) (*ListGroupResourcesOutput, error)

ListGroupResources API operation for AWS Resource Groups.

Returns a list of ARNs of the resources that are members of a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:ListGroupResources

  • cloudformation:DescribeStacks

  • cloudformation:ListStackResources

  • tag:GetResources

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's API operation ListGroupResources for usage and error information.

Returned Error Types:

  • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupResources

func (*ResourceGroups) ListGroupResourcesPages 

func (c *ResourceGroups) ListGroupResourcesPages(input *ListGroupResourcesInput, fn func(*ListGroupResourcesOutput, bool) bool) error

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

See ListGroupResources 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 ListGroupResources operation.
pageNum := 0
err := client.ListGroupResourcesPages(params,
    func(page *resourcegroups.ListGroupResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ResourceGroups) ListGroupResourcesPagesWithContext 

func (c *ResourceGroups) ListGroupResourcesPagesWithContext(ctx aws.Context, input *ListGroupResourcesInput, fn func(*ListGroupResourcesOutput, bool) bool, opts ...request.Option) error

ListGroupResourcesPagesWithContext same as ListGroupResourcesPages 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 (*ResourceGroups) ListGroupResourcesRequest 

func (c *ResourceGroups) ListGroupResourcesRequest(input *ListGroupResourcesInput) (req *request.Request, output *ListGroupResourcesOutput)

ListGroupResourcesRequest generates a "aws/request.Request" representing the client's request for the ListGroupResources 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 ListGroupResources for more information on using the ListGroupResources 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 ListGroupResourcesRequest method.
req, resp := client.ListGroupResourcesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupResources

func (*ResourceGroups) ListGroupResourcesWithContext 

func (c *ResourceGroups) ListGroupResourcesWithContext(ctx aws.Context, input *ListGroupResourcesInput, opts ...request.Option) (*ListGroupResourcesOutput, error)

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

See ListGroupResources 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 (*ResourceGroups) ListGroups 

func (c *ResourceGroups) ListGroups(input *ListGroupsInput) (*ListGroupsOutput, error)

ListGroups API operation for AWS Resource Groups.

Returns a list of existing resource groups in your account.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:ListGroups

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's API operation ListGroups for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroups

func (*ResourceGroups) ListGroupsPages 

func (c *ResourceGroups) ListGroupsPages(input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool) error

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

See ListGroups 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 ListGroups operation.
pageNum := 0
err := client.ListGroupsPages(params,
    func(page *resourcegroups.ListGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ResourceGroups) ListGroupsPagesWithContext 

func (c *ResourceGroups) ListGroupsPagesWithContext(ctx aws.Context, input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool, opts ...request.Option) error

ListGroupsPagesWithContext same as ListGroupsPages 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 (*ResourceGroups) ListGroupsRequest 

func (c *ResourceGroups) ListGroupsRequest(input *ListGroupsInput) (req *request.Request, output *ListGroupsOutput)

ListGroupsRequest generates a "aws/request.Request" representing the client's request for the ListGroups 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 ListGroups for more information on using the ListGroups 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 ListGroupsRequest method.
req, resp := client.ListGroupsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroups

func (*ResourceGroups) ListGroupsWithContext 

func (c *ResourceGroups) ListGroupsWithContext(ctx aws.Context, input *ListGroupsInput, opts ...request.Option) (*ListGroupsOutput, error)

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

See ListGroups 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 (*ResourceGroups) PutGroupConfiguration added in v1.36.15 

func (c *ResourceGroups) PutGroupConfiguration(input *PutGroupConfigurationInput) (*PutGroupConfigurationOutput, error)

PutGroupConfiguration API operation for AWS Resource Groups.

Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:PutGroupConfiguration

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's API operation PutGroupConfiguration for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/PutGroupConfiguration

func (*ResourceGroups) PutGroupConfigurationRequest added in v1.36.15 

func (c *ResourceGroups) PutGroupConfigurationRequest(input *PutGroupConfigurationInput) (req *request.Request, output *PutGroupConfigurationOutput)

PutGroupConfigurationRequest generates a "aws/request.Request" representing the client's request for the PutGroupConfiguration 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 PutGroupConfiguration for more information on using the PutGroupConfiguration 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 PutGroupConfigurationRequest method.
req, resp := client.PutGroupConfigurationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/PutGroupConfiguration

func (*ResourceGroups) PutGroupConfigurationWithContext added in v1.36.15 

func (c *ResourceGroups) PutGroupConfigurationWithContext(ctx aws.Context, input *PutGroupConfigurationInput, opts ...request.Option) (*PutGroupConfigurationOutput, error)

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

See PutGroupConfiguration 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 (*ResourceGroups) SearchResources 

func (c *ResourceGroups) SearchResources(input *SearchResourcesInput) (*SearchResourcesOutput, error)

SearchResources API operation for AWS Resource Groups.

Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:SearchResources

  • cloudformation:DescribeStacks

  • cloudformation:ListStackResources

  • tag:GetResources

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's API operation SearchResources for usage and error information.

Returned Error Types:

  • UnauthorizedException The request was rejected because it doesn't have valid credentials for the target resource.

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/SearchResources

func (*ResourceGroups) SearchResourcesPages 

func (c *ResourceGroups) SearchResourcesPages(input *SearchResourcesInput, fn func(*SearchResourcesOutput, bool) bool) error

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

See SearchResources 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 SearchResources operation.
pageNum := 0
err := client.SearchResourcesPages(params,
    func(page *resourcegroups.SearchResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ResourceGroups) SearchResourcesPagesWithContext 

func (c *ResourceGroups) SearchResourcesPagesWithContext(ctx aws.Context, input *SearchResourcesInput, fn func(*SearchResourcesOutput, bool) bool, opts ...request.Option) error

SearchResourcesPagesWithContext same as SearchResourcesPages 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 (*ResourceGroups) SearchResourcesRequest 

func (c *ResourceGroups) SearchResourcesRequest(input *SearchResourcesInput) (req *request.Request, output *SearchResourcesOutput)

SearchResourcesRequest generates a "aws/request.Request" representing the client's request for the SearchResources 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 SearchResources for more information on using the SearchResources 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 SearchResourcesRequest method.
req, resp := client.SearchResourcesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/SearchResources

func (*ResourceGroups) SearchResourcesWithContext 

func (c *ResourceGroups) SearchResourcesWithContext(ctx aws.Context, input *SearchResourcesInput, opts ...request.Option) (*SearchResourcesOutput, error)

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

See SearchResources 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 (*ResourceGroups) Tag 

func (c *ResourceGroups) Tag(input *TagInput) (*TagOutput, error)

Tag API operation for AWS Resource Groups.

Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.

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

To run this command, you must have the following permissions:

  • resource-groups:Tag

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's API operation Tag for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/Tag

func (*ResourceGroups) TagRequest 

func (c *ResourceGroups) TagRequest(input *TagInput) (req *request.Request, output *TagOutput)

TagRequest generates a "aws/request.Request" representing the client's request for the Tag 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 Tag for more information on using the Tag 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 TagRequest method.
req, resp := client.TagRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/Tag

func (*ResourceGroups) TagWithContext 

func (c *ResourceGroups) TagWithContext(ctx aws.Context, input *TagInput, opts ...request.Option) (*TagOutput, error)

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

See Tag 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 (*ResourceGroups) UngroupResources added in v1.33.15 

func (c *ResourceGroups) UngroupResources(input *UngroupResourcesInput) (*UngroupResourcesOutput, error)

UngroupResources API operation for AWS Resource Groups.

Removes the specified resources from the specified group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UngroupResources

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's API operation UngroupResources for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UngroupResources

func (*ResourceGroups) UngroupResourcesRequest added in v1.33.15 

func (c *ResourceGroups) UngroupResourcesRequest(input *UngroupResourcesInput) (req *request.Request, output *UngroupResourcesOutput)

UngroupResourcesRequest generates a "aws/request.Request" representing the client's request for the UngroupResources 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 UngroupResources for more information on using the UngroupResources 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 UngroupResourcesRequest method.
req, resp := client.UngroupResourcesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UngroupResources

func (*ResourceGroups) UngroupResourcesWithContext added in v1.33.15 

func (c *ResourceGroups) UngroupResourcesWithContext(ctx aws.Context, input *UngroupResourcesInput, opts ...request.Option) (*UngroupResourcesOutput, error)

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

See UngroupResources 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 (*ResourceGroups) Untag 

func (c *ResourceGroups) Untag(input *UntagInput) (*UntagOutput, error)

Untag API operation for AWS Resource Groups.

Deletes tags from a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:Untag

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's API operation Untag for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/Untag

func (*ResourceGroups) UntagRequest 

func (c *ResourceGroups) UntagRequest(input *UntagInput) (req *request.Request, output *UntagOutput)

UntagRequest generates a "aws/request.Request" representing the client's request for the Untag 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 Untag for more information on using the Untag 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 UntagRequest method.
req, resp := client.UntagRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/Untag

func (*ResourceGroups) UntagWithContext 

func (c *ResourceGroups) UntagWithContext(ctx aws.Context, input *UntagInput, opts ...request.Option) (*UntagOutput, error)

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

See Untag 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 (*ResourceGroups) UpdateGroup 

func (c *ResourceGroups) UpdateGroup(input *UpdateGroupInput) (*UpdateGroupOutput, error)

UpdateGroup API operation for AWS Resource Groups.

Updates the description for an existing group. You cannot update the name of a resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UpdateGroup

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's API operation UpdateGroup for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroup

func (*ResourceGroups) UpdateGroupQuery 

func (c *ResourceGroups) UpdateGroupQuery(input *UpdateGroupQueryInput) (*UpdateGroupQueryOutput, error)

UpdateGroupQuery API operation for AWS Resource Groups.

Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag).

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UpdateGroupQuery

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's API operation UpdateGroupQuery for usage and error information.

Returned Error Types:

  • BadRequestException The request includes one or more parameters that violate validation rules.

  • ForbiddenException The caller isn't authorized to make the request. Check permissions.

  • NotFoundException One or more of the specified resources don't exist.

  • MethodNotAllowedException The request uses an HTTP method that isn't allowed for the specified resource.

  • TooManyRequestsException You've exceeded throttling limits by making too many requests in a period of time.

  • InternalServerErrorException An internal error occurred while processing the request. Try again later.

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroupQuery

func (*ResourceGroups) UpdateGroupQueryRequest 

func (c *ResourceGroups) UpdateGroupQueryRequest(input *UpdateGroupQueryInput) (req *request.Request, output *UpdateGroupQueryOutput)

UpdateGroupQueryRequest generates a "aws/request.Request" representing the client's request for the UpdateGroupQuery 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 UpdateGroupQuery for more information on using the UpdateGroupQuery 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 UpdateGroupQueryRequest method.
req, resp := client.UpdateGroupQueryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroupQuery

func (*ResourceGroups) UpdateGroupQueryWithContext 

func (c *ResourceGroups) UpdateGroupQueryWithContext(ctx aws.Context, input *UpdateGroupQueryInput, opts ...request.Option) (*UpdateGroupQueryOutput, error)

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

See UpdateGroupQuery 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 (*ResourceGroups) UpdateGroupRequest 

func (c *ResourceGroups) UpdateGroupRequest(input *UpdateGroupInput) (req *request.Request, output *UpdateGroupOutput)

UpdateGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateGroup 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 UpdateGroup for more information on using the UpdateGroup 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 UpdateGroupRequest method.
req, resp := client.UpdateGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroup

func (*ResourceGroups) UpdateGroupWithContext 

func (c *ResourceGroups) UpdateGroupWithContext(ctx aws.Context, input *UpdateGroupInput, opts ...request.Option) (*UpdateGroupOutput, error)

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

See UpdateGroup 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 ResourceIdentifier 

type ResourceIdentifier struct {

	// The ARN of a resource.
	ResourceArn *string `type:"string"`

	// The resource type of a resource, such as AWS::EC2::Instance.
	ResourceType *string `type:"string"`
	// contains filtered or unexported fields
}

A structure that contains the ARN of a resource and its resource type.

func (ResourceIdentifier) GoString 

func (s ResourceIdentifier) 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 (*ResourceIdentifier) SetResourceArn 

func (s *ResourceIdentifier) SetResourceArn(v string) *ResourceIdentifier

SetResourceArn sets the ResourceArn field's value.

func (*ResourceIdentifier) SetResourceType 

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

SetResourceType sets the ResourceType field's value.

func (ResourceIdentifier) String 

func (s ResourceIdentifier) 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 ResourceQuery 

type ResourceQuery struct {

	// The query that defines a group or a search.
	//
	// Query is a required field
	Query *string `type:"string" required:"true"`

	// The type of the query. You can use the following values:
	//
	//    * CLOUDFORMATION_STACK_1_0: Specifies that the Query contains an ARN for
	//    a CloudFormation stack.
	//
	//    * TAG_FILTERS_1_0: Specifies that the Query parameter contains a JSON
	//    string that represents a collection of simple tag filters for resource
	//    types and tags. The JSON string uses a syntax similar to the GetResources
	//    (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html)
	//    operation, but uses only the ResourceTypeFilters (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-ResourceTypeFilters)
	//    and TagFilters (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-TagFiltersTagFilters)
	//    fields. If you specify more than one tag key, only resources that match
	//    all tag keys, and at least one value of each specified tag key, are returned
	//    in your query. If you specify more than one value for a tag key, a resource
	//    matches the filter if it has a tag key value that matches any of the specified
	//    values. For example, consider the following sample query for resources
	//    that have two tags, Stage and Version, with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]
	//    The results of this query could include the following. An EC2 instance
	//    that has the following two tags: {"Stage":"Deploy"}, and {"Version":"2"}
	//    An S3 bucket that has the following two tags: {"Stage":"Test"}, and {"Version":"1"}
	//    The query would not include the following items in the results, however.
	//    An EC2 instance that has only the following tag: {"Stage":"Deploy"}. The
	//    instance does not have all of the tag keys specified in the filter, so
	//    it is excluded from the results. An RDS database that has the following
	//    two tags: {"Stage":"Archived"} and {"Version":"4"} The database has all
	//    of the tag keys, but none of those keys has an associated value that matches
	//    at least one of the specified values in the filter.
	//
	// Type is a required field
	Type *string `min:"1" type:"string" required:"true" enum:"QueryType"`
	// contains filtered or unexported fields
}

The query that is used to define a resource group or a search for resources. A query specifies both a query type and a query string as a JSON object. See the examples section for example JSON strings.

The examples that follow are shown as standard JSON strings. If you include such a string as a parameter to the AWS CLI or an SDK API, you might need to 'escape' the string into a single line. For example, see the Quoting strings (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the AWS CLI User Guide.

Example 1

The following generic example shows a resource query JSON string that includes only resources that meet the following criteria:

  • The resource type must be either resource_type1 or resource_type2.

  • The resource must have a tag Key1 with a value of either ValueA or ValueB.

  • The resource must have a tag Key2 with a value of either ValueC or ValueD.

{ "Type": "TAG_FILTERS_1_0", "Query": { "ResourceTypeFilters": [ "resource_type1", "resource_type2"], "TagFilters": [ { "Key": "Key1", "Values": ["ValueA","ValueB"] }, { "Key":"Key2", "Values":["ValueC","ValueD"] } ] } }

This has the equivalent "shortcut" syntax of the following:

{ "Type": "TAG_FILTERS_1_0", "Query": { "ResourceTypeFilters": [ "resource_type1", "resource_type2"], "TagFilters": [ { "Key1": ["ValueA","ValueB"] }, { "Key2": ["ValueC","ValueD"] } ] } }

Example 2

The following example shows a resource query JSON string that includes only Amazon EC2 instances that are tagged Stage with a value of Test.

{ "Type": "TAG_FILTERS_1_0", "Query": "{ "ResourceTypeFilters": "AWS::EC2::Instance", "TagFilters": { "Stage": "Test" } } }

Example 3

The following example shows a resource query JSON string that includes resource of any supported type as long as it is tagged Stage with a value of Prod.

{ "Type": "TAG_FILTERS_1_0", "Query": { "ResourceTypeFilters": "AWS::AllSupported", "TagFilters": { "Stage": "Prod" } } }

Example 4

The following example shows a resource query JSON string that includes only Amazon EC2 instances and Amazon S3 buckets that are part of the specified AWS CloudFormation stack.

{ "Type": "CLOUDFORMATION_STACK_1_0", "Query": { "ResourceTypeFilters": [ "AWS::EC2::Instance", "AWS::S3::Bucket" ], "StackIdentifier": "arn:aws:cloudformation:us-west-2:123456789012:stack/AWStestuseraccount/fb0d5000-aba8-00e8-aa9e-50d5cEXAMPLE" } }

func (ResourceQuery) GoString 

func (s ResourceQuery) 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 (*ResourceQuery) SetQuery 

func (s *ResourceQuery) SetQuery(v string) *ResourceQuery

SetQuery sets the Query field's value.

func (*ResourceQuery) SetType 

func (s *ResourceQuery) SetType(v string) *ResourceQuery

SetType sets the Type field's value.

func (ResourceQuery) String 

func (s ResourceQuery) 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 (*ResourceQuery) Validate 

func (s *ResourceQuery) Validate() error

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

type ResourceStatus added in v1.36.15 

type ResourceStatus struct {

	// The current status.
	Name *string `type:"string" enum:"ResourceStatusValue"`
	// contains filtered or unexported fields
}

A structure that identifies the current group membership status for a resource. Adding a resource to a resource group is performed asynchronously as a background task. A PENDING status indicates, for this resource, that the process isn't completed yet.

func (ResourceStatus) GoString added in v1.36.15 

func (s ResourceStatus) 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 (*ResourceStatus) SetName added in v1.36.15 

func (s *ResourceStatus) SetName(v string) *ResourceStatus

SetName sets the Name field's value.

func (ResourceStatus) String added in v1.36.15 

func (s ResourceStatus) 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 SearchResourcesInput 

type SearchResourcesInput struct {

	// The total number of results that you want included on each page of the response.
	// If you do not include this parameter, it defaults to a value that is specific
	// to the operation. If additional items exist beyond the maximum you specify,
	// the NextToken response element is present and has a value (is not null).
	// Include that value as the NextToken request parameter in the next call to
	// the operation to get the next part of the results. Note that the service
	// might return fewer results than the maximum even when there are more results
	// available. You should check NextToken after every operation to ensure that
	// you receive all of the results.
	MaxResults *int64 `min:"1" type:"integer"`

	// The parameter for receiving additional results if you receive a NextToken
	// response in a previous request. A NextToken response indicates that more
	// output is available. Set this parameter to the value provided by a previous
	// call's NextToken response to indicate where the output should continue from.
	NextToken *string `type:"string"`

	// The search query, using the same formats that are supported for resource
	// group definition. For more information, see CreateGroup.
	//
	// ResourceQuery is a required field
	ResourceQuery *ResourceQuery `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SearchResourcesInput) GoString 

func (s SearchResourcesInput) 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 (*SearchResourcesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*SearchResourcesInput) SetNextToken 

func (s *SearchResourcesInput) SetNextToken(v string) *SearchResourcesInput

SetNextToken sets the NextToken field's value.

func (*SearchResourcesInput) SetResourceQuery 

func (s *SearchResourcesInput) SetResourceQuery(v *ResourceQuery) *SearchResourcesInput

SetResourceQuery sets the ResourceQuery field's value.

func (SearchResourcesInput) String 

func (s SearchResourcesInput) 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 (*SearchResourcesInput) Validate 

func (s *SearchResourcesInput) Validate() error

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

type SearchResourcesOutput 

type SearchResourcesOutput struct {

	// If present, indicates that more output is available than is included in the
	// current response. Use this value in the NextToken request parameter in a
	// subsequent call to the operation to get the next part of the output. You
	// should repeat this until the NextToken response element comes back as null.
	NextToken *string `type:"string"`

	// A list of QueryError objects. Each error is an object that contains ErrorCode
	// and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE
	// and CLOUDFORMATION_STACK_NOT_EXISTING.
	QueryErrors []*QueryError `type:"list"`

	// The ARNs and resource types of resources that are members of the group that
	// you specified.
	ResourceIdentifiers []*ResourceIdentifier `type:"list"`
	// contains filtered or unexported fields
}

func (SearchResourcesOutput) GoString 

func (s SearchResourcesOutput) 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 (*SearchResourcesOutput) SetNextToken 

func (s *SearchResourcesOutput) SetNextToken(v string) *SearchResourcesOutput

SetNextToken sets the NextToken field's value.

func (*SearchResourcesOutput) SetQueryErrors added in v1.15.76 

func (s *SearchResourcesOutput) SetQueryErrors(v []*QueryError) *SearchResourcesOutput

SetQueryErrors sets the QueryErrors field's value.

func (*SearchResourcesOutput) SetResourceIdentifiers 

func (s *SearchResourcesOutput) SetResourceIdentifiers(v []*ResourceIdentifier) *SearchResourcesOutput

SetResourceIdentifiers sets the ResourceIdentifiers field's value.

func (SearchResourcesOutput) String 

func (s SearchResourcesOutput) 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 TagInput 

type TagInput struct {

	// The ARN of the resource group to which to add tags.
	//
	// Arn is a required field
	Arn *string `location:"uri" locationName:"Arn" min:"12" type:"string" required:"true"`

	// The tags to add to the specified resource group. A tag is a string-to-string
	// map of key-value pairs.
	//
	// Tags is a required field
	Tags map[string]*string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagInput) GoString 

func (s TagInput) 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 (*TagInput) SetArn 

func (s *TagInput) SetArn(v string) *TagInput

SetArn sets the Arn field's value.

func (*TagInput) SetTags 

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

SetTags sets the Tags field's value.

func (TagInput) String 

func (s TagInput) 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 (*TagInput) Validate 

func (s *TagInput) Validate() error

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

type TagOutput 

type TagOutput struct {

	// The ARN of the tagged resource.
	Arn *string `min:"12" type:"string"`

	// The tags that have been added to the specified resource group.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (TagOutput) GoString 

func (s TagOutput) 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 (*TagOutput) SetArn 

func (s *TagOutput) SetArn(v string) *TagOutput

SetArn sets the Arn field's value.

func (*TagOutput) SetTags 

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

SetTags sets the Tags field's value.

func (TagOutput) String 

func (s TagOutput) 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 TooManyRequestsException added in v1.28.0 

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

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

You've exceeded throttling limits by making too many requests in a period of time.

func (*TooManyRequestsException) Code added in v1.28.0 

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error added in v1.28.0 

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString added in v1.28.0 

func (s TooManyRequestsException) 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 (*TooManyRequestsException) Message added in v1.28.0 

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr added in v1.28.0 

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID added in v1.28.0 

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode added in v1.28.0 

func (s *TooManyRequestsException) StatusCode() int

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

func (TooManyRequestsException) String added in v1.28.0 

func (s TooManyRequestsException) 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 UnauthorizedException added in v1.28.0 

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

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

The request was rejected because it doesn't have valid credentials for the target resource.

func (*UnauthorizedException) Code added in v1.28.0 

func (s *UnauthorizedException) Code() string

Code returns the exception type name.

func (*UnauthorizedException) Error added in v1.28.0 

func (s *UnauthorizedException) Error() string

func (UnauthorizedException) GoString added in v1.28.0 

func (s UnauthorizedException) 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 (*UnauthorizedException) Message added in v1.28.0 

func (s *UnauthorizedException) Message() string

Message returns the exception's message.

func (*UnauthorizedException) OrigErr added in v1.28.0 

func (s *UnauthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedException) RequestID added in v1.28.0 

func (s *UnauthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedException) StatusCode added in v1.28.0 

func (s *UnauthorizedException) StatusCode() int

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

func (UnauthorizedException) String added in v1.28.0 

func (s UnauthorizedException) 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 UngroupResourcesInput added in v1.33.15 

type UngroupResourcesInput struct {

	// The name or the ARN of the resource group from which to remove the resources.
	//
	// Group is a required field
	Group *string `min:"1" type:"string" required:"true"`

	// The ARNs of the resources to be removed from the group.
	//
	// ResourceArns is a required field
	ResourceArns []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UngroupResourcesInput) GoString added in v1.33.15 

func (s UngroupResourcesInput) 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 (*UngroupResourcesInput) SetGroup added in v1.33.15 

func (s *UngroupResourcesInput) SetGroup(v string) *UngroupResourcesInput

SetGroup sets the Group field's value.

func (*UngroupResourcesInput) SetResourceArns added in v1.33.15 

func (s *UngroupResourcesInput) SetResourceArns(v []*string) *UngroupResourcesInput

SetResourceArns sets the ResourceArns field's value.

func (UngroupResourcesInput) String added in v1.33.15 

func (s UngroupResourcesInput) 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 (*UngroupResourcesInput) Validate added in v1.33.15 

func (s *UngroupResourcesInput) Validate() error

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

type UngroupResourcesOutput added in v1.33.15 

type UngroupResourcesOutput struct {

	// A list of any resources that failed to be removed from the group by this
	// operation.
	Failed []*FailedResource `type:"list"`

	// A list of any resources that are still in the process of being removed from
	// the group by this operation. These pending removals continue asynchronously.
	// You can check the status of pending removals by using the ListGroupResources
	// operation. After the resource is successfully removed, it no longer appears
	// in the response.
	Pending []*PendingResource `type:"list"`

	// A list of resources that were successfully removed from the group by this
	// operation.
	Succeeded []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (UngroupResourcesOutput) GoString added in v1.33.15 

func (s UngroupResourcesOutput) 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 (*UngroupResourcesOutput) SetFailed added in v1.33.15 

func (s *UngroupResourcesOutput) SetFailed(v []*FailedResource) *UngroupResourcesOutput

SetFailed sets the Failed field's value.

func (*UngroupResourcesOutput) SetPending added in v1.36.15 

func (s *UngroupResourcesOutput) SetPending(v []*PendingResource) *UngroupResourcesOutput

SetPending sets the Pending field's value.

func (*UngroupResourcesOutput) SetSucceeded added in v1.33.15 

func (s *UngroupResourcesOutput) SetSucceeded(v []*string) *UngroupResourcesOutput

SetSucceeded sets the Succeeded field's value.

func (UngroupResourcesOutput) String added in v1.33.15 

func (s UngroupResourcesOutput) 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 UntagInput 

type UntagInput struct {

	// The ARN of the resource group from which to remove tags. The command removed
	// both the specified keys and any values associated with those keys.
	//
	// Arn is a required field
	Arn *string `location:"uri" locationName:"Arn" min:"12" type:"string" required:"true"`

	// The keys of the tags to be removed.
	//
	// Keys is a required field
	Keys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagInput) GoString 

func (s UntagInput) 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 (*UntagInput) SetArn 

func (s *UntagInput) SetArn(v string) *UntagInput

SetArn sets the Arn field's value.

func (*UntagInput) SetKeys 

func (s *UntagInput) SetKeys(v []*string) *UntagInput

SetKeys sets the Keys field's value.

func (UntagInput) String 

func (s UntagInput) 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 (*UntagInput) Validate 

func (s *UntagInput) Validate() error

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

type UntagOutput 

type UntagOutput struct {

	// The ARN of the resource group from which tags have been removed.
	Arn *string `min:"12" type:"string"`

	// The keys of the tags that were removed.
	Keys []*string `type:"list"`
	// contains filtered or unexported fields
}

func (UntagOutput) GoString 

func (s UntagOutput) 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 (*UntagOutput) SetArn 

func (s *UntagOutput) SetArn(v string) *UntagOutput

SetArn sets the Arn field's value.

func (*UntagOutput) SetKeys 

func (s *UntagOutput) SetKeys(v []*string) *UntagOutput

SetKeys sets the Keys field's value.

func (UntagOutput) String 

func (s UntagOutput) 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 UpdateGroupInput 

type UpdateGroupInput struct {

	// The new description that you want to update the resource group with. Descriptions
	// can contain letters, numbers, hyphens, underscores, periods, and spaces.
	Description *string `type:"string"`

	// The name or the ARN of the resource group to modify.
	Group *string `min:"1" type:"string"`

	// Don't use this parameter. Use Group instead.
	//
	// Deprecated: This field is deprecated, use Group instead.
	GroupName *string `min:"1" deprecated:"true" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateGroupInput) GoString 

func (s UpdateGroupInput) 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 (*UpdateGroupInput) SetDescription 

func (s *UpdateGroupInput) SetDescription(v string) *UpdateGroupInput

SetDescription sets the Description field's value.

func (*UpdateGroupInput) SetGroup added in v1.33.15 

func (s *UpdateGroupInput) SetGroup(v string) *UpdateGroupInput

SetGroup sets the Group field's value.

func (*UpdateGroupInput) SetGroupName 

func (s *UpdateGroupInput) SetGroupName(v string) *UpdateGroupInput

SetGroupName sets the GroupName field's value.

func (UpdateGroupInput) String 

func (s UpdateGroupInput) 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 (*UpdateGroupInput) Validate 

func (s *UpdateGroupInput) Validate() error

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

type UpdateGroupOutput 

type UpdateGroupOutput struct {

	// The update description of the resource group.
	Group *Group `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateGroupOutput) GoString 

func (s UpdateGroupOutput) 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 (*UpdateGroupOutput) SetGroup 

func (s *UpdateGroupOutput) SetGroup(v *Group) *UpdateGroupOutput

SetGroup sets the Group field's value.

func (UpdateGroupOutput) String 

func (s UpdateGroupOutput) 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 UpdateGroupQueryInput 

type UpdateGroupQueryInput struct {

	// The name or the ARN of the resource group to query.
	Group *string `min:"1" type:"string"`

	// Don't use this parameter. Use Group instead.
	//
	// Deprecated: This field is deprecated, use Group instead.
	GroupName *string `min:"1" deprecated:"true" type:"string"`

	// The resource query to determine which AWS resources are members of this resource
	// group.
	//
	// A resource group can contain either a Configuration or a ResourceQuery, but
	// not both.
	//
	// ResourceQuery is a required field
	ResourceQuery *ResourceQuery `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGroupQueryInput) GoString 

func (s UpdateGroupQueryInput) 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 (*UpdateGroupQueryInput) SetGroup added in v1.33.15 

func (s *UpdateGroupQueryInput) SetGroup(v string) *UpdateGroupQueryInput

SetGroup sets the Group field's value.

func (*UpdateGroupQueryInput) SetGroupName 

func (s *UpdateGroupQueryInput) SetGroupName(v string) *UpdateGroupQueryInput

SetGroupName sets the GroupName field's value.

func (*UpdateGroupQueryInput) SetResourceQuery 

func (s *UpdateGroupQueryInput) SetResourceQuery(v *ResourceQuery) *UpdateGroupQueryInput

SetResourceQuery sets the ResourceQuery field's value.

func (UpdateGroupQueryInput) String 

func (s UpdateGroupQueryInput) 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 (*UpdateGroupQueryInput) Validate 

func (s *UpdateGroupQueryInput) Validate() error

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

type UpdateGroupQueryOutput 

type UpdateGroupQueryOutput struct {

	// The updated resource query associated with the resource group after the update.
	GroupQuery *GroupQuery `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateGroupQueryOutput) GoString 

func (s UpdateGroupQueryOutput) 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 (*UpdateGroupQueryOutput) SetGroupQuery 

func (s *UpdateGroupQueryOutput) SetGroupQuery(v *GroupQuery) *UpdateGroupQueryOutput

SetGroupQuery sets the GroupQuery field's value.

func (UpdateGroupQueryOutput) String 

func (s UpdateGroupQueryOutput) 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 resourcegroupsiface provides an interface to enable mocking the AWS Resource Groups service client for testing your code.
 Package resourcegroupsiface provides an interface to enable mocking the AWS Resource Groups 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.