You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::APIGateway::Types::UpdateUsageRequest

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

Overview

Note:

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

{
  usage_plan_id: "String", # required
  key_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
}

The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.

Instance Attribute Summary collapse

Instance Attribute Details

#key_idString

The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

Returns:

  • (String)


7201
7202
7203
7204
7205
7206
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7201

class UpdateUsageRequest < Struct.new(
  :usage_plan_id,
  :key_id,
  :patch_operations)
  include Aws::Structure
end

#patch_operationsArray<Types::PatchOperation>

A list of update operations to be applied to the specified resource and in the order specified in this list.

Returns:



7201
7202
7203
7204
7205
7206
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7201

class UpdateUsageRequest < Struct.new(
  :usage_plan_id,
  :key_id,
  :patch_operations)
  include Aws::Structure
end

#usage_plan_idString

The Id of the usage plan associated with the usage data.

Returns:

  • (String)


7201
7202
7203
7204
7205
7206
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7201

class UpdateUsageRequest < Struct.new(
  :usage_plan_id,
  :key_id,
  :patch_operations)
  include Aws::Structure
end