resourcegroups

package
v0.7.0 Latest Latest
Warning

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

 Go to latest Published: Jan 3, 2019 License: Apache-2.0 Imports: 6 Imported by: 45

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 AWS Resource Groups with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

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

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

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

Index

Constants

View Source 
const (

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

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// The request has not been applied because it lacks valid authentication credentials
	// for the target resource.
	ErrCodeUnauthorizedException = "UnauthorizedException"
)
View Source 
const (
	ServiceName = "resource-groups" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName       // Service ID for Regions and Endpoints metadata.
)

Service information constants

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroupInput

func (CreateGroupInput) GoString 

func (s CreateGroupInput) GoString() string

GoString returns the string representation

func (CreateGroupInput) MarshalFields added in v0.3.0 

func (s CreateGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroupOutput

func (CreateGroupOutput) GoString 

func (s CreateGroupOutput) GoString() string

GoString returns the string representation

func (CreateGroupOutput) MarshalFields added in v0.3.0 

func (s CreateGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateGroupOutput) SDKResponseMetadata 

func (s CreateGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateGroupOutput) String 

func (s CreateGroupOutput) String() string

String returns the string representation

type CreateGroupRequest 

type CreateGroupRequest struct {
	*aws.Request
	Input *CreateGroupInput
	Copy  func(*CreateGroupInput) CreateGroupRequest
}

CreateGroupRequest is a API request type for the CreateGroup API operation.

func (CreateGroupRequest) Send 

func (r CreateGroupRequest) Send() (*CreateGroupOutput, error)

Send marshals and sends the CreateGroup API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/DeleteGroupInput

func (DeleteGroupInput) GoString 

func (s DeleteGroupInput) GoString() string

GoString returns the string representation

func (DeleteGroupInput) MarshalFields added in v0.3.0 

func (s DeleteGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/DeleteGroupOutput

func (DeleteGroupOutput) GoString 

func (s DeleteGroupOutput) GoString() string

GoString returns the string representation

func (DeleteGroupOutput) MarshalFields added in v0.3.0 

func (s DeleteGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteGroupOutput) SDKResponseMetadata 

func (s DeleteGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteGroupOutput) String 

func (s DeleteGroupOutput) String() string

String returns the string representation

type DeleteGroupRequest 

type DeleteGroupRequest struct {
	*aws.Request
	Input *DeleteGroupInput
	Copy  func(*DeleteGroupInput) DeleteGroupRequest
}

DeleteGroupRequest is a API request type for the DeleteGroup API operation.

func (DeleteGroupRequest) Send 

func (r DeleteGroupRequest) Send() (*DeleteGroupOutput, error)

Send marshals and sends the DeleteGroup API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupInput

func (GetGroupInput) GoString 

func (s GetGroupInput) GoString() string

GoString returns the string representation

func (GetGroupInput) MarshalFields added in v0.3.0 

func (s GetGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupOutput

func (GetGroupOutput) GoString 

func (s GetGroupOutput) GoString() string

GoString returns the string representation

func (GetGroupOutput) MarshalFields added in v0.3.0 

func (s GetGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetGroupOutput) SDKResponseMetadata 

func (s GetGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupQueryInput

func (GetGroupQueryInput) GoString 

func (s GetGroupQueryInput) GoString() string

GoString returns the string representation

func (GetGroupQueryInput) MarshalFields added in v0.3.0 

func (s GetGroupQueryInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupQueryOutput

func (GetGroupQueryOutput) GoString 

func (s GetGroupQueryOutput) GoString() string

GoString returns the string representation

func (GetGroupQueryOutput) MarshalFields added in v0.3.0 

func (s GetGroupQueryOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetGroupQueryOutput) SDKResponseMetadata 

func (s GetGroupQueryOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetGroupQueryOutput) String 

func (s GetGroupQueryOutput) String() string

String returns the string representation

type GetGroupQueryRequest 

type GetGroupQueryRequest struct {
	*aws.Request
	Input *GetGroupQueryInput
	Copy  func(*GetGroupQueryInput) GetGroupQueryRequest
}

GetGroupQueryRequest is a API request type for the GetGroupQuery API operation.

func (GetGroupQueryRequest) Send 

func (r GetGroupQueryRequest) Send() (*GetGroupQueryOutput, error)

Send marshals and sends the GetGroupQuery API request.

type GetGroupRequest 

type GetGroupRequest struct {
	*aws.Request
	Input *GetGroupInput
	Copy  func(*GetGroupInput) GetGroupRequest
}

GetGroupRequest is a API request type for the GetGroup API operation.

func (GetGroupRequest) Send 

func (r GetGroupRequest) Send() (*GetGroupOutput, error)

Send marshals and sends the GetGroup API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetTagsInput

func (GetTagsInput) GoString 

func (s GetTagsInput) GoString() string

GoString returns the string representation

func (GetTagsInput) MarshalFields added in v0.3.0 

func (s GetTagsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetTagsOutput

func (GetTagsOutput) GoString 

func (s GetTagsOutput) GoString() string

GoString returns the string representation

func (GetTagsOutput) MarshalFields added in v0.3.0 

func (s GetTagsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetTagsOutput) SDKResponseMetadata 

func (s GetTagsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetTagsOutput) String 

func (s GetTagsOutput) String() string

String returns the string representation

type GetTagsRequest 

type GetTagsRequest struct {
	*aws.Request
	Input *GetTagsInput
	Copy  func(*GetTagsInput) GetTagsRequest
}

GetTagsRequest is a API request type for the GetTags API operation.

func (GetTagsRequest) Send 

func (r GetTagsRequest) Send() (*GetTagsOutput, error)

Send marshals and sends the GetTags API request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/Group

func (Group) GoString 

func (s Group) GoString() string

GoString returns the string representation

func (Group) MarshalFields added in v0.3.0 

func (s Group) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Group) String 

func (s Group) String() string

String returns the string representation

type GroupFilter added in v0.6.0 

type GroupFilter struct {

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

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupFilter

func (GroupFilter) GoString added in v0.6.0 

func (s GroupFilter) GoString() string

GoString returns the string representation

func (GroupFilter) MarshalFields added in v0.6.0 

func (s GroupFilter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GroupFilter) String added in v0.6.0 

func (s GroupFilter) String() string

String returns the string representation

func (*GroupFilter) Validate added in v0.6.0 

func (s *GroupFilter) Validate() error

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

type GroupFilterName added in v0.6.0 

type GroupFilterName string
const (
	GroupFilterNameResourceType GroupFilterName = "resource-type"
)

Enum values for GroupFilterName

func (GroupFilterName) MarshalValue added in v0.6.0 

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

func (GroupFilterName) MarshalValueBuf added in v0.6.0 

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

type GroupIdentifier added in v0.6.0 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupIdentifier

func (GroupIdentifier) GoString added in v0.6.0 

func (s GroupIdentifier) GoString() string

GoString returns the string representation

func (GroupIdentifier) MarshalFields added in v0.6.0 

func (s GroupIdentifier) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GroupIdentifier) String added in v0.6.0 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupQuery

func (GroupQuery) GoString 

func (s GroupQuery) GoString() string

GoString returns the string representation

func (GroupQuery) MarshalFields added in v0.3.0 

func (s GroupQuery) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupResourcesInput

func (ListGroupResourcesInput) GoString 

func (s ListGroupResourcesInput) GoString() string

GoString returns the string representation

func (ListGroupResourcesInput) MarshalFields added in v0.3.0 

func (s ListGroupResourcesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupResourcesOutput

func (ListGroupResourcesOutput) GoString 

func (s ListGroupResourcesOutput) GoString() string

GoString returns the string representation

func (ListGroupResourcesOutput) MarshalFields added in v0.3.0 

func (s ListGroupResourcesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListGroupResourcesOutput) SDKResponseMetadata 

func (s ListGroupResourcesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListGroupResourcesOutput) String 

func (s ListGroupResourcesOutput) String() string

String returns the string representation

type ListGroupResourcesPager added in v0.3.0 

type ListGroupResourcesPager struct {
	aws.Pager
}

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

func (*ListGroupResourcesPager) CurrentPage added in v0.3.0 

func (p *ListGroupResourcesPager) CurrentPage() *ListGroupResourcesOutput

type ListGroupResourcesRequest 

type ListGroupResourcesRequest struct {
	*aws.Request
	Input *ListGroupResourcesInput
	Copy  func(*ListGroupResourcesInput) ListGroupResourcesRequest
}

ListGroupResourcesRequest is a API request type for the ListGroupResources API operation.

func (*ListGroupResourcesRequest) Paginate added in v0.3.0 

func (p *ListGroupResourcesRequest) Paginate(opts ...aws.Option) ListGroupResourcesPager

Paginate pages iterates over the pages of a ListGroupResourcesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a ListGroupResources operation.
		req := client.ListGroupResourcesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

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

func (ListGroupResourcesRequest) Send 

func (r ListGroupResourcesRequest) Send() (*ListGroupResourcesOutput, error)

Send marshals and sends the ListGroupResources API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupsInput

func (ListGroupsInput) GoString 

func (s ListGroupsInput) GoString() string

GoString returns the string representation

func (ListGroupsInput) MarshalFields added in v0.3.0 

func (s ListGroupsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupsOutput

func (ListGroupsOutput) GoString 

func (s ListGroupsOutput) GoString() string

GoString returns the string representation

func (ListGroupsOutput) MarshalFields added in v0.3.0 

func (s ListGroupsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListGroupsOutput) SDKResponseMetadata 

func (s ListGroupsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListGroupsOutput) String 

func (s ListGroupsOutput) String() string

String returns the string representation

type ListGroupsPager added in v0.3.0 

type ListGroupsPager struct {
	aws.Pager
}

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

func (*ListGroupsPager) CurrentPage added in v0.3.0 

func (p *ListGroupsPager) CurrentPage() *ListGroupsOutput

type ListGroupsRequest 

type ListGroupsRequest struct {
	*aws.Request
	Input *ListGroupsInput
	Copy  func(*ListGroupsInput) ListGroupsRequest
}

ListGroupsRequest is a API request type for the ListGroups API operation.

func (*ListGroupsRequest) Paginate added in v0.3.0 

func (p *ListGroupsRequest) Paginate(opts ...aws.Option) ListGroupsPager

Paginate pages iterates over the pages of a ListGroupsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a ListGroups operation.
		req := client.ListGroupsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

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

func (ListGroupsRequest) Send 

func (r ListGroupsRequest) Send() (*ListGroupsOutput, error)

Send marshals and sends the ListGroups API request.

type QueryError added in v0.6.0 

type QueryError struct {

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

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/QueryError

func (QueryError) GoString added in v0.6.0 

func (s QueryError) GoString() string

GoString returns the string representation

func (QueryError) MarshalFields added in v0.6.0 

func (s QueryError) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (QueryError) String added in v0.6.0 

func (s QueryError) String() string

String returns the string representation

type QueryErrorCode added in v0.6.0 

type QueryErrorCode string
const (
	QueryErrorCodeCloudformationStackInactive    QueryErrorCode = "CLOUDFORMATION_STACK_INACTIVE"
	QueryErrorCodeCloudformationStackNotExisting QueryErrorCode = "CLOUDFORMATION_STACK_NOT_EXISTING"
)

Enum values for QueryErrorCode

func (QueryErrorCode) MarshalValue added in v0.6.0 

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

func (QueryErrorCode) MarshalValueBuf added in v0.6.0 

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

type QueryType 

type QueryType string
const (
	QueryTypeTagFilters10          QueryType = "TAG_FILTERS_1_0"
	QueryTypeCloudformationStack10 QueryType = "CLOUDFORMATION_STACK_1_0"
)

Enum values for QueryType

func (QueryType) MarshalValue added in v0.3.0 

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

func (QueryType) MarshalValueBuf added in v0.3.0 

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

type ResourceFilter added in v0.5.0 

type ResourceFilter struct {

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

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ResourceFilter

func (ResourceFilter) GoString added in v0.5.0 

func (s ResourceFilter) GoString() string

GoString returns the string representation

func (ResourceFilter) MarshalFields added in v0.5.0 

func (s ResourceFilter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResourceFilter) String added in v0.5.0 

func (s ResourceFilter) String() string

String returns the string representation

func (*ResourceFilter) Validate added in v0.5.0 

func (s *ResourceFilter) Validate() error

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

type ResourceFilterName added in v0.5.0 

type ResourceFilterName string
const (
	ResourceFilterNameResourceType ResourceFilterName = "resource-type"
)

Enum values for ResourceFilterName

func (ResourceFilterName) MarshalValue added in v0.5.0 

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

func (ResourceFilterName) MarshalValueBuf added in v0.5.0 

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

type ResourceGroups 

type ResourceGroups struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *ResourceGroups

New creates a new instance of the ResourceGroups client with a config.

Example: 

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

func (*ResourceGroups) CreateGroupRequest 

func (c *ResourceGroups) CreateGroupRequest(input *CreateGroupInput) CreateGroupRequest

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

Creates a group with a specified name, description, and resource query. 

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

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

func (*ResourceGroups) DeleteGroupRequest 

func (c *ResourceGroups) DeleteGroupRequest(input *DeleteGroupInput) DeleteGroupRequest

DeleteGroupRequest returns a request value for making 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. 

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

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

func (*ResourceGroups) GetGroupQueryRequest 

func (c *ResourceGroups) GetGroupQueryRequest(input *GetGroupQueryInput) GetGroupQueryRequest

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

Returns the resource query associated with the specified resource group. 

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

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

func (*ResourceGroups) GetGroupRequest 

func (c *ResourceGroups) GetGroupRequest(input *GetGroupInput) GetGroupRequest

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

Returns information about a specified resource group. 

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

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

func (*ResourceGroups) GetTagsRequest 

func (c *ResourceGroups) GetTagsRequest(input *GetTagsInput) GetTagsRequest

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

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

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

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

func (*ResourceGroups) ListGroupResourcesRequest 

func (c *ResourceGroups) ListGroupResourcesRequest(input *ListGroupResourcesInput) ListGroupResourcesRequest

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

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

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

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

func (*ResourceGroups) ListGroupsRequest 

func (c *ResourceGroups) ListGroupsRequest(input *ListGroupsInput) ListGroupsRequest

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

Returns a list of existing resource groups in your account. 

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

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

func (*ResourceGroups) SearchResourcesRequest 

func (c *ResourceGroups) SearchResourcesRequest(input *SearchResourcesInput) SearchResourcesRequest

SearchResourcesRequest returns a request value for making 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. 

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

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

func (*ResourceGroups) TagRequest 

func (c *ResourceGroups) TagRequest(input *TagInput) TagRequest

TagRequest returns a request value for making 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. 

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

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

func (*ResourceGroups) UntagRequest 

func (c *ResourceGroups) UntagRequest(input *UntagInput) UntagRequest

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

Deletes specified tags from a specified resource. 

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

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

func (*ResourceGroups) UpdateGroupQueryRequest 

func (c *ResourceGroups) UpdateGroupQueryRequest(input *UpdateGroupQueryInput) UpdateGroupQueryRequest

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

Updates the resource query of a group. 

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

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

func (*ResourceGroups) UpdateGroupRequest 

func (c *ResourceGroups) UpdateGroupRequest(input *UpdateGroupInput) UpdateGroupRequest

UpdateGroupRequest returns a request value for making 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. 

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

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ResourceIdentifier

func (ResourceIdentifier) GoString 

func (s ResourceIdentifier) GoString() string

GoString returns the string representation

func (ResourceIdentifier) MarshalFields added in v0.3.0 

func (s ResourceIdentifier) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 QueryType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

The query that is used to define a resource group or a search for resources. Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ResourceQuery

func (ResourceQuery) GoString 

func (s ResourceQuery) GoString() string

GoString returns the string representation

func (ResourceQuery) MarshalFields added in v0.3.0 

func (s ResourceQuery) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/SearchResourcesInput

func (SearchResourcesInput) GoString 

func (s SearchResourcesInput) GoString() string

GoString returns the string representation

func (SearchResourcesInput) MarshalFields added in v0.3.0 

func (s SearchResourcesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/SearchResourcesOutput

func (SearchResourcesOutput) GoString 

func (s SearchResourcesOutput) GoString() string

GoString returns the string representation

func (SearchResourcesOutput) MarshalFields added in v0.3.0 

func (s SearchResourcesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SearchResourcesOutput) SDKResponseMetadata 

func (s SearchResourcesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SearchResourcesOutput) String 

func (s SearchResourcesOutput) String() string

String returns the string representation

type SearchResourcesPager added in v0.3.0 

type SearchResourcesPager struct {
	aws.Pager
}

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

func (*SearchResourcesPager) CurrentPage added in v0.3.0 

func (p *SearchResourcesPager) CurrentPage() *SearchResourcesOutput

type SearchResourcesRequest 

type SearchResourcesRequest struct {
	*aws.Request
	Input *SearchResourcesInput
	Copy  func(*SearchResourcesInput) SearchResourcesRequest
}

SearchResourcesRequest is a API request type for the SearchResources API operation.

func (*SearchResourcesRequest) Paginate added in v0.3.0 

func (p *SearchResourcesRequest) Paginate(opts ...aws.Option) SearchResourcesPager

Paginate pages iterates over the pages of a SearchResourcesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a SearchResources operation.
		req := client.SearchResourcesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

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

func (SearchResourcesRequest) Send 

func (r SearchResourcesRequest) Send() (*SearchResourcesOutput, error)

Send marshals and sends the SearchResources API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/TagInput

func (TagInput) GoString 

func (s TagInput) GoString() string

GoString returns the string representation

func (TagInput) MarshalFields added in v0.3.0 

func (s TagInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagInput) String 

func (s TagInput) String() string

String returns the string representation

func (*TagInput) Validate 

func (s *TagInput) Validate() error

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

type TagOutput 

type TagOutput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/TagOutput

func (TagOutput) GoString 

func (s TagOutput) GoString() string

GoString returns the string representation

func (TagOutput) MarshalFields added in v0.3.0 

func (s TagOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagOutput) SDKResponseMetadata 

func (s TagOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (TagOutput) String 

func (s TagOutput) String() string

String returns the string representation

type TagRequest 

type TagRequest struct {
	*aws.Request
	Input *TagInput
	Copy  func(*TagInput) TagRequest
}

TagRequest is a API request type for the Tag API operation.

func (TagRequest) Send 

func (r TagRequest) Send() (*TagOutput, error)

Send marshals and sends the Tag API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UntagInput

func (UntagInput) GoString 

func (s UntagInput) GoString() string

GoString returns the string representation

func (UntagInput) MarshalFields added in v0.3.0 

func (s UntagInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UntagOutput

func (UntagOutput) GoString 

func (s UntagOutput) GoString() string

GoString returns the string representation

func (UntagOutput) MarshalFields added in v0.3.0 

func (s UntagOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagOutput) SDKResponseMetadata 

func (s UntagOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UntagOutput) String 

func (s UntagOutput) String() string

String returns the string representation

type UntagRequest 

type UntagRequest struct {
	*aws.Request
	Input *UntagInput
	Copy  func(*UntagInput) UntagRequest
}

UntagRequest is a API request type for the Untag API operation.

func (UntagRequest) Send 

func (r UntagRequest) Send() (*UntagOutput, error)

Send marshals and sends the Untag API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroupInput

func (UpdateGroupInput) GoString 

func (s UpdateGroupInput) GoString() string

GoString returns the string representation

func (UpdateGroupInput) MarshalFields added in v0.3.0 

func (s UpdateGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroupOutput

func (UpdateGroupOutput) GoString 

func (s UpdateGroupOutput) GoString() string

GoString returns the string representation

func (UpdateGroupOutput) MarshalFields added in v0.3.0 

func (s UpdateGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateGroupOutput) SDKResponseMetadata 

func (s UpdateGroupOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroupQueryInput

func (UpdateGroupQueryInput) GoString 

func (s UpdateGroupQueryInput) GoString() string

GoString returns the string representation

func (UpdateGroupQueryInput) MarshalFields added in v0.3.0 

func (s UpdateGroupQueryInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroupQueryOutput

func (UpdateGroupQueryOutput) GoString 

func (s UpdateGroupQueryOutput) GoString() string

GoString returns the string representation

func (UpdateGroupQueryOutput) MarshalFields added in v0.3.0 

func (s UpdateGroupQueryOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateGroupQueryOutput) SDKResponseMetadata 

func (s UpdateGroupQueryOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateGroupQueryOutput) String 

func (s UpdateGroupQueryOutput) String() string

String returns the string representation

type UpdateGroupQueryRequest 

type UpdateGroupQueryRequest struct {
	*aws.Request
	Input *UpdateGroupQueryInput
	Copy  func(*UpdateGroupQueryInput) UpdateGroupQueryRequest
}

UpdateGroupQueryRequest is a API request type for the UpdateGroupQuery API operation.

func (UpdateGroupQueryRequest) Send 

func (r UpdateGroupQueryRequest) Send() (*UpdateGroupQueryOutput, error)

Send marshals and sends the UpdateGroupQuery API request.

type UpdateGroupRequest 

type UpdateGroupRequest struct {
	*aws.Request
	Input *UpdateGroupInput
	Copy  func(*UpdateGroupInput) UpdateGroupRequest
}

UpdateGroupRequest is a API request type for the UpdateGroup API operation.

func (UpdateGroupRequest) Send 

func (r UpdateGroupRequest) Send() (*UpdateGroupOutput, error)

Send marshals and sends the UpdateGroup API request.

Source Files

View all Source files

Directories

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

Jump to

Keyboard shortcuts

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