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.

Usage

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

type Usage struct { EndDate *string `locationName:"endDate" type:"string"` Items map[string][][]*int64 `locationName:"values" type:"map"` Position *string `locationName:"position" type:"string"` StartDate *string `locationName:"startDate" type:"string"` UsagePlanId *string `locationName:"usagePlanId" type:"string"` }

Represents the usage data of a usage plan.

Create and Use Usage Plans (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html), Manage Usage in a Usage Plan (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-usage-plans-with-console.html#api-gateway-usage-plan-manage-usage)

EndDate

Type: *string

The ending date of the usage data.

Items

Type: map[string][][]*int64

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

Position

Type: *string

StartDate

Type: *string

The starting date of the usage data.

UsagePlanId

Type: *string

The plan Id associated with this usage data.

Method

GoString

func (s Usage) GoString() string

GoString returns the string representation

SetEndDate

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

SetEndDate sets the EndDate field's value.

SetItems

func (s *Usage) SetItems(v map[string][][]*int64) *Usage

SetItems sets the Items field's value.

SetPosition

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

SetPosition sets the Position field's value.

SetStartDate

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

SetStartDate sets the StartDate field's value.

SetUsagePlanId

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

SetUsagePlanId sets the UsagePlanId field's value.

String

func (s Usage) String() string

String returns the string representation

On this page: