...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/recyclebin"
Overview
Constants

Overview ▾

Package recyclebin provides the client and types for making API requests to Amazon Recycle Bin.

This is the Recycle Bin API Reference. This documentation provides descriptions and syntax for each of the actions and data types in Recycle Bin.

Recycle Bin is a resource recovery feature that enables you to restore accidentally deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are deleted, they are retained in the Recycle Bin for a time period that you specify.

You can restore a resource from the Recycle Bin at any time before its retention period expires. After you restore a resource from the Recycle Bin, the resource is removed from the Recycle Bin, and you can then use it in the same way you use any other resource of that type in your account. If the retention period expires and the resource is not restored, the resource is permanently deleted from the Recycle Bin and is no longer available for recovery. For more information about Recycle Bin, see Recycle Bin (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-recycle-bin.html) in the Amazon Elastic Compute Cloud User Guide.

See https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15 for more information on this service.

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

Using the Client

To contact Amazon Recycle Bin 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 Amazon Recycle Bin client RecycleBin for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/recyclebin/#New

The stub package, recyclebiniface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type RecycleBin
func New(p client.ConfigProvider, cfgs ...*aws.Config) *RecycleBin
func (c *RecycleBin) CreateRule(input *CreateRuleInput) (*CreateRuleOutput, error)
func (c *RecycleBin) CreateRuleRequest(input *CreateRuleInput) (req *request.Request, output *CreateRuleOutput)
func (c *RecycleBin) CreateRuleWithContext(ctx aws.Context, input *CreateRuleInput, opts ...request.Option) (*CreateRuleOutput, error)
func (c *RecycleBin) DeleteRule(input *DeleteRuleInput) (*DeleteRuleOutput, error)
func (c *RecycleBin) DeleteRuleRequest(input *DeleteRuleInput) (req *request.Request, output *DeleteRuleOutput)
func (c *RecycleBin) DeleteRuleWithContext(ctx aws.Context, input *DeleteRuleInput, opts ...request.Option) (*DeleteRuleOutput, error)
func (c *RecycleBin) GetRule(input *GetRuleInput) (*GetRuleOutput, error)
func (c *RecycleBin) GetRuleRequest(input *GetRuleInput) (req *request.Request, output *GetRuleOutput)
func (c *RecycleBin) GetRuleWithContext(ctx aws.Context, input *GetRuleInput, opts ...request.Option) (*GetRuleOutput, error)
func (c *RecycleBin) ListRules(input *ListRulesInput) (*ListRulesOutput, error)
func (c *RecycleBin) ListRulesPages(input *ListRulesInput, fn func(*ListRulesOutput, bool) bool) error
func (c *RecycleBin) ListRulesPagesWithContext(ctx aws.Context, input *ListRulesInput, fn func(*ListRulesOutput, bool) bool, opts ...request.Option) error
func (c *RecycleBin) ListRulesRequest(input *ListRulesInput) (req *request.Request, output *ListRulesOutput)
func (c *RecycleBin) ListRulesWithContext(ctx aws.Context, input *ListRulesInput, opts ...request.Option) (*ListRulesOutput, error)
func (c *RecycleBin) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
func (c *RecycleBin) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
func (c *RecycleBin) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
func (c *RecycleBin) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
func (c *RecycleBin) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
func (c *RecycleBin) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
func (c *RecycleBin) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
func (c *RecycleBin) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
func (c *RecycleBin) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
func (c *RecycleBin) UpdateRule(input *UpdateRuleInput) (*UpdateRuleOutput, error)
func (c *RecycleBin) UpdateRuleRequest(input *UpdateRuleInput) (req *request.Request, output *UpdateRuleOutput)
func (c *RecycleBin) UpdateRuleWithContext(ctx aws.Context, input *UpdateRuleInput, opts ...request.Option) (*UpdateRuleOutput, error)
func ResourceNotFoundExceptionReason_Values() []string
func ResourceType_Values() []string
func RetentionPeriodUnit_Values() []string
func RuleStatus_Values() []string
func ServiceQuotaExceededExceptionReason_Values() []string
func ValidationExceptionReason_Values() []string
type CreateRuleInput
type CreateRuleOutput
type DeleteRuleInput
type DeleteRuleOutput
type GetRuleInput
type GetRuleOutput
type InternalServerException
type ListRulesInput
type ListRulesOutput
type ListTagsForResourceInput
type ListTagsForResourceOutput
type ResourceNotFoundException
type ResourceTag
type RetentionPeriod
type RuleSummary
type ServiceQuotaExceededException
type Tag
type TagResourceInput
type TagResourceOutput
type UntagResourceInput
type UntagResourceOutput
type UpdateRuleInput
type UpdateRuleOutput
type ValidationException

Constants ▾

const (
    // ResourceTypeEbsSnapshot is a ResourceType enum value
    ResourceTypeEbsSnapshot = "EBS_SNAPSHOT"

    // ResourceTypeEc2Image is a ResourceType enum value
    ResourceTypeEc2Image = "EC2_IMAGE"
)
const (
    // RuleStatusPending is a RuleStatus enum value
    RuleStatusPending = "pending"

    // RuleStatusAvailable is a RuleStatus enum value
    RuleStatusAvailable = "available"
)
const (
    // ValidationExceptionReasonInvalidPageToken is a ValidationExceptionReason enum value
    ValidationExceptionReasonInvalidPageToken = "INVALID_PAGE_TOKEN"

    // ValidationExceptionReasonInvalidParameterValue is a ValidationExceptionReason enum value
    ValidationExceptionReasonInvalidParameterValue = "INVALID_PARAMETER_VALUE"
)
const (

    // ErrCodeInternalServerException for service response error code
    // "InternalServerException".
    //
    // The service could not respond to the request due to an internal problem.
    ErrCodeInternalServerException = "InternalServerException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // The specified resource was not found.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeServiceQuotaExceededException for service response error code
    // "ServiceQuotaExceededException".
    //
    // The request would cause a service quota for the number of tags per resource
    // to be exceeded.
    ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

    // ErrCodeValidationException for service response error code
    // "ValidationException".
    //
    // One or more of the parameters in the request is not valid.
    ErrCodeValidationException = "ValidationException"
)
const (
    ServiceName = "rbin"      // Name of service.
    EndpointsID = ServiceName // ID to lookup a service endpoint with.
    ServiceID   = "rbin"      // ServiceID is a unique identifier of a specific service.
)

Service information constants

const (
    // ResourceNotFoundExceptionReasonRuleNotFound is a ResourceNotFoundExceptionReason enum value
    ResourceNotFoundExceptionReasonRuleNotFound = "RULE_NOT_FOUND"
)
const (
    // RetentionPeriodUnitDays is a RetentionPeriodUnit enum value
    RetentionPeriodUnitDays = "DAYS"
)
const (
    // ServiceQuotaExceededExceptionReasonServiceQuotaExceeded is a ServiceQuotaExceededExceptionReason enum value
    ServiceQuotaExceededExceptionReasonServiceQuotaExceeded = "SERVICE_QUOTA_EXCEEDED"
)

func ResourceNotFoundExceptionReason_Values

func ResourceNotFoundExceptionReason_Values() []string

ResourceNotFoundExceptionReason_Values returns all elements of the ResourceNotFoundExceptionReason enum

func ResourceType_Values

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func RetentionPeriodUnit_Values

func RetentionPeriodUnit_Values() []string

RetentionPeriodUnit_Values returns all elements of the RetentionPeriodUnit enum

func RuleStatus_Values

func RuleStatus_Values() []string

RuleStatus_Values returns all elements of the RuleStatus enum

func ServiceQuotaExceededExceptionReason_Values

func ServiceQuotaExceededExceptionReason_Values() []string

ServiceQuotaExceededExceptionReason_Values returns all elements of the ServiceQuotaExceededExceptionReason enum

func ValidationExceptionReason_Values

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

type CreateRuleInput

type CreateRuleInput struct {

    // The retention rule description.
    Description *string `type:"string"`

    // Specifies the resource tags to use to identify resources that are to be retained
    // by a tag-level retention rule. For tag-level retention rules, only deleted
    // resources, of the specified resource type, that have one or more of the specified
    // tag key and value pairs are retained. If a resource is deleted, but it does
    // not have any of the specified tag key and value pairs, it is immediately
    // deleted without being retained by the retention rule.
    //
    // You can add the same tag key and value pair to a maximum or five retention
    // rules.
    //
    // To create a Region-level retention rule, omit this parameter. A Region-level
    // retention rule does not have any resource tags specified. It retains all
    // deleted resources of the specified resource type in the Region in which the
    // rule is created, even if the resources are not tagged.
    ResourceTags []*ResourceTag `type:"list"`

    // The resource type to be retained by the retention rule. Currently, only Amazon
    // EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify
    // EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.
    //
    // ResourceType is a required field
    ResourceType *string `type:"string" required:"true" enum:"ResourceType"`

    // Information about the retention period for which the retention rule is to
    // retain resources.
    //
    // RetentionPeriod is a required field
    RetentionPeriod *RetentionPeriod `type:"structure" required:"true"`

    // Information about the tags to assign to the retention rule.
    Tags []*Tag `type:"list"`
    // contains filtered or unexported fields
}

func (CreateRuleInput) GoString

func (s CreateRuleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRuleInput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateRuleInput) SetResourceTags

func (s *CreateRuleInput) SetResourceTags(v []*ResourceTag) *CreateRuleInput

SetResourceTags sets the ResourceTags field's value.

func (*CreateRuleInput) SetResourceType

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

SetResourceType sets the ResourceType field's value.

func (*CreateRuleInput) SetRetentionPeriod

func (s *CreateRuleInput) SetRetentionPeriod(v *RetentionPeriod) *CreateRuleInput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*CreateRuleInput) SetTags

func (s *CreateRuleInput) SetTags(v []*Tag) *CreateRuleInput

SetTags sets the Tags field's value.

func (CreateRuleInput) String

func (s CreateRuleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRuleInput) Validate

func (s *CreateRuleInput) Validate() error

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

type CreateRuleOutput

type CreateRuleOutput struct {

    // The retention rule description.
    Description *string `type:"string"`

    // The unique ID of the retention rule.
    Identifier *string `type:"string"`

    // Information about the resource tags used to identify resources that are retained
    // by the retention rule.
    ResourceTags []*ResourceTag `type:"list"`

    // The resource type retained by the retention rule.
    ResourceType *string `type:"string" enum:"ResourceType"`

    // Information about the retention period for which the retention rule is to
    // retain resources.
    RetentionPeriod *RetentionPeriod `type:"structure"`

    // The state of the retention rule. Only retention rules that are in the available
    // state retain resources.
    Status *string `type:"string" enum:"RuleStatus"`

    // Information about the tags assigned to the retention rule.
    Tags []*Tag `type:"list"`
    // contains filtered or unexported fields
}

func (CreateRuleOutput) GoString

func (s CreateRuleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRuleOutput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateRuleOutput) SetIdentifier

func (s *CreateRuleOutput) SetIdentifier(v string) *CreateRuleOutput

SetIdentifier sets the Identifier field's value.

func (*CreateRuleOutput) SetResourceTags

func (s *CreateRuleOutput) SetResourceTags(v []*ResourceTag) *CreateRuleOutput

SetResourceTags sets the ResourceTags field's value.

func (*CreateRuleOutput) SetResourceType

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

SetResourceType sets the ResourceType field's value.

func (*CreateRuleOutput) SetRetentionPeriod

func (s *CreateRuleOutput) SetRetentionPeriod(v *RetentionPeriod) *CreateRuleOutput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*CreateRuleOutput) SetStatus

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

SetStatus sets the Status field's value.

func (*CreateRuleOutput) SetTags

func (s *CreateRuleOutput) SetTags(v []*Tag) *CreateRuleOutput

SetTags sets the Tags field's value.

func (CreateRuleOutput) String

func (s CreateRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteRuleInput

type DeleteRuleInput struct {

    // The unique ID of the retention rule.
    //
    // Identifier is a required field
    Identifier *string `location:"uri" locationName:"identifier" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteRuleInput) GoString

func (s DeleteRuleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRuleInput) SetIdentifier

func (s *DeleteRuleInput) SetIdentifier(v string) *DeleteRuleInput

SetIdentifier sets the Identifier field's value.

func (DeleteRuleInput) String

func (s DeleteRuleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRuleInput) Validate

func (s *DeleteRuleInput) Validate() error

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

type DeleteRuleOutput

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

func (DeleteRuleOutput) GoString

func (s DeleteRuleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteRuleOutput) String

func (s DeleteRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRuleInput

type GetRuleInput struct {

    // The unique ID of the retention rule.
    //
    // Identifier is a required field
    Identifier *string `location:"uri" locationName:"identifier" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetRuleInput) GoString

func (s GetRuleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRuleInput) SetIdentifier

func (s *GetRuleInput) SetIdentifier(v string) *GetRuleInput

SetIdentifier sets the Identifier field's value.

func (GetRuleInput) String

func (s GetRuleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRuleInput) Validate

func (s *GetRuleInput) Validate() error

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

type GetRuleOutput

type GetRuleOutput struct {

    // The retention rule description.
    Description *string `type:"string"`

    // The unique ID of the retention rule.
    Identifier *string `type:"string"`

    // Information about the resource tags used to identify resources that are retained
    // by the retention rule.
    ResourceTags []*ResourceTag `type:"list"`

    // The resource type retained by the retention rule.
    ResourceType *string `type:"string" enum:"ResourceType"`

    // Information about the retention period for which the retention rule is to
    // retain resources.
    RetentionPeriod *RetentionPeriod `type:"structure"`

    // The state of the retention rule. Only retention rules that are in the available
    // state retain resources.
    Status *string `type:"string" enum:"RuleStatus"`
    // contains filtered or unexported fields
}

func (GetRuleOutput) GoString

func (s GetRuleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRuleOutput) SetDescription

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

SetDescription sets the Description field's value.

func (*GetRuleOutput) SetIdentifier

func (s *GetRuleOutput) SetIdentifier(v string) *GetRuleOutput

SetIdentifier sets the Identifier field's value.

func (*GetRuleOutput) SetResourceTags

func (s *GetRuleOutput) SetResourceTags(v []*ResourceTag) *GetRuleOutput

SetResourceTags sets the ResourceTags field's value.

func (*GetRuleOutput) SetResourceType

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

SetResourceType sets the ResourceType field's value.

func (*GetRuleOutput) SetRetentionPeriod

func (s *GetRuleOutput) SetRetentionPeriod(v *RetentionPeriod) *GetRuleOutput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*GetRuleOutput) SetStatus

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

SetStatus sets the Status field's value.

func (GetRuleOutput) String

func (s GetRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

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

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

The service could not respond to the request due to an internal problem.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRulesInput

type ListRulesInput struct {

    // The maximum number of results to return with a single call. To retrieve the
    // remaining results, make another call with the returned NextToken value.
    MaxResults *int64 `min:"1" type:"integer"`

    // The token for the next page of results.
    NextToken *string `type:"string"`

    // Information about the resource tags used to identify resources that are retained
    // by the retention rule.
    ResourceTags []*ResourceTag `type:"list"`

    // The resource type retained by the retention rule. Only retention rules that
    // retain the specified resource type are listed. Currently, only Amazon EBS
    // snapshots and EBS-backed AMIs are supported. To list retention rules that
    // retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain
    // EBS-backed AMIs, specify EC2_IMAGE.
    //
    // ResourceType is a required field
    ResourceType *string `type:"string" required:"true" enum:"ResourceType"`
    // contains filtered or unexported fields
}

func (ListRulesInput) GoString

func (s ListRulesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRulesInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*ListRulesInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListRulesInput) SetResourceTags

func (s *ListRulesInput) SetResourceTags(v []*ResourceTag) *ListRulesInput

SetResourceTags sets the ResourceTags field's value.

func (*ListRulesInput) SetResourceType

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

SetResourceType sets the ResourceType field's value.

func (ListRulesInput) String

func (s ListRulesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRulesInput) Validate

func (s *ListRulesInput) Validate() error

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

type ListRulesOutput

type ListRulesOutput struct {

    // The token to use to retrieve the next page of results. This value is null
    // when there are no more results to return.
    NextToken *string `type:"string"`

    // Information about the retention rules.
    Rules []*RuleSummary `type:"list"`
    // contains filtered or unexported fields
}

func (ListRulesOutput) GoString

func (s ListRulesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRulesOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListRulesOutput) SetRules

func (s *ListRulesOutput) SetRules(v []*RuleSummary) *ListRulesOutput

SetRules sets the Rules field's value.

func (ListRulesOutput) String

func (s ListRulesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

    // The Amazon Resource Name (ARN) of the retention rule.
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

    // Information about the tags assigned to the retention rule.
    Tags []*Tag `type:"list"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecycleBin

type RecycleBin struct {
    *client.Client
}

RecycleBin provides the API operation methods for making requests to Amazon Recycle Bin. See this package's package overview docs for details on the service.

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

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *RecycleBin

New creates a new instance of the RecycleBin client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a RecycleBin client from just a session.
svc := recyclebin.New(mySession)

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

func (*RecycleBin) CreateRule

func (c *RecycleBin) CreateRule(input *CreateRuleInput) (*CreateRuleOutput, error)

CreateRule API operation for Amazon Recycle Bin.

Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin retention rules (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-create-rule) in the Amazon Elastic Compute Cloud User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Recycle Bin's API operation CreateRule for usage and error information.

Returned Error Types:

* ValidationException
One or more of the parameters in the request is not valid.

* ServiceQuotaExceededException
The request would cause a service quota for the number of tags per resource
to be exceeded.

* InternalServerException
The service could not respond to the request due to an internal problem.

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/CreateRule

func (*RecycleBin) CreateRuleRequest

func (c *RecycleBin) CreateRuleRequest(input *CreateRuleInput) (req *request.Request, output *CreateRuleOutput)

CreateRuleRequest generates a "aws/request.Request" representing the client's request for the CreateRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRule for more information on using the CreateRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRuleRequest method.
req, resp := client.CreateRuleRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/CreateRule

func (*RecycleBin) CreateRuleWithContext

func (c *RecycleBin) CreateRuleWithContext(ctx aws.Context, input *CreateRuleInput, opts ...request.Option) (*CreateRuleOutput, error)

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

See CreateRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RecycleBin) DeleteRule

func (c *RecycleBin) DeleteRule(input *DeleteRuleInput) (*DeleteRuleOutput, error)

DeleteRule API operation for Amazon Recycle Bin.

Deletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-delete-rule) in the Amazon Elastic Compute Cloud User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Recycle Bin's API operation DeleteRule for usage and error information.

Returned Error Types:

* InternalServerException
The service could not respond to the request due to an internal problem.

* ResourceNotFoundException
The specified resource was not found.

* ValidationException
One or more of the parameters in the request is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/DeleteRule

func (*RecycleBin) DeleteRuleRequest

func (c *RecycleBin) DeleteRuleRequest(input *DeleteRuleInput) (req *request.Request, output *DeleteRuleOutput)

DeleteRuleRequest generates a "aws/request.Request" representing the client's request for the DeleteRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRule for more information on using the DeleteRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRuleRequest method.
req, resp := client.DeleteRuleRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/DeleteRule

func (*RecycleBin) DeleteRuleWithContext

func (c *RecycleBin) DeleteRuleWithContext(ctx aws.Context, input *DeleteRuleInput, opts ...request.Option) (*DeleteRuleOutput, error)

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

See DeleteRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RecycleBin) GetRule

func (c *RecycleBin) GetRule(input *GetRuleInput) (*GetRuleOutput, error)

GetRule API operation for Amazon Recycle Bin.

Gets information about a Recycle Bin retention rule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Recycle Bin's API operation GetRule for usage and error information.

Returned Error Types:

* ValidationException
One or more of the parameters in the request is not valid.

* InternalServerException
The service could not respond to the request due to an internal problem.

* ResourceNotFoundException
The specified resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/GetRule

func (*RecycleBin) GetRuleRequest

func (c *RecycleBin) GetRuleRequest(input *GetRuleInput) (req *request.Request, output *GetRuleOutput)

GetRuleRequest generates a "aws/request.Request" representing the client's request for the GetRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRule for more information on using the GetRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRuleRequest method.
req, resp := client.GetRuleRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/GetRule

func (*RecycleBin) GetRuleWithContext

func (c *RecycleBin) GetRuleWithContext(ctx aws.Context, input *GetRuleInput, opts ...request.Option) (*GetRuleOutput, error)

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

See GetRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RecycleBin) ListRules

func (c *RecycleBin) ListRules(input *ListRulesInput) (*ListRulesOutput, error)

ListRules API operation for Amazon Recycle Bin.

Lists the Recycle Bin retention rules in the Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Recycle Bin's API operation ListRules for usage and error information.

Returned Error Types:

* ValidationException
One or more of the parameters in the request is not valid.

* InternalServerException
The service could not respond to the request due to an internal problem.

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListRules

func (*RecycleBin) ListRulesPages

func (c *RecycleBin) ListRulesPages(input *ListRulesInput, fn func(*ListRulesOutput, bool) bool) error

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

See ListRules method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListRules operation.
pageNum := 0
err := client.ListRulesPages(params,
    func(page *recyclebin.ListRulesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RecycleBin) ListRulesPagesWithContext

func (c *RecycleBin) ListRulesPagesWithContext(ctx aws.Context, input *ListRulesInput, fn func(*ListRulesOutput, bool) bool, opts ...request.Option) error

ListRulesPagesWithContext same as ListRulesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RecycleBin) ListRulesRequest

func (c *RecycleBin) ListRulesRequest(input *ListRulesInput) (req *request.Request, output *ListRulesOutput)

ListRulesRequest generates a "aws/request.Request" representing the client's request for the ListRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRules for more information on using the ListRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRulesRequest method.
req, resp := client.ListRulesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListRules

func (*RecycleBin) ListRulesWithContext

func (c *RecycleBin) ListRulesWithContext(ctx aws.Context, input *ListRulesInput, opts ...request.Option) (*ListRulesOutput, error)

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

See ListRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RecycleBin) ListTagsForResource

func (c *RecycleBin) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Recycle Bin.

Lists the tags assigned to a retention rule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Recycle Bin's API operation ListTagsForResource for usage and error information.

Returned Error Types:

* ValidationException
One or more of the parameters in the request is not valid.

* InternalServerException
The service could not respond to the request due to an internal problem.

* ResourceNotFoundException
The specified resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListTagsForResource

func (*RecycleBin) ListTagsForResourceRequest

func (c *RecycleBin) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListTagsForResource

func (*RecycleBin) ListTagsForResourceWithContext

func (c *RecycleBin) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RecycleBin) TagResource

func (c *RecycleBin) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Recycle Bin.

Assigns tags to the specified retention rule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Recycle Bin's API operation TagResource for usage and error information.

Returned Error Types:

* ValidationException
One or more of the parameters in the request is not valid.

* InternalServerException
The service could not respond to the request due to an internal problem.

* ResourceNotFoundException
The specified resource was not found.

* ServiceQuotaExceededException
The request would cause a service quota for the number of tags per resource
to be exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/TagResource

func (*RecycleBin) TagResourceRequest

func (c *RecycleBin) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/TagResource

func (*RecycleBin) TagResourceWithContext

func (c *RecycleBin) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RecycleBin) UntagResource

func (c *RecycleBin) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Recycle Bin.

Unassigns a tag from a retention rule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Recycle Bin's API operation UntagResource for usage and error information.

Returned Error Types:

* ValidationException
One or more of the parameters in the request is not valid.

* InternalServerException
The service could not respond to the request due to an internal problem.

* ResourceNotFoundException
The specified resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UntagResource

func (*RecycleBin) UntagResourceRequest

func (c *RecycleBin) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UntagResource

func (*RecycleBin) UntagResourceWithContext

func (c *RecycleBin) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RecycleBin) UpdateRule

func (c *RecycleBin) UpdateRule(input *UpdateRuleInput) (*UpdateRuleOutput, error)

UpdateRule API operation for Amazon Recycle Bin.

Updates an existing Recycle Bin retention rule. For more information, see Update Recycle Bin retention rules (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-update-rule) in the Amazon Elastic Compute Cloud User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Recycle Bin's API operation UpdateRule for usage and error information.

Returned Error Types:

* ValidationException
One or more of the parameters in the request is not valid.

* InternalServerException
The service could not respond to the request due to an internal problem.

* ResourceNotFoundException
The specified resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UpdateRule

func (*RecycleBin) UpdateRuleRequest

func (c *RecycleBin) UpdateRuleRequest(input *UpdateRuleInput) (req *request.Request, output *UpdateRuleOutput)

UpdateRuleRequest generates a "aws/request.Request" representing the client's request for the UpdateRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRule for more information on using the UpdateRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateRuleRequest method.
req, resp := client.UpdateRuleRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UpdateRule

func (*RecycleBin) UpdateRuleWithContext

func (c *RecycleBin) UpdateRuleWithContext(ctx aws.Context, input *UpdateRuleInput, opts ...request.Option) (*UpdateRuleOutput, error)

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

See UpdateRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ResourceNotFoundException

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

    Message_ *string `locationName:"Message" type:"string"`

    // The reason for the exception.
    Reason *string `type:"string" enum:"ResourceNotFoundExceptionReason"`
    // contains filtered or unexported fields
}

The specified resource was not found.

func (*ResourceNotFoundException) Code

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceTag

type ResourceTag struct {

    // The tag key.
    //
    // ResourceTagKey is a required field
    ResourceTagKey *string `type:"string" required:"true"`

    // The tag value.
    ResourceTagValue *string `type:"string"`
    // contains filtered or unexported fields
}

Information about the resource tags used to identify resources that are retained by the retention rule.

func (ResourceTag) GoString

func (s ResourceTag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceTag) SetResourceTagKey

func (s *ResourceTag) SetResourceTagKey(v string) *ResourceTag

SetResourceTagKey sets the ResourceTagKey field's value.

func (*ResourceTag) SetResourceTagValue

func (s *ResourceTag) SetResourceTagValue(v string) *ResourceTag

SetResourceTagValue sets the ResourceTagValue field's value.

func (ResourceTag) String

func (s ResourceTag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceTag) Validate

func (s *ResourceTag) Validate() error

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

type RetentionPeriod

type RetentionPeriod struct {

    // The unit of time in which the retention period is measured. Currently, only
    // DAYS is supported.
    //
    // RetentionPeriodUnit is a required field
    RetentionPeriodUnit *string `type:"string" required:"true" enum:"RetentionPeriodUnit"`

    // The period value for which the retention rule is to retain resources. The
    // period is measured using the unit specified for RetentionPeriodUnit.
    //
    // RetentionPeriodValue is a required field
    RetentionPeriodValue *int64 `min:"1" type:"integer" required:"true"`
    // contains filtered or unexported fields
}

Information about the retention period for which the retention rule is to retain resources.

func (RetentionPeriod) GoString

func (s RetentionPeriod) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetentionPeriod) SetRetentionPeriodUnit

func (s *RetentionPeriod) SetRetentionPeriodUnit(v string) *RetentionPeriod

SetRetentionPeriodUnit sets the RetentionPeriodUnit field's value.

func (*RetentionPeriod) SetRetentionPeriodValue

func (s *RetentionPeriod) SetRetentionPeriodValue(v int64) *RetentionPeriod

SetRetentionPeriodValue sets the RetentionPeriodValue field's value.

func (RetentionPeriod) String

func (s RetentionPeriod) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetentionPeriod) Validate

func (s *RetentionPeriod) Validate() error

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

type RuleSummary

type RuleSummary struct {

    // The retention rule description.
    Description *string `type:"string"`

    // The unique ID of the retention rule.
    Identifier *string `type:"string"`

    // Information about the retention period for which the retention rule is to
    // retain resources.
    RetentionPeriod *RetentionPeriod `type:"structure"`
    // contains filtered or unexported fields
}

Information about a Recycle Bin retention rule.

func (RuleSummary) GoString

func (s RuleSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleSummary) SetDescription

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

SetDescription sets the Description field's value.

func (*RuleSummary) SetIdentifier

func (s *RuleSummary) SetIdentifier(v string) *RuleSummary

SetIdentifier sets the Identifier field's value.

func (*RuleSummary) SetRetentionPeriod

func (s *RuleSummary) SetRetentionPeriod(v *RetentionPeriod) *RuleSummary

SetRetentionPeriod sets the RetentionPeriod field's value.

func (RuleSummary) String

func (s RuleSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException

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

    Message_ *string `locationName:"Message" type:"string"`

    // The reason for the exception.
    Reason *string `type:"string" enum:"ServiceQuotaExceededExceptionReason"`
    // contains filtered or unexported fields
}

The request would cause a service quota for the number of tags per resource to be exceeded.

func (*ServiceQuotaExceededException) Code

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag

type Tag struct {

    // The tag key.
    //
    // Key is a required field
    Key *string `min:"1" type:"string" required:"true"`

    // The tag value.
    //
    // Value is a required field
    Value *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Information about the tags to assign to the retention rule.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate

func (s *Tag) Validate() error

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

type TagResourceInput

type TagResourceInput struct {

    // The Amazon Resource Name (ARN) of the retention rule.
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

    // Information about the tags to assign to the retention rule.
    //
    // Tags is a required field
    Tags []*Tag `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

    // The Amazon Resource Name (ARN) of the retention rule.
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

    // The tag keys of the tags to unassign. All tags that have the specified tag
    // key are unassigned.
    //
    // TagKeys is a required field
    TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateRuleInput

type UpdateRuleInput struct {

    // The retention rule description.
    Description *string `type:"string"`

    // The unique ID of the retention rule.
    //
    // Identifier is a required field
    Identifier *string `location:"uri" locationName:"identifier" type:"string" required:"true"`

    // Specifies the resource tags to use to identify resources that are to be retained
    // by a tag-level retention rule. For tag-level retention rules, only deleted
    // resources, of the specified resource type, that have one or more of the specified
    // tag key and value pairs are retained. If a resource is deleted, but it does
    // not have any of the specified tag key and value pairs, it is immediately
    // deleted without being retained by the retention rule.
    //
    // You can add the same tag key and value pair to a maximum or five retention
    // rules.
    //
    // To create a Region-level retention rule, omit this parameter. A Region-level
    // retention rule does not have any resource tags specified. It retains all
    // deleted resources of the specified resource type in the Region in which the
    // rule is created, even if the resources are not tagged.
    ResourceTags []*ResourceTag `type:"list"`

    // The resource type to be retained by the retention rule. Currently, only Amazon
    // EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify
    // EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.
    ResourceType *string `type:"string" enum:"ResourceType"`

    // Information about the retention period for which the retention rule is to
    // retain resources.
    RetentionPeriod *RetentionPeriod `type:"structure"`
    // contains filtered or unexported fields
}

func (UpdateRuleInput) GoString

func (s UpdateRuleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRuleInput) SetDescription

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

SetDescription sets the Description field's value.

func (*UpdateRuleInput) SetIdentifier

func (s *UpdateRuleInput) SetIdentifier(v string) *UpdateRuleInput

SetIdentifier sets the Identifier field's value.

func (*UpdateRuleInput) SetResourceTags

func (s *UpdateRuleInput) SetResourceTags(v []*ResourceTag) *UpdateRuleInput

SetResourceTags sets the ResourceTags field's value.

func (*UpdateRuleInput) SetResourceType

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

SetResourceType sets the ResourceType field's value.

func (*UpdateRuleInput) SetRetentionPeriod

func (s *UpdateRuleInput) SetRetentionPeriod(v *RetentionPeriod) *UpdateRuleInput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (UpdateRuleInput) String

func (s UpdateRuleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRuleInput) Validate

func (s *UpdateRuleInput) Validate() error

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

type UpdateRuleOutput

type UpdateRuleOutput struct {

    // The retention rule description.
    Description *string `type:"string"`

    // The unique ID of the retention rule.
    Identifier *string `type:"string"`

    // Information about the resource tags used to identify resources that are retained
    // by the retention rule.
    ResourceTags []*ResourceTag `type:"list"`

    // The resource type retained by the retention rule.
    ResourceType *string `type:"string" enum:"ResourceType"`

    // Information about the retention period for which the retention rule is to
    // retain resources.
    RetentionPeriod *RetentionPeriod `type:"structure"`

    // The state of the retention rule. Only retention rules that are in the available
    // state retain resources.
    Status *string `type:"string" enum:"RuleStatus"`
    // contains filtered or unexported fields
}

func (UpdateRuleOutput) GoString

func (s UpdateRuleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRuleOutput) SetDescription

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

SetDescription sets the Description field's value.

func (*UpdateRuleOutput) SetIdentifier

func (s *UpdateRuleOutput) SetIdentifier(v string) *UpdateRuleOutput

SetIdentifier sets the Identifier field's value.

func (*UpdateRuleOutput) SetResourceTags

func (s *UpdateRuleOutput) SetResourceTags(v []*ResourceTag) *UpdateRuleOutput

SetResourceTags sets the ResourceTags field's value.

func (*UpdateRuleOutput) SetResourceType

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

SetResourceType sets the ResourceType field's value.

func (*UpdateRuleOutput) SetRetentionPeriod

func (s *UpdateRuleOutput) SetRetentionPeriod(v *RetentionPeriod) *UpdateRuleOutput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*UpdateRuleOutput) SetStatus

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

SetStatus sets the Status field's value.

func (UpdateRuleOutput) String

func (s UpdateRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

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

    Message_ *string `locationName:"Message" type:"string"`

    // The reason for the exception.
    Reason *string `type:"string" enum:"ValidationExceptionReason"`
    // contains filtered or unexported fields
}

One or more of the parameters in the request is not valid.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".