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
- type CreateGroupInput
- func (s CreateGroupInput) GoString() string
- func (s *CreateGroupInput) SetDescription(v string) *CreateGroupInput
- func (s *CreateGroupInput) SetName(v string) *CreateGroupInput
- func (s *CreateGroupInput) SetResourceQuery(v *ResourceQuery) *CreateGroupInput
- func (s *CreateGroupInput) SetTags(v map[string]*string) *CreateGroupInput
- func (s CreateGroupInput) String() string
- func (s *CreateGroupInput) Validate() error
- type CreateGroupOutput
- func (s CreateGroupOutput) GoString() string
- func (s *CreateGroupOutput) SetGroup(v *Group) *CreateGroupOutput
- func (s *CreateGroupOutput) SetResourceQuery(v *ResourceQuery) *CreateGroupOutput
- func (s *CreateGroupOutput) SetTags(v map[string]*string) *CreateGroupOutput
- func (s CreateGroupOutput) String() string
- type DeleteGroupInput
- type DeleteGroupOutput
- type GetGroupInput
- type GetGroupOutput
- type GetGroupQueryInput
- type GetGroupQueryOutput
- type GetTagsInput
- type GetTagsOutput
- type Group
- type GroupFilter
- type GroupIdentifier
- type GroupQuery
- type ListGroupResourcesInput
- func (s ListGroupResourcesInput) GoString() string
- func (s *ListGroupResourcesInput) SetFilters(v []*ResourceFilter) *ListGroupResourcesInput
- func (s *ListGroupResourcesInput) SetGroupName(v string) *ListGroupResourcesInput
- func (s *ListGroupResourcesInput) SetMaxResults(v int64) *ListGroupResourcesInput
- func (s *ListGroupResourcesInput) SetNextToken(v string) *ListGroupResourcesInput
- func (s ListGroupResourcesInput) String() string
- func (s *ListGroupResourcesInput) Validate() error
- type ListGroupResourcesOutput
- func (s ListGroupResourcesOutput) GoString() string
- func (s *ListGroupResourcesOutput) SetNextToken(v string) *ListGroupResourcesOutput
- func (s *ListGroupResourcesOutput) SetQueryErrors(v []*QueryError) *ListGroupResourcesOutput
- func (s *ListGroupResourcesOutput) SetResourceIdentifiers(v []*ResourceIdentifier) *ListGroupResourcesOutput
- func (s ListGroupResourcesOutput) String() string
- type ListGroupsInput
- func (s ListGroupsInput) GoString() string
- func (s *ListGroupsInput) SetFilters(v []*GroupFilter) *ListGroupsInput
- func (s *ListGroupsInput) SetMaxResults(v int64) *ListGroupsInput
- func (s *ListGroupsInput) SetNextToken(v string) *ListGroupsInput
- func (s ListGroupsInput) String() string
- func (s *ListGroupsInput) Validate() error
- type ListGroupsOutput
- func (s ListGroupsOutput) GoString() string
- func (s *ListGroupsOutput) SetGroupIdentifiers(v []*GroupIdentifier) *ListGroupsOutput
- func (s *ListGroupsOutput) SetGroups(v []*Group) *ListGroupsOutput
- func (s *ListGroupsOutput) SetNextToken(v string) *ListGroupsOutput
- func (s ListGroupsOutput) String() string
- type QueryError
- type ResourceFilter
- type ResourceGroups
- func (c *ResourceGroups) CreateGroup(input *CreateGroupInput) (*CreateGroupOutput, error)
- func (c *ResourceGroups) CreateGroupRequest(input *CreateGroupInput) (req *request.Request, output *CreateGroupOutput)
- func (c *ResourceGroups) CreateGroupWithContext(ctx aws.Context, input *CreateGroupInput, opts ...request.Option) (*CreateGroupOutput, error)
- func (c *ResourceGroups) DeleteGroup(input *DeleteGroupInput) (*DeleteGroupOutput, error)
- func (c *ResourceGroups) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Request, output *DeleteGroupOutput)
- func (c *ResourceGroups) DeleteGroupWithContext(ctx aws.Context, input *DeleteGroupInput, opts ...request.Option) (*DeleteGroupOutput, error)
- func (c *ResourceGroups) GetGroup(input *GetGroupInput) (*GetGroupOutput, error)
- func (c *ResourceGroups) GetGroupQuery(input *GetGroupQueryInput) (*GetGroupQueryOutput, error)
- func (c *ResourceGroups) GetGroupQueryRequest(input *GetGroupQueryInput) (req *request.Request, output *GetGroupQueryOutput)
- func (c *ResourceGroups) GetGroupQueryWithContext(ctx aws.Context, input *GetGroupQueryInput, opts ...request.Option) (*GetGroupQueryOutput, error)
- func (c *ResourceGroups) GetGroupRequest(input *GetGroupInput) (req *request.Request, output *GetGroupOutput)
- func (c *ResourceGroups) GetGroupWithContext(ctx aws.Context, input *GetGroupInput, opts ...request.Option) (*GetGroupOutput, error)
- func (c *ResourceGroups) GetTags(input *GetTagsInput) (*GetTagsOutput, error)
- func (c *ResourceGroups) GetTagsRequest(input *GetTagsInput) (req *request.Request, output *GetTagsOutput)
- func (c *ResourceGroups) GetTagsWithContext(ctx aws.Context, input *GetTagsInput, opts ...request.Option) (*GetTagsOutput, error)
- func (c *ResourceGroups) ListGroupResources(input *ListGroupResourcesInput) (*ListGroupResourcesOutput, error)
- func (c *ResourceGroups) ListGroupResourcesPages(input *ListGroupResourcesInput, fn func(*ListGroupResourcesOutput, bool) bool) error
- func (c *ResourceGroups) ListGroupResourcesPagesWithContext(ctx aws.Context, input *ListGroupResourcesInput, ...) error
- func (c *ResourceGroups) ListGroupResourcesRequest(input *ListGroupResourcesInput) (req *request.Request, output *ListGroupResourcesOutput)
- func (c *ResourceGroups) ListGroupResourcesWithContext(ctx aws.Context, input *ListGroupResourcesInput, opts ...request.Option) (*ListGroupResourcesOutput, error)
- func (c *ResourceGroups) ListGroups(input *ListGroupsInput) (*ListGroupsOutput, error)
- func (c *ResourceGroups) ListGroupsPages(input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool) error
- func (c *ResourceGroups) ListGroupsPagesWithContext(ctx aws.Context, input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool, ...) error
- func (c *ResourceGroups) ListGroupsRequest(input *ListGroupsInput) (req *request.Request, output *ListGroupsOutput)
- func (c *ResourceGroups) ListGroupsWithContext(ctx aws.Context, input *ListGroupsInput, opts ...request.Option) (*ListGroupsOutput, error)
- func (c *ResourceGroups) SearchResources(input *SearchResourcesInput) (*SearchResourcesOutput, error)
- func (c *ResourceGroups) SearchResourcesPages(input *SearchResourcesInput, fn func(*SearchResourcesOutput, bool) bool) error
- func (c *ResourceGroups) SearchResourcesPagesWithContext(ctx aws.Context, input *SearchResourcesInput, ...) error
- func (c *ResourceGroups) SearchResourcesRequest(input *SearchResourcesInput) (req *request.Request, output *SearchResourcesOutput)
- func (c *ResourceGroups) SearchResourcesWithContext(ctx aws.Context, input *SearchResourcesInput, opts ...request.Option) (*SearchResourcesOutput, error)
- func (c *ResourceGroups) Tag(input *TagInput) (*TagOutput, error)
- func (c *ResourceGroups) TagRequest(input *TagInput) (req *request.Request, output *TagOutput)
- func (c *ResourceGroups) TagWithContext(ctx aws.Context, input *TagInput, opts ...request.Option) (*TagOutput, error)
- func (c *ResourceGroups) Untag(input *UntagInput) (*UntagOutput, error)
- func (c *ResourceGroups) UntagRequest(input *UntagInput) (req *request.Request, output *UntagOutput)
- func (c *ResourceGroups) UntagWithContext(ctx aws.Context, input *UntagInput, opts ...request.Option) (*UntagOutput, error)
- func (c *ResourceGroups) UpdateGroup(input *UpdateGroupInput) (*UpdateGroupOutput, error)
- func (c *ResourceGroups) UpdateGroupQuery(input *UpdateGroupQueryInput) (*UpdateGroupQueryOutput, error)
- func (c *ResourceGroups) UpdateGroupQueryRequest(input *UpdateGroupQueryInput) (req *request.Request, output *UpdateGroupQueryOutput)
- func (c *ResourceGroups) UpdateGroupQueryWithContext(ctx aws.Context, input *UpdateGroupQueryInput, opts ...request.Option) (*UpdateGroupQueryOutput, error)
- func (c *ResourceGroups) UpdateGroupRequest(input *UpdateGroupInput) (req *request.Request, output *UpdateGroupOutput)
- func (c *ResourceGroups) UpdateGroupWithContext(ctx aws.Context, input *UpdateGroupInput, opts ...request.Option) (*UpdateGroupOutput, error)
- type ResourceIdentifier
- type ResourceQuery
- type SearchResourcesInput
- func (s SearchResourcesInput) GoString() string
- func (s *SearchResourcesInput) SetMaxResults(v int64) *SearchResourcesInput
- func (s *SearchResourcesInput) SetNextToken(v string) *SearchResourcesInput
- func (s *SearchResourcesInput) SetResourceQuery(v *ResourceQuery) *SearchResourcesInput
- func (s SearchResourcesInput) String() string
- func (s *SearchResourcesInput) Validate() error
- type SearchResourcesOutput
- func (s SearchResourcesOutput) GoString() string
- func (s *SearchResourcesOutput) SetNextToken(v string) *SearchResourcesOutput
- func (s *SearchResourcesOutput) SetQueryErrors(v []*QueryError) *SearchResourcesOutput
- func (s *SearchResourcesOutput) SetResourceIdentifiers(v []*ResourceIdentifier) *SearchResourcesOutput
- func (s SearchResourcesOutput) String() string
- type TagInput
- type TagOutput
- type UntagInput
- type UntagOutput
- type UpdateGroupInput
- type UpdateGroupOutput
- type UpdateGroupQueryInput
- func (s UpdateGroupQueryInput) GoString() string
- func (s *UpdateGroupQueryInput) SetGroupName(v string) *UpdateGroupQueryInput
- func (s *UpdateGroupQueryInput) SetResourceQuery(v *ResourceQuery) *UpdateGroupQueryInput
- func (s UpdateGroupQueryInput) String() string
- func (s *UpdateGroupQueryInput) Validate() error
- type UpdateGroupQueryOutput
Constants ¶
const ( // QueryErrorCodeCloudformationStackInactive is a QueryErrorCode enum value QueryErrorCodeCloudformationStackInactive = "CLOUDFORMATION_STACK_INACTIVE" // QueryErrorCodeCloudformationStackNotExisting is a QueryErrorCode enum value QueryErrorCodeCloudformationStackNotExisting = "CLOUDFORMATION_STACK_NOT_EXISTING" )
const ( // QueryTypeTagFilters10 is a QueryType enum value QueryTypeTagFilters10 = "TAG_FILTERS_1_0" // QueryTypeCloudformationStack10 is a QueryType enum value QueryTypeCloudformationStack10 = "CLOUDFORMATION_STACK_1_0" )
const ( // ErrCodeBadRequestException for service response error code // "BadRequestException". // // The request does not comply with validation rules that are defined for the // request parameters. ErrCodeBadRequestException = "BadRequestException" // ErrCodeForbiddenException for service response error code // "ForbiddenException". // // The caller is not authorized to make the request. ErrCodeForbiddenException = "ForbiddenException" // ErrCodeInternalServerErrorException for service response error code // "InternalServerErrorException". // // An internal error occurred while processing the request. ErrCodeInternalServerErrorException = "InternalServerErrorException" // ErrCodeMethodNotAllowedException for service response error code // "MethodNotAllowedException". // // The request uses an HTTP method which is not allowed for the specified resource. ErrCodeMethodNotAllowedException = "MethodNotAllowedException" // ErrCodeNotFoundException for service response error code // "NotFoundException". // // One or more resources specified in the request do not exist. ErrCodeNotFoundException = "NotFoundException" // ErrCodeTooManyRequestsException for service response error code // "TooManyRequestsException". // // The caller has exceeded throttling limits. ErrCodeTooManyRequestsException = "TooManyRequestsException" // "UnauthorizedException". // // The request has not been applied because it lacks valid authentication credentials // for the target resource. ErrCodeUnauthorizedException = "UnauthorizedException" )
const ( ServiceName = "resource-groups" // Name of service. EndpointsID = ServiceName // ID to lookup a service endpoint with. ServiceID = "Resource Groups" // ServiceID is a unique identifer of a specific service. )
Service information constants
const (
// GroupFilterNameResourceType is a GroupFilterName enum value
GroupFilterNameResourceType = "resource-type"
)
const (
// ResourceFilterNameResourceType is a ResourceFilterName enum value
ResourceFilterNameResourceType = "resource-type"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateGroupInput ¶
type CreateGroupInput struct { // The description of the resource group. Descriptions can have a maximum of // 511 characters, including letters, numbers, hyphens, underscores, punctuation, // and spaces. Description *string `type:"string"` // The name of the group, which is the identifier of the group in other operations. // A resource group name cannot be updated after it is created. A resource group // name can have a maximum of 128 characters, including letters, numbers, hyphens, // dots, and underscores. The name cannot start with AWS or aws; these are reserved. // A resource group name must be unique within your 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. // // ResourceQuery is a required field ResourceQuery *ResourceQuery `type:"structure" required:"true"` // The tags to add to the group. A tag is a string-to-string map of key-value // pairs. Tag keys can have a maximum character length of 128 characters, and // tag values can have a maximum length of 256 characters. Tags map[string]*string `type:"map"` // contains filtered or unexported fields }
func (CreateGroupInput) GoString ¶
func (s CreateGroupInput) GoString() string
GoString returns the string representation
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
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 { // A full description of the resource group after it is created. Group *Group `type:"structure"` // The resource query associated with the group. 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
func (*CreateGroupOutput) SetGroup ¶
func (s *CreateGroupOutput) SetGroup(v *Group) *CreateGroupOutput
SetGroup sets the Group 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
type DeleteGroupInput ¶
type DeleteGroupInput struct { // The name of the resource group to delete. // // GroupName is a required field GroupName *string `location:"uri" locationName:"GroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteGroupInput) GoString ¶
func (s DeleteGroupInput) GoString() string
GoString returns the string representation
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
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
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
type GetGroupInput ¶
type GetGroupInput struct { // The name of the resource group. // // GroupName is a required field GroupName *string `location:"uri" locationName:"GroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetGroupInput) GoString ¶
func (s GetGroupInput) GoString() string
GoString returns the string representation
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
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
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
type GetGroupQueryInput ¶
type GetGroupQueryInput struct { // The name of the resource group. // // GroupName is a required field GroupName *string `location:"uri" locationName:"GroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetGroupQueryInput) GoString ¶
func (s GetGroupQueryInput) GoString() string
GoString returns the string representation
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
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. GroupQuery *GroupQuery `type:"structure"` // contains filtered or unexported fields }
func (GetGroupQueryOutput) GoString ¶
func (s GetGroupQueryOutput) GoString() string
GoString returns the string representation
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
type GetTagsInput ¶
type GetTagsInput struct { // The ARN of the resource for which you want a list of tags. The resource must // exist within the account you are using. // // Arn is a required field Arn *string `location:"uri" locationName:"Arn" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetTagsInput) GoString ¶
func (s GetTagsInput) GoString() string
GoString returns the string representation
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
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. Arn *string `type:"string"` // The tags associated with the specified resource. Tags map[string]*string `type:"map"` // contains filtered or unexported fields }
func (GetTagsOutput) GoString ¶
func (s GetTagsOutput) GoString() string
GoString returns the string representation
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
type Group ¶
type Group struct { // The description of the resource group. Description *string `type:"string"` // The ARN of a resource group. // // GroupArn is a required field GroupArn *string `type:"string" required:"true"` // The name of a resource group. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
A resource group.
func (*Group) SetDescription ¶
SetDescription sets the Description field's value.
func (*Group) SetGroupArn ¶
SetGroupArn sets the GroupArn field's value.
type GroupFilter ¶
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 name and value pair that is used to obtain more specific results from a list of groups.
func (GroupFilter) GoString ¶
func (s GroupFilter) GoString() string
GoString returns the string representation
func (*GroupFilter) SetName ¶
func (s *GroupFilter) SetName(v string) *GroupFilter
SetName sets the Name field's value.
func (*GroupFilter) SetValues ¶
func (s *GroupFilter) SetValues(v []*string) *GroupFilter
SetValues sets the Values field's value.
func (GroupFilter) String ¶
func (s GroupFilter) String() string
String returns the string representation
func (*GroupFilter) Validate ¶
func (s *GroupFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GroupIdentifier ¶
type GroupIdentifier struct { // The ARN of a resource group. GroupArn *string `type:"string"` // The name of a resource group. GroupName *string `min:"1" type:"string"` // contains filtered or unexported fields }
The ARN and group name of a group.
func (GroupIdentifier) GoString ¶
func (s GroupIdentifier) GoString() string
GoString returns the string representation
func (*GroupIdentifier) SetGroupArn ¶
func (s *GroupIdentifier) SetGroupArn(v string) *GroupIdentifier
SetGroupArn sets the GroupArn field's value.
func (*GroupIdentifier) SetGroupName ¶
func (s *GroupIdentifier) SetGroupName(v string) *GroupIdentifier
SetGroupName sets the GroupName field's value.
func (GroupIdentifier) String ¶
func (s GroupIdentifier) String() string
String returns the string representation
type GroupQuery ¶
type GroupQuery struct { // The name of a resource group that is associated with a specific resource // query. // // GroupName is a required field GroupName *string `min:"1" type:"string" required:"true"` // The resource query which 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 }
The underlying resource query of a resource group. Resources that match query results are part of the group.
func (GroupQuery) GoString ¶
func (s GroupQuery) GoString() string
GoString returns the string representation
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
type ListGroupResourcesInput ¶
type ListGroupResourcesInput struct { // Filters, formatted as ResourceFilter objects, that you want to apply to a // ListGroupResources operation. // // * 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. Filters []*ResourceFilter `type:"list"` // The name of the resource group. // // GroupName is a required field GroupName *string `location:"uri" locationName:"GroupName" min:"1" type:"string" required:"true"` // The maximum number of group member ARNs that are returned in a single call // by ListGroupResources, in paginated output. By default, this number is 50. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The NextToken value that is returned in a paginated ListGroupResources request. // To get the next page of results, run the call again, add the NextToken parameter, // and specify the NextToken value. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListGroupResourcesInput) GoString ¶
func (s ListGroupResourcesInput) GoString() string
GoString returns the string representation
func (*ListGroupResourcesInput) SetFilters ¶
func (s *ListGroupResourcesInput) SetFilters(v []*ResourceFilter) *ListGroupResourcesInput
SetFilters sets the Filters 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
func (*ListGroupResourcesInput) Validate ¶
func (s *ListGroupResourcesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListGroupResourcesOutput ¶
type ListGroupResourcesOutput struct { // The NextToken value to include in a subsequent ListGroupResources request, // to get more results. 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 (ListGroupResourcesOutput) GoString ¶
func (s ListGroupResourcesOutput) GoString() string
GoString returns the string representation
func (*ListGroupResourcesOutput) SetNextToken ¶
func (s *ListGroupResourcesOutput) SetNextToken(v string) *ListGroupResourcesOutput
SetNextToken sets the NextToken field's value.
func (*ListGroupResourcesOutput) SetQueryErrors ¶
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) String ¶
func (s ListGroupResourcesOutput) String() string
String returns the string representation
type ListGroupsInput ¶
type ListGroupsInput struct { // Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups // operation. // // * resource-type - Filter groups by resource type. Specify up to five resource // types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, // or AWS::S3::Bucket. Filters []*GroupFilter `type:"list"` // The maximum number of resource group results that are returned by ListGroups // in paginated output. By default, this number is 50. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The NextToken value that is returned in a paginated ListGroups request. To // get the next page of results, run the call again, add the NextToken parameter, // and specify the NextToken value. 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
func (*ListGroupsInput) SetFilters ¶
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
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 GroupName and the GroupArn. GroupIdentifiers []*GroupIdentifier `type:"list"` // A list of resource groups. // // Deprecated: This field is deprecated, use GroupIdentifiers instead. Groups []*Group `deprecated:"true" type:"list"` // The NextToken value to include in a subsequent ListGroups request, to get // more results. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListGroupsOutput) GoString ¶
func (s ListGroupsOutput) GoString() string
GoString returns the string representation
func (*ListGroupsOutput) SetGroupIdentifiers ¶
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
type QueryError ¶
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 ¶
func (s QueryError) GoString() string
GoString returns the string representation
func (*QueryError) SetErrorCode ¶
func (s *QueryError) SetErrorCode(v string) *QueryError
SetErrorCode sets the ErrorCode field's value.
func (*QueryError) SetMessage ¶
func (s *QueryError) SetMessage(v string) *QueryError
SetMessage sets the Message field's value.
func (QueryError) String ¶
func (s QueryError) String() string
String returns the string representation
type ResourceFilter ¶
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 ¶
func (s ResourceFilter) GoString() string
GoString returns the string representation
func (*ResourceFilter) SetName ¶
func (s *ResourceFilter) SetName(v string) *ResourceFilter
SetName sets the Name field's value.
func (*ResourceFilter) SetValues ¶
func (s *ResourceFilter) SetValues(v []*string) *ResourceFilter
SetValues sets the Values field's value.
func (ResourceFilter) String ¶
func (s ResourceFilter) String() string
String returns the string representation
func (*ResourceFilter) Validate ¶
func (s *ResourceFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ResourceGroups ¶
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:
// 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 group with a specified name, description, and resource query.
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 Codes:
ErrCodeBadRequestException "BadRequestException" The request does not comply with validation rules that are defined for the request parameters.
ErrCodeForbiddenException "ForbiddenException" The caller is not authorized to make the request.
ErrCodeMethodNotAllowedException "MethodNotAllowedException" The request uses an HTTP method which is not allowed for the specified resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" The caller has exceeded throttling limits.
ErrCodeInternalServerErrorException "InternalServerErrorException" An internal error occurred while processing the request.
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 a specified resource group. Deleting a resource group does not delete resources that are members of the group; it only deletes the group structure.
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 Codes:
ErrCodeBadRequestException "BadRequestException" The request does not comply with validation rules that are defined for the request parameters.
ErrCodeForbiddenException "ForbiddenException" The caller is not authorized to make the request.
ErrCodeNotFoundException "NotFoundException" One or more resources specified in the request do not exist.
ErrCodeMethodNotAllowedException "MethodNotAllowedException" The request uses an HTTP method which is not allowed for the specified resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" The caller has exceeded throttling limits.
ErrCodeInternalServerErrorException "InternalServerErrorException" An internal error occurred while processing the request.
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.
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 Codes:
ErrCodeBadRequestException "BadRequestException" The request does not comply with validation rules that are defined for the request parameters.
ErrCodeForbiddenException "ForbiddenException" The caller is not authorized to make the request.
ErrCodeNotFoundException "NotFoundException" One or more resources specified in the request do not exist.
ErrCodeMethodNotAllowedException "MethodNotAllowedException" The request uses an HTTP method which is not allowed for the specified resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" The caller has exceeded throttling limits.
ErrCodeInternalServerErrorException "InternalServerErrorException" An internal error occurred while processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroup
func (*ResourceGroups) GetGroupQuery ¶
func (c *ResourceGroups) GetGroupQuery(input *GetGroupQueryInput) (*GetGroupQueryOutput, error)
GetGroupQuery API operation for AWS Resource Groups.
Returns the resource query associated with the specified resource group.
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 Codes:
ErrCodeBadRequestException "BadRequestException" The request does not comply with validation rules that are defined for the request parameters.
ErrCodeForbiddenException "ForbiddenException" The caller is not authorized to make the request.
ErrCodeNotFoundException "NotFoundException" One or more resources specified in the request do not exist.
ErrCodeMethodNotAllowedException "MethodNotAllowedException" The request uses an HTTP method which is not allowed for the specified resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" The caller has exceeded throttling limits.
ErrCodeInternalServerErrorException "InternalServerErrorException" An internal error occurred while processing the request.
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, specified by an ARN.
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 Codes:
ErrCodeBadRequestException "BadRequestException" The request does not comply with validation rules that are defined for the request parameters.
ErrCodeForbiddenException "ForbiddenException" The caller is not authorized to make the request.
ErrCodeNotFoundException "NotFoundException" One or more resources specified in the request do not exist.
ErrCodeMethodNotAllowedException "MethodNotAllowedException" The request uses an HTTP method which is not allowed for the specified resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" The caller has exceeded throttling limits.
ErrCodeInternalServerErrorException "InternalServerErrorException" An internal error occurred while processing the request.
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) ListGroupResources ¶
func (c *ResourceGroups) ListGroupResources(input *ListGroupResourcesInput) (*ListGroupResourcesOutput, error)
ListGroupResources API operation for AWS Resource Groups.
Returns a list of ARNs of resources that are members of a specified resource group.
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 Codes:
ErrCodeUnauthorizedException "UnauthorizedException" The request has not been applied because it lacks valid authentication credentials for the target resource.
ErrCodeBadRequestException "BadRequestException" The request does not comply with validation rules that are defined for the request parameters.
ErrCodeForbiddenException "ForbiddenException" The caller is not authorized to make the request.
ErrCodeNotFoundException "NotFoundException" One or more resources specified in the request do not exist.
ErrCodeMethodNotAllowedException "MethodNotAllowedException" The request uses an HTTP method which is not allowed for the specified resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" The caller has exceeded throttling limits.
ErrCodeInternalServerErrorException "InternalServerErrorException" An internal error occurred while processing the request.
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 *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.
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 Codes:
ErrCodeBadRequestException "BadRequestException" The request does not comply with validation rules that are defined for the request parameters.
ErrCodeForbiddenException "ForbiddenException" The caller is not authorized to make the request.
ErrCodeMethodNotAllowedException "MethodNotAllowedException" The request uses an HTTP method which is not allowed for the specified resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" The caller has exceeded throttling limits.
ErrCodeInternalServerErrorException "InternalServerErrorException" An internal error occurred while processing the request.
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 *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) 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 a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
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 Codes:
ErrCodeUnauthorizedException "UnauthorizedException" The request has not been applied because it lacks valid authentication credentials for the target resource.
ErrCodeBadRequestException "BadRequestException" The request does not comply with validation rules that are defined for the request parameters.
ErrCodeForbiddenException "ForbiddenException" The caller is not authorized to make the request.
ErrCodeMethodNotAllowedException "MethodNotAllowedException" The request uses an HTTP method which is not allowed for the specified resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" The caller has exceeded throttling limits.
ErrCodeInternalServerErrorException "InternalServerErrorException" An internal error occurred while processing the request.
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 *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 specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
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 Codes:
ErrCodeBadRequestException "BadRequestException" The request does not comply with validation rules that are defined for the request parameters.
ErrCodeForbiddenException "ForbiddenException" The caller is not authorized to make the request.
ErrCodeNotFoundException "NotFoundException" One or more resources specified in the request do not exist.
ErrCodeMethodNotAllowedException "MethodNotAllowedException" The request uses an HTTP method which is not allowed for the specified resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" The caller has exceeded throttling limits.
ErrCodeInternalServerErrorException "InternalServerErrorException" An internal error occurred while processing the request.
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) Untag ¶
func (c *ResourceGroups) Untag(input *UntagInput) (*UntagOutput, error)
Untag API operation for AWS Resource Groups.
Deletes specified tags from a specified resource.
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 Codes:
ErrCodeBadRequestException "BadRequestException" The request does not comply with validation rules that are defined for the request parameters.
ErrCodeForbiddenException "ForbiddenException" The caller is not authorized to make the request.
ErrCodeNotFoundException "NotFoundException" One or more resources specified in the request do not exist.
ErrCodeMethodNotAllowedException "MethodNotAllowedException" The request uses an HTTP method which is not allowed for the specified resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" The caller has exceeded throttling limits.
ErrCodeInternalServerErrorException "InternalServerErrorException" An internal error occurred while processing the request.
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 an existing group with a new or changed description. You cannot update the name of a resource group.
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 Codes:
ErrCodeBadRequestException "BadRequestException" The request does not comply with validation rules that are defined for the request parameters.
ErrCodeForbiddenException "ForbiddenException" The caller is not authorized to make the request.
ErrCodeNotFoundException "NotFoundException" One or more resources specified in the request do not exist.
ErrCodeMethodNotAllowedException "MethodNotAllowedException" The request uses an HTTP method which is not allowed for the specified resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" The caller has exceeded throttling limits.
ErrCodeInternalServerErrorException "InternalServerErrorException" An internal error occurred while processing the request.
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.
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 Codes:
ErrCodeBadRequestException "BadRequestException" The request does not comply with validation rules that are defined for the request parameters.
ErrCodeForbiddenException "ForbiddenException" The caller is not authorized to make the request.
ErrCodeNotFoundException "NotFoundException" One or more resources specified in the request do not exist.
ErrCodeMethodNotAllowedException "MethodNotAllowedException" The request uses an HTTP method which is not allowed for the specified resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" The caller has exceeded throttling limits.
ErrCodeInternalServerErrorException "InternalServerErrorException" An internal error occurred while processing the request.
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 }
The ARN of a resource, and its resource type.
func (ResourceIdentifier) GoString ¶
func (s ResourceIdentifier) GoString() string
GoString returns the string representation
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
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. The valid values in this release are TAG_FILTERS_1_0 // and CLOUDFORMATION_STACK_1_0. // // TAG_FILTERS_1_0: A JSON syntax that lets you specify a collection of simple // tag filters for resource types and tags, as supported by the AWS Tagging // API GetResources (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html) // operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}]) // The results of this query might include the following. // // * An EC2 instance that has the following two tags: {"Key":"Stage","Values":["Deploy"]}, // and {"Key":"Version","Values":["2"]} // // * An S3 bucket that has the following two tags: {"Key":"Stage","Values":["Test","Deploy"]}, // and {"Key":"Version","Values":["1"]} // // The query would not return the following results, however. The following // EC2 instance does not have all tag keys specified in the filter, so it is // rejected. The RDS database has all of the tag keys, but no values that match // at least one of the specified tag key values in the filter. // // * An EC2 instance that has only the following tag: {"Key":"Stage","Values":["Deploy"]}. // // * An RDS database that has the following two tags: {"Key":"Stage","Values":["Archived"]}, // and {"Key":"Version","Values":["4"]} // // CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation // stack ARN. // // Type is a required field Type *string `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.
func (ResourceQuery) GoString ¶
func (s ResourceQuery) GoString() string
GoString returns the string representation
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
func (*ResourceQuery) Validate ¶
func (s *ResourceQuery) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SearchResourcesInput ¶
type SearchResourcesInput struct { // The maximum number of group member ARNs returned by SearchResources in paginated // output. By default, this number is 50. MaxResults *int64 `min:"1" type:"integer"` // The NextToken value that is returned in a paginated SearchResources request. // To get the next page of results, run the call again, add the NextToken parameter, // and specify the NextToken value. NextToken *string `type:"string"` // The search query, using the same formats that are supported for resource // group definition. // // 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
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
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 { // The NextToken value to include in a subsequent SearchResources request, to // get more results. 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
func (*SearchResourcesOutput) SetNextToken ¶
func (s *SearchResourcesOutput) SetNextToken(v string) *SearchResourcesOutput
SetNextToken sets the NextToken field's value.
func (*SearchResourcesOutput) SetQueryErrors ¶
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
type TagInput ¶
type TagInput struct { // The ARN of the resource to which to add tags. // // Arn is a required field Arn *string `location:"uri" locationName:"Arn" type:"string" required:"true"` // The tags to add to the specified resource. A tag is a string-to-string map // of key-value pairs. Tag keys can have a maximum character length of 128 characters, // and tag values can have a maximum length of 256 characters. // // Tags is a required field Tags map[string]*string `type:"map" required:"true"` // contains filtered or unexported fields }
type TagOutput ¶
type TagOutput struct { // The ARN of the tagged resource. Arn *string `type:"string"` // The tags that have been added to the specified resource. Tags map[string]*string `type:"map"` // contains filtered or unexported fields }
type UntagInput ¶
type UntagInput struct { // The ARN of the resource from which to remove tags. // // Arn is a required field Arn *string `location:"uri" locationName:"Arn" 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
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
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 from which tags have been removed. Arn *string `type:"string"` // The keys of tags that have been removed. Keys []*string `type:"list"` // contains filtered or unexported fields }
func (UntagOutput) GoString ¶
func (s UntagOutput) GoString() string
GoString returns the string representation
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
type UpdateGroupInput ¶
type UpdateGroupInput struct { // The description of the resource group. Descriptions can have a maximum of // 511 characters, including letters, numbers, hyphens, underscores, punctuation, // and spaces. Description *string `type:"string"` // The name of the resource group for which you want to update its description. // // GroupName is a required field GroupName *string `location:"uri" locationName:"GroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateGroupInput) GoString ¶
func (s UpdateGroupInput) GoString() string
GoString returns the string representation
func (*UpdateGroupInput) SetDescription ¶
func (s *UpdateGroupInput) SetDescription(v string) *UpdateGroupInput
SetDescription sets the Description 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
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 full description of the resource group after it has been updated. Group *Group `type:"structure"` // contains filtered or unexported fields }
func (UpdateGroupOutput) GoString ¶
func (s UpdateGroupOutput) GoString() string
GoString returns the string representation
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
type UpdateGroupQueryInput ¶
type UpdateGroupQueryInput struct { // The name of the resource group for which you want to edit the query. // // GroupName is a required field GroupName *string `location:"uri" locationName:"GroupName" min:"1" type:"string" required:"true"` // The resource query that determines which AWS resources are members of the // resource group. // // 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
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
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 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
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
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. |