Class: Aws::LocationService::Types::DeleteKeyRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#force_delete ⇒ Boolean

ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

Returns:

  • (Boolean) 


2150
2151
2152
2153
2154
2155
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2150

class DeleteKeyRequest < Struct.new(
  :force_delete,
  :key_name)
  SENSITIVE = []
  include Aws::Structure
end

#key_name ⇒ String

The name of the API key to delete.

Returns:

  • (String) 


2150
2151
2152
2153
2154
2155
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2150

class DeleteKeyRequest < Struct.new(
  :force_delete,
  :key_name)
  SENSITIVE = []
  include Aws::Structure
end