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.

GetUsageInput

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

type GetUsageInput struct { EndDate *string `location:"querystring" locationName:"endDate" type:"string" required:"true"` KeyId *string `location:"querystring" locationName:"keyId" type:"string"` Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` Position *string `location:"querystring" locationName:"position" type:"string"` StartDate *string `location:"querystring" locationName:"startDate" type:"string" required:"true"` UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` }

The GET request to get the usage data of a usage plan in a specified time interval.

EndDate

Type: *string

[Required] The ending date (e.g., 2016-12-31) of the usage data.

EndDate is a required field

KeyId

Type: *string

The Id of the API key associated with the resultant usage data.

Limit

Type: *int64

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

Position

Type: *string

The current pagination position in the paged result set.

StartDate

Type: *string

[Required] The starting date (e.g., 2016-01-01) of the usage data.

StartDate is a required field

UsagePlanId

Type: *string

[Required] The Id of the usage plan associated with the usage data.

UsagePlanId is a required field

Method

GoString

func (s GetUsageInput) GoString() string

GoString returns the string representation

SetEndDate

func (s *GetUsageInput) SetEndDate(v string) *GetUsageInput

SetEndDate sets the EndDate field's value.

SetKeyId

func (s *GetUsageInput) SetKeyId(v string) *GetUsageInput

SetKeyId sets the KeyId field's value.

SetLimit

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

SetLimit sets the Limit field's value.

SetPosition

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

SetPosition sets the Position field's value.

SetStartDate

func (s *GetUsageInput) SetStartDate(v string) *GetUsageInput

SetStartDate sets the StartDate field's value.

SetUsagePlanId

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

SetUsagePlanId sets the UsagePlanId field's value.

String

func (s GetUsageInput) String() string

String returns the string representation

Validate

func (s *GetUsageInput) Validate() error

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

On this page: