Class: Aws::SSM::Types::RemoveTagsFromResourceRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

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

{
  resource_type: "Document", # required, accepts Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline, OpsItem, OpsMetadata
  resource_id: "ResourceId", # required
  tag_keys: ["TagKey"], # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#resource_idString

The ID of the resource from which you want to remove tags. For example:

ManagedInstance: mi-012345abcde

MaintenanceWindow: mw-012345abcde

PatchBaseline: pb-012345abcde

OpsMetadata object: `ResourceID` for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, `ResourceID` is created from the strings that come after the word `opsmetadata` in the ARN. For example, an OpsMetadata object with an ARN of `arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager` has a `ResourceID` of either `aws/ssm/MyGroup/appmanager` or `/aws/ssm/MyGroup/appmanager`.

For the Document and Parameter values, use the name of the resource.

<note markdown=“1”> The `ManagedInstance` type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

</note>

Returns:

  • (String)

17128
17129
17130
17131
17132
17133
17134
# File 'lib/aws-sdk-ssm/types.rb', line 17128

class RemoveTagsFromResourceRequest < Struct.new(
  :resource_type,
  :resource_id,
  :tag_keys)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

The type of resource from which you want to remove a tag.

<note markdown=“1”> The `ManagedInstance` type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: `mi-ID_number `. For example, `mi-1a2b3c4d5e6f`.

</note>

Returns:

  • (String)

17128
17129
17130
17131
17132
17133
17134
# File 'lib/aws-sdk-ssm/types.rb', line 17128

class RemoveTagsFromResourceRequest < Struct.new(
  :resource_type,
  :resource_id,
  :tag_keys)
  SENSITIVE = []
  include Aws::Structure
end

#tag_keysArray<String>

Tag keys that you want to remove from the specified resource.

Returns:

  • (Array<String>)

17128
17129
17130
17131
17132
17133
17134
# File 'lib/aws-sdk-ssm/types.rb', line 17128

class RemoveTagsFromResourceRequest < Struct.new(
  :resource_type,
  :resource_id,
  :tag_keys)
  SENSITIVE = []
  include Aws::Structure
end