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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateUsageRequest as input to an Aws::Client method, you can use a vanilla 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)

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

#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:

  • (Array<Types::PatchOperation>)

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

#usage_plan_idString

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

Returns:

  • (String)

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