Class: Aws::APIGateway::Types::DeleteUsagePlanKeyRequest

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::DeleteUsagePlanKeyRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Note:

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

{
  usage_plan_id: "String", # required
  key_id: "String", # required
}

The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #key_id ⇒ String

  [Required] The Id of the UsagePlanKey resource to be deleted.

• #usage_plan_id ⇒ String

  [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

Instance Attribute Details

#key_id ⇒ String

[Required] The Id of the UsagePlanKey resource to be deleted.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2119

class DeleteUsagePlanKeyRequest < Struct.new(
  :usage_plan_id,
  :key_id)
  SENSITIVE = []
  include Aws::Structure
end

#usage_plan_id ⇒ String

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2119

class DeleteUsagePlanKeyRequest < Struct.new(
  :usage_plan_id,
  :key_id)
  SENSITIVE = []
  include Aws::Structure
end