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.

GetUsagePlanKeysInput

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

type GetUsagePlanKeysInput struct { Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` NameQuery *string `location:"querystring" locationName:"name" type:"string"` Position *string `location:"querystring" locationName:"position" type:"string"` UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` }

The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

Limit

Type: *int64

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

NameQuery

Type: *string

A query parameter specifying the name of the to-be-returned usage plan keys.

Position

Type: *string

The current pagination position in the paged result set.

UsagePlanId

Type: *string

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

UsagePlanId is a required field

Method

GoString

func (s GetUsagePlanKeysInput) GoString() string

GoString returns the string representation

SetLimit

func (s *GetUsagePlanKeysInput) SetLimit(v int64) *GetUsagePlanKeysInput

SetLimit sets the Limit field's value.

SetNameQuery

func (s *GetUsagePlanKeysInput) SetNameQuery(v string) *GetUsagePlanKeysInput

SetNameQuery sets the NameQuery field's value.

SetPosition

func (s *GetUsagePlanKeysInput) SetPosition(v string) *GetUsagePlanKeysInput

SetPosition sets the Position field's value.

SetUsagePlanId

func (s *GetUsagePlanKeysInput) SetUsagePlanId(v string) *GetUsagePlanKeysInput

SetUsagePlanId sets the UsagePlanId field's value.

String

func (s GetUsagePlanKeysInput) String() string

String returns the string representation

Validate

func (s *GetUsagePlanKeysInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: