AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.APIGateway.Model.GetUsagePlanResponse

Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z

Syntax

C#
public class GetUsagePlanResponse : AmazonWebServiceResponse

The GetUsagePlanResponse type exposes the following members

Constructors

NameDescription
Public Method GetUsagePlanResponse()

Properties

NameTypeDescription
Public Property ApiStages System.Collections.Generic.List<Amazon.APIGateway.Model.ApiStage>

Gets and sets the property ApiStages.

The associated API stages of a usage plan.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Description System.String

Gets and sets the property Description.

The description of a usage plan.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Id System.String

Gets and sets the property Id.

The identifier of a UsagePlan resource.

Public Property Name System.String

Gets and sets the property Name.

The name of a usage plan.

Public Property ProductCode System.String

Gets and sets the property ProductCode.

The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.

Public Property Quota Amazon.APIGateway.Model.QuotaSettings

Gets and sets the property Quota.

The target maximum number of permitted requests per a given unit time interval.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

The collection of tags. Each tag element is associated with a given resource.

Public Property Throttle Amazon.APIGateway.Model.ThrottleSettings

Gets and sets the property Throttle.

A map containing method level throttling information for API stage in a usage plan.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5