Class: Aws::EC2::Types::DeleteTagsRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DeleteTagsRequest

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DeleteTagsRequest data as a hash:

{
  dry_run: false,
  resources: ["TaggableResourceId"], # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #resources ⇒ Array<String>

  The IDs of the resources, separated by spaces.

• #tags ⇒ Array<Types::Tag>

  The tags to delete.

Instance Attribute Details

#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11548

class DeleteTagsRequest < Struct.new(
  :dry_run,
  :resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resources ⇒ Array<String>

The IDs of the resources, separated by spaces.

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11548

class DeleteTagsRequest < Struct.new(
  :dry_run,
  :resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete AWS-generated tags (tags that have the aws: prefix).

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11548

class DeleteTagsRequest < Struct.new(
  :dry_run,
  :resources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end