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) 


2209
2210
2211
2212
2213
2214
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2209

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

#key_name ⇒ String

The name of the API key to delete.

Returns:

  • (String) 


2209
2210
2211
2212
2213
2214
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2209

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