Package software.amazon.awssdk.services.ssm.model

Class RemoveTagsFromResourceRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ssm.model.SsmRequest
software.amazon.awssdk.services.ssm.model.RemoveTagsFromResourceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RemoveTagsFromResourceRequest.Builder,RemoveTagsFromResourceRequest>
@Generated("software.amazon.awssdk:codegen") public final class RemoveTagsFromResourceRequest extends SsmRequest implements ToCopyableBuilder<RemoveTagsFromResourceRequest.Builder,RemoveTagsFromResourceRequest>

  • Method Details

    • resourceType

      public final ResourceTypeForTagging resourceType()

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

      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.

      If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceTypeForTagging.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

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

      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.

      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

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

      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.

      If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceTypeForTagging.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

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

      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.

      See Also:

    • resourceId

      public final String resourceId()

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

      ManagedInstance: mi-012345abcde

      MaintenanceWindow: mw-012345abcde

      Automation: example-c160-4567-8519-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.

      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.

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

      ManagedInstance: mi-012345abcde

      MaintenanceWindow: mw-012345abcde

      Automation: example-c160-4567-8519-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.

      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.

    • hasTagKeys

      public final boolean hasTagKeys()
      For responses, this returns true if the service returned a value for the TagKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tagKeys

      public final List<String> tagKeys()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagKeys() method.

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

    • toBuilder

      public RemoveTagsFromResourceRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<RemoveTagsFromResourceRequest.Builder,RemoveTagsFromResourceRequest>
      Specified by:
      toBuilder in class SsmRequest

    • builder

      public static RemoveTagsFromResourceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RemoveTagsFromResourceRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo