AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

UsagePlan

import "github.com/aws/aws-sdk-go/service/apigateway"

type UsagePlan struct { ApiStages []*ApiStage `locationName:"apiStages" type:"list"` Description *string `locationName:"description" type:"string"` Id *string `locationName:"id" type:"string"` Name *string `locationName:"name" type:"string"` ProductCode *string `locationName:"productCode" type:"string"` Quota *QuotaSettings `locationName:"quota" type:"structure"` Throttle *ThrottleSettings `locationName:"throttle" type:"structure"` }

Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

Create and Use Usage Plans (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)

ApiStages

API stage name of the associated API stage in a usage plan.

Description

Type: *string

The description of a usage plan.

Id

Type: *string

The identifier of a UsagePlan resource.

Name

Type: *string

The name of a usage plan.

ProductCode

Type: *string

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Quota

Quotas configured for a usage plan.

Throttle

The API request rate limits.

Method

GoString

func (s UsagePlan) GoString() string

GoString returns the string representation

SetApiStages

func (s *UsagePlan) SetApiStages(v []*ApiStage) *UsagePlan

SetApiStages sets the ApiStages field's value.

SetDescription

func (s *UsagePlan) SetDescription(v string) *UsagePlan

SetDescription sets the Description field's value.

SetId

func (s *UsagePlan) SetId(v string) *UsagePlan

SetId sets the Id field's value.

SetName

func (s *UsagePlan) SetName(v string) *UsagePlan

SetName sets the Name field's value.

SetProductCode

func (s *UsagePlan) SetProductCode(v string) *UsagePlan

SetProductCode sets the ProductCode field's value.

SetQuota

func (s *UsagePlan) SetQuota(v *QuotaSettings) *UsagePlan

SetQuota sets the Quota field's value.

SetThrottle

func (s *UsagePlan) SetThrottle(v *ThrottleSettings) *UsagePlan

SetThrottle sets the Throttle field's value.

String

func (s UsagePlan) String() string

String returns the string representation

On this page: