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.

ApiKey

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

type ApiKey struct { CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` CustomerId *string `locationName:"customerId" type:"string"` Description *string `locationName:"description" type:"string"` Enabled *bool `locationName:"enabled" type:"boolean"` Id *string `locationName:"id" type:"string"` LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp"` Name *string `locationName:"name" type:"string"` StageKeys []*string `locationName:"stageKeys" type:"list"` Value *string `locationName:"value" type:"string"` }

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

Use API Keys (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html)

CreatedDate

Type: *time.Time

The timestamp when the API Key was created.

CustomerId

Type: *string

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Description

Type: *string

The description of the API Key.

Enabled

Type: *bool

Specifies whether the API Key can be used by callers.

Id

Type: *string

The identifier of the API Key.

LastUpdatedDate

Type: *time.Time

The timestamp when the API Key was last updated.

Name

Type: *string

The name of the API Key.

StageKeys

Type: []*string

A list of Stage resources that are associated with the ApiKey resource.

Value

Type: *string

The value of the API Key.

Method

GoString

func (s ApiKey) GoString() string

GoString returns the string representation

SetCreatedDate

func (s *ApiKey) SetCreatedDate(v time.Time) *ApiKey

SetCreatedDate sets the CreatedDate field's value.

SetCustomerId

func (s *ApiKey) SetCustomerId(v string) *ApiKey

SetCustomerId sets the CustomerId field's value.

SetDescription

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

SetDescription sets the Description field's value.

SetEnabled

func (s *ApiKey) SetEnabled(v bool) *ApiKey

SetEnabled sets the Enabled field's value.

SetId

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

SetId sets the Id field's value.

SetLastUpdatedDate

func (s *ApiKey) SetLastUpdatedDate(v time.Time) *ApiKey

SetLastUpdatedDate sets the LastUpdatedDate field's value.

SetName

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

SetName sets the Name field's value.

SetStageKeys

func (s *ApiKey) SetStageKeys(v []*string) *ApiKey

SetStageKeys sets the StageKeys field's value.

SetValue

func (s *ApiKey) SetValue(v string) *ApiKey

SetValue sets the Value field's value.

String

func (s ApiKey) String() string

String returns the string representation

On this page: