resourcegroups

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 45

Documentation

Overview

Package resourcegroups provides the client and types for making API requests to 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 use 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 Resource Groups client 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 (
	ServiceName = "Resource Groups" // Service's name
	ServiceID   = "ResourceGroups"  // Service's identifier
	EndpointsID = "resource-groups" // Service's Endpoint identifier
)
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"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

The client's 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) *Client

New creates a new instance of the client from the provided Config.

Example: 

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

func (*Client) CreateGroupRequest added in v0.9.0 

func (c *Client) 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 CreateGroupRequest.
req := client.CreateGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteGroupRequest added in v0.9.0 

func (c *Client) 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 DeleteGroupRequest.
req := client.DeleteGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetGroupQueryRequest added in v0.9.0 

func (c *Client) 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 GetGroupQueryRequest.
req := client.GetGroupQueryRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetGroupRequest added in v0.9.0 

func (c *Client) 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 GetGroupRequest.
req := client.GetGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetTagsRequest added in v0.9.0 

func (c *Client) 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 group, specified by an ARN. 

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

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

func (*Client) ListGroupResourcesRequest added in v0.9.0 

func (c *Client) 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 ListGroupResourcesRequest.
req := client.ListGroupResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListGroupsRequest added in v0.9.0 

func (c *Client) 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 ListGroupsRequest.
req := client.ListGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) SearchResourcesRequest added in v0.9.0 

func (c *Client) 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 SearchResourcesRequest.
req := client.SearchResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) TagRequest added in v0.9.0 

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

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

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

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

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

func (*Client) UntagRequest added in v0.9.0 

func (c *Client) 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 UntagRequest.
req := client.UntagRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateGroupQueryRequest added in v0.9.0 

func (c *Client) 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 UpdateGroupQueryRequest.
req := client.UpdateGroupQueryRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateGroupRequest added in v0.9.0 

func (c *Client) 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 UpdateGroupRequest.
req := client.UpdateGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

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

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) 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 the request type for the CreateGroup API operation.

func (CreateGroupRequest) Send 

func (r CreateGroupRequest) Send(ctx context.Context) (*CreateGroupResponse, error)

Send marshals and sends the CreateGroup API request.

type CreateGroupResponse added in v0.9.0 

type CreateGroupResponse struct {
	*CreateGroupOutput
	// contains filtered or unexported fields
}

CreateGroupResponse is the response type for the CreateGroup API operation.

func (*CreateGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateGroup 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
}

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
}

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) 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 the request type for the DeleteGroup API operation.

func (DeleteGroupRequest) Send 

func (r DeleteGroupRequest) Send(ctx context.Context) (*DeleteGroupResponse, error)

Send marshals and sends the DeleteGroup API request.

type DeleteGroupResponse added in v0.9.0 

type DeleteGroupResponse struct {
	*DeleteGroupOutput
	// contains filtered or unexported fields
}

DeleteGroupResponse is the response type for the DeleteGroup API operation.

func (*DeleteGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteGroup 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
}

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
}

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

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) 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 the request type for the GetGroupQuery API operation.

func (GetGroupQueryRequest) Send 

func (r GetGroupQueryRequest) Send(ctx context.Context) (*GetGroupQueryResponse, error)

Send marshals and sends the GetGroupQuery API request.

type GetGroupQueryResponse added in v0.9.0 

type GetGroupQueryResponse struct {
	*GetGroupQueryOutput
	// contains filtered or unexported fields
}

GetGroupQueryResponse is the response type for the GetGroupQuery API operation.

func (*GetGroupQueryResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetGroupQueryResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetGroupQuery request.

type GetGroupRequest 

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

GetGroupRequest is the request type for the GetGroup API operation.

func (GetGroupRequest) Send 

func (r GetGroupRequest) Send(ctx context.Context) (*GetGroupResponse, error)

Send marshals and sends the GetGroup API request.

type GetGroupResponse added in v0.9.0 

type GetGroupResponse struct {
	*GetGroupOutput
	// contains filtered or unexported fields
}

GetGroupResponse is the response type for the GetGroup API operation.

func (*GetGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetGroup request.

type GetTagsInput 

type GetTagsInput struct {

	// The ARN of the resource group 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" min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 group.
	Arn *string `min:"12" type:"string"`

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

func (GetTagsOutput) 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) 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 the request type for the GetTags API operation.

func (GetTagsRequest) Send 

func (r GetTagsRequest) Send(ctx context.Context) (*GetTagsResponse, error)

Send marshals and sends the GetTags API request.

type GetTagsResponse added in v0.9.0 

type GetTagsResponse struct {
	*GetTagsOutput
	// contains filtered or unexported fields
}

GetTagsResponse is the response type for the GetTags API operation.

func (*GetTagsResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetTagsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetTags 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 `min:"12" 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) 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.

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 `min:"12" 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) 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.

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
}

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
}

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) String 

func (s ListGroupResourcesOutput) String() string

String returns the string representation

type ListGroupResourcesPaginator added in v0.9.0 

type ListGroupResourcesPaginator struct {
	aws.Pager
}

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

func NewListGroupResourcesPaginator added in v0.9.0 

func NewListGroupResourcesPaginator(req ListGroupResourcesRequest) ListGroupResourcesPaginator

NewListGroupResourcesRequestPaginator returns a paginator for ListGroupResources. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListGroupResourcesRequest(input)
p := resourcegroups.NewListGroupResourcesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

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

func (*ListGroupResourcesPaginator) CurrentPage added in v0.9.0 

func (p *ListGroupResourcesPaginator) CurrentPage() *ListGroupResourcesOutput

type ListGroupResourcesRequest 

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

ListGroupResourcesRequest is the request type for the ListGroupResources API operation.

func (ListGroupResourcesRequest) Send 

func (r ListGroupResourcesRequest) Send(ctx context.Context) (*ListGroupResourcesResponse, error)

Send marshals and sends the ListGroupResources API request.

type ListGroupResourcesResponse added in v0.9.0 

type ListGroupResourcesResponse struct {
	*ListGroupResourcesOutput
	// contains filtered or unexported fields
}

ListGroupResourcesResponse is the response type for the ListGroupResources API operation.

func (*ListGroupResourcesResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListGroupResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListGroupResources 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
}

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
}

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) String 

func (s ListGroupsOutput) String() string

String returns the string representation

type ListGroupsPaginator added in v0.9.0 

type ListGroupsPaginator struct {
	aws.Pager
}

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

func NewListGroupsPaginator added in v0.9.0 

func NewListGroupsPaginator(req ListGroupsRequest) ListGroupsPaginator

NewListGroupsRequestPaginator returns a paginator for ListGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListGroupsRequest(input)
p := resourcegroups.NewListGroupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

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

func (*ListGroupsPaginator) CurrentPage added in v0.9.0 

func (p *ListGroupsPaginator) CurrentPage() *ListGroupsOutput

type ListGroupsRequest 

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

ListGroupsRequest is the request type for the ListGroups API operation.

func (ListGroupsRequest) Send 

func (r ListGroupsRequest) Send(ctx context.Context) (*ListGroupsResponse, error)

Send marshals and sends the ListGroups API request.

type ListGroupsResponse added in v0.9.0 

type ListGroupsResponse struct {
	*ListGroupsOutput
	// contains filtered or unexported fields
}

ListGroupsResponse is the response type for the ListGroups API operation.

func (*ListGroupsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListGroups 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.

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.

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 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) 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","Value":"Deploy"},
	//    and {"Key":"Version","Value":"2"}
	//
	//    * An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"},
	//    and {"Key":"Version","Value":"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","Value":"Deploy"}.
	//
	//    * An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"},
	//    and {"Key":"Version","Value":"4"}
	//
	//  CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation
	//  stack ARN.
	//
	// Type is a required field
	Type QueryType `min:"1" 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.

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
}

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
}

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) String 

func (s SearchResourcesOutput) String() string

String returns the string representation

type SearchResourcesPaginator added in v0.9.0 

type SearchResourcesPaginator struct {
	aws.Pager
}

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

func NewSearchResourcesPaginator added in v0.9.0 

func NewSearchResourcesPaginator(req SearchResourcesRequest) SearchResourcesPaginator

NewSearchResourcesRequestPaginator returns a paginator for SearchResources. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.SearchResourcesRequest(input)
p := resourcegroups.NewSearchResourcesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

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

func (*SearchResourcesPaginator) CurrentPage added in v0.9.0 

func (p *SearchResourcesPaginator) CurrentPage() *SearchResourcesOutput

type SearchResourcesRequest 

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

SearchResourcesRequest is the request type for the SearchResources API operation.

func (SearchResourcesRequest) Send 

func (r SearchResourcesRequest) Send(ctx context.Context) (*SearchResourcesResponse, error)

Send marshals and sends the SearchResources API request.

type SearchResourcesResponse added in v0.9.0 

type SearchResourcesResponse struct {
	*SearchResourcesOutput
	// contains filtered or unexported fields
}

SearchResourcesResponse is the response type for the SearchResources API operation.

func (*SearchResourcesResponse) SDKResponseMetdata added in v0.9.0 

func (r *SearchResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SearchResources 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" min:"12" 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
}

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 `min:"12" type:"string"`

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

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) 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 the request type for the Tag API operation.

func (TagRequest) Send 

func (r TagRequest) Send(ctx context.Context) (*TagResponse, error)

Send marshals and sends the Tag API request.

type TagResponse added in v0.9.0 

type TagResponse struct {
	*TagOutput
	// contains filtered or unexported fields
}

TagResponse is the response type for the Tag API operation.

func (*TagResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the Tag 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" min:"12" type:"string" required:"true"`

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

func (UntagInput) 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 `min:"12" type:"string"`

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

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) 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 the request type for the Untag API operation.

func (UntagRequest) Send 

func (r UntagRequest) Send(ctx context.Context) (*UntagResponse, error)

Send marshals and sends the Untag API request.

type UntagResponse added in v0.9.0 

type UntagResponse struct {
	*UntagOutput
	// contains filtered or unexported fields
}

UntagResponse is the response type for the Untag API operation.

func (*UntagResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the Untag 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
}

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
}

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

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) 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 the request type for the UpdateGroupQuery API operation.

func (UpdateGroupQueryRequest) Send 

func (r UpdateGroupQueryRequest) Send(ctx context.Context) (*UpdateGroupQueryResponse, error)

Send marshals and sends the UpdateGroupQuery API request.

type UpdateGroupQueryResponse added in v0.9.0 

type UpdateGroupQueryResponse struct {
	*UpdateGroupQueryOutput
	// contains filtered or unexported fields
}

UpdateGroupQueryResponse is the response type for the UpdateGroupQuery API operation.

func (*UpdateGroupQueryResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateGroupQueryResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateGroupQuery request.

type UpdateGroupRequest 

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

UpdateGroupRequest is the request type for the UpdateGroup API operation.

func (UpdateGroupRequest) Send 

func (r UpdateGroupRequest) Send(ctx context.Context) (*UpdateGroupResponse, error)

Send marshals and sends the UpdateGroup API request.

type UpdateGroupResponse added in v0.9.0 

type UpdateGroupResponse struct {
	*UpdateGroupOutput
	// contains filtered or unexported fields
}

UpdateGroupResponse is the response type for the UpdateGroup API operation.

func (*UpdateGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateGroup 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.