apigateway

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 21, 2017 License: Apache-2.0, Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package apigateway provides the client and types for making API requests to Amazon API Gateway.

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

See apigateway package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/apigateway/

Using the Client

To Amazon API Gateway with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon API Gateway client APIGateway for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/apigateway/#New

Index

Constants

View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// The submitted request is not valid, for example, the input is incomplete
	// or incorrect. See the accompanying error message for details.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The request configuration has conflicts. For details, see the accompanying
	// error message.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The request exceeded the rate limit. Retry after the specified time period.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// The requested resource is not found. Make sure that the request URI is correct.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The requested service is not available. For details see the accompanying
	// error message. Retry after the specified time period.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// The request has reached its throttling limit. Retry after the specified time
	// period.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// The request is denied because the caller has insufficient permissions.
	ErrCodeUnauthorizedException = "UnauthorizedException"
)
View Source 
const (
	ServiceName = "apigateway" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName  // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type APIGateway 

type APIGateway struct {
	*aws.Client
}

APIGateway provides the API operation methods for making requests to Amazon API Gateway. See this package's package overview docs for details on the service.

APIGateway methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *APIGateway

New creates a new instance of the APIGateway client with a config. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a APIGateway client from just a config.
svc := apigateway.New(myConfig)

// Create a APIGateway client with additional configuration
svc := apigateway.New(myConfig, aws.NewConfig().WithRegion("us-west-2"))

func (*APIGateway) CreateApiKeyRequest 

func (c *APIGateway) CreateApiKeyRequest(input *CreateApiKeyInput) CreateApiKeyRequest

CreateApiKeyRequest returns a request value for making API operation for Amazon API Gateway.

Create an ApiKey resource.

AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html) 

// Example sending a request using the CreateApiKeyRequest method.
req := client.CreateApiKeyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateAuthorizerRequest 

func (c *APIGateway) CreateAuthorizerRequest(input *CreateAuthorizerInput) CreateAuthorizerRequest

CreateAuthorizerRequest returns a request value for making API operation for Amazon API Gateway.

Adds a new Authorizer resource to an existing RestApi resource.

AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html) 

// Example sending a request using the CreateAuthorizerRequest method.
req := client.CreateAuthorizerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateBasePathMappingRequest 

func (c *APIGateway) CreateBasePathMappingRequest(input *CreateBasePathMappingInput) CreateBasePathMappingRequest

CreateBasePathMappingRequest returns a request value for making API operation for Amazon API Gateway.

Creates a new BasePathMapping resource. 

// Example sending a request using the CreateBasePathMappingRequest method.
req := client.CreateBasePathMappingRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateDeploymentRequest 

func (c *APIGateway) CreateDeploymentRequest(input *CreateDeploymentInput) CreateDeploymentRequest

CreateDeploymentRequest returns a request value for making API operation for Amazon API Gateway.

Creates a Deployment resource, which makes a specified RestApi callable over the internet. 

// Example sending a request using the CreateDeploymentRequest method.
req := client.CreateDeploymentRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateDocumentationPartRequest 

func (c *APIGateway) CreateDocumentationPartRequest(input *CreateDocumentationPartInput) CreateDocumentationPartRequest

CreateDocumentationPartRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the CreateDocumentationPartRequest method.
req := client.CreateDocumentationPartRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateDocumentationVersionRequest 

func (c *APIGateway) CreateDocumentationVersionRequest(input *CreateDocumentationVersionInput) CreateDocumentationVersionRequest

CreateDocumentationVersionRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the CreateDocumentationVersionRequest method.
req := client.CreateDocumentationVersionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateDomainNameRequest 

func (c *APIGateway) CreateDomainNameRequest(input *CreateDomainNameInput) CreateDomainNameRequest

CreateDomainNameRequest returns a request value for making API operation for Amazon API Gateway.

Creates a new domain name. 

// Example sending a request using the CreateDomainNameRequest method.
req := client.CreateDomainNameRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateModelRequest 

func (c *APIGateway) CreateModelRequest(input *CreateModelInput) CreateModelRequest

CreateModelRequest returns a request value for making API operation for Amazon API Gateway.

Adds a new Model resource to an existing RestApi resource. 

// Example sending a request using the CreateModelRequest method.
req := client.CreateModelRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateRequestValidatorRequest 

func (c *APIGateway) CreateRequestValidatorRequest(input *CreateRequestValidatorInput) CreateRequestValidatorRequest

CreateRequestValidatorRequest returns a request value for making API operation for Amazon API Gateway.

Creates a ReqeustValidator of a given RestApi. 

// Example sending a request using the CreateRequestValidatorRequest method.
req := client.CreateRequestValidatorRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateResourceRequest 

func (c *APIGateway) CreateResourceRequest(input *CreateResourceInput) CreateResourceRequest

CreateResourceRequest returns a request value for making API operation for Amazon API Gateway.

Creates a Resource resource. 

// Example sending a request using the CreateResourceRequest method.
req := client.CreateResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateRestApiRequest 

func (c *APIGateway) CreateRestApiRequest(input *CreateRestApiInput) CreateRestApiRequest

CreateRestApiRequest returns a request value for making API operation for Amazon API Gateway.

Creates a new RestApi resource. 

// Example sending a request using the CreateRestApiRequest method.
req := client.CreateRestApiRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateStageRequest 

func (c *APIGateway) CreateStageRequest(input *CreateStageInput) CreateStageRequest

CreateStageRequest returns a request value for making API operation for Amazon API Gateway.

Creates a new Stage resource that references a pre-existing Deployment for the API. 

// Example sending a request using the CreateStageRequest method.
req := client.CreateStageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateUsagePlanKeyRequest 

func (c *APIGateway) CreateUsagePlanKeyRequest(input *CreateUsagePlanKeyInput) CreateUsagePlanKeyRequest

CreateUsagePlanKeyRequest returns a request value for making API operation for Amazon API Gateway.

Creates a usage plan key for adding an existing API key to a usage plan. 

// Example sending a request using the CreateUsagePlanKeyRequest method.
req := client.CreateUsagePlanKeyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) CreateUsagePlanRequest 

func (c *APIGateway) CreateUsagePlanRequest(input *CreateUsagePlanInput) CreateUsagePlanRequest

CreateUsagePlanRequest returns a request value for making API operation for Amazon API Gateway.

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. 

// Example sending a request using the CreateUsagePlanRequest method.
req := client.CreateUsagePlanRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteApiKeyRequest 

func (c *APIGateway) DeleteApiKeyRequest(input *DeleteApiKeyInput) DeleteApiKeyRequest

DeleteApiKeyRequest returns a request value for making API operation for Amazon API Gateway.

Deletes the ApiKey resource. 

// Example sending a request using the DeleteApiKeyRequest method.
req := client.DeleteApiKeyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteAuthorizerRequest 

func (c *APIGateway) DeleteAuthorizerRequest(input *DeleteAuthorizerInput) DeleteAuthorizerRequest

DeleteAuthorizerRequest returns a request value for making API operation for Amazon API Gateway.

Deletes an existing Authorizer resource.

AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html) 

// Example sending a request using the DeleteAuthorizerRequest method.
req := client.DeleteAuthorizerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteBasePathMappingRequest 

func (c *APIGateway) DeleteBasePathMappingRequest(input *DeleteBasePathMappingInput) DeleteBasePathMappingRequest

DeleteBasePathMappingRequest returns a request value for making API operation for Amazon API Gateway.

Deletes the BasePathMapping resource. 

// Example sending a request using the DeleteBasePathMappingRequest method.
req := client.DeleteBasePathMappingRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteClientCertificateRequest 

func (c *APIGateway) DeleteClientCertificateRequest(input *DeleteClientCertificateInput) DeleteClientCertificateRequest

DeleteClientCertificateRequest returns a request value for making API operation for Amazon API Gateway.

Deletes the ClientCertificate resource. 

// Example sending a request using the DeleteClientCertificateRequest method.
req := client.DeleteClientCertificateRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteDeploymentRequest 

func (c *APIGateway) DeleteDeploymentRequest(input *DeleteDeploymentInput) DeleteDeploymentRequest

DeleteDeploymentRequest returns a request value for making API operation for Amazon API Gateway.

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it. 

// Example sending a request using the DeleteDeploymentRequest method.
req := client.DeleteDeploymentRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteDocumentationPartRequest 

func (c *APIGateway) DeleteDocumentationPartRequest(input *DeleteDocumentationPartInput) DeleteDocumentationPartRequest

DeleteDocumentationPartRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the DeleteDocumentationPartRequest method.
req := client.DeleteDocumentationPartRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteDocumentationVersionRequest 

func (c *APIGateway) DeleteDocumentationVersionRequest(input *DeleteDocumentationVersionInput) DeleteDocumentationVersionRequest

DeleteDocumentationVersionRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the DeleteDocumentationVersionRequest method.
req := client.DeleteDocumentationVersionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteDomainNameRequest 

func (c *APIGateway) DeleteDomainNameRequest(input *DeleteDomainNameInput) DeleteDomainNameRequest

DeleteDomainNameRequest returns a request value for making API operation for Amazon API Gateway.

Deletes the DomainName resource. 

// Example sending a request using the DeleteDomainNameRequest method.
req := client.DeleteDomainNameRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteGatewayResponseRequest 

func (c *APIGateway) DeleteGatewayResponseRequest(input *DeleteGatewayResponseInput) DeleteGatewayResponseRequest

DeleteGatewayResponseRequest returns a request value for making API operation for Amazon API Gateway.

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings. 

// Example sending a request using the DeleteGatewayResponseRequest method.
req := client.DeleteGatewayResponseRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteIntegrationRequest 

func (c *APIGateway) DeleteIntegrationRequest(input *DeleteIntegrationInput) DeleteIntegrationRequest

DeleteIntegrationRequest returns a request value for making API operation for Amazon API Gateway.

Represents a delete integration. 

// Example sending a request using the DeleteIntegrationRequest method.
req := client.DeleteIntegrationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteIntegrationResponseRequest 

func (c *APIGateway) DeleteIntegrationResponseRequest(input *DeleteIntegrationResponseInput) DeleteIntegrationResponseRequest

DeleteIntegrationResponseRequest returns a request value for making API operation for Amazon API Gateway.

Represents a delete integration response. 

// Example sending a request using the DeleteIntegrationResponseRequest method.
req := client.DeleteIntegrationResponseRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteMethodRequest 

func (c *APIGateway) DeleteMethodRequest(input *DeleteMethodInput) DeleteMethodRequest

DeleteMethodRequest returns a request value for making API operation for Amazon API Gateway.

Deletes an existing Method resource. 

// Example sending a request using the DeleteMethodRequest method.
req := client.DeleteMethodRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteMethodResponseRequest 

func (c *APIGateway) DeleteMethodResponseRequest(input *DeleteMethodResponseInput) DeleteMethodResponseRequest

DeleteMethodResponseRequest returns a request value for making API operation for Amazon API Gateway.

Deletes an existing MethodResponse resource. 

// Example sending a request using the DeleteMethodResponseRequest method.
req := client.DeleteMethodResponseRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteModelRequest 

func (c *APIGateway) DeleteModelRequest(input *DeleteModelInput) DeleteModelRequest

DeleteModelRequest returns a request value for making API operation for Amazon API Gateway.

Deletes a model. 

// Example sending a request using the DeleteModelRequest method.
req := client.DeleteModelRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteRequestValidatorRequest 

func (c *APIGateway) DeleteRequestValidatorRequest(input *DeleteRequestValidatorInput) DeleteRequestValidatorRequest

DeleteRequestValidatorRequest returns a request value for making API operation for Amazon API Gateway.

Deletes a RequestValidator of a given RestApi. 

// Example sending a request using the DeleteRequestValidatorRequest method.
req := client.DeleteRequestValidatorRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteResourceRequest 

func (c *APIGateway) DeleteResourceRequest(input *DeleteResourceInput) DeleteResourceRequest

DeleteResourceRequest returns a request value for making API operation for Amazon API Gateway.

Deletes a Resource resource. 

// Example sending a request using the DeleteResourceRequest method.
req := client.DeleteResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteRestApiRequest 

func (c *APIGateway) DeleteRestApiRequest(input *DeleteRestApiInput) DeleteRestApiRequest

DeleteRestApiRequest returns a request value for making API operation for Amazon API Gateway.

Deletes the specified API. 

// Example sending a request using the DeleteRestApiRequest method.
req := client.DeleteRestApiRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteStageRequest 

func (c *APIGateway) DeleteStageRequest(input *DeleteStageInput) DeleteStageRequest

DeleteStageRequest returns a request value for making API operation for Amazon API Gateway.

Deletes a Stage resource. 

// Example sending a request using the DeleteStageRequest method.
req := client.DeleteStageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteUsagePlanKeyRequest 

func (c *APIGateway) DeleteUsagePlanKeyRequest(input *DeleteUsagePlanKeyInput) DeleteUsagePlanKeyRequest

DeleteUsagePlanKeyRequest returns a request value for making API operation for Amazon API Gateway.

Deletes a usage plan key and remove the underlying API key from the associated usage plan. 

// Example sending a request using the DeleteUsagePlanKeyRequest method.
req := client.DeleteUsagePlanKeyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) DeleteUsagePlanRequest 

func (c *APIGateway) DeleteUsagePlanRequest(input *DeleteUsagePlanInput) DeleteUsagePlanRequest

DeleteUsagePlanRequest returns a request value for making API operation for Amazon API Gateway.

Deletes a usage plan of a given plan Id. 

// Example sending a request using the DeleteUsagePlanRequest method.
req := client.DeleteUsagePlanRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) FlushStageAuthorizersCacheRequest 

func (c *APIGateway) FlushStageAuthorizersCacheRequest(input *FlushStageAuthorizersCacheInput) FlushStageAuthorizersCacheRequest

FlushStageAuthorizersCacheRequest returns a request value for making API operation for Amazon API Gateway.

Flushes all authorizer cache entries on a stage. 

// Example sending a request using the FlushStageAuthorizersCacheRequest method.
req := client.FlushStageAuthorizersCacheRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) FlushStageCacheRequest 

func (c *APIGateway) FlushStageCacheRequest(input *FlushStageCacheInput) FlushStageCacheRequest

FlushStageCacheRequest returns a request value for making API operation for Amazon API Gateway.

Flushes a stage's cache. 

// Example sending a request using the FlushStageCacheRequest method.
req := client.FlushStageCacheRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GenerateClientCertificateRequest 

func (c *APIGateway) GenerateClientCertificateRequest(input *GenerateClientCertificateInput) GenerateClientCertificateRequest

GenerateClientCertificateRequest returns a request value for making API operation for Amazon API Gateway.

Generates a ClientCertificate resource. 

// Example sending a request using the GenerateClientCertificateRequest method.
req := client.GenerateClientCertificateRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetAccountRequest 

func (c *APIGateway) GetAccountRequest(input *GetAccountInput) GetAccountRequest

GetAccountRequest returns a request value for making API operation for Amazon API Gateway.

Gets information about the current Account resource. 

// Example sending a request using the GetAccountRequest method.
req := client.GetAccountRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetApiKeyRequest 

func (c *APIGateway) GetApiKeyRequest(input *GetApiKeyInput) GetApiKeyRequest

GetApiKeyRequest returns a request value for making API operation for Amazon API Gateway.

Gets information about the current ApiKey resource. 

// Example sending a request using the GetApiKeyRequest method.
req := client.GetApiKeyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetApiKeysPages 

func (c *APIGateway) GetApiKeysPages(input *GetApiKeysInput, fn func(*GetApiKeysOutput, bool) bool) error

GetApiKeysPages iterates over the pages of a GetApiKeys operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetApiKeys method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetApiKeys operation.
pageNum := 0
err := client.GetApiKeysPages(params,
    func(page *GetApiKeysOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*APIGateway) GetApiKeysPagesWithContext 

func (c *APIGateway) GetApiKeysPagesWithContext(ctx aws.Context, input *GetApiKeysInput, fn func(*GetApiKeysOutput, bool) bool, opts ...aws.Option) error

GetApiKeysPagesWithContext same as GetApiKeysPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*APIGateway) GetApiKeysRequest 

func (c *APIGateway) GetApiKeysRequest(input *GetApiKeysInput) GetApiKeysRequest

GetApiKeysRequest returns a request value for making API operation for Amazon API Gateway.

Gets information about the current ApiKeys resource. 

// Example sending a request using the GetApiKeysRequest method.
req := client.GetApiKeysRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetAuthorizerRequest 

func (c *APIGateway) GetAuthorizerRequest(input *GetAuthorizerInput) GetAuthorizerRequest

GetAuthorizerRequest returns a request value for making API operation for Amazon API Gateway.

Describe an existing Authorizer resource.

AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html) 

// Example sending a request using the GetAuthorizerRequest method.
req := client.GetAuthorizerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetAuthorizersRequest 

func (c *APIGateway) GetAuthorizersRequest(input *GetAuthorizersInput) GetAuthorizersRequest

GetAuthorizersRequest returns a request value for making API operation for Amazon API Gateway.

Describe an existing Authorizers resource.

AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html) 

// Example sending a request using the GetAuthorizersRequest method.
req := client.GetAuthorizersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetBasePathMappingRequest 

func (c *APIGateway) GetBasePathMappingRequest(input *GetBasePathMappingInput) GetBasePathMappingRequest

GetBasePathMappingRequest returns a request value for making API operation for Amazon API Gateway.

Describe a BasePathMapping resource. 

// Example sending a request using the GetBasePathMappingRequest method.
req := client.GetBasePathMappingRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetBasePathMappingsPages 

func (c *APIGateway) GetBasePathMappingsPages(input *GetBasePathMappingsInput, fn func(*GetBasePathMappingsOutput, bool) bool) error

GetBasePathMappingsPages iterates over the pages of a GetBasePathMappings operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetBasePathMappings method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetBasePathMappings operation.
pageNum := 0
err := client.GetBasePathMappingsPages(params,
    func(page *GetBasePathMappingsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*APIGateway) GetBasePathMappingsPagesWithContext 

func (c *APIGateway) GetBasePathMappingsPagesWithContext(ctx aws.Context, input *GetBasePathMappingsInput, fn func(*GetBasePathMappingsOutput, bool) bool, opts ...aws.Option) error

GetBasePathMappingsPagesWithContext same as GetBasePathMappingsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*APIGateway) GetBasePathMappingsRequest 

func (c *APIGateway) GetBasePathMappingsRequest(input *GetBasePathMappingsInput) GetBasePathMappingsRequest

GetBasePathMappingsRequest returns a request value for making API operation for Amazon API Gateway.

Represents a collection of BasePathMapping resources. 

// Example sending a request using the GetBasePathMappingsRequest method.
req := client.GetBasePathMappingsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetClientCertificateRequest 

func (c *APIGateway) GetClientCertificateRequest(input *GetClientCertificateInput) GetClientCertificateRequest

GetClientCertificateRequest returns a request value for making API operation for Amazon API Gateway.

Gets information about the current ClientCertificate resource. 

// Example sending a request using the GetClientCertificateRequest method.
req := client.GetClientCertificateRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetClientCertificatesPages 

func (c *APIGateway) GetClientCertificatesPages(input *GetClientCertificatesInput, fn func(*GetClientCertificatesOutput, bool) bool) error

GetClientCertificatesPages iterates over the pages of a GetClientCertificates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetClientCertificates method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetClientCertificates operation.
pageNum := 0
err := client.GetClientCertificatesPages(params,
    func(page *GetClientCertificatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*APIGateway) GetClientCertificatesPagesWithContext 

func (c *APIGateway) GetClientCertificatesPagesWithContext(ctx aws.Context, input *GetClientCertificatesInput, fn func(*GetClientCertificatesOutput, bool) bool, opts ...aws.Option) error

GetClientCertificatesPagesWithContext same as GetClientCertificatesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*APIGateway) GetClientCertificatesRequest 

func (c *APIGateway) GetClientCertificatesRequest(input *GetClientCertificatesInput) GetClientCertificatesRequest

GetClientCertificatesRequest returns a request value for making API operation for Amazon API Gateway.

Gets a collection of ClientCertificate resources. 

// Example sending a request using the GetClientCertificatesRequest method.
req := client.GetClientCertificatesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetDeploymentRequest 

func (c *APIGateway) GetDeploymentRequest(input *GetDeploymentInput) GetDeploymentRequest

GetDeploymentRequest returns a request value for making API operation for Amazon API Gateway.

Gets information about a Deployment resource. 

// Example sending a request using the GetDeploymentRequest method.
req := client.GetDeploymentRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetDeploymentsPages 

func (c *APIGateway) GetDeploymentsPages(input *GetDeploymentsInput, fn func(*GetDeploymentsOutput, bool) bool) error

GetDeploymentsPages iterates over the pages of a GetDeployments operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetDeployments method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetDeployments operation.
pageNum := 0
err := client.GetDeploymentsPages(params,
    func(page *GetDeploymentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*APIGateway) GetDeploymentsPagesWithContext 

func (c *APIGateway) GetDeploymentsPagesWithContext(ctx aws.Context, input *GetDeploymentsInput, fn func(*GetDeploymentsOutput, bool) bool, opts ...aws.Option) error

GetDeploymentsPagesWithContext same as GetDeploymentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*APIGateway) GetDeploymentsRequest 

func (c *APIGateway) GetDeploymentsRequest(input *GetDeploymentsInput) GetDeploymentsRequest

GetDeploymentsRequest returns a request value for making API operation for Amazon API Gateway.

Gets information about a Deployments collection. 

// Example sending a request using the GetDeploymentsRequest method.
req := client.GetDeploymentsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetDocumentationPartRequest 

func (c *APIGateway) GetDocumentationPartRequest(input *GetDocumentationPartInput) GetDocumentationPartRequest

GetDocumentationPartRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the GetDocumentationPartRequest method.
req := client.GetDocumentationPartRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetDocumentationPartsRequest 

func (c *APIGateway) GetDocumentationPartsRequest(input *GetDocumentationPartsInput) GetDocumentationPartsRequest

GetDocumentationPartsRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the GetDocumentationPartsRequest method.
req := client.GetDocumentationPartsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetDocumentationVersionRequest 

func (c *APIGateway) GetDocumentationVersionRequest(input *GetDocumentationVersionInput) GetDocumentationVersionRequest

GetDocumentationVersionRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the GetDocumentationVersionRequest method.
req := client.GetDocumentationVersionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetDocumentationVersionsRequest 

func (c *APIGateway) GetDocumentationVersionsRequest(input *GetDocumentationVersionsInput) GetDocumentationVersionsRequest

GetDocumentationVersionsRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the GetDocumentationVersionsRequest method.
req := client.GetDocumentationVersionsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetDomainNameRequest 

func (c *APIGateway) GetDomainNameRequest(input *GetDomainNameInput) GetDomainNameRequest

GetDomainNameRequest returns a request value for making API operation for Amazon API Gateway.

Represents a domain name that is contained in a simpler, more intuitive URL that can be called. 

// Example sending a request using the GetDomainNameRequest method.
req := client.GetDomainNameRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetDomainNamesPages 

func (c *APIGateway) GetDomainNamesPages(input *GetDomainNamesInput, fn func(*GetDomainNamesOutput, bool) bool) error

GetDomainNamesPages iterates over the pages of a GetDomainNames operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetDomainNames method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetDomainNames operation.
pageNum := 0
err := client.GetDomainNamesPages(params,
    func(page *GetDomainNamesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*APIGateway) GetDomainNamesPagesWithContext 

func (c *APIGateway) GetDomainNamesPagesWithContext(ctx aws.Context, input *GetDomainNamesInput, fn func(*GetDomainNamesOutput, bool) bool, opts ...aws.Option) error

GetDomainNamesPagesWithContext same as GetDomainNamesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*APIGateway) GetDomainNamesRequest 

func (c *APIGateway) GetDomainNamesRequest(input *GetDomainNamesInput) GetDomainNamesRequest

GetDomainNamesRequest returns a request value for making API operation for Amazon API Gateway.

Represents a collection of DomainName resources. 

// Example sending a request using the GetDomainNamesRequest method.
req := client.GetDomainNamesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetExportRequest 

func (c *APIGateway) GetExportRequest(input *GetExportInput) GetExportRequest

GetExportRequest returns a request value for making API operation for Amazon API Gateway.

Exports a deployed version of a RestApi in a specified format. 

// Example sending a request using the GetExportRequest method.
req := client.GetExportRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetGatewayResponseRequest 

func (c *APIGateway) GetGatewayResponseRequest(input *GetGatewayResponseInput) GetGatewayResponseRequest

GetGatewayResponseRequest returns a request value for making API operation for Amazon API Gateway.

Gets a GatewayResponse of a specified response type on the given RestApi. 

// Example sending a request using the GetGatewayResponseRequest method.
req := client.GetGatewayResponseRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetGatewayResponsesRequest 

func (c *APIGateway) GetGatewayResponsesRequest(input *GetGatewayResponsesInput) GetGatewayResponsesRequest

GetGatewayResponsesRequest returns a request value for making API operation for Amazon API Gateway.

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the Amazon API Gateway-generated default GatewayResponses collection for the supported response types. 

// Example sending a request using the GetGatewayResponsesRequest method.
req := client.GetGatewayResponsesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetIntegrationRequest 

func (c *APIGateway) GetIntegrationRequest(input *GetIntegrationInput) GetIntegrationRequest

GetIntegrationRequest returns a request value for making API operation for Amazon API Gateway.

Represents a get integration. 

// Example sending a request using the GetIntegrationRequest method.
req := client.GetIntegrationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetIntegrationResponseRequest 

func (c *APIGateway) GetIntegrationResponseRequest(input *GetIntegrationResponseInput) GetIntegrationResponseRequest

GetIntegrationResponseRequest returns a request value for making API operation for Amazon API Gateway.

Represents a get integration response. 

// Example sending a request using the GetIntegrationResponseRequest method.
req := client.GetIntegrationResponseRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetMethodRequest 

func (c *APIGateway) GetMethodRequest(input *GetMethodInput) GetMethodRequest

GetMethodRequest returns a request value for making API operation for Amazon API Gateway.

Describe an existing Method resource. 

// Example sending a request using the GetMethodRequest method.
req := client.GetMethodRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetMethodResponseRequest 

func (c *APIGateway) GetMethodResponseRequest(input *GetMethodResponseInput) GetMethodResponseRequest

GetMethodResponseRequest returns a request value for making API operation for Amazon API Gateway.

Describes a MethodResponse resource. 

// Example sending a request using the GetMethodResponseRequest method.
req := client.GetMethodResponseRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetModelRequest 

func (c *APIGateway) GetModelRequest(input *GetModelInput) GetModelRequest

GetModelRequest returns a request value for making API operation for Amazon API Gateway.

Describes an existing model defined for a RestApi resource. 

// Example sending a request using the GetModelRequest method.
req := client.GetModelRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetModelTemplateRequest 

func (c *APIGateway) GetModelTemplateRequest(input *GetModelTemplateInput) GetModelTemplateRequest

GetModelTemplateRequest returns a request value for making API operation for Amazon API Gateway.

Generates a sample mapping template that can be used to transform a payload into the structure of a model. 

// Example sending a request using the GetModelTemplateRequest method.
req := client.GetModelTemplateRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetModelsPages 

func (c *APIGateway) GetModelsPages(input *GetModelsInput, fn func(*GetModelsOutput, bool) bool) error

GetModelsPages iterates over the pages of a GetModels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetModels method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetModels operation.
pageNum := 0
err := client.GetModelsPages(params,
    func(page *GetModelsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*APIGateway) GetModelsPagesWithContext 

func (c *APIGateway) GetModelsPagesWithContext(ctx aws.Context, input *GetModelsInput, fn func(*GetModelsOutput, bool) bool, opts ...aws.Option) error

GetModelsPagesWithContext same as GetModelsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*APIGateway) GetModelsRequest 

func (c *APIGateway) GetModelsRequest(input *GetModelsInput) GetModelsRequest

GetModelsRequest returns a request value for making API operation for Amazon API Gateway.

Describes existing Models defined for a RestApi resource. 

// Example sending a request using the GetModelsRequest method.
req := client.GetModelsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetRequestValidatorRequest 

func (c *APIGateway) GetRequestValidatorRequest(input *GetRequestValidatorInput) GetRequestValidatorRequest

GetRequestValidatorRequest returns a request value for making API operation for Amazon API Gateway.

Gets a RequestValidator of a given RestApi. 

// Example sending a request using the GetRequestValidatorRequest method.
req := client.GetRequestValidatorRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetRequestValidatorsRequest 

func (c *APIGateway) GetRequestValidatorsRequest(input *GetRequestValidatorsInput) GetRequestValidatorsRequest

GetRequestValidatorsRequest returns a request value for making API operation for Amazon API Gateway.

Gets the RequestValidators collection of a given RestApi. 

// Example sending a request using the GetRequestValidatorsRequest method.
req := client.GetRequestValidatorsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetResourceRequest 

func (c *APIGateway) GetResourceRequest(input *GetResourceInput) GetResourceRequest

GetResourceRequest returns a request value for making API operation for Amazon API Gateway.

Lists information about a resource. 

// Example sending a request using the GetResourceRequest method.
req := client.GetResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetResourcesPages 

func (c *APIGateway) GetResourcesPages(input *GetResourcesInput, fn func(*GetResourcesOutput, bool) bool) error

GetResourcesPages iterates over the pages of a GetResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetResources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetResources operation.
pageNum := 0
err := client.GetResourcesPages(params,
    func(page *GetResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*APIGateway) GetResourcesPagesWithContext 

func (c *APIGateway) GetResourcesPagesWithContext(ctx aws.Context, input *GetResourcesInput, fn func(*GetResourcesOutput, bool) bool, opts ...aws.Option) error

GetResourcesPagesWithContext same as GetResourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*APIGateway) GetResourcesRequest 

func (c *APIGateway) GetResourcesRequest(input *GetResourcesInput) GetResourcesRequest

GetResourcesRequest returns a request value for making API operation for Amazon API Gateway.

Lists information about a collection of Resource resources. 

// Example sending a request using the GetResourcesRequest method.
req := client.GetResourcesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetRestApiRequest 

func (c *APIGateway) GetRestApiRequest(input *GetRestApiInput) GetRestApiRequest

GetRestApiRequest returns a request value for making API operation for Amazon API Gateway.

Lists the RestApi resource in the collection. 

// Example sending a request using the GetRestApiRequest method.
req := client.GetRestApiRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetRestApisPages 

func (c *APIGateway) GetRestApisPages(input *GetRestApisInput, fn func(*GetRestApisOutput, bool) bool) error

GetRestApisPages iterates over the pages of a GetRestApis operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetRestApis method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetRestApis operation.
pageNum := 0
err := client.GetRestApisPages(params,
    func(page *GetRestApisOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*APIGateway) GetRestApisPagesWithContext 

func (c *APIGateway) GetRestApisPagesWithContext(ctx aws.Context, input *GetRestApisInput, fn func(*GetRestApisOutput, bool) bool, opts ...aws.Option) error

GetRestApisPagesWithContext same as GetRestApisPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*APIGateway) GetRestApisRequest 

func (c *APIGateway) GetRestApisRequest(input *GetRestApisInput) GetRestApisRequest

GetRestApisRequest returns a request value for making API operation for Amazon API Gateway.

Lists the RestApis resources for your collection. 

// Example sending a request using the GetRestApisRequest method.
req := client.GetRestApisRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetSdkRequest 

func (c *APIGateway) GetSdkRequest(input *GetSdkInput) GetSdkRequest

GetSdkRequest returns a request value for making API operation for Amazon API Gateway.

Generates a client SDK for a RestApi and Stage. 

// Example sending a request using the GetSdkRequest method.
req := client.GetSdkRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetSdkTypeRequest 

func (c *APIGateway) GetSdkTypeRequest(input *GetSdkTypeInput) GetSdkTypeRequest

GetSdkTypeRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the GetSdkTypeRequest method.
req := client.GetSdkTypeRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetSdkTypesRequest 

func (c *APIGateway) GetSdkTypesRequest(input *GetSdkTypesInput) GetSdkTypesRequest

GetSdkTypesRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the GetSdkTypesRequest method.
req := client.GetSdkTypesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetStageRequest 

func (c *APIGateway) GetStageRequest(input *GetStageInput) GetStageRequest

GetStageRequest returns a request value for making API operation for Amazon API Gateway.

Gets information about a Stage resource. 

// Example sending a request using the GetStageRequest method.
req := client.GetStageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetStagesRequest 

func (c *APIGateway) GetStagesRequest(input *GetStagesInput) GetStagesRequest

GetStagesRequest returns a request value for making API operation for Amazon API Gateway.

Gets information about one or more Stage resources. 

// Example sending a request using the GetStagesRequest method.
req := client.GetStagesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetUsagePages 

func (c *APIGateway) GetUsagePages(input *GetUsageInput, fn func(*UpdateUsageOutput, bool) bool) error

GetUsagePages iterates over the pages of a GetUsage operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetUsage method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetUsage operation.
pageNum := 0
err := client.GetUsagePages(params,
    func(page *UpdateUsageOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*APIGateway) GetUsagePagesWithContext 

func (c *APIGateway) GetUsagePagesWithContext(ctx aws.Context, input *GetUsageInput, fn func(*UpdateUsageOutput, bool) bool, opts ...aws.Option) error

GetUsagePagesWithContext same as GetUsagePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*APIGateway) GetUsagePlanKeyRequest 

func (c *APIGateway) GetUsagePlanKeyRequest(input *GetUsagePlanKeyInput) GetUsagePlanKeyRequest

GetUsagePlanKeyRequest returns a request value for making API operation for Amazon API Gateway.

Gets a usage plan key of a given key identifier. 

// Example sending a request using the GetUsagePlanKeyRequest method.
req := client.GetUsagePlanKeyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetUsagePlanKeysPages 

func (c *APIGateway) GetUsagePlanKeysPages(input *GetUsagePlanKeysInput, fn func(*GetUsagePlanKeysOutput, bool) bool) error

GetUsagePlanKeysPages iterates over the pages of a GetUsagePlanKeys operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetUsagePlanKeys method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetUsagePlanKeys operation.
pageNum := 0
err := client.GetUsagePlanKeysPages(params,
    func(page *GetUsagePlanKeysOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*APIGateway) GetUsagePlanKeysPagesWithContext 

func (c *APIGateway) GetUsagePlanKeysPagesWithContext(ctx aws.Context, input *GetUsagePlanKeysInput, fn func(*GetUsagePlanKeysOutput, bool) bool, opts ...aws.Option) error

GetUsagePlanKeysPagesWithContext same as GetUsagePlanKeysPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*APIGateway) GetUsagePlanKeysRequest 

func (c *APIGateway) GetUsagePlanKeysRequest(input *GetUsagePlanKeysInput) GetUsagePlanKeysRequest

GetUsagePlanKeysRequest returns a request value for making API operation for Amazon API Gateway.

Gets all the usage plan keys representing the API keys added to a specified usage plan. 

// Example sending a request using the GetUsagePlanKeysRequest method.
req := client.GetUsagePlanKeysRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetUsagePlanRequest 

func (c *APIGateway) GetUsagePlanRequest(input *GetUsagePlanInput) GetUsagePlanRequest

GetUsagePlanRequest returns a request value for making API operation for Amazon API Gateway.

Gets a usage plan of a given plan identifier. 

// Example sending a request using the GetUsagePlanRequest method.
req := client.GetUsagePlanRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetUsagePlansPages 

func (c *APIGateway) GetUsagePlansPages(input *GetUsagePlansInput, fn func(*GetUsagePlansOutput, bool) bool) error

GetUsagePlansPages iterates over the pages of a GetUsagePlans operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetUsagePlans method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetUsagePlans operation.
pageNum := 0
err := client.GetUsagePlansPages(params,
    func(page *GetUsagePlansOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*APIGateway) GetUsagePlansPagesWithContext 

func (c *APIGateway) GetUsagePlansPagesWithContext(ctx aws.Context, input *GetUsagePlansInput, fn func(*GetUsagePlansOutput, bool) bool, opts ...aws.Option) error

GetUsagePlansPagesWithContext same as GetUsagePlansPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*APIGateway) GetUsagePlansRequest 

func (c *APIGateway) GetUsagePlansRequest(input *GetUsagePlansInput) GetUsagePlansRequest

GetUsagePlansRequest returns a request value for making API operation for Amazon API Gateway.

Gets all the usage plans of the caller's account. 

// Example sending a request using the GetUsagePlansRequest method.
req := client.GetUsagePlansRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) GetUsageRequest 

func (c *APIGateway) GetUsageRequest(input *GetUsageInput) GetUsageRequest

GetUsageRequest returns a request value for making API operation for Amazon API Gateway.

Gets the usage data of a usage plan in a specified time interval. 

// Example sending a request using the GetUsageRequest method.
req := client.GetUsageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) ImportApiKeysRequest 

func (c *APIGateway) ImportApiKeysRequest(input *ImportApiKeysInput) ImportApiKeysRequest

ImportApiKeysRequest returns a request value for making API operation for Amazon API Gateway.

Import API keys from an external source, such as a CSV-formatted file. 

// Example sending a request using the ImportApiKeysRequest method.
req := client.ImportApiKeysRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) ImportDocumentationPartsRequest 

func (c *APIGateway) ImportDocumentationPartsRequest(input *ImportDocumentationPartsInput) ImportDocumentationPartsRequest

ImportDocumentationPartsRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the ImportDocumentationPartsRequest method.
req := client.ImportDocumentationPartsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) ImportRestApiRequest 

func (c *APIGateway) ImportRestApiRequest(input *ImportRestApiInput) ImportRestApiRequest

ImportRestApiRequest returns a request value for making API operation for Amazon API Gateway.

A feature of the Amazon API Gateway control service for creating a new API from an external API definition file. 

// Example sending a request using the ImportRestApiRequest method.
req := client.ImportRestApiRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) PutGatewayResponseRequest 

func (c *APIGateway) PutGatewayResponseRequest(input *PutGatewayResponseInput) PutGatewayResponseRequest

PutGatewayResponseRequest returns a request value for making API operation for Amazon API Gateway.

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi. 

// Example sending a request using the PutGatewayResponseRequest method.
req := client.PutGatewayResponseRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) PutIntegrationRequest 

func (c *APIGateway) PutIntegrationRequest(input *PutIntegrationInput) PutIntegrationRequest

PutIntegrationRequest returns a request value for making API operation for Amazon API Gateway.

Sets up a method's integration. 

// Example sending a request using the PutIntegrationRequest method.
req := client.PutIntegrationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) PutIntegrationResponseRequest 

func (c *APIGateway) PutIntegrationResponseRequest(input *PutIntegrationResponseInput) PutIntegrationResponseRequest

PutIntegrationResponseRequest returns a request value for making API operation for Amazon API Gateway.

Represents a put integration. 

// Example sending a request using the PutIntegrationResponseRequest method.
req := client.PutIntegrationResponseRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) PutMethodRequest 

func (c *APIGateway) PutMethodRequest(input *PutMethodInput) PutMethodRequest

PutMethodRequest returns a request value for making API operation for Amazon API Gateway.

Add a method to an existing Resource resource. 

// Example sending a request using the PutMethodRequest method.
req := client.PutMethodRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) PutMethodResponseRequest 

func (c *APIGateway) PutMethodResponseRequest(input *PutMethodResponseInput) PutMethodResponseRequest

PutMethodResponseRequest returns a request value for making API operation for Amazon API Gateway.

Adds a MethodResponse to an existing Method resource. 

// Example sending a request using the PutMethodResponseRequest method.
req := client.PutMethodResponseRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) PutRestApiRequest 

func (c *APIGateway) PutRestApiRequest(input *PutRestApiInput) PutRestApiRequest

PutRestApiRequest returns a request value for making API operation for Amazon API Gateway.

A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API. 

// Example sending a request using the PutRestApiRequest method.
req := client.PutRestApiRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) TestInvokeAuthorizerRequest 

func (c *APIGateway) TestInvokeAuthorizerRequest(input *TestInvokeAuthorizerInput) TestInvokeAuthorizerRequest

TestInvokeAuthorizerRequest returns a request value for making API operation for Amazon API Gateway.

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

Enable custom authorizers (http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html) 

// Example sending a request using the TestInvokeAuthorizerRequest method.
req := client.TestInvokeAuthorizerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) TestInvokeMethodRequest 

func (c *APIGateway) TestInvokeMethodRequest(input *TestInvokeMethodInput) TestInvokeMethodRequest

TestInvokeMethodRequest returns a request value for making API operation for Amazon API Gateway.

Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body. 

// Example sending a request using the TestInvokeMethodRequest method.
req := client.TestInvokeMethodRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateAccountRequest 

func (c *APIGateway) UpdateAccountRequest(input *UpdateAccountInput) UpdateAccountRequest

UpdateAccountRequest returns a request value for making API operation for Amazon API Gateway.

Changes information about the current Account resource. 

// Example sending a request using the UpdateAccountRequest method.
req := client.UpdateAccountRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateApiKeyRequest 

func (c *APIGateway) UpdateApiKeyRequest(input *UpdateApiKeyInput) UpdateApiKeyRequest

UpdateApiKeyRequest returns a request value for making API operation for Amazon API Gateway.

Changes information about an ApiKey resource. 

// Example sending a request using the UpdateApiKeyRequest method.
req := client.UpdateApiKeyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateAuthorizerRequest 

func (c *APIGateway) UpdateAuthorizerRequest(input *UpdateAuthorizerInput) UpdateAuthorizerRequest

UpdateAuthorizerRequest returns a request value for making API operation for Amazon API Gateway.

Updates an existing Authorizer resource.

AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html) 

// Example sending a request using the UpdateAuthorizerRequest method.
req := client.UpdateAuthorizerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateBasePathMappingRequest 

func (c *APIGateway) UpdateBasePathMappingRequest(input *UpdateBasePathMappingInput) UpdateBasePathMappingRequest

UpdateBasePathMappingRequest returns a request value for making API operation for Amazon API Gateway.

Changes information about the BasePathMapping resource. 

// Example sending a request using the UpdateBasePathMappingRequest method.
req := client.UpdateBasePathMappingRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateClientCertificateRequest 

func (c *APIGateway) UpdateClientCertificateRequest(input *UpdateClientCertificateInput) UpdateClientCertificateRequest

UpdateClientCertificateRequest returns a request value for making API operation for Amazon API Gateway.

Changes information about an ClientCertificate resource. 

// Example sending a request using the UpdateClientCertificateRequest method.
req := client.UpdateClientCertificateRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateDeploymentRequest 

func (c *APIGateway) UpdateDeploymentRequest(input *UpdateDeploymentInput) UpdateDeploymentRequest

UpdateDeploymentRequest returns a request value for making API operation for Amazon API Gateway.

Changes information about a Deployment resource. 

// Example sending a request using the UpdateDeploymentRequest method.
req := client.UpdateDeploymentRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateDocumentationPartRequest 

func (c *APIGateway) UpdateDocumentationPartRequest(input *UpdateDocumentationPartInput) UpdateDocumentationPartRequest

UpdateDocumentationPartRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the UpdateDocumentationPartRequest method.
req := client.UpdateDocumentationPartRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateDocumentationVersionRequest 

func (c *APIGateway) UpdateDocumentationVersionRequest(input *UpdateDocumentationVersionInput) UpdateDocumentationVersionRequest

UpdateDocumentationVersionRequest returns a request value for making API operation for Amazon API Gateway. 

// Example sending a request using the UpdateDocumentationVersionRequest method.
req := client.UpdateDocumentationVersionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateDomainNameRequest 

func (c *APIGateway) UpdateDomainNameRequest(input *UpdateDomainNameInput) UpdateDomainNameRequest

UpdateDomainNameRequest returns a request value for making API operation for Amazon API Gateway.

Changes information about the DomainName resource. 

// Example sending a request using the UpdateDomainNameRequest method.
req := client.UpdateDomainNameRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateGatewayResponseRequest 

func (c *APIGateway) UpdateGatewayResponseRequest(input *UpdateGatewayResponseInput) UpdateGatewayResponseRequest

UpdateGatewayResponseRequest returns a request value for making API operation for Amazon API Gateway.

Updates a GatewayResponse of a specified response type on the given RestApi. 

// Example sending a request using the UpdateGatewayResponseRequest method.
req := client.UpdateGatewayResponseRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateIntegrationRequest 

func (c *APIGateway) UpdateIntegrationRequest(input *UpdateIntegrationInput) UpdateIntegrationRequest

UpdateIntegrationRequest returns a request value for making API operation for Amazon API Gateway.

Represents an update integration. 

// Example sending a request using the UpdateIntegrationRequest method.
req := client.UpdateIntegrationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateIntegrationResponseRequest 

func (c *APIGateway) UpdateIntegrationResponseRequest(input *UpdateIntegrationResponseInput) UpdateIntegrationResponseRequest

UpdateIntegrationResponseRequest returns a request value for making API operation for Amazon API Gateway.

Represents an update integration response. 

// Example sending a request using the UpdateIntegrationResponseRequest method.
req := client.UpdateIntegrationResponseRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateMethodRequest 

func (c *APIGateway) UpdateMethodRequest(input *UpdateMethodInput) UpdateMethodRequest

UpdateMethodRequest returns a request value for making API operation for Amazon API Gateway.

Updates an existing Method resource. 

// Example sending a request using the UpdateMethodRequest method.
req := client.UpdateMethodRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateMethodResponseRequest 

func (c *APIGateway) UpdateMethodResponseRequest(input *UpdateMethodResponseInput) UpdateMethodResponseRequest

UpdateMethodResponseRequest returns a request value for making API operation for Amazon API Gateway.

Updates an existing MethodResponse resource. 

// Example sending a request using the UpdateMethodResponseRequest method.
req := client.UpdateMethodResponseRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateModelRequest 

func (c *APIGateway) UpdateModelRequest(input *UpdateModelInput) UpdateModelRequest

UpdateModelRequest returns a request value for making API operation for Amazon API Gateway.

Changes information about a model. 

// Example sending a request using the UpdateModelRequest method.
req := client.UpdateModelRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateRequestValidatorRequest 

func (c *APIGateway) UpdateRequestValidatorRequest(input *UpdateRequestValidatorInput) UpdateRequestValidatorRequest

UpdateRequestValidatorRequest returns a request value for making API operation for Amazon API Gateway.

Updates a RequestValidator of a given RestApi. 

// Example sending a request using the UpdateRequestValidatorRequest method.
req := client.UpdateRequestValidatorRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateResourceRequest 

func (c *APIGateway) UpdateResourceRequest(input *UpdateResourceInput) UpdateResourceRequest

UpdateResourceRequest returns a request value for making API operation for Amazon API Gateway.

Changes information about a Resource resource. 

// Example sending a request using the UpdateResourceRequest method.
req := client.UpdateResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateRestApiRequest 

func (c *APIGateway) UpdateRestApiRequest(input *UpdateRestApiInput) UpdateRestApiRequest

UpdateRestApiRequest returns a request value for making API operation for Amazon API Gateway.

Changes information about the specified API. 

// Example sending a request using the UpdateRestApiRequest method.
req := client.UpdateRestApiRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateStageRequest 

func (c *APIGateway) UpdateStageRequest(input *UpdateStageInput) UpdateStageRequest

UpdateStageRequest returns a request value for making API operation for Amazon API Gateway.

Changes information about a Stage resource. 

// Example sending a request using the UpdateStageRequest method.
req := client.UpdateStageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateUsagePlanRequest 

func (c *APIGateway) UpdateUsagePlanRequest(input *UpdateUsagePlanInput) UpdateUsagePlanRequest

UpdateUsagePlanRequest returns a request value for making API operation for Amazon API Gateway.

Updates a usage plan of a given plan Id. 

// Example sending a request using the UpdateUsagePlanRequest method.
req := client.UpdateUsagePlanRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

func (*APIGateway) UpdateUsageRequest 

func (c *APIGateway) UpdateUsageRequest(input *UpdateUsageInput) UpdateUsageRequest

UpdateUsageRequest returns a request value for making API operation for Amazon API Gateway.

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key. 

// Example sending a request using the UpdateUsageRequest method.
req := client.UpdateUsageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

type ApiKeysFormat 

type ApiKeysFormat string
const (
	ApiKeysFormatCsv ApiKeysFormat = "csv"
)

Enum values for ApiKeysFormat

type ApiStage 

type ApiStage struct {

	// API Id of the associated API stage in a usage plan.
	ApiId *string `locationName:"apiId" type:"string"`

	// API stage name of the associated API stage in a usage plan.
	Stage *string `locationName:"stage" type:"string"`
	// contains filtered or unexported fields
}

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

func (ApiStage) GoString 

func (s ApiStage) GoString() string

GoString returns the string representation

func (*ApiStage) SetApiId 

func (s *ApiStage) SetApiId(v string) *ApiStage

SetApiId sets the ApiId field's value.

func (*ApiStage) SetStage 

func (s *ApiStage) SetStage(v string) *ApiStage

SetStage sets the Stage field's value.

func (ApiStage) String 

func (s ApiStage) String() string

String returns the string representation

type AuthorizerType 

type AuthorizerType string

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool. 

const (
	AuthorizerTypeToken            AuthorizerType = "TOKEN"
	AuthorizerTypeRequest          AuthorizerType = "REQUEST"
	AuthorizerTypeCognitoUserPools AuthorizerType = "COGNITO_USER_POOLS"
)

Enum values for AuthorizerType

type CacheClusterSize 

type CacheClusterSize string

Returns the size of the CacheCluster. 

const (
	CacheClusterSize05  CacheClusterSize = "0.5"
	CacheClusterSize16  CacheClusterSize = "1.6"
	CacheClusterSize61  CacheClusterSize = "6.1"
	CacheClusterSize135 CacheClusterSize = "13.5"
	CacheClusterSize284 CacheClusterSize = "28.4"
	CacheClusterSize582 CacheClusterSize = "58.2"
	CacheClusterSize118 CacheClusterSize = "118"
	CacheClusterSize237 CacheClusterSize = "237"
)

Enum values for CacheClusterSize

type CacheClusterStatus 

type CacheClusterStatus string

Returns the status of the CacheCluster. 

const (
	CacheClusterStatusCreateInProgress CacheClusterStatus = "CREATE_IN_PROGRESS"
	CacheClusterStatusAvailable        CacheClusterStatus = "AVAILABLE"
	CacheClusterStatusDeleteInProgress CacheClusterStatus = "DELETE_IN_PROGRESS"
	CacheClusterStatusNotAvailable     CacheClusterStatus = "NOT_AVAILABLE"
	CacheClusterStatusFlushInProgress  CacheClusterStatus = "FLUSH_IN_PROGRESS"
)

Enum values for CacheClusterStatus

type ContentHandlingStrategy 

type ContentHandlingStrategy string
const (
	ContentHandlingStrategyConvertToBinary ContentHandlingStrategy = "CONVERT_TO_BINARY"
	ContentHandlingStrategyConvertToText   ContentHandlingStrategy = "CONVERT_TO_TEXT"
)

Enum values for ContentHandlingStrategy

type CreateApiKeyInput 

type CreateApiKeyInput struct {

	// An AWS Marketplace customer identifier , when integrating with the AWS SaaS
	// Marketplace.
	CustomerId *string `locationName:"customerId" type:"string"`

	// The description of the ApiKey.
	Description *string `locationName:"description" type:"string"`

	// Specifies whether the ApiKey can be used by callers.
	Enabled *bool `locationName:"enabled" type:"boolean"`

	// Specifies whether (true) or not (false) the key identifier is distinct from
	// the created API key value.
	GenerateDistinctId *bool `locationName:"generateDistinctId" type:"boolean"`

	// The name of the ApiKey.
	Name *string `locationName:"name" type:"string"`

	// DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
	StageKeys []StageKey `locationName:"stageKeys" type:"list"`

	// Specifies a value of the API key.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Request to create an ApiKey resource.

func (CreateApiKeyInput) GoString 

func (s CreateApiKeyInput) GoString() string

GoString returns the string representation

func (*CreateApiKeyInput) SetCustomerId 

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

SetCustomerId sets the CustomerId field's value.

func (*CreateApiKeyInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateApiKeyInput) SetEnabled 

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

SetEnabled sets the Enabled field's value.

func (*CreateApiKeyInput) SetGenerateDistinctId 

func (s *CreateApiKeyInput) SetGenerateDistinctId(v bool) *CreateApiKeyInput

SetGenerateDistinctId sets the GenerateDistinctId field's value.

func (*CreateApiKeyInput) SetName 

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

SetName sets the Name field's value.

func (*CreateApiKeyInput) SetStageKeys 

func (s *CreateApiKeyInput) SetStageKeys(v []StageKey) *CreateApiKeyInput

SetStageKeys sets the StageKeys field's value.

func (*CreateApiKeyInput) SetValue 

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

SetValue sets the Value field's value.

func (CreateApiKeyInput) String 

func (s CreateApiKeyInput) String() string

String returns the string representation

type CreateApiKeyRequest 

type CreateApiKeyRequest struct {
	*aws.Request
	Input *CreateApiKeyInput
}

CreateApiKeyRequest is a API request type for the CreateApiKey API operation.

func (CreateApiKeyRequest) Send 

func (r CreateApiKeyRequest) Send() (*UpdateApiKeyOutput, error)

Send marshals and sends the CreateApiKey API request.

type CreateAuthorizerInput 

type CreateAuthorizerInput struct {

	// Optional customer-defined field, used in Swagger imports and exports without
	// functional impact.
	AuthType *string `locationName:"authType" type:"string"`

	// Specifies the required credentials as an IAM role for Amazon API Gateway
	// to invoke the authorizer. To specify an IAM role for Amazon API Gateway to
	// assume, use the role's Amazon Resource Name (ARN). To use resource-based
	// permissions on the Lambda function, specify null.
	AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"`

	// The TTL in seconds of cached authorizer results. If it equals 0, authorization
	// caching is disabled. If it is greater than 0, API Gateway will cache authorizer
	// responses. If this field is not set, the default value is 300. The maximum
	// value is 3600, or 1 hour.
	AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"`

	// Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or
	// REQUEST authorizers, this must be a well-formed Lambda function URI, for
	// example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.
	// In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api},
	// where {region} is the same as the region hosting the Lambda function, path
	// indicates that the remaining substring in the URI should be treated as the
	// path to the resource, including the initial /. For Lambda functions, this
	// is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
	AuthorizerUri *string `locationName:"authorizerUri" type:"string"`

	// The identity source for which authorization is requested. For a TOKEN authorizer,
	// this is required and specifies the request header mapping expression for
	// the custom header holding the authorization token submitted by the client.
	// For example, if the token header name is Auth, the header mapping expression
	// is method.request.header.Auth.
	// For the REQUEST authorizer, this is required when authorization caching is
	// enabled. The value is a comma-separated string of one or more mapping expressions
	// of the specified request parameters. For example, if an Auth header, a Name
	// query string parameter are defined as identity sources, this value is method.request.header.Auth,
	// method.request.querystring.Name. These parameters will be used to derive
	// the authorization caching key and to perform runtime validation of the REQUEST
	// authorizer by verifying all of the identity-related request parameters are
	// present, not null and non-empty. Only when this is true does the authorizer
	// invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized
	// response without calling the Lambda function. The valid value is a string
	// of comma-separated mapping expressions of the specified request parameters.
	// When the authorization caching is not enabled, this property is optional.
	//
	// For a COGNITO_USER_POOLS authorizer, this property is not used.
	IdentitySource *string `locationName:"identitySource" type:"string"`

	// A validation expression for the incoming identity token. For TOKEN authorizers,
	// this value is a regular expression. Amazon API Gateway will match the incoming
	// token from the client against the specified regular expression. It will invoke
	// the authorizer's Lambda function there is a match. Otherwise, it will return
	// a 401 Unauthorized response without calling the Lambda function. The validation
	// expression does not apply to the REQUEST authorizer.
	IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"`

	// [Required] The name of the authorizer.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
	// Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.
	// For a TOKEN or REQUEST authorizer, this is not defined.
	ProviderARNs []string `locationName:"providerARNs" type:"list"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// [Required] The authorizer type. Valid values are TOKEN for a Lambda function
	// using a single authorization token submitted in a custom header, REQUEST
	// for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS
	// for using an Amazon Cognito user pool.
	//
	// Type is a required field
	Type AuthorizerType `locationName:"type" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Request to add a new Authorizer to an existing RestApi resource.

func (CreateAuthorizerInput) GoString 

func (s CreateAuthorizerInput) GoString() string

GoString returns the string representation

func (*CreateAuthorizerInput) SetAuthType 

func (s *CreateAuthorizerInput) SetAuthType(v string) *CreateAuthorizerInput

SetAuthType sets the AuthType field's value.

func (*CreateAuthorizerInput) SetAuthorizerCredentials 

func (s *CreateAuthorizerInput) SetAuthorizerCredentials(v string) *CreateAuthorizerInput

SetAuthorizerCredentials sets the AuthorizerCredentials field's value.

func (*CreateAuthorizerInput) SetAuthorizerResultTtlInSeconds 

func (s *CreateAuthorizerInput) SetAuthorizerResultTtlInSeconds(v int64) *CreateAuthorizerInput

SetAuthorizerResultTtlInSeconds sets the AuthorizerResultTtlInSeconds field's value.

func (*CreateAuthorizerInput) SetAuthorizerUri 

func (s *CreateAuthorizerInput) SetAuthorizerUri(v string) *CreateAuthorizerInput

SetAuthorizerUri sets the AuthorizerUri field's value.

func (*CreateAuthorizerInput) SetIdentitySource 

func (s *CreateAuthorizerInput) SetIdentitySource(v string) *CreateAuthorizerInput

SetIdentitySource sets the IdentitySource field's value.

func (*CreateAuthorizerInput) SetIdentityValidationExpression 

func (s *CreateAuthorizerInput) SetIdentityValidationExpression(v string) *CreateAuthorizerInput

SetIdentityValidationExpression sets the IdentityValidationExpression field's value.

func (*CreateAuthorizerInput) SetName 

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

SetName sets the Name field's value.

func (*CreateAuthorizerInput) SetProviderARNs 

func (s *CreateAuthorizerInput) SetProviderARNs(v []string) *CreateAuthorizerInput

SetProviderARNs sets the ProviderARNs field's value.

func (*CreateAuthorizerInput) SetRestApiId 

func (s *CreateAuthorizerInput) SetRestApiId(v string) *CreateAuthorizerInput

SetRestApiId sets the RestApiId field's value.

func (*CreateAuthorizerInput) SetType 

func (s *CreateAuthorizerInput) SetType(v AuthorizerType) *CreateAuthorizerInput

SetType sets the Type field's value.

func (CreateAuthorizerInput) String 

func (s CreateAuthorizerInput) String() string

String returns the string representation

func (*CreateAuthorizerInput) Validate 

func (s *CreateAuthorizerInput) Validate() error

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

type CreateAuthorizerRequest 

type CreateAuthorizerRequest struct {
	*aws.Request
	Input *CreateAuthorizerInput
}

CreateAuthorizerRequest is a API request type for the CreateAuthorizer API operation.

func (CreateAuthorizerRequest) Send 

func (r CreateAuthorizerRequest) Send() (*UpdateAuthorizerOutput, error)

Send marshals and sends the CreateAuthorizer API request.

type CreateBasePathMappingInput 

type CreateBasePathMappingInput struct {

	// The base path name that callers of the API must provide as part of the URL
	// after the domain name. This value must be unique for all of the mappings
	// across a single API. Leave this blank if you do not want callers to specify
	// a base path name after the domain name.
	BasePath *string `locationName:"basePath" type:"string"`

	// The domain name of the BasePathMapping resource to create.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `locationName:"restApiId" type:"string" required:"true"`

	// The name of the API's stage that you want to use for this mapping. Leave
	// this blank if you do not want callers to explicitly specify the stage name
	// after any base path name.
	Stage *string `locationName:"stage" type:"string"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to create a new BasePathMapping resource.

func (CreateBasePathMappingInput) GoString 

func (s CreateBasePathMappingInput) GoString() string

GoString returns the string representation

func (*CreateBasePathMappingInput) SetBasePath 

func (s *CreateBasePathMappingInput) SetBasePath(v string) *CreateBasePathMappingInput

SetBasePath sets the BasePath field's value.

func (*CreateBasePathMappingInput) SetDomainName 

func (s *CreateBasePathMappingInput) SetDomainName(v string) *CreateBasePathMappingInput

SetDomainName sets the DomainName field's value.

func (*CreateBasePathMappingInput) SetRestApiId 

func (s *CreateBasePathMappingInput) SetRestApiId(v string) *CreateBasePathMappingInput

SetRestApiId sets the RestApiId field's value.

func (*CreateBasePathMappingInput) SetStage 

func (s *CreateBasePathMappingInput) SetStage(v string) *CreateBasePathMappingInput

SetStage sets the Stage field's value.

func (CreateBasePathMappingInput) String 

func (s CreateBasePathMappingInput) String() string

String returns the string representation

func (*CreateBasePathMappingInput) Validate 

func (s *CreateBasePathMappingInput) Validate() error

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

type CreateBasePathMappingRequest 

type CreateBasePathMappingRequest struct {
	*aws.Request
	Input *CreateBasePathMappingInput
}

CreateBasePathMappingRequest is a API request type for the CreateBasePathMapping API operation.

func (CreateBasePathMappingRequest) Send 

func (r CreateBasePathMappingRequest) Send() (*UpdateBasePathMappingOutput, error)

Send marshals and sends the CreateBasePathMapping API request.

type CreateDeploymentInput 

type CreateDeploymentInput struct {

	// Enables a cache cluster for the Stage resource specified in the input.
	CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"`

	// Specifies the cache cluster size for the Stage resource specified in the
	// input, if a cache cluster is enabled.
	CacheClusterSize CacheClusterSize `locationName:"cacheClusterSize" type:"string" enum:"true"`

	// The description for the Deployment resource to create.
	Description *string `locationName:"description" type:"string"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The description of the Stage resource for the Deployment resource to create.
	StageDescription *string `locationName:"stageDescription" type:"string"`

	// The name of the Stage resource for the Deployment resource to create.
	StageName *string `locationName:"stageName" type:"string"`

	// A map that defines the stage variables for the Stage resource that is associated
	// with the new deployment. Variable names can have alphanumeric and underscore
	// characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
	Variables map[string]string `locationName:"variables" type:"map"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to create a Deployment resource.

func (CreateDeploymentInput) GoString 

func (s CreateDeploymentInput) GoString() string

GoString returns the string representation

func (*CreateDeploymentInput) SetCacheClusterEnabled 

func (s *CreateDeploymentInput) SetCacheClusterEnabled(v bool) *CreateDeploymentInput

SetCacheClusterEnabled sets the CacheClusterEnabled field's value.

func (*CreateDeploymentInput) SetCacheClusterSize 

func (s *CreateDeploymentInput) SetCacheClusterSize(v CacheClusterSize) *CreateDeploymentInput

SetCacheClusterSize sets the CacheClusterSize field's value.

func (*CreateDeploymentInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateDeploymentInput) SetRestApiId 

func (s *CreateDeploymentInput) SetRestApiId(v string) *CreateDeploymentInput

SetRestApiId sets the RestApiId field's value.

func (*CreateDeploymentInput) SetStageDescription 

func (s *CreateDeploymentInput) SetStageDescription(v string) *CreateDeploymentInput

SetStageDescription sets the StageDescription field's value.

func (*CreateDeploymentInput) SetStageName 

func (s *CreateDeploymentInput) SetStageName(v string) *CreateDeploymentInput

SetStageName sets the StageName field's value.

func (*CreateDeploymentInput) SetVariables 

func (s *CreateDeploymentInput) SetVariables(v map[string]string) *CreateDeploymentInput

SetVariables sets the Variables field's value.

func (CreateDeploymentInput) String 

func (s CreateDeploymentInput) String() string

String returns the string representation

func (*CreateDeploymentInput) Validate 

func (s *CreateDeploymentInput) Validate() error

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

type CreateDeploymentRequest 

type CreateDeploymentRequest struct {
	*aws.Request
	Input *CreateDeploymentInput
}

CreateDeploymentRequest is a API request type for the CreateDeployment API operation.

func (CreateDeploymentRequest) Send 

func (r CreateDeploymentRequest) Send() (*UpdateDeploymentOutput, error)

Send marshals and sends the CreateDeployment API request.

type CreateDocumentationPartInput 

type CreateDocumentationPartInput struct {

	// [Required] The location of the targeted API entity of the to-be-created documentation
	// part.
	//
	// Location is a required field
	Location *DocumentationPartLocation `locationName:"location" type:"structure" required:"true"`

	// [Required] The new documentation content map of the targeted API entity.
	// Enclosed key-value pairs are API-specific, but only Swagger-compliant key-value
	// pairs can be exported and, hence, published.
	//
	// Properties is a required field
	Properties *string `locationName:"properties" type:"string" required:"true"`

	// [Required] The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Creates a new documentation part of a given API.

func (CreateDocumentationPartInput) GoString 

func (s CreateDocumentationPartInput) GoString() string

GoString returns the string representation

func (*CreateDocumentationPartInput) SetLocation 

func (s *CreateDocumentationPartInput) SetLocation(v *DocumentationPartLocation) *CreateDocumentationPartInput

SetLocation sets the Location field's value.

func (*CreateDocumentationPartInput) SetProperties 

func (s *CreateDocumentationPartInput) SetProperties(v string) *CreateDocumentationPartInput

SetProperties sets the Properties field's value.

func (*CreateDocumentationPartInput) SetRestApiId 

func (s *CreateDocumentationPartInput) SetRestApiId(v string) *CreateDocumentationPartInput

SetRestApiId sets the RestApiId field's value.

func (CreateDocumentationPartInput) String 

func (s CreateDocumentationPartInput) String() string

String returns the string representation

func (*CreateDocumentationPartInput) Validate 

func (s *CreateDocumentationPartInput) Validate() error

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

type CreateDocumentationPartRequest 

type CreateDocumentationPartRequest struct {
	*aws.Request
	Input *CreateDocumentationPartInput
}

CreateDocumentationPartRequest is a API request type for the CreateDocumentationPart API operation.

func (CreateDocumentationPartRequest) Send 

func (r CreateDocumentationPartRequest) Send() (*UpdateDocumentationPartOutput, error)

Send marshals and sends the CreateDocumentationPart API request.

type CreateDocumentationVersionInput 

type CreateDocumentationVersionInput struct {

	// A description about the new documentation snapshot.
	Description *string `locationName:"description" type:"string"`

	// [Required] The version identifier of the new snapshot.
	//
	// DocumentationVersion is a required field
	DocumentationVersion *string `locationName:"documentationVersion" type:"string" required:"true"`

	// [Required] The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The stage name to be associated with the new documentation snapshot.
	StageName *string `locationName:"stageName" type:"string"`
	// contains filtered or unexported fields
}

Creates a new documentation version of a given API.

func (CreateDocumentationVersionInput) GoString 

func (s CreateDocumentationVersionInput) GoString() string

GoString returns the string representation

func (*CreateDocumentationVersionInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateDocumentationVersionInput) SetDocumentationVersion 

func (s *CreateDocumentationVersionInput) SetDocumentationVersion(v string) *CreateDocumentationVersionInput

SetDocumentationVersion sets the DocumentationVersion field's value.

func (*CreateDocumentationVersionInput) SetRestApiId 

func (s *CreateDocumentationVersionInput) SetRestApiId(v string) *CreateDocumentationVersionInput

SetRestApiId sets the RestApiId field's value.

func (*CreateDocumentationVersionInput) SetStageName 

func (s *CreateDocumentationVersionInput) SetStageName(v string) *CreateDocumentationVersionInput

SetStageName sets the StageName field's value.

func (CreateDocumentationVersionInput) String 

func (s CreateDocumentationVersionInput) String() string

String returns the string representation

func (*CreateDocumentationVersionInput) Validate 

func (s *CreateDocumentationVersionInput) Validate() error

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

type CreateDocumentationVersionRequest 

type CreateDocumentationVersionRequest struct {
	*aws.Request
	Input *CreateDocumentationVersionInput
}

CreateDocumentationVersionRequest is a API request type for the CreateDocumentationVersion API operation.

func (CreateDocumentationVersionRequest) Send 

func (r CreateDocumentationVersionRequest) Send() (*UpdateDocumentationVersionOutput, error)

Send marshals and sends the CreateDocumentationVersion API request.

type CreateDomainNameInput 

type CreateDomainNameInput struct {

	// The reference to an AWS-managed certificate. AWS Certificate Manager is the
	// only supported source.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// [Deprecated] The body of the server certificate provided by your certificate
	// authority.
	CertificateBody *string `locationName:"certificateBody" type:"string"`

	// [Deprecated] The intermediate certificates and optionally the root certificate,
	// one after the other without any blank lines. If you include the root certificate,
	// your certificate chain must start with intermediate certificates and end
	// with the root certificate. Use the intermediate certificates that were provided
	// by your certificate authority. Do not include any intermediaries that are
	// not in the chain of trust path.
	CertificateChain *string `locationName:"certificateChain" type:"string"`

	// The user-friendly name of the certificate.
	CertificateName *string `locationName:"certificateName" type:"string"`

	// [Deprecated] Your certificate's private key.
	CertificatePrivateKey *string `locationName:"certificatePrivateKey" type:"string"`

	// (Required) The name of the DomainName resource.
	//
	// DomainName is a required field
	DomainName *string `locationName:"domainName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to create a new domain name.

func (CreateDomainNameInput) GoString 

func (s CreateDomainNameInput) GoString() string

GoString returns the string representation

func (*CreateDomainNameInput) SetCertificateArn 

func (s *CreateDomainNameInput) SetCertificateArn(v string) *CreateDomainNameInput

SetCertificateArn sets the CertificateArn field's value.

func (*CreateDomainNameInput) SetCertificateBody 

func (s *CreateDomainNameInput) SetCertificateBody(v string) *CreateDomainNameInput

SetCertificateBody sets the CertificateBody field's value.

func (*CreateDomainNameInput) SetCertificateChain 

func (s *CreateDomainNameInput) SetCertificateChain(v string) *CreateDomainNameInput

SetCertificateChain sets the CertificateChain field's value.

func (*CreateDomainNameInput) SetCertificateName 

func (s *CreateDomainNameInput) SetCertificateName(v string) *CreateDomainNameInput

SetCertificateName sets the CertificateName field's value.

func (*CreateDomainNameInput) SetCertificatePrivateKey 

func (s *CreateDomainNameInput) SetCertificatePrivateKey(v string) *CreateDomainNameInput

SetCertificatePrivateKey sets the CertificatePrivateKey field's value.

func (*CreateDomainNameInput) SetDomainName 

func (s *CreateDomainNameInput) SetDomainName(v string) *CreateDomainNameInput

SetDomainName sets the DomainName field's value.

func (CreateDomainNameInput) String 

func (s CreateDomainNameInput) String() string

String returns the string representation

func (*CreateDomainNameInput) Validate 

func (s *CreateDomainNameInput) Validate() error

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

type CreateDomainNameRequest 

type CreateDomainNameRequest struct {
	*aws.Request
	Input *CreateDomainNameInput
}

CreateDomainNameRequest is a API request type for the CreateDomainName API operation.

func (CreateDomainNameRequest) Send 

func (r CreateDomainNameRequest) Send() (*UpdateDomainNameOutput, error)

Send marshals and sends the CreateDomainName API request.

type CreateModelInput 

type CreateModelInput struct {

	// The content-type for the model.
	//
	// ContentType is a required field
	ContentType *string `locationName:"contentType" type:"string" required:"true"`

	// The description of the model.
	Description *string `locationName:"description" type:"string"`

	// The name of the model. Must be alphanumeric.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The RestApi identifier under which the Model will be created.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The schema for the model. For application/json models, this should be JSON-schema
	// draft v4 (http://json-schema.org/documentation.html) model.
	Schema *string `locationName:"schema" type:"string"`
	// contains filtered or unexported fields
}

Request to add a new Model to an existing RestApi resource.

func (CreateModelInput) GoString 

func (s CreateModelInput) GoString() string

GoString returns the string representation

func (*CreateModelInput) SetContentType 

func (s *CreateModelInput) SetContentType(v string) *CreateModelInput

SetContentType sets the ContentType field's value.

func (*CreateModelInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateModelInput) SetName 

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

SetName sets the Name field's value.

func (*CreateModelInput) SetRestApiId 

func (s *CreateModelInput) SetRestApiId(v string) *CreateModelInput

SetRestApiId sets the RestApiId field's value.

func (*CreateModelInput) SetSchema 

func (s *CreateModelInput) SetSchema(v string) *CreateModelInput

SetSchema sets the Schema field's value.

func (CreateModelInput) String 

func (s CreateModelInput) String() string

String returns the string representation

func (*CreateModelInput) Validate 

func (s *CreateModelInput) Validate() error

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

type CreateModelRequest 

type CreateModelRequest struct {
	*aws.Request
	Input *CreateModelInput
}

CreateModelRequest is a API request type for the CreateModel API operation.

func (CreateModelRequest) Send 

func (r CreateModelRequest) Send() (*UpdateModelOutput, error)

Send marshals and sends the CreateModel API request.

type CreateRequestValidatorInput 

type CreateRequestValidatorInput struct {

	// The name of the to-be-created RequestValidator.
	Name *string `locationName:"name" type:"string"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// A Boolean flag to indicate whether to validate request body according to
	// the configured model schema for the method (true) or not (false).
	ValidateRequestBody *bool `locationName:"validateRequestBody" type:"boolean"`

	// A Boolean flag to indicate whether to validate request parameters, true,
	// or not false.
	ValidateRequestParameters *bool `locationName:"validateRequestParameters" type:"boolean"`
	// contains filtered or unexported fields
}

Creates a RequestValidator of a given RestApi.

func (CreateRequestValidatorInput) GoString 

func (s CreateRequestValidatorInput) GoString() string

GoString returns the string representation

func (*CreateRequestValidatorInput) SetName 

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

SetName sets the Name field's value.

func (*CreateRequestValidatorInput) SetRestApiId 

func (s *CreateRequestValidatorInput) SetRestApiId(v string) *CreateRequestValidatorInput

SetRestApiId sets the RestApiId field's value.

func (*CreateRequestValidatorInput) SetValidateRequestBody 

func (s *CreateRequestValidatorInput) SetValidateRequestBody(v bool) *CreateRequestValidatorInput

SetValidateRequestBody sets the ValidateRequestBody field's value.

func (*CreateRequestValidatorInput) SetValidateRequestParameters 

func (s *CreateRequestValidatorInput) SetValidateRequestParameters(v bool) *CreateRequestValidatorInput

SetValidateRequestParameters sets the ValidateRequestParameters field's value.

func (CreateRequestValidatorInput) String 

func (s CreateRequestValidatorInput) String() string

String returns the string representation

func (*CreateRequestValidatorInput) Validate 

func (s *CreateRequestValidatorInput) Validate() error

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

type CreateRequestValidatorRequest 

type CreateRequestValidatorRequest struct {
	*aws.Request
	Input *CreateRequestValidatorInput
}

CreateRequestValidatorRequest is a API request type for the CreateRequestValidator API operation.

func (CreateRequestValidatorRequest) Send 

func (r CreateRequestValidatorRequest) Send() (*UpdateRequestValidatorOutput, error)

Send marshals and sends the CreateRequestValidator API request.

type CreateResourceInput 

type CreateResourceInput struct {

	// The parent resource's identifier.
	//
	// ParentId is a required field
	ParentId *string `location:"uri" locationName:"parent_id" type:"string" required:"true"`

	// The last path segment for this resource.
	//
	// PathPart is a required field
	PathPart *string `locationName:"pathPart" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to create a Resource resource.

func (CreateResourceInput) GoString 

func (s CreateResourceInput) GoString() string

GoString returns the string representation

func (*CreateResourceInput) SetParentId 

func (s *CreateResourceInput) SetParentId(v string) *CreateResourceInput

SetParentId sets the ParentId field's value.

func (*CreateResourceInput) SetPathPart 

func (s *CreateResourceInput) SetPathPart(v string) *CreateResourceInput

SetPathPart sets the PathPart field's value.

func (*CreateResourceInput) SetRestApiId 

func (s *CreateResourceInput) SetRestApiId(v string) *CreateResourceInput

SetRestApiId sets the RestApiId field's value.

func (CreateResourceInput) String 

func (s CreateResourceInput) String() string

String returns the string representation

func (*CreateResourceInput) Validate 

func (s *CreateResourceInput) Validate() error

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

type CreateResourceRequest 

type CreateResourceRequest struct {
	*aws.Request
	Input *CreateResourceInput
}

CreateResourceRequest is a API request type for the CreateResource API operation.

func (CreateResourceRequest) Send 

func (r CreateResourceRequest) Send() (*UpdateResourceOutput, error)

Send marshals and sends the CreateResource API request.

type CreateRestApiInput 

type CreateRestApiInput struct {

	// The list of binary media types supported by the RestApi. By default, the
	// RestApi supports only UTF-8-encoded text payloads.
	BinaryMediaTypes []string `locationName:"binaryMediaTypes" type:"list"`

	// The ID of the RestApi that you want to clone from.
	CloneFrom *string `locationName:"cloneFrom" type:"string"`

	// The description of the RestApi.
	Description *string `locationName:"description" type:"string"`

	// The name of the RestApi.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// A version identifier for the API.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

The POST Request to add a new RestApi resource to your collection.

func (CreateRestApiInput) GoString 

func (s CreateRestApiInput) GoString() string

GoString returns the string representation

func (*CreateRestApiInput) SetBinaryMediaTypes 

func (s *CreateRestApiInput) SetBinaryMediaTypes(v []string) *CreateRestApiInput

SetBinaryMediaTypes sets the BinaryMediaTypes field's value.

func (*CreateRestApiInput) SetCloneFrom 

func (s *CreateRestApiInput) SetCloneFrom(v string) *CreateRestApiInput

SetCloneFrom sets the CloneFrom field's value.

func (*CreateRestApiInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateRestApiInput) SetName 

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

SetName sets the Name field's value.

func (*CreateRestApiInput) SetVersion 

func (s *CreateRestApiInput) SetVersion(v string) *CreateRestApiInput

SetVersion sets the Version field's value.

func (CreateRestApiInput) String 

func (s CreateRestApiInput) String() string

String returns the string representation

func (*CreateRestApiInput) Validate 

func (s *CreateRestApiInput) Validate() error

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

type CreateRestApiRequest 

type CreateRestApiRequest struct {
	*aws.Request
	Input *CreateRestApiInput
}

CreateRestApiRequest is a API request type for the CreateRestApi API operation.

func (CreateRestApiRequest) Send 

func (r CreateRestApiRequest) Send() (*UpdateRestApiOutput, error)

Send marshals and sends the CreateRestApi API request.

type CreateStageInput 

type CreateStageInput struct {

	// Whether cache clustering is enabled for the stage.
	CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"`

	// The stage's cache cluster size.
	CacheClusterSize CacheClusterSize `locationName:"cacheClusterSize" type:"string" enum:"true"`

	// The identifier of the Deployment resource for the Stage resource.
	//
	// DeploymentId is a required field
	DeploymentId *string `locationName:"deploymentId" type:"string" required:"true"`

	// The description of the Stage resource.
	Description *string `locationName:"description" type:"string"`

	// The version of the associated API documentation.
	DocumentationVersion *string `locationName:"documentationVersion" type:"string"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The name for the Stage resource.
	//
	// StageName is a required field
	StageName *string `locationName:"stageName" type:"string" required:"true"`

	// A map that defines the stage variables for the new Stage resource. Variable
	// names can have alphanumeric and underscore characters, and the values must
	// match [A-Za-z0-9-._~:/?#&=,]+.
	Variables map[string]string `locationName:"variables" type:"map"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to create a Stage resource.

func (CreateStageInput) GoString 

func (s CreateStageInput) GoString() string

GoString returns the string representation

func (*CreateStageInput) SetCacheClusterEnabled 

func (s *CreateStageInput) SetCacheClusterEnabled(v bool) *CreateStageInput

SetCacheClusterEnabled sets the CacheClusterEnabled field's value.

func (*CreateStageInput) SetCacheClusterSize 

func (s *CreateStageInput) SetCacheClusterSize(v CacheClusterSize) *CreateStageInput

SetCacheClusterSize sets the CacheClusterSize field's value.

func (*CreateStageInput) SetDeploymentId 

func (s *CreateStageInput) SetDeploymentId(v string) *CreateStageInput

SetDeploymentId sets the DeploymentId field's value.

func (*CreateStageInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateStageInput) SetDocumentationVersion 

func (s *CreateStageInput) SetDocumentationVersion(v string) *CreateStageInput

SetDocumentationVersion sets the DocumentationVersion field's value.

func (*CreateStageInput) SetRestApiId 

func (s *CreateStageInput) SetRestApiId(v string) *CreateStageInput

SetRestApiId sets the RestApiId field's value.

func (*CreateStageInput) SetStageName 

func (s *CreateStageInput) SetStageName(v string) *CreateStageInput

SetStageName sets the StageName field's value.

func (*CreateStageInput) SetVariables 

func (s *CreateStageInput) SetVariables(v map[string]string) *CreateStageInput

SetVariables sets the Variables field's value.

func (CreateStageInput) String 

func (s CreateStageInput) String() string

String returns the string representation

func (*CreateStageInput) Validate 

func (s *CreateStageInput) Validate() error

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

type CreateStageRequest 

type CreateStageRequest struct {
	*aws.Request
	Input *CreateStageInput
}

CreateStageRequest is a API request type for the CreateStage API operation.

func (CreateStageRequest) Send 

func (r CreateStageRequest) Send() (*UpdateStageOutput, error)

Send marshals and sends the CreateStage API request.

type CreateUsagePlanInput 

type CreateUsagePlanInput struct {

	// The associated API stages of the usage plan.
	ApiStages []ApiStage `locationName:"apiStages" type:"list"`

	// The description of the usage plan.
	Description *string `locationName:"description" type:"string"`

	// The name of the usage plan.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The quota of the usage plan.
	Quota *QuotaSettings `locationName:"quota" type:"structure"`

	// The throttling limits of the usage plan.
	Throttle *ThrottleSettings `locationName:"throttle" type:"structure"`
	// contains filtered or unexported fields
}

The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

func (CreateUsagePlanInput) GoString 

func (s CreateUsagePlanInput) GoString() string

GoString returns the string representation

func (*CreateUsagePlanInput) SetApiStages 

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

SetApiStages sets the ApiStages field's value.

func (*CreateUsagePlanInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateUsagePlanInput) SetName 

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

SetName sets the Name field's value.

func (*CreateUsagePlanInput) SetQuota 

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

SetQuota sets the Quota field's value.

func (*CreateUsagePlanInput) SetThrottle 

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

SetThrottle sets the Throttle field's value.

func (CreateUsagePlanInput) String 

func (s CreateUsagePlanInput) String() string

String returns the string representation

func (*CreateUsagePlanInput) Validate 

func (s *CreateUsagePlanInput) Validate() error

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

type CreateUsagePlanKeyInput 

type CreateUsagePlanKeyInput struct {

	// The identifier of a UsagePlanKey resource for a plan customer.
	//
	// KeyId is a required field
	KeyId *string `locationName:"keyId" type:"string" required:"true"`

	// The type of a UsagePlanKey resource for a plan customer.
	//
	// KeyType is a required field
	KeyType *string `locationName:"keyType" type:"string" required:"true"`

	// The Id of the UsagePlan resource representing the usage plan containing the
	// to-be-created UsagePlanKey resource representing a plan customer.
	//
	// UsagePlanId is a required field
	UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The POST request to create a usage plan key for adding an existing API key to a usage plan.

func (CreateUsagePlanKeyInput) GoString 

func (s CreateUsagePlanKeyInput) GoString() string

GoString returns the string representation

func (*CreateUsagePlanKeyInput) SetKeyId 

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

SetKeyId sets the KeyId field's value.

func (*CreateUsagePlanKeyInput) SetKeyType 

func (s *CreateUsagePlanKeyInput) SetKeyType(v string) *CreateUsagePlanKeyInput

SetKeyType sets the KeyType field's value.

func (*CreateUsagePlanKeyInput) SetUsagePlanId 

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

SetUsagePlanId sets the UsagePlanId field's value.

func (CreateUsagePlanKeyInput) String 

func (s CreateUsagePlanKeyInput) String() string

String returns the string representation

func (*CreateUsagePlanKeyInput) Validate 

func (s *CreateUsagePlanKeyInput) Validate() error

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

type CreateUsagePlanKeyRequest 

type CreateUsagePlanKeyRequest struct {
	*aws.Request
	Input *CreateUsagePlanKeyInput
}

CreateUsagePlanKeyRequest is a API request type for the CreateUsagePlanKey API operation.

func (CreateUsagePlanKeyRequest) Send 

func (r CreateUsagePlanKeyRequest) Send() (*GetUsagePlanKeyOutput, error)

Send marshals and sends the CreateUsagePlanKey API request.

type CreateUsagePlanRequest 

type CreateUsagePlanRequest struct {
	*aws.Request
	Input *CreateUsagePlanInput
}

CreateUsagePlanRequest is a API request type for the CreateUsagePlan API operation.

func (CreateUsagePlanRequest) Send 

func (r CreateUsagePlanRequest) Send() (*UpdateUsagePlanOutput, error)

Send marshals and sends the CreateUsagePlan API request.

type DeleteApiKeyInput 

type DeleteApiKeyInput struct {

	// The identifier of the ApiKey resource to be deleted.
	//
	// ApiKey is a required field
	ApiKey *string `location:"uri" locationName:"api_Key" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to delete the ApiKey resource.

func (DeleteApiKeyInput) GoString 

func (s DeleteApiKeyInput) GoString() string

GoString returns the string representation

func (*DeleteApiKeyInput) SetApiKey 

func (s *DeleteApiKeyInput) SetApiKey(v string) *DeleteApiKeyInput

SetApiKey sets the ApiKey field's value.

func (DeleteApiKeyInput) String 

func (s DeleteApiKeyInput) String() string

String returns the string representation

func (*DeleteApiKeyInput) Validate 

func (s *DeleteApiKeyInput) Validate() error

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

type DeleteApiKeyOutput 

type DeleteApiKeyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteApiKeyOutput) GoString 

func (s DeleteApiKeyOutput) GoString() string

GoString returns the string representation

func (DeleteApiKeyOutput) SDKResponseMetadata 

func (s DeleteApiKeyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteApiKeyOutput) String 

func (s DeleteApiKeyOutput) String() string

String returns the string representation

type DeleteApiKeyRequest 

type DeleteApiKeyRequest struct {
	*aws.Request
	Input *DeleteApiKeyInput
}

DeleteApiKeyRequest is a API request type for the DeleteApiKey API operation.

func (DeleteApiKeyRequest) Send 

func (r DeleteApiKeyRequest) Send() (*DeleteApiKeyOutput, error)

Send marshals and sends the DeleteApiKey API request.

type DeleteAuthorizerInput 

type DeleteAuthorizerInput struct {

	// The identifier of the Authorizer resource.
	//
	// AuthorizerId is a required field
	AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to delete an existing Authorizer resource.

func (DeleteAuthorizerInput) GoString 

func (s DeleteAuthorizerInput) GoString() string

GoString returns the string representation

func (*DeleteAuthorizerInput) SetAuthorizerId 

func (s *DeleteAuthorizerInput) SetAuthorizerId(v string) *DeleteAuthorizerInput

SetAuthorizerId sets the AuthorizerId field's value.

func (*DeleteAuthorizerInput) SetRestApiId 

func (s *DeleteAuthorizerInput) SetRestApiId(v string) *DeleteAuthorizerInput

SetRestApiId sets the RestApiId field's value.

func (DeleteAuthorizerInput) String 

func (s DeleteAuthorizerInput) String() string

String returns the string representation

func (*DeleteAuthorizerInput) Validate 

func (s *DeleteAuthorizerInput) Validate() error

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

type DeleteAuthorizerOutput 

type DeleteAuthorizerOutput struct {
	// contains filtered or unexported fields
}

func (DeleteAuthorizerOutput) GoString 

func (s DeleteAuthorizerOutput) GoString() string

GoString returns the string representation

func (DeleteAuthorizerOutput) SDKResponseMetadata 

func (s DeleteAuthorizerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteAuthorizerOutput) String 

func (s DeleteAuthorizerOutput) String() string

String returns the string representation

type DeleteAuthorizerRequest 

type DeleteAuthorizerRequest struct {
	*aws.Request
	Input *DeleteAuthorizerInput
}

DeleteAuthorizerRequest is a API request type for the DeleteAuthorizer API operation.

func (DeleteAuthorizerRequest) Send 

func (r DeleteAuthorizerRequest) Send() (*DeleteAuthorizerOutput, error)

Send marshals and sends the DeleteAuthorizer API request.

type DeleteBasePathMappingInput 

type DeleteBasePathMappingInput struct {

	// The base path name of the BasePathMapping resource to delete.
	//
	// BasePath is a required field
	BasePath *string `location:"uri" locationName:"base_path" type:"string" required:"true"`

	// The domain name of the BasePathMapping resource to delete.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to delete the BasePathMapping resource.

func (DeleteBasePathMappingInput) GoString 

func (s DeleteBasePathMappingInput) GoString() string

GoString returns the string representation

func (*DeleteBasePathMappingInput) SetBasePath 

func (s *DeleteBasePathMappingInput) SetBasePath(v string) *DeleteBasePathMappingInput

SetBasePath sets the BasePath field's value.

func (*DeleteBasePathMappingInput) SetDomainName 

func (s *DeleteBasePathMappingInput) SetDomainName(v string) *DeleteBasePathMappingInput

SetDomainName sets the DomainName field's value.

func (DeleteBasePathMappingInput) String 

func (s DeleteBasePathMappingInput) String() string

String returns the string representation

func (*DeleteBasePathMappingInput) Validate 

func (s *DeleteBasePathMappingInput) Validate() error

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

type DeleteBasePathMappingOutput 

type DeleteBasePathMappingOutput struct {
	// contains filtered or unexported fields
}

func (DeleteBasePathMappingOutput) GoString 

func (s DeleteBasePathMappingOutput) GoString() string

GoString returns the string representation

func (DeleteBasePathMappingOutput) SDKResponseMetadata 

func (s DeleteBasePathMappingOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteBasePathMappingOutput) String 

func (s DeleteBasePathMappingOutput) String() string

String returns the string representation

type DeleteBasePathMappingRequest 

type DeleteBasePathMappingRequest struct {
	*aws.Request
	Input *DeleteBasePathMappingInput
}

DeleteBasePathMappingRequest is a API request type for the DeleteBasePathMapping API operation.

func (DeleteBasePathMappingRequest) Send 

func (r DeleteBasePathMappingRequest) Send() (*DeleteBasePathMappingOutput, error)

Send marshals and sends the DeleteBasePathMapping API request.

type DeleteClientCertificateInput 

type DeleteClientCertificateInput struct {

	// The identifier of the ClientCertificate resource to be deleted.
	//
	// ClientCertificateId is a required field
	ClientCertificateId *string `location:"uri" locationName:"clientcertificate_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to delete the ClientCertificate resource.

func (DeleteClientCertificateInput) GoString 

func (s DeleteClientCertificateInput) GoString() string

GoString returns the string representation

func (*DeleteClientCertificateInput) SetClientCertificateId 

func (s *DeleteClientCertificateInput) SetClientCertificateId(v string) *DeleteClientCertificateInput

SetClientCertificateId sets the ClientCertificateId field's value.

func (DeleteClientCertificateInput) String 

func (s DeleteClientCertificateInput) String() string

String returns the string representation

func (*DeleteClientCertificateInput) Validate 

func (s *DeleteClientCertificateInput) Validate() error

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

type DeleteClientCertificateOutput 

type DeleteClientCertificateOutput struct {
	// contains filtered or unexported fields
}

func (DeleteClientCertificateOutput) GoString 

func (s DeleteClientCertificateOutput) GoString() string

GoString returns the string representation

func (DeleteClientCertificateOutput) SDKResponseMetadata 

func (s DeleteClientCertificateOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteClientCertificateOutput) String 

func (s DeleteClientCertificateOutput) String() string

String returns the string representation

type DeleteClientCertificateRequest 

type DeleteClientCertificateRequest struct {
	*aws.Request
	Input *DeleteClientCertificateInput
}

DeleteClientCertificateRequest is a API request type for the DeleteClientCertificate API operation.

func (DeleteClientCertificateRequest) Send 

func (r DeleteClientCertificateRequest) Send() (*DeleteClientCertificateOutput, error)

Send marshals and sends the DeleteClientCertificate API request.

type DeleteDeploymentInput 

type DeleteDeploymentInput struct {

	// The identifier of the Deployment resource to delete.
	//
	// DeploymentId is a required field
	DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to delete a Deployment resource.

func (DeleteDeploymentInput) GoString 

func (s DeleteDeploymentInput) GoString() string

GoString returns the string representation

func (*DeleteDeploymentInput) SetDeploymentId 

func (s *DeleteDeploymentInput) SetDeploymentId(v string) *DeleteDeploymentInput

SetDeploymentId sets the DeploymentId field's value.

func (*DeleteDeploymentInput) SetRestApiId 

func (s *DeleteDeploymentInput) SetRestApiId(v string) *DeleteDeploymentInput

SetRestApiId sets the RestApiId field's value.

func (DeleteDeploymentInput) String 

func (s DeleteDeploymentInput) String() string

String returns the string representation

func (*DeleteDeploymentInput) Validate 

func (s *DeleteDeploymentInput) Validate() error

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

type DeleteDeploymentOutput 

type DeleteDeploymentOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDeploymentOutput) GoString 

func (s DeleteDeploymentOutput) GoString() string

GoString returns the string representation

func (DeleteDeploymentOutput) SDKResponseMetadata 

func (s DeleteDeploymentOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteDeploymentOutput) String 

func (s DeleteDeploymentOutput) String() string

String returns the string representation

type DeleteDeploymentRequest 

type DeleteDeploymentRequest struct {
	*aws.Request
	Input *DeleteDeploymentInput
}

DeleteDeploymentRequest is a API request type for the DeleteDeployment API operation.

func (DeleteDeploymentRequest) Send 

func (r DeleteDeploymentRequest) Send() (*DeleteDeploymentOutput, error)

Send marshals and sends the DeleteDeployment API request.

type DeleteDocumentationPartInput 

type DeleteDocumentationPartInput struct {

	// [Required] The identifier of the to-be-deleted documentation part.
	//
	// DocumentationPartId is a required field
	DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"`

	// [Required] The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Deletes an existing documentation part of an API.

func (DeleteDocumentationPartInput) GoString 

func (s DeleteDocumentationPartInput) GoString() string

GoString returns the string representation

func (*DeleteDocumentationPartInput) SetDocumentationPartId 

func (s *DeleteDocumentationPartInput) SetDocumentationPartId(v string) *DeleteDocumentationPartInput

SetDocumentationPartId sets the DocumentationPartId field's value.

func (*DeleteDocumentationPartInput) SetRestApiId 

func (s *DeleteDocumentationPartInput) SetRestApiId(v string) *DeleteDocumentationPartInput

SetRestApiId sets the RestApiId field's value.

func (DeleteDocumentationPartInput) String 

func (s DeleteDocumentationPartInput) String() string

String returns the string representation

func (*DeleteDocumentationPartInput) Validate 

func (s *DeleteDocumentationPartInput) Validate() error

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

type DeleteDocumentationPartOutput 

type DeleteDocumentationPartOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDocumentationPartOutput) GoString 

func (s DeleteDocumentationPartOutput) GoString() string

GoString returns the string representation

func (DeleteDocumentationPartOutput) SDKResponseMetadata 

func (s DeleteDocumentationPartOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteDocumentationPartOutput) String 

func (s DeleteDocumentationPartOutput) String() string

String returns the string representation

type DeleteDocumentationPartRequest 

type DeleteDocumentationPartRequest struct {
	*aws.Request
	Input *DeleteDocumentationPartInput
}

DeleteDocumentationPartRequest is a API request type for the DeleteDocumentationPart API operation.

func (DeleteDocumentationPartRequest) Send 

func (r DeleteDocumentationPartRequest) Send() (*DeleteDocumentationPartOutput, error)

Send marshals and sends the DeleteDocumentationPart API request.

type DeleteDocumentationVersionInput 

type DeleteDocumentationVersionInput struct {

	// [Required] The version identifier of a to-be-deleted documentation snapshot.
	//
	// DocumentationVersion is a required field
	DocumentationVersion *string `location:"uri" locationName:"doc_version" type:"string" required:"true"`

	// [Required] The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Deletes an existing documentation version of an API.

func (DeleteDocumentationVersionInput) GoString 

func (s DeleteDocumentationVersionInput) GoString() string

GoString returns the string representation

func (*DeleteDocumentationVersionInput) SetDocumentationVersion 

func (s *DeleteDocumentationVersionInput) SetDocumentationVersion(v string) *DeleteDocumentationVersionInput

SetDocumentationVersion sets the DocumentationVersion field's value.

func (*DeleteDocumentationVersionInput) SetRestApiId 

func (s *DeleteDocumentationVersionInput) SetRestApiId(v string) *DeleteDocumentationVersionInput

SetRestApiId sets the RestApiId field's value.

func (DeleteDocumentationVersionInput) String 

func (s DeleteDocumentationVersionInput) String() string

String returns the string representation

func (*DeleteDocumentationVersionInput) Validate 

func (s *DeleteDocumentationVersionInput) Validate() error

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

type DeleteDocumentationVersionOutput 

type DeleteDocumentationVersionOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDocumentationVersionOutput) GoString 

func (s DeleteDocumentationVersionOutput) GoString() string

GoString returns the string representation

func (DeleteDocumentationVersionOutput) SDKResponseMetadata 

func (s DeleteDocumentationVersionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteDocumentationVersionOutput) String 

func (s DeleteDocumentationVersionOutput) String() string

String returns the string representation

type DeleteDocumentationVersionRequest 

type DeleteDocumentationVersionRequest struct {
	*aws.Request
	Input *DeleteDocumentationVersionInput
}

DeleteDocumentationVersionRequest is a API request type for the DeleteDocumentationVersion API operation.

func (DeleteDocumentationVersionRequest) Send 

func (r DeleteDocumentationVersionRequest) Send() (*DeleteDocumentationVersionOutput, error)

Send marshals and sends the DeleteDocumentationVersion API request.

type DeleteDomainNameInput 

type DeleteDomainNameInput struct {

	// The name of the DomainName resource to be deleted.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to delete the DomainName resource.

func (DeleteDomainNameInput) GoString 

func (s DeleteDomainNameInput) GoString() string

GoString returns the string representation

func (*DeleteDomainNameInput) SetDomainName 

func (s *DeleteDomainNameInput) SetDomainName(v string) *DeleteDomainNameInput

SetDomainName sets the DomainName field's value.

func (DeleteDomainNameInput) String 

func (s DeleteDomainNameInput) String() string

String returns the string representation

func (*DeleteDomainNameInput) Validate 

func (s *DeleteDomainNameInput) Validate() error

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

type DeleteDomainNameOutput 

type DeleteDomainNameOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDomainNameOutput) GoString 

func (s DeleteDomainNameOutput) GoString() string

GoString returns the string representation

func (DeleteDomainNameOutput) SDKResponseMetadata 

func (s DeleteDomainNameOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteDomainNameOutput) String 

func (s DeleteDomainNameOutput) String() string

String returns the string representation

type DeleteDomainNameRequest 

type DeleteDomainNameRequest struct {
	*aws.Request
	Input *DeleteDomainNameInput
}

DeleteDomainNameRequest is a API request type for the DeleteDomainName API operation.

func (DeleteDomainNameRequest) Send 

func (r DeleteDomainNameRequest) Send() (*DeleteDomainNameOutput, error)

Send marshals and sends the DeleteDomainName API request.

type DeleteGatewayResponseInput 

type DeleteGatewayResponseInput struct {

	// The response type of the associated GatewayResponse. Valid values are ACCESS_DENIED
	//
	// API_CONFIGURATION_ERROR
	// AUTHORIZER_FAILURE
	//  AUTHORIZER_CONFIGURATION_ERROR
	// BAD_REQUEST_PARAMETERS
	// BAD_REQUEST_BODY
	// DEFAULT_4XX
	// DEFAULT_5XX
	// EXPIRED_TOKEN
	// INVALID_SIGNATURE
	// INTEGRATION_FAILURE
	// INTEGRATION_TIMEOUT
	// INVALID_API_KEY
	// MISSING_AUTHENTICATION_TOKEN
	//  QUOTA_EXCEEDED
	// REQUEST_TOO_LARGE
	// RESOURCE_NOT_FOUND
	// THROTTLED
	// UNAUTHORIZED
	// UNSUPPORTED_MEDIA_TYPES
	//
	// ResponseType is a required field
	ResponseType GatewayResponseType `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

func (DeleteGatewayResponseInput) GoString 

func (s DeleteGatewayResponseInput) GoString() string

GoString returns the string representation

func (*DeleteGatewayResponseInput) SetResponseType 

func (s *DeleteGatewayResponseInput) SetResponseType(v GatewayResponseType) *DeleteGatewayResponseInput

SetResponseType sets the ResponseType field's value.

func (*DeleteGatewayResponseInput) SetRestApiId 

func (s *DeleteGatewayResponseInput) SetRestApiId(v string) *DeleteGatewayResponseInput

SetRestApiId sets the RestApiId field's value.

func (DeleteGatewayResponseInput) String 

func (s DeleteGatewayResponseInput) String() string

String returns the string representation

func (*DeleteGatewayResponseInput) Validate 

func (s *DeleteGatewayResponseInput) Validate() error

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

type DeleteGatewayResponseOutput 

type DeleteGatewayResponseOutput struct {
	// contains filtered or unexported fields
}

func (DeleteGatewayResponseOutput) GoString 

func (s DeleteGatewayResponseOutput) GoString() string

GoString returns the string representation

func (DeleteGatewayResponseOutput) SDKResponseMetadata 

func (s DeleteGatewayResponseOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteGatewayResponseOutput) String 

func (s DeleteGatewayResponseOutput) String() string

String returns the string representation

type DeleteGatewayResponseRequest 

type DeleteGatewayResponseRequest struct {
	*aws.Request
	Input *DeleteGatewayResponseInput
}

DeleteGatewayResponseRequest is a API request type for the DeleteGatewayResponse API operation.

func (DeleteGatewayResponseRequest) Send 

func (r DeleteGatewayResponseRequest) Send() (*DeleteGatewayResponseOutput, error)

Send marshals and sends the DeleteGatewayResponse API request.

type DeleteIntegrationInput 

type DeleteIntegrationInput struct {

	// Specifies a delete integration request's HTTP method.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// Specifies a delete integration request's resource identifier.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a delete integration request.

func (DeleteIntegrationInput) GoString 

func (s DeleteIntegrationInput) GoString() string

GoString returns the string representation

func (*DeleteIntegrationInput) SetHttpMethod 

func (s *DeleteIntegrationInput) SetHttpMethod(v string) *DeleteIntegrationInput

SetHttpMethod sets the HttpMethod field's value.

func (*DeleteIntegrationInput) SetResourceId 

func (s *DeleteIntegrationInput) SetResourceId(v string) *DeleteIntegrationInput

SetResourceId sets the ResourceId field's value.

func (*DeleteIntegrationInput) SetRestApiId 

func (s *DeleteIntegrationInput) SetRestApiId(v string) *DeleteIntegrationInput

SetRestApiId sets the RestApiId field's value.

func (DeleteIntegrationInput) String 

func (s DeleteIntegrationInput) String() string

String returns the string representation

func (*DeleteIntegrationInput) Validate 

func (s *DeleteIntegrationInput) Validate() error

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

type DeleteIntegrationOutput 

type DeleteIntegrationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteIntegrationOutput) GoString 

func (s DeleteIntegrationOutput) GoString() string

GoString returns the string representation

func (DeleteIntegrationOutput) SDKResponseMetadata 

func (s DeleteIntegrationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteIntegrationOutput) String 

func (s DeleteIntegrationOutput) String() string

String returns the string representation

type DeleteIntegrationRequest 

type DeleteIntegrationRequest struct {
	*aws.Request
	Input *DeleteIntegrationInput
}

DeleteIntegrationRequest is a API request type for the DeleteIntegration API operation.

func (DeleteIntegrationRequest) Send 

func (r DeleteIntegrationRequest) Send() (*DeleteIntegrationOutput, error)

Send marshals and sends the DeleteIntegration API request.

type DeleteIntegrationResponseInput 

type DeleteIntegrationResponseInput struct {

	// Specifies a delete integration response request's HTTP method.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// Specifies a delete integration response request's resource identifier.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// Specifies a delete integration response request's status code.
	//
	// StatusCode is a required field
	StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a delete integration response request.

func (DeleteIntegrationResponseInput) GoString 

func (s DeleteIntegrationResponseInput) GoString() string

GoString returns the string representation

func (*DeleteIntegrationResponseInput) SetHttpMethod 

func (s *DeleteIntegrationResponseInput) SetHttpMethod(v string) *DeleteIntegrationResponseInput

SetHttpMethod sets the HttpMethod field's value.

func (*DeleteIntegrationResponseInput) SetResourceId 

func (s *DeleteIntegrationResponseInput) SetResourceId(v string) *DeleteIntegrationResponseInput

SetResourceId sets the ResourceId field's value.

func (*DeleteIntegrationResponseInput) SetRestApiId 

func (s *DeleteIntegrationResponseInput) SetRestApiId(v string) *DeleteIntegrationResponseInput

SetRestApiId sets the RestApiId field's value.

func (*DeleteIntegrationResponseInput) SetStatusCode 

func (s *DeleteIntegrationResponseInput) SetStatusCode(v string) *DeleteIntegrationResponseInput

SetStatusCode sets the StatusCode field's value.

func (DeleteIntegrationResponseInput) String 

func (s DeleteIntegrationResponseInput) String() string

String returns the string representation

func (*DeleteIntegrationResponseInput) Validate 

func (s *DeleteIntegrationResponseInput) Validate() error

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

type DeleteIntegrationResponseOutput 

type DeleteIntegrationResponseOutput struct {
	// contains filtered or unexported fields
}

func (DeleteIntegrationResponseOutput) GoString 

func (s DeleteIntegrationResponseOutput) GoString() string

GoString returns the string representation

func (DeleteIntegrationResponseOutput) SDKResponseMetadata 

func (s DeleteIntegrationResponseOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteIntegrationResponseOutput) String 

func (s DeleteIntegrationResponseOutput) String() string

String returns the string representation

type DeleteIntegrationResponseRequest 

type DeleteIntegrationResponseRequest struct {
	*aws.Request
	Input *DeleteIntegrationResponseInput
}

DeleteIntegrationResponseRequest is a API request type for the DeleteIntegrationResponse API operation.

func (DeleteIntegrationResponseRequest) Send 

func (r DeleteIntegrationResponseRequest) Send() (*DeleteIntegrationResponseOutput, error)

Send marshals and sends the DeleteIntegrationResponse API request.

type DeleteMethodInput 

type DeleteMethodInput struct {

	// The HTTP verb of the Method resource.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// The Resource identifier for the Method resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to delete an existing Method resource.

func (DeleteMethodInput) GoString 

func (s DeleteMethodInput) GoString() string

GoString returns the string representation

func (*DeleteMethodInput) SetHttpMethod 

func (s *DeleteMethodInput) SetHttpMethod(v string) *DeleteMethodInput

SetHttpMethod sets the HttpMethod field's value.

func (*DeleteMethodInput) SetResourceId 

func (s *DeleteMethodInput) SetResourceId(v string) *DeleteMethodInput

SetResourceId sets the ResourceId field's value.

func (*DeleteMethodInput) SetRestApiId 

func (s *DeleteMethodInput) SetRestApiId(v string) *DeleteMethodInput

SetRestApiId sets the RestApiId field's value.

func (DeleteMethodInput) String 

func (s DeleteMethodInput) String() string

String returns the string representation

func (*DeleteMethodInput) Validate 

func (s *DeleteMethodInput) Validate() error

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

type DeleteMethodOutput 

type DeleteMethodOutput struct {
	// contains filtered or unexported fields
}

func (DeleteMethodOutput) GoString 

func (s DeleteMethodOutput) GoString() string

GoString returns the string representation

func (DeleteMethodOutput) SDKResponseMetadata 

func (s DeleteMethodOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteMethodOutput) String 

func (s DeleteMethodOutput) String() string

String returns the string representation

type DeleteMethodRequest 

type DeleteMethodRequest struct {
	*aws.Request
	Input *DeleteMethodInput
}

DeleteMethodRequest is a API request type for the DeleteMethod API operation.

func (DeleteMethodRequest) Send 

func (r DeleteMethodRequest) Send() (*DeleteMethodOutput, error)

Send marshals and sends the DeleteMethod API request.

type DeleteMethodResponseInput 

type DeleteMethodResponseInput struct {

	// The HTTP verb of the Method resource.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// The Resource identifier for the MethodResponse resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The status code identifier for the MethodResponse resource.
	//
	// StatusCode is a required field
	StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to delete an existing MethodResponse resource.

func (DeleteMethodResponseInput) GoString 

func (s DeleteMethodResponseInput) GoString() string

GoString returns the string representation

func (*DeleteMethodResponseInput) SetHttpMethod 

func (s *DeleteMethodResponseInput) SetHttpMethod(v string) *DeleteMethodResponseInput

SetHttpMethod sets the HttpMethod field's value.

func (*DeleteMethodResponseInput) SetResourceId 

func (s *DeleteMethodResponseInput) SetResourceId(v string) *DeleteMethodResponseInput

SetResourceId sets the ResourceId field's value.

func (*DeleteMethodResponseInput) SetRestApiId 

func (s *DeleteMethodResponseInput) SetRestApiId(v string) *DeleteMethodResponseInput

SetRestApiId sets the RestApiId field's value.

func (*DeleteMethodResponseInput) SetStatusCode 

func (s *DeleteMethodResponseInput) SetStatusCode(v string) *DeleteMethodResponseInput

SetStatusCode sets the StatusCode field's value.

func (DeleteMethodResponseInput) String 

func (s DeleteMethodResponseInput) String() string

String returns the string representation

func (*DeleteMethodResponseInput) Validate 

func (s *DeleteMethodResponseInput) Validate() error

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

type DeleteMethodResponseOutput 

type DeleteMethodResponseOutput struct {
	// contains filtered or unexported fields
}

func (DeleteMethodResponseOutput) GoString 

func (s DeleteMethodResponseOutput) GoString() string

GoString returns the string representation

func (DeleteMethodResponseOutput) SDKResponseMetadata 

func (s DeleteMethodResponseOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteMethodResponseOutput) String 

func (s DeleteMethodResponseOutput) String() string

String returns the string representation

type DeleteMethodResponseRequest 

type DeleteMethodResponseRequest struct {
	*aws.Request
	Input *DeleteMethodResponseInput
}

DeleteMethodResponseRequest is a API request type for the DeleteMethodResponse API operation.

func (DeleteMethodResponseRequest) Send 

func (r DeleteMethodResponseRequest) Send() (*DeleteMethodResponseOutput, error)

Send marshals and sends the DeleteMethodResponse API request.

type DeleteModelInput 

type DeleteModelInput struct {

	// The name of the model to delete.
	//
	// ModelName is a required field
	ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to delete an existing model in an existing RestApi resource.

func (DeleteModelInput) GoString 

func (s DeleteModelInput) GoString() string

GoString returns the string representation

func (*DeleteModelInput) SetModelName 

func (s *DeleteModelInput) SetModelName(v string) *DeleteModelInput

SetModelName sets the ModelName field's value.

func (*DeleteModelInput) SetRestApiId 

func (s *DeleteModelInput) SetRestApiId(v string) *DeleteModelInput

SetRestApiId sets the RestApiId field's value.

func (DeleteModelInput) String 

func (s DeleteModelInput) String() string

String returns the string representation

func (*DeleteModelInput) Validate 

func (s *DeleteModelInput) Validate() error

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

type DeleteModelOutput 

type DeleteModelOutput struct {
	// contains filtered or unexported fields
}

func (DeleteModelOutput) GoString 

func (s DeleteModelOutput) GoString() string

GoString returns the string representation

func (DeleteModelOutput) SDKResponseMetadata 

func (s DeleteModelOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteModelOutput) String 

func (s DeleteModelOutput) String() string

String returns the string representation

type DeleteModelRequest 

type DeleteModelRequest struct {
	*aws.Request
	Input *DeleteModelInput
}

DeleteModelRequest is a API request type for the DeleteModel API operation.

func (DeleteModelRequest) Send 

func (r DeleteModelRequest) Send() (*DeleteModelOutput, error)

Send marshals and sends the DeleteModel API request.

type DeleteRequestValidatorInput 

type DeleteRequestValidatorInput struct {

	// [Required] The identifier of the RequestValidator to be deleted.
	//
	// RequestValidatorId is a required field
	RequestValidatorId *string `location:"uri" locationName:"requestvalidator_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Deletes a specified RequestValidator of a given RestApi.

func (DeleteRequestValidatorInput) GoString 

func (s DeleteRequestValidatorInput) GoString() string

GoString returns the string representation

func (*DeleteRequestValidatorInput) SetRequestValidatorId 

func (s *DeleteRequestValidatorInput) SetRequestValidatorId(v string) *DeleteRequestValidatorInput

SetRequestValidatorId sets the RequestValidatorId field's value.

func (*DeleteRequestValidatorInput) SetRestApiId 

func (s *DeleteRequestValidatorInput) SetRestApiId(v string) *DeleteRequestValidatorInput

SetRestApiId sets the RestApiId field's value.

func (DeleteRequestValidatorInput) String 

func (s DeleteRequestValidatorInput) String() string

String returns the string representation

func (*DeleteRequestValidatorInput) Validate 

func (s *DeleteRequestValidatorInput) Validate() error

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

type DeleteRequestValidatorOutput 

type DeleteRequestValidatorOutput struct {
	// contains filtered or unexported fields
}

func (DeleteRequestValidatorOutput) GoString 

func (s DeleteRequestValidatorOutput) GoString() string

GoString returns the string representation

func (DeleteRequestValidatorOutput) SDKResponseMetadata 

func (s DeleteRequestValidatorOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteRequestValidatorOutput) String 

func (s DeleteRequestValidatorOutput) String() string

String returns the string representation

type DeleteRequestValidatorRequest 

type DeleteRequestValidatorRequest struct {
	*aws.Request
	Input *DeleteRequestValidatorInput
}

DeleteRequestValidatorRequest is a API request type for the DeleteRequestValidator API operation.

func (DeleteRequestValidatorRequest) Send 

func (r DeleteRequestValidatorRequest) Send() (*DeleteRequestValidatorOutput, error)

Send marshals and sends the DeleteRequestValidator API request.

type DeleteResourceInput 

type DeleteResourceInput struct {

	// The identifier of the Resource resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to delete a Resource.

func (DeleteResourceInput) GoString 

func (s DeleteResourceInput) GoString() string

GoString returns the string representation

func (*DeleteResourceInput) SetResourceId 

func (s *DeleteResourceInput) SetResourceId(v string) *DeleteResourceInput

SetResourceId sets the ResourceId field's value.

func (*DeleteResourceInput) SetRestApiId 

func (s *DeleteResourceInput) SetRestApiId(v string) *DeleteResourceInput

SetRestApiId sets the RestApiId field's value.

func (DeleteResourceInput) String 

func (s DeleteResourceInput) String() string

String returns the string representation

func (*DeleteResourceInput) Validate 

func (s *DeleteResourceInput) Validate() error

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

type DeleteResourceOutput 

type DeleteResourceOutput struct {
	// contains filtered or unexported fields
}

func (DeleteResourceOutput) GoString 

func (s DeleteResourceOutput) GoString() string

GoString returns the string representation

func (DeleteResourceOutput) SDKResponseMetadata 

func (s DeleteResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteResourceOutput) String 

func (s DeleteResourceOutput) String() string

String returns the string representation

type DeleteResourceRequest 

type DeleteResourceRequest struct {
	*aws.Request
	Input *DeleteResourceInput
}

DeleteResourceRequest is a API request type for the DeleteResource API operation.

func (DeleteResourceRequest) Send 

func (r DeleteResourceRequest) Send() (*DeleteResourceOutput, error)

Send marshals and sends the DeleteResource API request.

type DeleteRestApiInput 

type DeleteRestApiInput struct {

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to delete the specified API from your collection.

func (DeleteRestApiInput) GoString 

func (s DeleteRestApiInput) GoString() string

GoString returns the string representation

func (*DeleteRestApiInput) SetRestApiId 

func (s *DeleteRestApiInput) SetRestApiId(v string) *DeleteRestApiInput

SetRestApiId sets the RestApiId field's value.

func (DeleteRestApiInput) String 

func (s DeleteRestApiInput) String() string

String returns the string representation

func (*DeleteRestApiInput) Validate 

func (s *DeleteRestApiInput) Validate() error

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

type DeleteRestApiOutput 

type DeleteRestApiOutput struct {
	// contains filtered or unexported fields
}

func (DeleteRestApiOutput) GoString 

func (s DeleteRestApiOutput) GoString() string

GoString returns the string representation

func (DeleteRestApiOutput) SDKResponseMetadata 

func (s DeleteRestApiOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteRestApiOutput) String 

func (s DeleteRestApiOutput) String() string

String returns the string representation

type DeleteRestApiRequest 

type DeleteRestApiRequest struct {
	*aws.Request
	Input *DeleteRestApiInput
}

DeleteRestApiRequest is a API request type for the DeleteRestApi API operation.

func (DeleteRestApiRequest) Send 

func (r DeleteRestApiRequest) Send() (*DeleteRestApiOutput, error)

Send marshals and sends the DeleteRestApi API request.

type DeleteStageInput 

type DeleteStageInput struct {

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The name of the Stage resource to delete.
	//
	// StageName is a required field
	StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to delete a Stage resource.

func (DeleteStageInput) GoString 

func (s DeleteStageInput) GoString() string

GoString returns the string representation

func (*DeleteStageInput) SetRestApiId 

func (s *DeleteStageInput) SetRestApiId(v string) *DeleteStageInput

SetRestApiId sets the RestApiId field's value.

func (*DeleteStageInput) SetStageName 

func (s *DeleteStageInput) SetStageName(v string) *DeleteStageInput

SetStageName sets the StageName field's value.

func (DeleteStageInput) String 

func (s DeleteStageInput) String() string

String returns the string representation

func (*DeleteStageInput) Validate 

func (s *DeleteStageInput) Validate() error

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

type DeleteStageOutput 

type DeleteStageOutput struct {
	// contains filtered or unexported fields
}

func (DeleteStageOutput) GoString 

func (s DeleteStageOutput) GoString() string

GoString returns the string representation

func (DeleteStageOutput) SDKResponseMetadata 

func (s DeleteStageOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteStageOutput) String 

func (s DeleteStageOutput) String() string

String returns the string representation

type DeleteStageRequest 

type DeleteStageRequest struct {
	*aws.Request
	Input *DeleteStageInput
}

DeleteStageRequest is a API request type for the DeleteStage API operation.

func (DeleteStageRequest) Send 

func (r DeleteStageRequest) Send() (*DeleteStageOutput, error)

Send marshals and sends the DeleteStage API request.

type DeleteUsagePlanInput 

type DeleteUsagePlanInput struct {

	// The Id of the to-be-deleted usage plan.
	//
	// UsagePlanId is a required field
	UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The DELETE request to delete a usage plan of a given plan Id.

func (DeleteUsagePlanInput) GoString 

func (s DeleteUsagePlanInput) GoString() string

GoString returns the string representation

func (*DeleteUsagePlanInput) SetUsagePlanId 

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

SetUsagePlanId sets the UsagePlanId field's value.

func (DeleteUsagePlanInput) String 

func (s DeleteUsagePlanInput) String() string

String returns the string representation

func (*DeleteUsagePlanInput) Validate 

func (s *DeleteUsagePlanInput) Validate() error

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

type DeleteUsagePlanKeyInput 

type DeleteUsagePlanKeyInput struct {

	// The Id of the UsagePlanKey resource to be deleted.
	//
	// KeyId is a required field
	KeyId *string `location:"uri" locationName:"keyId" type:"string" required:"true"`

	// The Id of the UsagePlan resource representing the usage plan containing the
	// to-be-deleted UsagePlanKey resource representing a plan customer.
	//
	// UsagePlanId is a required field
	UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.

func (DeleteUsagePlanKeyInput) GoString 

func (s DeleteUsagePlanKeyInput) GoString() string

GoString returns the string representation

func (*DeleteUsagePlanKeyInput) SetKeyId 

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

SetKeyId sets the KeyId field's value.

func (*DeleteUsagePlanKeyInput) SetUsagePlanId 

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

SetUsagePlanId sets the UsagePlanId field's value.

func (DeleteUsagePlanKeyInput) String 

func (s DeleteUsagePlanKeyInput) String() string

String returns the string representation

func (*DeleteUsagePlanKeyInput) Validate 

func (s *DeleteUsagePlanKeyInput) Validate() error

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

type DeleteUsagePlanKeyOutput 

type DeleteUsagePlanKeyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteUsagePlanKeyOutput) GoString 

func (s DeleteUsagePlanKeyOutput) GoString() string

GoString returns the string representation

func (DeleteUsagePlanKeyOutput) SDKResponseMetadata 

func (s DeleteUsagePlanKeyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteUsagePlanKeyOutput) String 

func (s DeleteUsagePlanKeyOutput) String() string

String returns the string representation

type DeleteUsagePlanKeyRequest 

type DeleteUsagePlanKeyRequest struct {
	*aws.Request
	Input *DeleteUsagePlanKeyInput
}

DeleteUsagePlanKeyRequest is a API request type for the DeleteUsagePlanKey API operation.

func (DeleteUsagePlanKeyRequest) Send 

func (r DeleteUsagePlanKeyRequest) Send() (*DeleteUsagePlanKeyOutput, error)

Send marshals and sends the DeleteUsagePlanKey API request.

type DeleteUsagePlanOutput 

type DeleteUsagePlanOutput struct {
	// contains filtered or unexported fields
}

func (DeleteUsagePlanOutput) GoString 

func (s DeleteUsagePlanOutput) GoString() string

GoString returns the string representation

func (DeleteUsagePlanOutput) SDKResponseMetadata 

func (s DeleteUsagePlanOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteUsagePlanOutput) String 

func (s DeleteUsagePlanOutput) String() string

String returns the string representation

type DeleteUsagePlanRequest 

type DeleteUsagePlanRequest struct {
	*aws.Request
	Input *DeleteUsagePlanInput
}

DeleteUsagePlanRequest is a API request type for the DeleteUsagePlan API operation.

func (DeleteUsagePlanRequest) Send 

func (r DeleteUsagePlanRequest) Send() (*DeleteUsagePlanOutput, error)

Send marshals and sends the DeleteUsagePlan API request.

type DocumentationPartLocation 

type DocumentationPartLocation struct {

	// The HTTP verb of a method. It is a valid field for the API entity types of
	// METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE,
	// RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method.
	// When an applicable child entity inherits the content of an entity of the
	// same type with more general specifications of the other location attributes,
	// the child entity's method attribute must match that of the parent entity
	// exactly.
	Method *string `locationName:"method" type:"string"`

	// The name of the targeted API entity. It is a valid and required field for
	// the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER,
	// REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field
	// for any other entity type.
	Name *string `locationName:"name" type:"string"`

	// The URL path of the target. It is a valid field for the API entity types
	// of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY,
	// RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for
	// the root resource. When an applicable child entity inherits the content of
	// another entity of the same type with more general specifications of the other
	// location attributes, the child entity's path attribute must match that of
	// the parent entity as a prefix.
	Path *string `locationName:"path" type:"string"`

	// The HTTP status code of a response. It is a valid field for the API entity
	// types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value
	// is * for any status code. When an applicable child entity inherits the content
	// of an entity of the same type with more general specifications of the other
	// location attributes, the child entity's statusCode attribute must match that
	// of the parent entity exactly.
	StatusCode *string `locationName:"statusCode" type:"string"`

	// The type of API entity to which the documentation content applies. It is
	// a valid and required field for API entity types of API, AUTHORIZER, MODEL,
	// RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY,
	// RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not
	// apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY,
	// or RESOURCE type.
	//
	// Type is a required field
	Type DocumentationPartType `locationName:"type" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Specifies the target API entity to which the documentation applies.

func (DocumentationPartLocation) GoString 

func (s DocumentationPartLocation) GoString() string

GoString returns the string representation

func (*DocumentationPartLocation) SetMethod 

func (s *DocumentationPartLocation) SetMethod(v string) *DocumentationPartLocation

SetMethod sets the Method field's value.

func (*DocumentationPartLocation) SetName 

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

SetName sets the Name field's value.

func (*DocumentationPartLocation) SetPath 

func (s *DocumentationPartLocation) SetPath(v string) *DocumentationPartLocation

SetPath sets the Path field's value.

func (*DocumentationPartLocation) SetStatusCode 

func (s *DocumentationPartLocation) SetStatusCode(v string) *DocumentationPartLocation

SetStatusCode sets the StatusCode field's value.

func (*DocumentationPartLocation) SetType 

func (s *DocumentationPartLocation) SetType(v DocumentationPartType) *DocumentationPartLocation

SetType sets the Type field's value.

func (DocumentationPartLocation) String 

func (s DocumentationPartLocation) String() string

String returns the string representation

func (*DocumentationPartLocation) Validate 

func (s *DocumentationPartLocation) Validate() error

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

type DocumentationPartType 

type DocumentationPartType string
const (
	DocumentationPartTypeApi            DocumentationPartType = "API"
	DocumentationPartTypeAuthorizer     DocumentationPartType = "AUTHORIZER"
	DocumentationPartTypeModel          DocumentationPartType = "MODEL"
	DocumentationPartTypeResource       DocumentationPartType = "RESOURCE"
	DocumentationPartTypeMethod         DocumentationPartType = "METHOD"
	DocumentationPartTypePathParameter  DocumentationPartType = "PATH_PARAMETER"
	DocumentationPartTypeQueryParameter DocumentationPartType = "QUERY_PARAMETER"
	DocumentationPartTypeRequestHeader  DocumentationPartType = "REQUEST_HEADER"
	DocumentationPartTypeRequestBody    DocumentationPartType = "REQUEST_BODY"
	DocumentationPartTypeResponse       DocumentationPartType = "RESPONSE"
	DocumentationPartTypeResponseHeader DocumentationPartType = "RESPONSE_HEADER"
	DocumentationPartTypeResponseBody   DocumentationPartType = "RESPONSE_BODY"
)

Enum values for DocumentationPartType

type FlushStageAuthorizersCacheInput 

type FlushStageAuthorizersCacheInput struct {

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The name of the stage to flush.
	//
	// StageName is a required field
	StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to flush authorizer cache entries on a specified stage.

func (FlushStageAuthorizersCacheInput) GoString 

func (s FlushStageAuthorizersCacheInput) GoString() string

GoString returns the string representation

func (*FlushStageAuthorizersCacheInput) SetRestApiId 

func (s *FlushStageAuthorizersCacheInput) SetRestApiId(v string) *FlushStageAuthorizersCacheInput

SetRestApiId sets the RestApiId field's value.

func (*FlushStageAuthorizersCacheInput) SetStageName 

func (s *FlushStageAuthorizersCacheInput) SetStageName(v string) *FlushStageAuthorizersCacheInput

SetStageName sets the StageName field's value.

func (FlushStageAuthorizersCacheInput) String 

func (s FlushStageAuthorizersCacheInput) String() string

String returns the string representation

func (*FlushStageAuthorizersCacheInput) Validate 

func (s *FlushStageAuthorizersCacheInput) Validate() error

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

type FlushStageAuthorizersCacheOutput 

type FlushStageAuthorizersCacheOutput struct {
	// contains filtered or unexported fields
}

func (FlushStageAuthorizersCacheOutput) GoString 

func (s FlushStageAuthorizersCacheOutput) GoString() string

GoString returns the string representation

func (FlushStageAuthorizersCacheOutput) SDKResponseMetadata 

func (s FlushStageAuthorizersCacheOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (FlushStageAuthorizersCacheOutput) String 

func (s FlushStageAuthorizersCacheOutput) String() string

String returns the string representation

type FlushStageAuthorizersCacheRequest 

type FlushStageAuthorizersCacheRequest struct {
	*aws.Request
	Input *FlushStageAuthorizersCacheInput
}

FlushStageAuthorizersCacheRequest is a API request type for the FlushStageAuthorizersCache API operation.

func (FlushStageAuthorizersCacheRequest) Send 

func (r FlushStageAuthorizersCacheRequest) Send() (*FlushStageAuthorizersCacheOutput, error)

Send marshals and sends the FlushStageAuthorizersCache API request.

type FlushStageCacheInput 

type FlushStageCacheInput struct {

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The name of the stage to flush its cache.
	//
	// StageName is a required field
	StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to flush a stage's cache.

func (FlushStageCacheInput) GoString 

func (s FlushStageCacheInput) GoString() string

GoString returns the string representation

func (*FlushStageCacheInput) SetRestApiId 

func (s *FlushStageCacheInput) SetRestApiId(v string) *FlushStageCacheInput

SetRestApiId sets the RestApiId field's value.

func (*FlushStageCacheInput) SetStageName 

func (s *FlushStageCacheInput) SetStageName(v string) *FlushStageCacheInput

SetStageName sets the StageName field's value.

func (FlushStageCacheInput) String 

func (s FlushStageCacheInput) String() string

String returns the string representation

func (*FlushStageCacheInput) Validate 

func (s *FlushStageCacheInput) Validate() error

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

type FlushStageCacheOutput 

type FlushStageCacheOutput struct {
	// contains filtered or unexported fields
}

func (FlushStageCacheOutput) GoString 

func (s FlushStageCacheOutput) GoString() string

GoString returns the string representation

func (FlushStageCacheOutput) SDKResponseMetadata 

func (s FlushStageCacheOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (FlushStageCacheOutput) String 

func (s FlushStageCacheOutput) String() string

String returns the string representation

type FlushStageCacheRequest 

type FlushStageCacheRequest struct {
	*aws.Request
	Input *FlushStageCacheInput
}

FlushStageCacheRequest is a API request type for the FlushStageCache API operation.

func (FlushStageCacheRequest) Send 

func (r FlushStageCacheRequest) Send() (*FlushStageCacheOutput, error)

Send marshals and sends the FlushStageCache API request.

type GatewayResponseType 

type GatewayResponseType string
const (
	GatewayResponseTypeDefault4xx                   GatewayResponseType = "DEFAULT_4XX"
	GatewayResponseTypeDefault5xx                   GatewayResponseType = "DEFAULT_5XX"
	GatewayResponseTypeResourceNotFound             GatewayResponseType = "RESOURCE_NOT_FOUND"
	GatewayResponseTypeUnauthorized                 GatewayResponseType = "UNAUTHORIZED"
	GatewayResponseTypeInvalidApiKey                GatewayResponseType = "INVALID_API_KEY"
	GatewayResponseTypeAccessDenied                 GatewayResponseType = "ACCESS_DENIED"
	GatewayResponseTypeAuthorizerFailure            GatewayResponseType = "AUTHORIZER_FAILURE"
	GatewayResponseTypeAuthorizerConfigurationError GatewayResponseType = "AUTHORIZER_CONFIGURATION_ERROR"
	GatewayResponseTypeInvalidSignature             GatewayResponseType = "INVALID_SIGNATURE"
	GatewayResponseTypeExpiredToken                 GatewayResponseType = "EXPIRED_TOKEN"
	GatewayResponseTypeMissingAuthenticationToken   GatewayResponseType = "MISSING_AUTHENTICATION_TOKEN"
	GatewayResponseTypeIntegrationFailure           GatewayResponseType = "INTEGRATION_FAILURE"
	GatewayResponseTypeIntegrationTimeout           GatewayResponseType = "INTEGRATION_TIMEOUT"
	GatewayResponseTypeApiConfigurationError        GatewayResponseType = "API_CONFIGURATION_ERROR"
	GatewayResponseTypeUnsupportedMediaType         GatewayResponseType = "UNSUPPORTED_MEDIA_TYPE"
	GatewayResponseTypeBadRequestParameters         GatewayResponseType = "BAD_REQUEST_PARAMETERS"
	GatewayResponseTypeBadRequestBody               GatewayResponseType = "BAD_REQUEST_BODY"
	GatewayResponseTypeRequestTooLarge              GatewayResponseType = "REQUEST_TOO_LARGE"
	GatewayResponseTypeThrottled                    GatewayResponseType = "THROTTLED"
	GatewayResponseTypeQuotaExceeded                GatewayResponseType = "QUOTA_EXCEEDED"
)

Enum values for GatewayResponseType

type GenerateClientCertificateInput 

type GenerateClientCertificateInput struct {

	// The description of the ClientCertificate.
	Description *string `locationName:"description" type:"string"`
	// contains filtered or unexported fields
}

A request to generate a ClientCertificate resource.

func (GenerateClientCertificateInput) GoString 

func (s GenerateClientCertificateInput) GoString() string

GoString returns the string representation

func (*GenerateClientCertificateInput) SetDescription 

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

SetDescription sets the Description field's value.

func (GenerateClientCertificateInput) String 

func (s GenerateClientCertificateInput) String() string

String returns the string representation

type GenerateClientCertificateRequest 

type GenerateClientCertificateRequest struct {
	*aws.Request
	Input *GenerateClientCertificateInput
}

GenerateClientCertificateRequest is a API request type for the GenerateClientCertificate API operation.

func (GenerateClientCertificateRequest) Send 

func (r GenerateClientCertificateRequest) Send() (*UpdateClientCertificateOutput, error)

Send marshals and sends the GenerateClientCertificate API request.

type GetAccountInput 

type GetAccountInput struct {
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to get information about the current Account resource.

func (GetAccountInput) GoString 

func (s GetAccountInput) GoString() string

GoString returns the string representation

func (GetAccountInput) String 

func (s GetAccountInput) String() string

String returns the string representation

type GetAccountRequest 

type GetAccountRequest struct {
	*aws.Request
	Input *GetAccountInput
}

GetAccountRequest is a API request type for the GetAccount API operation.

func (GetAccountRequest) Send 

func (r GetAccountRequest) Send() (*UpdateAccountOutput, error)

Send marshals and sends the GetAccount API request.

type GetApiKeyInput 

type GetApiKeyInput struct {

	// The identifier of the ApiKey resource.
	//
	// ApiKey is a required field
	ApiKey *string `location:"uri" locationName:"api_Key" type:"string" required:"true"`

	// A boolean flag to specify whether (true) or not (false) the result contains
	// the key value.
	IncludeValue *bool `location:"querystring" locationName:"includeValue" type:"boolean"`
	// contains filtered or unexported fields
}

A request to get information about the current ApiKey resource.

func (GetApiKeyInput) GoString 

func (s GetApiKeyInput) GoString() string

GoString returns the string representation

func (*GetApiKeyInput) SetApiKey 

func (s *GetApiKeyInput) SetApiKey(v string) *GetApiKeyInput

SetApiKey sets the ApiKey field's value.

func (*GetApiKeyInput) SetIncludeValue 

func (s *GetApiKeyInput) SetIncludeValue(v bool) *GetApiKeyInput

SetIncludeValue sets the IncludeValue field's value.

func (GetApiKeyInput) String 

func (s GetApiKeyInput) String() string

String returns the string representation

func (*GetApiKeyInput) Validate 

func (s *GetApiKeyInput) Validate() error

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

type GetApiKeyRequest 

type GetApiKeyRequest struct {
	*aws.Request
	Input *GetApiKeyInput
}

GetApiKeyRequest is a API request type for the GetApiKey API operation.

func (GetApiKeyRequest) Send 

func (r GetApiKeyRequest) Send() (*UpdateApiKeyOutput, error)

Send marshals and sends the GetApiKey API request.

type GetApiKeysInput 

type GetApiKeysInput struct {

	// The identifier of a customer in AWS Marketplace or an external system, such
	// as a developer portal.
	CustomerId *string `location:"querystring" locationName:"customerId" type:"string"`

	// A boolean flag to specify whether (true) or not (false) the result contains
	// key values.
	IncludeValues *bool `location:"querystring" locationName:"includeValues" type:"boolean"`

	// The maximum number of returned results per page.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The name of queried API keys.
	NameQuery *string `location:"querystring" locationName:"name" type:"string"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

A request to get information about the current ApiKeys resource.

func (GetApiKeysInput) GoString 

func (s GetApiKeysInput) GoString() string

GoString returns the string representation

func (*GetApiKeysInput) SetCustomerId 

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

SetCustomerId sets the CustomerId field's value.

func (*GetApiKeysInput) SetIncludeValues 

func (s *GetApiKeysInput) SetIncludeValues(v bool) *GetApiKeysInput

SetIncludeValues sets the IncludeValues field's value.

func (*GetApiKeysInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetApiKeysInput) SetNameQuery 

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

SetNameQuery sets the NameQuery field's value.

func (*GetApiKeysInput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetApiKeysInput) String 

func (s GetApiKeysInput) String() string

String returns the string representation

type GetApiKeysOutput 

type GetApiKeysOutput struct {

	// The current page of elements from this collection.
	Items []UpdateApiKeyOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`

	// A list of warning messages logged during the import of API keys when the
	// failOnWarnings option is set to true.
	Warnings []string `locationName:"warnings" type:"list"`
	// contains filtered or unexported fields
}

Represents a collection of API keys as represented by an ApiKeys resource.

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

func (GetApiKeysOutput) GoString 

func (s GetApiKeysOutput) GoString() string

GoString returns the string representation

func (GetApiKeysOutput) SDKResponseMetadata 

func (s GetApiKeysOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetApiKeysOutput) SetItems 

func (s *GetApiKeysOutput) SetItems(v []UpdateApiKeyOutput) *GetApiKeysOutput

SetItems sets the Items field's value.

func (*GetApiKeysOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (*GetApiKeysOutput) SetWarnings 

func (s *GetApiKeysOutput) SetWarnings(v []string) *GetApiKeysOutput

SetWarnings sets the Warnings field's value.

func (GetApiKeysOutput) String 

func (s GetApiKeysOutput) String() string

String returns the string representation

type GetApiKeysRequest 

type GetApiKeysRequest struct {
	*aws.Request
	Input *GetApiKeysInput
}

GetApiKeysRequest is a API request type for the GetApiKeys API operation.

func (GetApiKeysRequest) Send 

func (r GetApiKeysRequest) Send() (*GetApiKeysOutput, error)

Send marshals and sends the GetApiKeys API request.

type GetAuthorizerInput 

type GetAuthorizerInput struct {

	// The identifier of the Authorizer resource.
	//
	// AuthorizerId is a required field
	AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to describe an existing Authorizer resource.

func (GetAuthorizerInput) GoString 

func (s GetAuthorizerInput) GoString() string

GoString returns the string representation

func (*GetAuthorizerInput) SetAuthorizerId 

func (s *GetAuthorizerInput) SetAuthorizerId(v string) *GetAuthorizerInput

SetAuthorizerId sets the AuthorizerId field's value.

func (*GetAuthorizerInput) SetRestApiId 

func (s *GetAuthorizerInput) SetRestApiId(v string) *GetAuthorizerInput

SetRestApiId sets the RestApiId field's value.

func (GetAuthorizerInput) String 

func (s GetAuthorizerInput) String() string

String returns the string representation

func (*GetAuthorizerInput) Validate 

func (s *GetAuthorizerInput) Validate() error

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

type GetAuthorizerRequest 

type GetAuthorizerRequest struct {
	*aws.Request
	Input *GetAuthorizerInput
}

GetAuthorizerRequest is a API request type for the GetAuthorizer API operation.

func (GetAuthorizerRequest) Send 

func (r GetAuthorizerRequest) Send() (*UpdateAuthorizerOutput, error)

Send marshals and sends the GetAuthorizer API request.

type GetAuthorizersInput 

type GetAuthorizersInput struct {

	// The maximum number of returned results per page.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to describe an existing Authorizers resource.

func (GetAuthorizersInput) GoString 

func (s GetAuthorizersInput) GoString() string

GoString returns the string representation

func (*GetAuthorizersInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetAuthorizersInput) SetPosition 

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

SetPosition sets the Position field's value.

func (*GetAuthorizersInput) SetRestApiId 

func (s *GetAuthorizersInput) SetRestApiId(v string) *GetAuthorizersInput

SetRestApiId sets the RestApiId field's value.

func (GetAuthorizersInput) String 

func (s GetAuthorizersInput) String() string

String returns the string representation

func (*GetAuthorizersInput) Validate 

func (s *GetAuthorizersInput) Validate() error

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

type GetAuthorizersOutput 

type GetAuthorizersOutput struct {

	// The current page of elements from this collection.
	Items []UpdateAuthorizerOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

Represents a collection of Authorizer resources.

Enable custom authorization (http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html)

func (GetAuthorizersOutput) GoString 

func (s GetAuthorizersOutput) GoString() string

GoString returns the string representation

func (GetAuthorizersOutput) SDKResponseMetadata 

func (s GetAuthorizersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetAuthorizersOutput) SetItems 

func (s *GetAuthorizersOutput) SetItems(v []UpdateAuthorizerOutput) *GetAuthorizersOutput

SetItems sets the Items field's value.

func (*GetAuthorizersOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetAuthorizersOutput) String 

func (s GetAuthorizersOutput) String() string

String returns the string representation

type GetAuthorizersRequest 

type GetAuthorizersRequest struct {
	*aws.Request
	Input *GetAuthorizersInput
}

GetAuthorizersRequest is a API request type for the GetAuthorizers API operation.

func (GetAuthorizersRequest) Send 

func (r GetAuthorizersRequest) Send() (*GetAuthorizersOutput, error)

Send marshals and sends the GetAuthorizers API request.

type GetBasePathMappingInput 

type GetBasePathMappingInput struct {

	// The base path name that callers of the API must provide as part of the URL
	// after the domain name. This value must be unique for all of the mappings
	// across a single API. Leave this blank if you do not want callers to specify
	// any base path name after the domain name.
	//
	// BasePath is a required field
	BasePath *string `location:"uri" locationName:"base_path" type:"string" required:"true"`

	// The domain name of the BasePathMapping resource to be described.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to describe a BasePathMapping resource.

func (GetBasePathMappingInput) GoString 

func (s GetBasePathMappingInput) GoString() string

GoString returns the string representation

func (*GetBasePathMappingInput) SetBasePath 

func (s *GetBasePathMappingInput) SetBasePath(v string) *GetBasePathMappingInput

SetBasePath sets the BasePath field's value.

func (*GetBasePathMappingInput) SetDomainName 

func (s *GetBasePathMappingInput) SetDomainName(v string) *GetBasePathMappingInput

SetDomainName sets the DomainName field's value.

func (GetBasePathMappingInput) String 

func (s GetBasePathMappingInput) String() string

String returns the string representation

func (*GetBasePathMappingInput) Validate 

func (s *GetBasePathMappingInput) Validate() error

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

type GetBasePathMappingRequest 

type GetBasePathMappingRequest struct {
	*aws.Request
	Input *GetBasePathMappingInput
}

GetBasePathMappingRequest is a API request type for the GetBasePathMapping API operation.

func (GetBasePathMappingRequest) Send 

func (r GetBasePathMappingRequest) Send() (*UpdateBasePathMappingOutput, error)

Send marshals and sends the GetBasePathMapping API request.

type GetBasePathMappingsInput 

type GetBasePathMappingsInput struct {

	// The domain name of a BasePathMapping resource.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"`

	// The maximum number of returned results per page. The value is 25 by default
	// and could be between 1 - 500.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

A request to get information about a collection of BasePathMapping resources.

func (GetBasePathMappingsInput) GoString 

func (s GetBasePathMappingsInput) GoString() string

GoString returns the string representation

func (*GetBasePathMappingsInput) SetDomainName 

func (s *GetBasePathMappingsInput) SetDomainName(v string) *GetBasePathMappingsInput

SetDomainName sets the DomainName field's value.

func (*GetBasePathMappingsInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetBasePathMappingsInput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetBasePathMappingsInput) String 

func (s GetBasePathMappingsInput) String() string

String returns the string representation

func (*GetBasePathMappingsInput) Validate 

func (s *GetBasePathMappingsInput) Validate() error

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

type GetBasePathMappingsOutput 

type GetBasePathMappingsOutput struct {

	// The current page of elements from this collection.
	Items []UpdateBasePathMappingOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

Represents a collection of BasePathMapping resources.

Use Custom Domain Names (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)

func (GetBasePathMappingsOutput) GoString 

func (s GetBasePathMappingsOutput) GoString() string

GoString returns the string representation

func (GetBasePathMappingsOutput) SDKResponseMetadata 

func (s GetBasePathMappingsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetBasePathMappingsOutput) SetItems 

func (s *GetBasePathMappingsOutput) SetItems(v []UpdateBasePathMappingOutput) *GetBasePathMappingsOutput

SetItems sets the Items field's value.

func (*GetBasePathMappingsOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetBasePathMappingsOutput) String 

func (s GetBasePathMappingsOutput) String() string

String returns the string representation

type GetBasePathMappingsRequest 

type GetBasePathMappingsRequest struct {
	*aws.Request
	Input *GetBasePathMappingsInput
}

GetBasePathMappingsRequest is a API request type for the GetBasePathMappings API operation.

func (GetBasePathMappingsRequest) Send 

func (r GetBasePathMappingsRequest) Send() (*GetBasePathMappingsOutput, error)

Send marshals and sends the GetBasePathMappings API request.

type GetClientCertificateInput 

type GetClientCertificateInput struct {

	// The identifier of the ClientCertificate resource to be described.
	//
	// ClientCertificateId is a required field
	ClientCertificateId *string `location:"uri" locationName:"clientcertificate_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to get information about the current ClientCertificate resource.

func (GetClientCertificateInput) GoString 

func (s GetClientCertificateInput) GoString() string

GoString returns the string representation

func (*GetClientCertificateInput) SetClientCertificateId 

func (s *GetClientCertificateInput) SetClientCertificateId(v string) *GetClientCertificateInput

SetClientCertificateId sets the ClientCertificateId field's value.

func (GetClientCertificateInput) String 

func (s GetClientCertificateInput) String() string

String returns the string representation

func (*GetClientCertificateInput) Validate 

func (s *GetClientCertificateInput) Validate() error

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

type GetClientCertificateRequest 

type GetClientCertificateRequest struct {
	*aws.Request
	Input *GetClientCertificateInput
}

GetClientCertificateRequest is a API request type for the GetClientCertificate API operation.

func (GetClientCertificateRequest) Send 

func (r GetClientCertificateRequest) Send() (*UpdateClientCertificateOutput, error)

Send marshals and sends the GetClientCertificate API request.

type GetClientCertificatesInput 

type GetClientCertificatesInput struct {

	// The maximum number of returned results per page. The value is 25 by default
	// and could be between 1 - 500.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

A request to get information about a collection of ClientCertificate resources.

func (GetClientCertificatesInput) GoString 

func (s GetClientCertificatesInput) GoString() string

GoString returns the string representation

func (*GetClientCertificatesInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetClientCertificatesInput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetClientCertificatesInput) String 

func (s GetClientCertificatesInput) String() string

String returns the string representation

type GetClientCertificatesOutput 

type GetClientCertificatesOutput struct {

	// The current page of elements from this collection.
	Items []UpdateClientCertificateOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

Represents a collection of ClientCertificate resources.

Use Client-Side Certificate (http://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)

func (GetClientCertificatesOutput) GoString 

func (s GetClientCertificatesOutput) GoString() string

GoString returns the string representation

func (GetClientCertificatesOutput) SDKResponseMetadata 

func (s GetClientCertificatesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetClientCertificatesOutput) SetItems 

func (s *GetClientCertificatesOutput) SetItems(v []UpdateClientCertificateOutput) *GetClientCertificatesOutput

SetItems sets the Items field's value.

func (*GetClientCertificatesOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetClientCertificatesOutput) String 

func (s GetClientCertificatesOutput) String() string

String returns the string representation

type GetClientCertificatesRequest 

type GetClientCertificatesRequest struct {
	*aws.Request
	Input *GetClientCertificatesInput
}

GetClientCertificatesRequest is a API request type for the GetClientCertificates API operation.

func (GetClientCertificatesRequest) Send 

func (r GetClientCertificatesRequest) Send() (*GetClientCertificatesOutput, error)

Send marshals and sends the GetClientCertificates API request.

type GetDeploymentInput 

type GetDeploymentInput struct {

	// The identifier of the Deployment resource to get information about.
	//
	// DeploymentId is a required field
	DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"`

	// A query parameter to retrieve the specified embedded resources of the returned
	// Deployment resource in the response. In a REST API call, this embed parameter
	// value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2.
	// The SDK and other platform-dependent libraries might use a different format
	// for the list. Currently, this request supports only retrieval of the embedded
	// API summary this way. Hence, the parameter value must be a single-valued
	// list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
	Embed []string `location:"querystring" locationName:"embed" type:"list"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to get information about a Deployment resource.

func (GetDeploymentInput) GoString 

func (s GetDeploymentInput) GoString() string

GoString returns the string representation

func (*GetDeploymentInput) SetDeploymentId 

func (s *GetDeploymentInput) SetDeploymentId(v string) *GetDeploymentInput

SetDeploymentId sets the DeploymentId field's value.

func (*GetDeploymentInput) SetEmbed 

func (s *GetDeploymentInput) SetEmbed(v []string) *GetDeploymentInput

SetEmbed sets the Embed field's value.

func (*GetDeploymentInput) SetRestApiId 

func (s *GetDeploymentInput) SetRestApiId(v string) *GetDeploymentInput

SetRestApiId sets the RestApiId field's value.

func (GetDeploymentInput) String 

func (s GetDeploymentInput) String() string

String returns the string representation

func (*GetDeploymentInput) Validate 

func (s *GetDeploymentInput) Validate() error

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

type GetDeploymentRequest 

type GetDeploymentRequest struct {
	*aws.Request
	Input *GetDeploymentInput
}

GetDeploymentRequest is a API request type for the GetDeployment API operation.

func (GetDeploymentRequest) Send 

func (r GetDeploymentRequest) Send() (*UpdateDeploymentOutput, error)

Send marshals and sends the GetDeployment API request.

type GetDeploymentsInput 

type GetDeploymentsInput struct {

	// The maximum number of returned results per page. The value is 25 by default
	// and could be between 1 - 500.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to get information about a Deployments collection.

func (GetDeploymentsInput) GoString 

func (s GetDeploymentsInput) GoString() string

GoString returns the string representation

func (*GetDeploymentsInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetDeploymentsInput) SetPosition 

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

SetPosition sets the Position field's value.

func (*GetDeploymentsInput) SetRestApiId 

func (s *GetDeploymentsInput) SetRestApiId(v string) *GetDeploymentsInput

SetRestApiId sets the RestApiId field's value.

func (GetDeploymentsInput) String 

func (s GetDeploymentsInput) String() string

String returns the string representation

func (*GetDeploymentsInput) Validate 

func (s *GetDeploymentsInput) Validate() error

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

type GetDeploymentsOutput 

type GetDeploymentsOutput struct {

	// The current page of elements from this collection.
	Items []UpdateDeploymentOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.

To create a new deployment of a RestApi, make a POST request against this resource. To view, update, or delete an existing deployment, make a GET, PATCH, or DELETE request, respectively, on a specified Deployment resource.

Deploying an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html), AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html), AWS SDKs (https://aws.amazon.com/tools/)

func (GetDeploymentsOutput) GoString 

func (s GetDeploymentsOutput) GoString() string

GoString returns the string representation

func (GetDeploymentsOutput) SDKResponseMetadata 

func (s GetDeploymentsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetDeploymentsOutput) SetItems 

func (s *GetDeploymentsOutput) SetItems(v []UpdateDeploymentOutput) *GetDeploymentsOutput

SetItems sets the Items field's value.

func (*GetDeploymentsOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetDeploymentsOutput) String 

func (s GetDeploymentsOutput) String() string

String returns the string representation

type GetDeploymentsRequest 

type GetDeploymentsRequest struct {
	*aws.Request
	Input *GetDeploymentsInput
}

GetDeploymentsRequest is a API request type for the GetDeployments API operation.

func (GetDeploymentsRequest) Send 

func (r GetDeploymentsRequest) Send() (*GetDeploymentsOutput, error)

Send marshals and sends the GetDeployments API request.

type GetDocumentationPartInput 

type GetDocumentationPartInput struct {

	// [Required] The string identifier of the associated RestApi.
	//
	// DocumentationPartId is a required field
	DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"`

	// [Required] The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Gets a specified documentation part of a given API.

func (GetDocumentationPartInput) GoString 

func (s GetDocumentationPartInput) GoString() string

GoString returns the string representation

func (*GetDocumentationPartInput) SetDocumentationPartId 

func (s *GetDocumentationPartInput) SetDocumentationPartId(v string) *GetDocumentationPartInput

SetDocumentationPartId sets the DocumentationPartId field's value.

func (*GetDocumentationPartInput) SetRestApiId 

func (s *GetDocumentationPartInput) SetRestApiId(v string) *GetDocumentationPartInput

SetRestApiId sets the RestApiId field's value.

func (GetDocumentationPartInput) String 

func (s GetDocumentationPartInput) String() string

String returns the string representation

func (*GetDocumentationPartInput) Validate 

func (s *GetDocumentationPartInput) Validate() error

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

type GetDocumentationPartRequest 

type GetDocumentationPartRequest struct {
	*aws.Request
	Input *GetDocumentationPartInput
}

GetDocumentationPartRequest is a API request type for the GetDocumentationPart API operation.

func (GetDocumentationPartRequest) Send 

func (r GetDocumentationPartRequest) Send() (*UpdateDocumentationPartOutput, error)

Send marshals and sends the GetDocumentationPart API request.

type GetDocumentationPartsInput 

type GetDocumentationPartsInput struct {

	// The maximum number of returned results per page.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The name of API entities of the to-be-retrieved documentation parts.
	NameQuery *string `location:"querystring" locationName:"name" type:"string"`

	// The path of API entities of the to-be-retrieved documentation parts.
	Path *string `location:"querystring" locationName:"path" type:"string"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`

	// [Required] The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The type of API entities of the to-be-retrieved documentation parts.
	Type DocumentationPartType `location:"querystring" locationName:"type" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

func (GetDocumentationPartsInput) GoString 

func (s GetDocumentationPartsInput) GoString() string

GoString returns the string representation

func (*GetDocumentationPartsInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetDocumentationPartsInput) SetNameQuery 

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

SetNameQuery sets the NameQuery field's value.

func (*GetDocumentationPartsInput) SetPath 

func (s *GetDocumentationPartsInput) SetPath(v string) *GetDocumentationPartsInput

SetPath sets the Path field's value.

func (*GetDocumentationPartsInput) SetPosition 

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

SetPosition sets the Position field's value.

func (*GetDocumentationPartsInput) SetRestApiId 

func (s *GetDocumentationPartsInput) SetRestApiId(v string) *GetDocumentationPartsInput

SetRestApiId sets the RestApiId field's value.

func (*GetDocumentationPartsInput) SetType 

func (s *GetDocumentationPartsInput) SetType(v DocumentationPartType) *GetDocumentationPartsInput

SetType sets the Type field's value.

func (GetDocumentationPartsInput) String 

func (s GetDocumentationPartsInput) String() string

String returns the string representation

func (*GetDocumentationPartsInput) Validate 

func (s *GetDocumentationPartsInput) Validate() error

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

type GetDocumentationPartsOutput 

type GetDocumentationPartsOutput struct {

	// The current page of elements from this collection.
	Items []UpdateDocumentationPartOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

The collection of documentation parts of an API.

Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart

func (GetDocumentationPartsOutput) GoString 

func (s GetDocumentationPartsOutput) GoString() string

GoString returns the string representation

func (GetDocumentationPartsOutput) SDKResponseMetadata 

func (s GetDocumentationPartsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetDocumentationPartsOutput) SetItems 

func (s *GetDocumentationPartsOutput) SetItems(v []UpdateDocumentationPartOutput) *GetDocumentationPartsOutput

SetItems sets the Items field's value.

func (*GetDocumentationPartsOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetDocumentationPartsOutput) String 

func (s GetDocumentationPartsOutput) String() string

String returns the string representation

type GetDocumentationPartsRequest 

type GetDocumentationPartsRequest struct {
	*aws.Request
	Input *GetDocumentationPartsInput
}

GetDocumentationPartsRequest is a API request type for the GetDocumentationParts API operation.

func (GetDocumentationPartsRequest) Send 

func (r GetDocumentationPartsRequest) Send() (*GetDocumentationPartsOutput, error)

Send marshals and sends the GetDocumentationParts API request.

type GetDocumentationVersionInput 

type GetDocumentationVersionInput struct {

	// [Required] The version identifier of the to-be-retrieved documentation snapshot.
	//
	// DocumentationVersion is a required field
	DocumentationVersion *string `location:"uri" locationName:"doc_version" type:"string" required:"true"`

	// [Required] The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Gets a documentation snapshot of an API.

func (GetDocumentationVersionInput) GoString 

func (s GetDocumentationVersionInput) GoString() string

GoString returns the string representation

func (*GetDocumentationVersionInput) SetDocumentationVersion 

func (s *GetDocumentationVersionInput) SetDocumentationVersion(v string) *GetDocumentationVersionInput

SetDocumentationVersion sets the DocumentationVersion field's value.

func (*GetDocumentationVersionInput) SetRestApiId 

func (s *GetDocumentationVersionInput) SetRestApiId(v string) *GetDocumentationVersionInput

SetRestApiId sets the RestApiId field's value.

func (GetDocumentationVersionInput) String 

func (s GetDocumentationVersionInput) String() string

String returns the string representation

func (*GetDocumentationVersionInput) Validate 

func (s *GetDocumentationVersionInput) Validate() error

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

type GetDocumentationVersionRequest 

type GetDocumentationVersionRequest struct {
	*aws.Request
	Input *GetDocumentationVersionInput
}

GetDocumentationVersionRequest is a API request type for the GetDocumentationVersion API operation.

func (GetDocumentationVersionRequest) Send 

func (r GetDocumentationVersionRequest) Send() (*UpdateDocumentationVersionOutput, error)

Send marshals and sends the GetDocumentationVersion API request.

type GetDocumentationVersionsInput 

type GetDocumentationVersionsInput struct {

	// The maximum number of returned results per page.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`

	// [Required] The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Gets the documentation versions of an API.

func (GetDocumentationVersionsInput) GoString 

func (s GetDocumentationVersionsInput) GoString() string

GoString returns the string representation

func (*GetDocumentationVersionsInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetDocumentationVersionsInput) SetPosition 

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

SetPosition sets the Position field's value.

func (*GetDocumentationVersionsInput) SetRestApiId 

func (s *GetDocumentationVersionsInput) SetRestApiId(v string) *GetDocumentationVersionsInput

SetRestApiId sets the RestApiId field's value.

func (GetDocumentationVersionsInput) String 

func (s GetDocumentationVersionsInput) String() string

String returns the string representation

func (*GetDocumentationVersionsInput) Validate 

func (s *GetDocumentationVersionsInput) Validate() error

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

type GetDocumentationVersionsOutput 

type GetDocumentationVersionsOutput struct {

	// The current page of elements from this collection.
	Items []UpdateDocumentationVersionOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

The collection of documentation snapshots of an API.

Use the DocumentationVersions to manage documentation snapshots associated with various API stages.

Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart, DocumentationVersion

func (GetDocumentationVersionsOutput) GoString 

func (s GetDocumentationVersionsOutput) GoString() string

GoString returns the string representation

func (GetDocumentationVersionsOutput) SDKResponseMetadata 

func (s GetDocumentationVersionsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetDocumentationVersionsOutput) SetItems 

func (s *GetDocumentationVersionsOutput) SetItems(v []UpdateDocumentationVersionOutput) *GetDocumentationVersionsOutput

SetItems sets the Items field's value.

func (*GetDocumentationVersionsOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetDocumentationVersionsOutput) String 

func (s GetDocumentationVersionsOutput) String() string

String returns the string representation

type GetDocumentationVersionsRequest 

type GetDocumentationVersionsRequest struct {
	*aws.Request
	Input *GetDocumentationVersionsInput
}

GetDocumentationVersionsRequest is a API request type for the GetDocumentationVersions API operation.

func (GetDocumentationVersionsRequest) Send 

func (r GetDocumentationVersionsRequest) Send() (*GetDocumentationVersionsOutput, error)

Send marshals and sends the GetDocumentationVersions API request.

type GetDomainNameInput 

type GetDomainNameInput struct {

	// The name of the DomainName resource.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to get the name of a DomainName resource.

func (GetDomainNameInput) GoString 

func (s GetDomainNameInput) GoString() string

GoString returns the string representation

func (*GetDomainNameInput) SetDomainName 

func (s *GetDomainNameInput) SetDomainName(v string) *GetDomainNameInput

SetDomainName sets the DomainName field's value.

func (GetDomainNameInput) String 

func (s GetDomainNameInput) String() string

String returns the string representation

func (*GetDomainNameInput) Validate 

func (s *GetDomainNameInput) Validate() error

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

type GetDomainNameRequest 

type GetDomainNameRequest struct {
	*aws.Request
	Input *GetDomainNameInput
}

GetDomainNameRequest is a API request type for the GetDomainName API operation.

func (GetDomainNameRequest) Send 

func (r GetDomainNameRequest) Send() (*UpdateDomainNameOutput, error)

Send marshals and sends the GetDomainName API request.

type GetDomainNamesInput 

type GetDomainNamesInput struct {

	// The maximum number of returned results per page. The value is 25 by default
	// and could be between 1 - 500.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

Request to describe a collection of DomainName resources.

func (GetDomainNamesInput) GoString 

func (s GetDomainNamesInput) GoString() string

GoString returns the string representation

func (*GetDomainNamesInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetDomainNamesInput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetDomainNamesInput) String 

func (s GetDomainNamesInput) String() string

String returns the string representation

type GetDomainNamesOutput 

type GetDomainNamesOutput struct {

	// The current page of elements from this collection.
	Items []UpdateDomainNameOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

Represents a collection of DomainName resources.

Use Client-Side Certificate (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)

func (GetDomainNamesOutput) GoString 

func (s GetDomainNamesOutput) GoString() string

GoString returns the string representation

func (GetDomainNamesOutput) SDKResponseMetadata 

func (s GetDomainNamesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetDomainNamesOutput) SetItems 

func (s *GetDomainNamesOutput) SetItems(v []UpdateDomainNameOutput) *GetDomainNamesOutput

SetItems sets the Items field's value.

func (*GetDomainNamesOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetDomainNamesOutput) String 

func (s GetDomainNamesOutput) String() string

String returns the string representation

type GetDomainNamesRequest 

type GetDomainNamesRequest struct {
	*aws.Request
	Input *GetDomainNamesInput
}

GetDomainNamesRequest is a API request type for the GetDomainNames API operation.

func (GetDomainNamesRequest) Send 

func (r GetDomainNamesRequest) Send() (*GetDomainNamesOutput, error)

Send marshals and sends the GetDomainNames API request.

type GetExportInput 

type GetExportInput struct {

	// The content-type of the export, for example application/json. Currently application/json
	// and application/yaml are supported for exportType of swagger. This should
	// be specified in the Accept header for direct API requests.
	Accepts *string `location:"header" locationName:"Accept" type:"string"`

	// The type of export. Currently only 'swagger' is supported.
	//
	// ExportType is a required field
	ExportType *string `location:"uri" locationName:"export_type" type:"string" required:"true"`

	// A key-value map of query string parameters that specify properties of the
	// export, depending on the requested exportType. For exportTypeswagger, any
	// combination of the following parameters are supported: integrations will
	// export the API with x-amazon-apigateway-integration extensions. authorizers
	// will export the API with x-amazon-apigateway-authorizer extensions. postman
	// will export the API with Postman extensions, allowing for import to the Postman
	// tool
	Parameters map[string]string `location:"querystring" locationName:"parameters" type:"map"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The name of the Stage that will be exported.
	//
	// StageName is a required field
	StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request a new export of a RestApi for a particular Stage.

func (GetExportInput) GoString 

func (s GetExportInput) GoString() string

GoString returns the string representation

func (*GetExportInput) SetAccepts 

func (s *GetExportInput) SetAccepts(v string) *GetExportInput

SetAccepts sets the Accepts field's value.

func (*GetExportInput) SetExportType 

func (s *GetExportInput) SetExportType(v string) *GetExportInput

SetExportType sets the ExportType field's value.

func (*GetExportInput) SetParameters 

func (s *GetExportInput) SetParameters(v map[string]string) *GetExportInput

SetParameters sets the Parameters field's value.

func (*GetExportInput) SetRestApiId 

func (s *GetExportInput) SetRestApiId(v string) *GetExportInput

SetRestApiId sets the RestApiId field's value.

func (*GetExportInput) SetStageName 

func (s *GetExportInput) SetStageName(v string) *GetExportInput

SetStageName sets the StageName field's value.

func (GetExportInput) String 

func (s GetExportInput) String() string

String returns the string representation

func (*GetExportInput) Validate 

func (s *GetExportInput) Validate() error

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

type GetExportOutput 

type GetExportOutput struct {

	// The binary blob response to GetExport, which contains the export.
	Body []byte `locationName:"body" type:"blob"`

	// The content-disposition header value in the HTTP response.
	ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"`

	// The content-type header value in the HTTP response. This will correspond
	// to a valid 'accept' type in the request.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`
	// contains filtered or unexported fields
}

The binary blob response to GetExport, which contains the generated SDK.

func (GetExportOutput) GoString 

func (s GetExportOutput) GoString() string

GoString returns the string representation

func (GetExportOutput) SDKResponseMetadata 

func (s GetExportOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetExportOutput) SetBody 

func (s *GetExportOutput) SetBody(v []byte) *GetExportOutput

SetBody sets the Body field's value.

func (*GetExportOutput) SetContentDisposition 

func (s *GetExportOutput) SetContentDisposition(v string) *GetExportOutput

SetContentDisposition sets the ContentDisposition field's value.

func (*GetExportOutput) SetContentType 

func (s *GetExportOutput) SetContentType(v string) *GetExportOutput

SetContentType sets the ContentType field's value.

func (GetExportOutput) String 

func (s GetExportOutput) String() string

String returns the string representation

type GetExportRequest 

type GetExportRequest struct {
	*aws.Request
	Input *GetExportInput
}

GetExportRequest is a API request type for the GetExport API operation.

func (GetExportRequest) Send 

func (r GetExportRequest) Send() (*GetExportOutput, error)

Send marshals and sends the GetExport API request.

type GetGatewayResponseInput 

type GetGatewayResponseInput struct {

	// The response type of the associated GatewayResponse. Valid values are ACCESS_DENIED
	//
	// API_CONFIGURATION_ERROR
	// AUTHORIZER_FAILURE
	//  AUTHORIZER_CONFIGURATION_ERROR
	// BAD_REQUEST_PARAMETERS
	// BAD_REQUEST_BODY
	// DEFAULT_4XX
	// DEFAULT_5XX
	// EXPIRED_TOKEN
	// INVALID_SIGNATURE
	// INTEGRATION_FAILURE
	// INTEGRATION_TIMEOUT
	// INVALID_API_KEY
	// MISSING_AUTHENTICATION_TOKEN
	//  QUOTA_EXCEEDED
	// REQUEST_TOO_LARGE
	// RESOURCE_NOT_FOUND
	// THROTTLED
	// UNAUTHORIZED
	// UNSUPPORTED_MEDIA_TYPES
	//
	// ResponseType is a required field
	ResponseType GatewayResponseType `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Gets a GatewayResponse of a specified response type on the given RestApi.

func (GetGatewayResponseInput) GoString 

func (s GetGatewayResponseInput) GoString() string

GoString returns the string representation

func (*GetGatewayResponseInput) SetResponseType 

func (s *GetGatewayResponseInput) SetResponseType(v GatewayResponseType) *GetGatewayResponseInput

SetResponseType sets the ResponseType field's value.

func (*GetGatewayResponseInput) SetRestApiId 

func (s *GetGatewayResponseInput) SetRestApiId(v string) *GetGatewayResponseInput

SetRestApiId sets the RestApiId field's value.

func (GetGatewayResponseInput) String 

func (s GetGatewayResponseInput) String() string

String returns the string representation

func (*GetGatewayResponseInput) Validate 

func (s *GetGatewayResponseInput) Validate() error

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

type GetGatewayResponseRequest 

type GetGatewayResponseRequest struct {
	*aws.Request
	Input *GetGatewayResponseInput
}

GetGatewayResponseRequest is a API request type for the GetGatewayResponse API operation.

func (GetGatewayResponseRequest) Send 

func (r GetGatewayResponseRequest) Send() (*UpdateGatewayResponseOutput, error)

Send marshals and sends the GetGatewayResponse API request.

type GetGatewayResponsesInput 

type GetGatewayResponsesInput struct {

	// The maximum number of returned results per page. The GatewayResponses collection
	// does not support pagination and the limit does not apply here.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set. The GatewayResponse
	// collection does not support pagination and the position does not apply here.
	Position *string `location:"querystring" locationName:"position" type:"string"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the Amazon API Gateway-generated default GatewayResponses collection for the supported response types.

func (GetGatewayResponsesInput) GoString 

func (s GetGatewayResponsesInput) GoString() string

GoString returns the string representation

func (*GetGatewayResponsesInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetGatewayResponsesInput) SetPosition 

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

SetPosition sets the Position field's value.

func (*GetGatewayResponsesInput) SetRestApiId 

func (s *GetGatewayResponsesInput) SetRestApiId(v string) *GetGatewayResponsesInput

SetRestApiId sets the RestApiId field's value.

func (GetGatewayResponsesInput) String 

func (s GetGatewayResponsesInput) String() string

String returns the string representation

func (*GetGatewayResponsesInput) Validate 

func (s *GetGatewayResponsesInput) Validate() error

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

type GetGatewayResponsesOutput 

type GetGatewayResponsesOutput struct {

	// Returns the entire collection, because of no pagination support.
	Items []UpdateGatewayResponseOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.

For more information about valid gateway response types, see Gateway Response Types Supported by Amazon API Gateway (http://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html)Example: Get the collection of gateway responses of an API

Request

This example request shows how to retrieve the GatewayResponses collection from an API.

GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515

Response

The successful operation returns the 200 OK status code and a payload similar to the following:

{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "first": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "gatewayresponse:by-type": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "item": [ { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" }, { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" }, { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } ] }, "_embedded": { "item": [ { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "INTEGRATION_FAILURE", "statusCode": "504" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "RESOURCE_NOT_FOUND", "statusCode": "404" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "REQUEST_TOO_LARGE", "statusCode": "413" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "THROTTLED", "statusCode": "429" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "UNSUPPORTED_MEDIA_TYPE", "statusCode": "415" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "AUTHORIZER_CONFIGURATION_ERROR", "statusCode": "500" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "DEFAULT_5XX" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "DEFAULT_4XX" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "BAD_REQUEST_PARAMETERS", "statusCode": "400" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "BAD_REQUEST_BODY", "statusCode": "400" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "EXPIRED_TOKEN", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "ACCESS_DENIED", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "INVALID_API_KEY", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "UNAUTHORIZED", "statusCode": "401" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "API_CONFIGURATION_ERROR", "statusCode": "500" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "QUOTA_EXCEEDED", "statusCode": "429" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "INTEGRATION_TIMEOUT", "statusCode": "504" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "INVALID_SIGNATURE", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "AUTHORIZER_FAILURE", "statusCode": "500" } ] } }

Customize Gateway Responses (http://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html)

func (GetGatewayResponsesOutput) GoString 

func (s GetGatewayResponsesOutput) GoString() string

GoString returns the string representation

func (GetGatewayResponsesOutput) SDKResponseMetadata 

func (s GetGatewayResponsesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetGatewayResponsesOutput) SetItems 

func (s *GetGatewayResponsesOutput) SetItems(v []UpdateGatewayResponseOutput) *GetGatewayResponsesOutput

SetItems sets the Items field's value.

func (*GetGatewayResponsesOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetGatewayResponsesOutput) String 

func (s GetGatewayResponsesOutput) String() string

String returns the string representation

type GetGatewayResponsesRequest 

type GetGatewayResponsesRequest struct {
	*aws.Request
	Input *GetGatewayResponsesInput
}

GetGatewayResponsesRequest is a API request type for the GetGatewayResponses API operation.

func (GetGatewayResponsesRequest) Send 

func (r GetGatewayResponsesRequest) Send() (*GetGatewayResponsesOutput, error)

Send marshals and sends the GetGatewayResponses API request.

type GetIntegrationInput 

type GetIntegrationInput struct {

	// Specifies a get integration request's HTTP method.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// Specifies a get integration request's resource identifier
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a get integration request.

func (GetIntegrationInput) GoString 

func (s GetIntegrationInput) GoString() string

GoString returns the string representation

func (*GetIntegrationInput) SetHttpMethod 

func (s *GetIntegrationInput) SetHttpMethod(v string) *GetIntegrationInput

SetHttpMethod sets the HttpMethod field's value.

func (*GetIntegrationInput) SetResourceId 

func (s *GetIntegrationInput) SetResourceId(v string) *GetIntegrationInput

SetResourceId sets the ResourceId field's value.

func (*GetIntegrationInput) SetRestApiId 

func (s *GetIntegrationInput) SetRestApiId(v string) *GetIntegrationInput

SetRestApiId sets the RestApiId field's value.

func (GetIntegrationInput) String 

func (s GetIntegrationInput) String() string

String returns the string representation

func (*GetIntegrationInput) Validate 

func (s *GetIntegrationInput) Validate() error

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

type GetIntegrationRequest 

type GetIntegrationRequest struct {
	*aws.Request
	Input *GetIntegrationInput
}

GetIntegrationRequest is a API request type for the GetIntegration API operation.

func (GetIntegrationRequest) Send 

func (r GetIntegrationRequest) Send() (*UpdateIntegrationOutput, error)

Send marshals and sends the GetIntegration API request.

type GetIntegrationResponseInput 

type GetIntegrationResponseInput struct {

	// Specifies a get integration response request's HTTP method.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// Specifies a get integration response request's resource identifier.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// Specifies a get integration response request's status code.
	//
	// StatusCode is a required field
	StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a get integration response request.

func (GetIntegrationResponseInput) GoString 

func (s GetIntegrationResponseInput) GoString() string

GoString returns the string representation

func (*GetIntegrationResponseInput) SetHttpMethod 

func (s *GetIntegrationResponseInput) SetHttpMethod(v string) *GetIntegrationResponseInput

SetHttpMethod sets the HttpMethod field's value.

func (*GetIntegrationResponseInput) SetResourceId 

func (s *GetIntegrationResponseInput) SetResourceId(v string) *GetIntegrationResponseInput

SetResourceId sets the ResourceId field's value.

func (*GetIntegrationResponseInput) SetRestApiId 

func (s *GetIntegrationResponseInput) SetRestApiId(v string) *GetIntegrationResponseInput

SetRestApiId sets the RestApiId field's value.

func (*GetIntegrationResponseInput) SetStatusCode 

func (s *GetIntegrationResponseInput) SetStatusCode(v string) *GetIntegrationResponseInput

SetStatusCode sets the StatusCode field's value.

func (GetIntegrationResponseInput) String 

func (s GetIntegrationResponseInput) String() string

String returns the string representation

func (*GetIntegrationResponseInput) Validate 

func (s *GetIntegrationResponseInput) Validate() error

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

type GetIntegrationResponseRequest 

type GetIntegrationResponseRequest struct {
	*aws.Request
	Input *GetIntegrationResponseInput
}

GetIntegrationResponseRequest is a API request type for the GetIntegrationResponse API operation.

func (GetIntegrationResponseRequest) Send 

func (r GetIntegrationResponseRequest) Send() (*UpdateIntegrationResponseOutput, error)

Send marshals and sends the GetIntegrationResponse API request.

type GetMethodInput 

type GetMethodInput struct {

	// Specifies the method request's HTTP method type.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// The Resource identifier for the Method resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to describe an existing Method resource.

func (GetMethodInput) GoString 

func (s GetMethodInput) GoString() string

GoString returns the string representation

func (*GetMethodInput) SetHttpMethod 

func (s *GetMethodInput) SetHttpMethod(v string) *GetMethodInput

SetHttpMethod sets the HttpMethod field's value.

func (*GetMethodInput) SetResourceId 

func (s *GetMethodInput) SetResourceId(v string) *GetMethodInput

SetResourceId sets the ResourceId field's value.

func (*GetMethodInput) SetRestApiId 

func (s *GetMethodInput) SetRestApiId(v string) *GetMethodInput

SetRestApiId sets the RestApiId field's value.

func (GetMethodInput) String 

func (s GetMethodInput) String() string

String returns the string representation

func (*GetMethodInput) Validate 

func (s *GetMethodInput) Validate() error

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

type GetMethodRequest 

type GetMethodRequest struct {
	*aws.Request
	Input *GetMethodInput
}

GetMethodRequest is a API request type for the GetMethod API operation.

func (GetMethodRequest) Send 

func (r GetMethodRequest) Send() (*UpdateMethodOutput, error)

Send marshals and sends the GetMethod API request.

type GetMethodResponseInput 

type GetMethodResponseInput struct {

	// The HTTP verb of the Method resource.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// The Resource identifier for the MethodResponse resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The status code for the MethodResponse resource.
	//
	// StatusCode is a required field
	StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to describe a MethodResponse resource.

func (GetMethodResponseInput) GoString 

func (s GetMethodResponseInput) GoString() string

GoString returns the string representation

func (*GetMethodResponseInput) SetHttpMethod 

func (s *GetMethodResponseInput) SetHttpMethod(v string) *GetMethodResponseInput

SetHttpMethod sets the HttpMethod field's value.

func (*GetMethodResponseInput) SetResourceId 

func (s *GetMethodResponseInput) SetResourceId(v string) *GetMethodResponseInput

SetResourceId sets the ResourceId field's value.

func (*GetMethodResponseInput) SetRestApiId 

func (s *GetMethodResponseInput) SetRestApiId(v string) *GetMethodResponseInput

SetRestApiId sets the RestApiId field's value.

func (*GetMethodResponseInput) SetStatusCode 

func (s *GetMethodResponseInput) SetStatusCode(v string) *GetMethodResponseInput

SetStatusCode sets the StatusCode field's value.

func (GetMethodResponseInput) String 

func (s GetMethodResponseInput) String() string

String returns the string representation

func (*GetMethodResponseInput) Validate 

func (s *GetMethodResponseInput) Validate() error

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

type GetMethodResponseRequest 

type GetMethodResponseRequest struct {
	*aws.Request
	Input *GetMethodResponseInput
}

GetMethodResponseRequest is a API request type for the GetMethodResponse API operation.

func (GetMethodResponseRequest) Send 

func (r GetMethodResponseRequest) Send() (*UpdateMethodResponseOutput, error)

Send marshals and sends the GetMethodResponse API request.

type GetModelInput 

type GetModelInput struct {

	// A query parameter of a Boolean value to resolve (true) all external model
	// references and returns a flattened model schema or not (false) The default
	// is false.
	Flatten *bool `location:"querystring" locationName:"flatten" type:"boolean"`

	// The name of the model as an identifier.
	//
	// ModelName is a required field
	ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"`

	// The RestApi identifier under which the Model exists.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to list information about a model in an existing RestApi resource.

func (GetModelInput) GoString 

func (s GetModelInput) GoString() string

GoString returns the string representation

func (*GetModelInput) SetFlatten 

func (s *GetModelInput) SetFlatten(v bool) *GetModelInput

SetFlatten sets the Flatten field's value.

func (*GetModelInput) SetModelName 

func (s *GetModelInput) SetModelName(v string) *GetModelInput

SetModelName sets the ModelName field's value.

func (*GetModelInput) SetRestApiId 

func (s *GetModelInput) SetRestApiId(v string) *GetModelInput

SetRestApiId sets the RestApiId field's value.

func (GetModelInput) String 

func (s GetModelInput) String() string

String returns the string representation

func (*GetModelInput) Validate 

func (s *GetModelInput) Validate() error

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

type GetModelRequest 

type GetModelRequest struct {
	*aws.Request
	Input *GetModelInput
}

GetModelRequest is a API request type for the GetModel API operation.

func (GetModelRequest) Send 

func (r GetModelRequest) Send() (*UpdateModelOutput, error)

Send marshals and sends the GetModel API request.

type GetModelTemplateInput 

type GetModelTemplateInput struct {

	// The name of the model for which to generate a template.
	//
	// ModelName is a required field
	ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to generate a sample mapping template used to transform the payload.

func (GetModelTemplateInput) GoString 

func (s GetModelTemplateInput) GoString() string

GoString returns the string representation

func (*GetModelTemplateInput) SetModelName 

func (s *GetModelTemplateInput) SetModelName(v string) *GetModelTemplateInput

SetModelName sets the ModelName field's value.

func (*GetModelTemplateInput) SetRestApiId 

func (s *GetModelTemplateInput) SetRestApiId(v string) *GetModelTemplateInput

SetRestApiId sets the RestApiId field's value.

func (GetModelTemplateInput) String 

func (s GetModelTemplateInput) String() string

String returns the string representation

func (*GetModelTemplateInput) Validate 

func (s *GetModelTemplateInput) Validate() error

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

type GetModelTemplateOutput 

type GetModelTemplateOutput struct {

	// The Apache Velocity Template Language (VTL) (http://velocity.apache.org/engine/devel/vtl-reference-guide.html)
	// template content used for the template resource.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Represents a mapping template used to transform a payload.

Mapping Templates (http://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html#models-mappings-mappings)

func (GetModelTemplateOutput) GoString 

func (s GetModelTemplateOutput) GoString() string

GoString returns the string representation

func (GetModelTemplateOutput) SDKResponseMetadata 

func (s GetModelTemplateOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetModelTemplateOutput) SetValue 

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

SetValue sets the Value field's value.

func (GetModelTemplateOutput) String 

func (s GetModelTemplateOutput) String() string

String returns the string representation

type GetModelTemplateRequest 

type GetModelTemplateRequest struct {
	*aws.Request
	Input *GetModelTemplateInput
}

GetModelTemplateRequest is a API request type for the GetModelTemplate API operation.

func (GetModelTemplateRequest) Send 

func (r GetModelTemplateRequest) Send() (*GetModelTemplateOutput, error)

Send marshals and sends the GetModelTemplate API request.

type GetModelsInput 

type GetModelsInput struct {

	// The maximum number of returned results per page. The value is 25 by default
	// and could be between 1 - 500.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to list existing Models defined for a RestApi resource.

func (GetModelsInput) GoString 

func (s GetModelsInput) GoString() string

GoString returns the string representation

func (*GetModelsInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetModelsInput) SetPosition 

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

SetPosition sets the Position field's value.

func (*GetModelsInput) SetRestApiId 

func (s *GetModelsInput) SetRestApiId(v string) *GetModelsInput

SetRestApiId sets the RestApiId field's value.

func (GetModelsInput) String 

func (s GetModelsInput) String() string

String returns the string representation

func (*GetModelsInput) Validate 

func (s *GetModelsInput) Validate() error

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

type GetModelsOutput 

type GetModelsOutput struct {

	// The current page of elements from this collection.
	Items []UpdateModelOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

Represents a collection of Model resources.

Method, MethodResponse, Models and Mappings (http://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html)

func (GetModelsOutput) GoString 

func (s GetModelsOutput) GoString() string

GoString returns the string representation

func (GetModelsOutput) SDKResponseMetadata 

func (s GetModelsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetModelsOutput) SetItems 

func (s *GetModelsOutput) SetItems(v []UpdateModelOutput) *GetModelsOutput

SetItems sets the Items field's value.

func (*GetModelsOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetModelsOutput) String 

func (s GetModelsOutput) String() string

String returns the string representation

type GetModelsRequest 

type GetModelsRequest struct {
	*aws.Request
	Input *GetModelsInput
}

GetModelsRequest is a API request type for the GetModels API operation.

func (GetModelsRequest) Send 

func (r GetModelsRequest) Send() (*GetModelsOutput, error)

Send marshals and sends the GetModels API request.

type GetRequestValidatorInput 

type GetRequestValidatorInput struct {

	// [Required] The identifier of the RequestValidator to be retrieved.
	//
	// RequestValidatorId is a required field
	RequestValidatorId *string `location:"uri" locationName:"requestvalidator_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Gets a RequestValidator of a given RestApi.

func (GetRequestValidatorInput) GoString 

func (s GetRequestValidatorInput) GoString() string

GoString returns the string representation

func (*GetRequestValidatorInput) SetRequestValidatorId 

func (s *GetRequestValidatorInput) SetRequestValidatorId(v string) *GetRequestValidatorInput

SetRequestValidatorId sets the RequestValidatorId field's value.

func (*GetRequestValidatorInput) SetRestApiId 

func (s *GetRequestValidatorInput) SetRestApiId(v string) *GetRequestValidatorInput

SetRestApiId sets the RestApiId field's value.

func (GetRequestValidatorInput) String 

func (s GetRequestValidatorInput) String() string

String returns the string representation

func (*GetRequestValidatorInput) Validate 

func (s *GetRequestValidatorInput) Validate() error

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

type GetRequestValidatorRequest 

type GetRequestValidatorRequest struct {
	*aws.Request
	Input *GetRequestValidatorInput
}

GetRequestValidatorRequest is a API request type for the GetRequestValidator API operation.

func (GetRequestValidatorRequest) Send 

func (r GetRequestValidatorRequest) Send() (*UpdateRequestValidatorOutput, error)

Send marshals and sends the GetRequestValidator API request.

type GetRequestValidatorsInput 

type GetRequestValidatorsInput struct {

	// The maximum number of returned results per page.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Gets the RequestValidators collection of a given RestApi.

func (GetRequestValidatorsInput) GoString 

func (s GetRequestValidatorsInput) GoString() string

GoString returns the string representation

func (*GetRequestValidatorsInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetRequestValidatorsInput) SetPosition 

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

SetPosition sets the Position field's value.

func (*GetRequestValidatorsInput) SetRestApiId 

func (s *GetRequestValidatorsInput) SetRestApiId(v string) *GetRequestValidatorsInput

SetRestApiId sets the RestApiId field's value.

func (GetRequestValidatorsInput) String 

func (s GetRequestValidatorsInput) String() string

String returns the string representation

func (*GetRequestValidatorsInput) Validate 

func (s *GetRequestValidatorsInput) Validate() error

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

type GetRequestValidatorsOutput 

type GetRequestValidatorsOutput struct {

	// The current page of elements from this collection.
	Items []UpdateRequestValidatorOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

A collection of RequestValidator resources of a given RestApi.

In Swagger, the RequestValidators of an API is defined by the x-amazon-apigateway-request-validators (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.html) extension.

Enable Basic Request Validation in API Gateway (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html)

func (GetRequestValidatorsOutput) GoString 

func (s GetRequestValidatorsOutput) GoString() string

GoString returns the string representation

func (GetRequestValidatorsOutput) SDKResponseMetadata 

func (s GetRequestValidatorsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetRequestValidatorsOutput) SetItems 

func (s *GetRequestValidatorsOutput) SetItems(v []UpdateRequestValidatorOutput) *GetRequestValidatorsOutput

SetItems sets the Items field's value.

func (*GetRequestValidatorsOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetRequestValidatorsOutput) String 

func (s GetRequestValidatorsOutput) String() string

String returns the string representation

type GetRequestValidatorsRequest 

type GetRequestValidatorsRequest struct {
	*aws.Request
	Input *GetRequestValidatorsInput
}

GetRequestValidatorsRequest is a API request type for the GetRequestValidators API operation.

func (GetRequestValidatorsRequest) Send 

func (r GetRequestValidatorsRequest) Send() (*GetRequestValidatorsOutput, error)

Send marshals and sends the GetRequestValidators API request.

type GetResourceInput 

type GetResourceInput struct {

	// A query parameter to retrieve the specified resources embedded in the returned
	// Resource representation in the response. This embed parameter value is a
	// list of comma-separated strings. Currently, the request supports only retrieval
	// of the embedded Method resources this way. The query parameter value must
	// be a single-valued list and contain the "methods" string. For example, GET
	// /restapis/{restapi_id}/resources/{resource_id}?embed=methods.
	Embed []string `location:"querystring" locationName:"embed" type:"list"`

	// The identifier for the Resource resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to list information about a resource.

func (GetResourceInput) GoString 

func (s GetResourceInput) GoString() string

GoString returns the string representation

func (*GetResourceInput) SetEmbed 

func (s *GetResourceInput) SetEmbed(v []string) *GetResourceInput

SetEmbed sets the Embed field's value.

func (*GetResourceInput) SetResourceId 

func (s *GetResourceInput) SetResourceId(v string) *GetResourceInput

SetResourceId sets the ResourceId field's value.

func (*GetResourceInput) SetRestApiId 

func (s *GetResourceInput) SetRestApiId(v string) *GetResourceInput

SetRestApiId sets the RestApiId field's value.

func (GetResourceInput) String 

func (s GetResourceInput) String() string

String returns the string representation

func (*GetResourceInput) Validate 

func (s *GetResourceInput) Validate() error

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

type GetResourceRequest 

type GetResourceRequest struct {
	*aws.Request
	Input *GetResourceInput
}

GetResourceRequest is a API request type for the GetResource API operation.

func (GetResourceRequest) Send 

func (r GetResourceRequest) Send() (*UpdateResourceOutput, error)

Send marshals and sends the GetResource API request.

type GetResourcesInput 

type GetResourcesInput struct {

	// A query parameter used to retrieve the specified resources embedded in the
	// returned Resources resource in the response. This embed parameter value is
	// a list of comma-separated strings. Currently, the request supports only retrieval
	// of the embedded Method resources this way. The query parameter value must
	// be a single-valued list and contain the "methods" string. For example, GET
	// /restapis/{restapi_id}/resources?embed=methods.
	Embed []string `location:"querystring" locationName:"embed" type:"list"`

	// The maximum number of returned results per page. The value is 25 by default
	// and could be between 1 - 500.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to list information about a collection of resources.

func (GetResourcesInput) GoString 

func (s GetResourcesInput) GoString() string

GoString returns the string representation

func (*GetResourcesInput) SetEmbed 

func (s *GetResourcesInput) SetEmbed(v []string) *GetResourcesInput

SetEmbed sets the Embed field's value.

func (*GetResourcesInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetResourcesInput) SetPosition 

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

SetPosition sets the Position field's value.

func (*GetResourcesInput) SetRestApiId 

func (s *GetResourcesInput) SetRestApiId(v string) *GetResourcesInput

SetRestApiId sets the RestApiId field's value.

func (GetResourcesInput) String 

func (s GetResourcesInput) String() string

String returns the string representation

func (*GetResourcesInput) Validate 

func (s *GetResourcesInput) Validate() error

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

type GetResourcesOutput 

type GetResourcesOutput struct {

	// The current page of elements from this collection.
	Items []UpdateResourceOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

Represents a collection of Resource resources.

Create an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)

func (GetResourcesOutput) GoString 

func (s GetResourcesOutput) GoString() string

GoString returns the string representation

func (GetResourcesOutput) SDKResponseMetadata 

func (s GetResourcesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetResourcesOutput) SetItems 

func (s *GetResourcesOutput) SetItems(v []UpdateResourceOutput) *GetResourcesOutput

SetItems sets the Items field's value.

func (*GetResourcesOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetResourcesOutput) String 

func (s GetResourcesOutput) String() string

String returns the string representation

type GetResourcesRequest 

type GetResourcesRequest struct {
	*aws.Request
	Input *GetResourcesInput
}

GetResourcesRequest is a API request type for the GetResources API operation.

func (GetResourcesRequest) Send 

func (r GetResourcesRequest) Send() (*GetResourcesOutput, error)

Send marshals and sends the GetResources API request.

type GetRestApiInput 

type GetRestApiInput struct {

	// The identifier of the RestApi resource.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The GET request to list an existing RestApi defined for your collection.

func (GetRestApiInput) GoString 

func (s GetRestApiInput) GoString() string

GoString returns the string representation

func (*GetRestApiInput) SetRestApiId 

func (s *GetRestApiInput) SetRestApiId(v string) *GetRestApiInput

SetRestApiId sets the RestApiId field's value.

func (GetRestApiInput) String 

func (s GetRestApiInput) String() string

String returns the string representation

func (*GetRestApiInput) Validate 

func (s *GetRestApiInput) Validate() error

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

type GetRestApiRequest 

type GetRestApiRequest struct {
	*aws.Request
	Input *GetRestApiInput
}

GetRestApiRequest is a API request type for the GetRestApi API operation.

func (GetRestApiRequest) Send 

func (r GetRestApiRequest) Send() (*UpdateRestApiOutput, error)

Send marshals and sends the GetRestApi API request.

type GetRestApisInput 

type GetRestApisInput struct {

	// The maximum number of returned results per page. The value is 25 by default
	// and could be between 1 - 500.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

The GET request to list existing RestApis defined for your collection.

func (GetRestApisInput) GoString 

func (s GetRestApisInput) GoString() string

GoString returns the string representation

func (*GetRestApisInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetRestApisInput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetRestApisInput) String 

func (s GetRestApisInput) String() string

String returns the string representation

type GetRestApisOutput 

type GetRestApisOutput struct {

	// The current page of elements from this collection.
	Items []UpdateRestApiOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.

Create an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)

func (GetRestApisOutput) GoString 

func (s GetRestApisOutput) GoString() string

GoString returns the string representation

func (GetRestApisOutput) SDKResponseMetadata 

func (s GetRestApisOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetRestApisOutput) SetItems 

func (s *GetRestApisOutput) SetItems(v []UpdateRestApiOutput) *GetRestApisOutput

SetItems sets the Items field's value.

func (*GetRestApisOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetRestApisOutput) String 

func (s GetRestApisOutput) String() string

String returns the string representation

type GetRestApisRequest 

type GetRestApisRequest struct {
	*aws.Request
	Input *GetRestApisInput
}

GetRestApisRequest is a API request type for the GetRestApis API operation.

func (GetRestApisRequest) Send 

func (r GetRestApisRequest) Send() (*GetRestApisOutput, error)

Send marshals and sends the GetRestApis API request.

type GetSdkInput 

type GetSdkInput struct {

	// A string-to-string key-value map of query parameters sdkType-dependent properties
	// of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix
	// is required. For sdkType of android, parameters named groupId, artifactId,
	// artifactVersion, and invokerPackage are required. For sdkType of java, parameters
	// named serviceName and javaPackageName are required.
	Parameters map[string]string `location:"querystring" locationName:"parameters" type:"map"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The language for the generated SDK. Currently java, javascript, android,
	// objectivec and swift (for iOS) are supported.
	//
	// SdkType is a required field
	SdkType *string `location:"uri" locationName:"sdk_type" type:"string" required:"true"`

	// The name of the Stage that the SDK will use.
	//
	// StageName is a required field
	StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request a new generated client SDK for a RestApi and Stage.

func (GetSdkInput) GoString 

func (s GetSdkInput) GoString() string

GoString returns the string representation

func (*GetSdkInput) SetParameters 

func (s *GetSdkInput) SetParameters(v map[string]string) *GetSdkInput

SetParameters sets the Parameters field's value.

func (*GetSdkInput) SetRestApiId 

func (s *GetSdkInput) SetRestApiId(v string) *GetSdkInput

SetRestApiId sets the RestApiId field's value.

func (*GetSdkInput) SetSdkType 

func (s *GetSdkInput) SetSdkType(v string) *GetSdkInput

SetSdkType sets the SdkType field's value.

func (*GetSdkInput) SetStageName 

func (s *GetSdkInput) SetStageName(v string) *GetSdkInput

SetStageName sets the StageName field's value.

func (GetSdkInput) String 

func (s GetSdkInput) String() string

String returns the string representation

func (*GetSdkInput) Validate 

func (s *GetSdkInput) Validate() error

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

type GetSdkOutput 

type GetSdkOutput struct {

	// The binary blob response to GetSdk, which contains the generated SDK.
	Body []byte `locationName:"body" type:"blob"`

	// The content-disposition header value in the HTTP response.
	ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"`

	// The content-type header value in the HTTP response.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`
	// contains filtered or unexported fields
}

The binary blob response to GetSdk, which contains the generated SDK.

func (GetSdkOutput) GoString 

func (s GetSdkOutput) GoString() string

GoString returns the string representation

func (GetSdkOutput) SDKResponseMetadata 

func (s GetSdkOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetSdkOutput) SetBody 

func (s *GetSdkOutput) SetBody(v []byte) *GetSdkOutput

SetBody sets the Body field's value.

func (*GetSdkOutput) SetContentDisposition 

func (s *GetSdkOutput) SetContentDisposition(v string) *GetSdkOutput

SetContentDisposition sets the ContentDisposition field's value.

func (*GetSdkOutput) SetContentType 

func (s *GetSdkOutput) SetContentType(v string) *GetSdkOutput

SetContentType sets the ContentType field's value.

func (GetSdkOutput) String 

func (s GetSdkOutput) String() string

String returns the string representation

type GetSdkRequest 

type GetSdkRequest struct {
	*aws.Request
	Input *GetSdkInput
}

GetSdkRequest is a API request type for the GetSdk API operation.

func (GetSdkRequest) Send 

func (r GetSdkRequest) Send() (*GetSdkOutput, error)

Send marshals and sends the GetSdk API request.

type GetSdkTypeInput 

type GetSdkTypeInput struct {

	// The identifier of the queried SdkType instance.
	//
	// Id is a required field
	Id *string `location:"uri" locationName:"sdktype_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Get an SdkType instance.

func (GetSdkTypeInput) GoString 

func (s GetSdkTypeInput) GoString() string

GoString returns the string representation

func (*GetSdkTypeInput) SetId 

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

SetId sets the Id field's value.

func (GetSdkTypeInput) String 

func (s GetSdkTypeInput) String() string

String returns the string representation

func (*GetSdkTypeInput) Validate 

func (s *GetSdkTypeInput) Validate() error

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

type GetSdkTypeOutput 

type GetSdkTypeOutput struct {

	// A list of configuration properties of an SdkType.
	ConfigurationProperties []SdkConfigurationProperty `locationName:"configurationProperties" type:"list"`

	// The description of an SdkType.
	Description *string `locationName:"description" type:"string"`

	// The user-friendly name of an SdkType instance.
	FriendlyName *string `locationName:"friendlyName" type:"string"`

	// The identifier of an SdkType instance.
	Id *string `locationName:"id" type:"string"`
	// contains filtered or unexported fields
}

A type of SDK that API Gateway can generate.

func (GetSdkTypeOutput) GoString 

func (s GetSdkTypeOutput) GoString() string

GoString returns the string representation

func (GetSdkTypeOutput) SDKResponseMetadata 

func (s GetSdkTypeOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetSdkTypeOutput) SetConfigurationProperties 

func (s *GetSdkTypeOutput) SetConfigurationProperties(v []SdkConfigurationProperty) *GetSdkTypeOutput

SetConfigurationProperties sets the ConfigurationProperties field's value.

func (*GetSdkTypeOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*GetSdkTypeOutput) SetFriendlyName 

func (s *GetSdkTypeOutput) SetFriendlyName(v string) *GetSdkTypeOutput

SetFriendlyName sets the FriendlyName field's value.

func (*GetSdkTypeOutput) SetId 

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

SetId sets the Id field's value.

func (GetSdkTypeOutput) String 

func (s GetSdkTypeOutput) String() string

String returns the string representation

type GetSdkTypeRequest 

type GetSdkTypeRequest struct {
	*aws.Request
	Input *GetSdkTypeInput
}

GetSdkTypeRequest is a API request type for the GetSdkType API operation.

func (GetSdkTypeRequest) Send 

func (r GetSdkTypeRequest) Send() (*GetSdkTypeOutput, error)

Send marshals and sends the GetSdkType API request.

type GetSdkTypesInput 

type GetSdkTypesInput struct {

	// The maximum number of returned results per page.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

Get the SdkTypes collection.

func (GetSdkTypesInput) GoString 

func (s GetSdkTypesInput) GoString() string

GoString returns the string representation

func (*GetSdkTypesInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetSdkTypesInput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetSdkTypesInput) String 

func (s GetSdkTypesInput) String() string

String returns the string representation

type GetSdkTypesOutput 

type GetSdkTypesOutput struct {

	// The current page of elements from this collection.
	Items []GetSdkTypeOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

The collection of SdkType instances.

func (GetSdkTypesOutput) GoString 

func (s GetSdkTypesOutput) GoString() string

GoString returns the string representation

func (GetSdkTypesOutput) SDKResponseMetadata 

func (s GetSdkTypesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetSdkTypesOutput) SetItems 

func (s *GetSdkTypesOutput) SetItems(v []GetSdkTypeOutput) *GetSdkTypesOutput

SetItems sets the Items field's value.

func (*GetSdkTypesOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetSdkTypesOutput) String 

func (s GetSdkTypesOutput) String() string

String returns the string representation

type GetSdkTypesRequest 

type GetSdkTypesRequest struct {
	*aws.Request
	Input *GetSdkTypesInput
}

GetSdkTypesRequest is a API request type for the GetSdkTypes API operation.

func (GetSdkTypesRequest) Send 

func (r GetSdkTypesRequest) Send() (*GetSdkTypesOutput, error)

Send marshals and sends the GetSdkTypes API request.

type GetStageInput 

type GetStageInput struct {

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The name of the Stage resource to get information about.
	//
	// StageName is a required field
	StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to get information about a Stage resource.

func (GetStageInput) GoString 

func (s GetStageInput) GoString() string

GoString returns the string representation

func (*GetStageInput) SetRestApiId 

func (s *GetStageInput) SetRestApiId(v string) *GetStageInput

SetRestApiId sets the RestApiId field's value.

func (*GetStageInput) SetStageName 

func (s *GetStageInput) SetStageName(v string) *GetStageInput

SetStageName sets the StageName field's value.

func (GetStageInput) String 

func (s GetStageInput) String() string

String returns the string representation

func (*GetStageInput) Validate 

func (s *GetStageInput) Validate() error

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

type GetStageRequest 

type GetStageRequest struct {
	*aws.Request
	Input *GetStageInput
}

GetStageRequest is a API request type for the GetStage API operation.

func (GetStageRequest) Send 

func (r GetStageRequest) Send() (*UpdateStageOutput, error)

Send marshals and sends the GetStage API request.

type GetStagesInput 

type GetStagesInput struct {

	// The stages' deployment identifiers.
	DeploymentId *string `location:"querystring" locationName:"deploymentId" type:"string"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to get information about one or more Stage resources.

func (GetStagesInput) GoString 

func (s GetStagesInput) GoString() string

GoString returns the string representation

func (*GetStagesInput) SetDeploymentId 

func (s *GetStagesInput) SetDeploymentId(v string) *GetStagesInput

SetDeploymentId sets the DeploymentId field's value.

func (*GetStagesInput) SetRestApiId 

func (s *GetStagesInput) SetRestApiId(v string) *GetStagesInput

SetRestApiId sets the RestApiId field's value.

func (GetStagesInput) String 

func (s GetStagesInput) String() string

String returns the string representation

func (*GetStagesInput) Validate 

func (s *GetStagesInput) Validate() error

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

type GetStagesOutput 

type GetStagesOutput struct {

	// The current page of elements from this collection.
	Item []UpdateStageOutput `locationName:"item" type:"list"`
	// contains filtered or unexported fields
}

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

Deploying API in Stages (http://docs.aws.amazon.com/apigateway/latest/developerguide/stages.html)

func (GetStagesOutput) GoString 

func (s GetStagesOutput) GoString() string

GoString returns the string representation

func (GetStagesOutput) SDKResponseMetadata 

func (s GetStagesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetStagesOutput) SetItem 

func (s *GetStagesOutput) SetItem(v []UpdateStageOutput) *GetStagesOutput

SetItem sets the Item field's value.

func (GetStagesOutput) String 

func (s GetStagesOutput) String() string

String returns the string representation

type GetStagesRequest 

type GetStagesRequest struct {
	*aws.Request
	Input *GetStagesInput
}

GetStagesRequest is a API request type for the GetStages API operation.

func (GetStagesRequest) Send 

func (r GetStagesRequest) Send() (*GetStagesOutput, error)

Send marshals and sends the GetStages API request.

type GetUsageInput 

type GetUsageInput struct {

	// The ending date (e.g., 2016-12-31) of the usage data.
	//
	// EndDate is a required field
	EndDate *string `location:"querystring" locationName:"endDate" type:"string" required:"true"`

	// The Id of the API key associated with the resultant usage data.
	KeyId *string `location:"querystring" locationName:"keyId" type:"string"`

	// The maximum number of returned results per page.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`

	// The starting date (e.g., 2016-01-01) of the usage data.
	//
	// StartDate is a required field
	StartDate *string `location:"querystring" locationName:"startDate" type:"string" required:"true"`

	// The Id of the usage plan associated with the usage data.
	//
	// UsagePlanId is a required field
	UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (GetUsageInput) GoString 

func (s GetUsageInput) GoString() string

GoString returns the string representation

func (*GetUsageInput) SetEndDate 

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

SetEndDate sets the EndDate field's value.

func (*GetUsageInput) SetKeyId 

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

SetKeyId sets the KeyId field's value.

func (*GetUsageInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetUsageInput) SetPosition 

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

SetPosition sets the Position field's value.

func (*GetUsageInput) SetStartDate 

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

SetStartDate sets the StartDate field's value.

func (*GetUsageInput) SetUsagePlanId 

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

SetUsagePlanId sets the UsagePlanId field's value.

func (GetUsageInput) String 

func (s GetUsageInput) String() string

String returns the string representation

func (*GetUsageInput) Validate 

func (s *GetUsageInput) Validate() error

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

type GetUsagePlanInput 

type GetUsagePlanInput struct {

	// The identifier of the UsagePlan resource to be retrieved.
	//
	// UsagePlanId is a required field
	UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The GET request to get a usage plan of a given plan identifier.

func (GetUsagePlanInput) GoString 

func (s GetUsagePlanInput) GoString() string

GoString returns the string representation

func (*GetUsagePlanInput) SetUsagePlanId 

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

SetUsagePlanId sets the UsagePlanId field's value.

func (GetUsagePlanInput) String 

func (s GetUsagePlanInput) String() string

String returns the string representation

func (*GetUsagePlanInput) Validate 

func (s *GetUsagePlanInput) Validate() error

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

type GetUsagePlanKeyInput 

type GetUsagePlanKeyInput struct {

	// The key Id of the to-be-retrieved UsagePlanKey resource representing a plan
	// customer.
	//
	// KeyId is a required field
	KeyId *string `location:"uri" locationName:"keyId" type:"string" required:"true"`

	// 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
	UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The GET request to get a usage plan key of a given key identifier.

func (GetUsagePlanKeyInput) GoString 

func (s GetUsagePlanKeyInput) GoString() string

GoString returns the string representation

func (*GetUsagePlanKeyInput) SetKeyId 

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

SetKeyId sets the KeyId field's value.

func (*GetUsagePlanKeyInput) SetUsagePlanId 

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

SetUsagePlanId sets the UsagePlanId field's value.

func (GetUsagePlanKeyInput) String 

func (s GetUsagePlanKeyInput) String() string

String returns the string representation

func (*GetUsagePlanKeyInput) Validate 

func (s *GetUsagePlanKeyInput) Validate() error

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

type GetUsagePlanKeyOutput 

type GetUsagePlanKeyOutput struct {

	// The Id of a usage plan key.
	Id *string `locationName:"id" type:"string"`

	// The name of a usage plan key.
	Name *string `locationName:"name" type:"string"`

	// The type of a usage plan key. Currently, the valid key type is API_KEY.
	Type *string `locationName:"type" type:"string"`

	// The value of a usage plan key.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Represents a usage plan key to identify a plan customer.

To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.

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

func (GetUsagePlanKeyOutput) GoString 

func (s GetUsagePlanKeyOutput) GoString() string

GoString returns the string representation

func (GetUsagePlanKeyOutput) SDKResponseMetadata 

func (s GetUsagePlanKeyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetUsagePlanKeyOutput) SetId 

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

SetId sets the Id field's value.

func (*GetUsagePlanKeyOutput) SetName 

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

SetName sets the Name field's value.

func (*GetUsagePlanKeyOutput) SetType 

func (s *GetUsagePlanKeyOutput) SetType(v string) *GetUsagePlanKeyOutput

SetType sets the Type field's value.

func (*GetUsagePlanKeyOutput) SetValue 

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

SetValue sets the Value field's value.

func (GetUsagePlanKeyOutput) String 

func (s GetUsagePlanKeyOutput) String() string

String returns the string representation

type GetUsagePlanKeyRequest 

type GetUsagePlanKeyRequest struct {
	*aws.Request
	Input *GetUsagePlanKeyInput
}

GetUsagePlanKeyRequest is a API request type for the GetUsagePlanKey API operation.

func (GetUsagePlanKeyRequest) Send 

func (r GetUsagePlanKeyRequest) Send() (*GetUsagePlanKeyOutput, error)

Send marshals and sends the GetUsagePlanKey API request.

type GetUsagePlanKeysInput 

type GetUsagePlanKeysInput struct {

	// The maximum number of returned results per page.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// A query parameter specifying the name of the to-be-returned usage plan keys.
	NameQuery *string `location:"querystring" locationName:"name" type:"string"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`

	// 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
	UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (GetUsagePlanKeysInput) GoString 

func (s GetUsagePlanKeysInput) GoString() string

GoString returns the string representation

func (*GetUsagePlanKeysInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetUsagePlanKeysInput) SetNameQuery 

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

SetNameQuery sets the NameQuery field's value.

func (*GetUsagePlanKeysInput) SetPosition 

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

SetPosition sets the Position field's value.

func (*GetUsagePlanKeysInput) SetUsagePlanId 

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

SetUsagePlanId sets the UsagePlanId field's value.

func (GetUsagePlanKeysInput) String 

func (s GetUsagePlanKeysInput) String() string

String returns the string representation

func (*GetUsagePlanKeysInput) Validate 

func (s *GetUsagePlanKeysInput) Validate() error

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

type GetUsagePlanKeysOutput 

type GetUsagePlanKeysOutput struct {

	// The current page of elements from this collection.
	Items []GetUsagePlanKeyOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.

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

func (GetUsagePlanKeysOutput) GoString 

func (s GetUsagePlanKeysOutput) GoString() string

GoString returns the string representation

func (GetUsagePlanKeysOutput) SDKResponseMetadata 

func (s GetUsagePlanKeysOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetUsagePlanKeysOutput) SetItems 

func (s *GetUsagePlanKeysOutput) SetItems(v []GetUsagePlanKeyOutput) *GetUsagePlanKeysOutput

SetItems sets the Items field's value.

func (*GetUsagePlanKeysOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetUsagePlanKeysOutput) String 

func (s GetUsagePlanKeysOutput) String() string

String returns the string representation

type GetUsagePlanKeysRequest 

type GetUsagePlanKeysRequest struct {
	*aws.Request
	Input *GetUsagePlanKeysInput
}

GetUsagePlanKeysRequest is a API request type for the GetUsagePlanKeys API operation.

func (GetUsagePlanKeysRequest) Send 

func (r GetUsagePlanKeysRequest) Send() (*GetUsagePlanKeysOutput, error)

Send marshals and sends the GetUsagePlanKeys API request.

type GetUsagePlanRequest 

type GetUsagePlanRequest struct {
	*aws.Request
	Input *GetUsagePlanInput
}

GetUsagePlanRequest is a API request type for the GetUsagePlan API operation.

func (GetUsagePlanRequest) Send 

func (r GetUsagePlanRequest) Send() (*UpdateUsagePlanOutput, error)

Send marshals and sends the GetUsagePlan API request.

type GetUsagePlansInput 

type GetUsagePlansInput struct {

	// The identifier of the API key associated with the usage plans.
	KeyId *string `location:"querystring" locationName:"keyId" type:"string"`

	// The maximum number of returned results per page.
	Limit *int64 `location:"querystring" locationName:"limit" type:"integer"`

	// The current pagination position in the paged result set.
	Position *string `location:"querystring" locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

The GET request to get all the usage plans of the caller's account.

func (GetUsagePlansInput) GoString 

func (s GetUsagePlansInput) GoString() string

GoString returns the string representation

func (*GetUsagePlansInput) SetKeyId 

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

SetKeyId sets the KeyId field's value.

func (*GetUsagePlansInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*GetUsagePlansInput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetUsagePlansInput) String 

func (s GetUsagePlansInput) String() string

String returns the string representation

type GetUsagePlansOutput 

type GetUsagePlansOutput struct {

	// The current page of elements from this collection.
	Items []UpdateUsagePlanOutput `locationName:"item" type:"list"`

	Position *string `locationName:"position" type:"string"`
	// contains filtered or unexported fields
}

Represents a collection of usage plans for an AWS account.

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

func (GetUsagePlansOutput) GoString 

func (s GetUsagePlansOutput) GoString() string

GoString returns the string representation

func (GetUsagePlansOutput) SDKResponseMetadata 

func (s GetUsagePlansOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetUsagePlansOutput) SetItems 

func (s *GetUsagePlansOutput) SetItems(v []UpdateUsagePlanOutput) *GetUsagePlansOutput

SetItems sets the Items field's value.

func (*GetUsagePlansOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (GetUsagePlansOutput) String 

func (s GetUsagePlansOutput) String() string

String returns the string representation

type GetUsagePlansRequest 

type GetUsagePlansRequest struct {
	*aws.Request
	Input *GetUsagePlansInput
}

GetUsagePlansRequest is a API request type for the GetUsagePlans API operation.

func (GetUsagePlansRequest) Send 

func (r GetUsagePlansRequest) Send() (*GetUsagePlansOutput, error)

Send marshals and sends the GetUsagePlans API request.

type GetUsageRequest 

type GetUsageRequest struct {
	*aws.Request
	Input *GetUsageInput
}

GetUsageRequest is a API request type for the GetUsage API operation.

func (GetUsageRequest) Send 

func (r GetUsageRequest) Send() (*UpdateUsageOutput, error)

Send marshals and sends the GetUsage API request.

type ImportApiKeysInput 

type ImportApiKeysInput struct {

	// The payload of the POST request to import API keys. For the payload format,
	// see API Key File Format (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html).
	//
	// Body is a required field
	Body []byte `locationName:"body" type:"blob" required:"true"`

	// A query parameter to indicate whether to rollback ApiKey importation (true)
	// or not (false) when error is encountered.
	FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"`

	// A query parameter to specify the input format to imported API keys. Currently,
	// only the csv format is supported.
	//
	// Format is a required field
	Format ApiKeysFormat `location:"querystring" locationName:"format" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

The POST request to import API keys from an external source, such as a CSV-formatted file.

func (ImportApiKeysInput) GoString 

func (s ImportApiKeysInput) GoString() string

GoString returns the string representation

func (*ImportApiKeysInput) SetBody 

func (s *ImportApiKeysInput) SetBody(v []byte) *ImportApiKeysInput

SetBody sets the Body field's value.

func (*ImportApiKeysInput) SetFailOnWarnings 

func (s *ImportApiKeysInput) SetFailOnWarnings(v bool) *ImportApiKeysInput

SetFailOnWarnings sets the FailOnWarnings field's value.

func (*ImportApiKeysInput) SetFormat 

func (s *ImportApiKeysInput) SetFormat(v ApiKeysFormat) *ImportApiKeysInput

SetFormat sets the Format field's value.

func (ImportApiKeysInput) String 

func (s ImportApiKeysInput) String() string

String returns the string representation

func (*ImportApiKeysInput) Validate 

func (s *ImportApiKeysInput) Validate() error

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

type ImportApiKeysOutput 

type ImportApiKeysOutput struct {

	// A list of all the ApiKey identifiers.
	Ids []string `locationName:"ids" type:"list"`

	// A list of warning messages.
	Warnings []string `locationName:"warnings" type:"list"`
	// contains filtered or unexported fields
}

The identifier of an ApiKey used in a UsagePlan.

func (ImportApiKeysOutput) GoString 

func (s ImportApiKeysOutput) GoString() string

GoString returns the string representation

func (ImportApiKeysOutput) SDKResponseMetadata 

func (s ImportApiKeysOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*ImportApiKeysOutput) SetIds 

func (s *ImportApiKeysOutput) SetIds(v []string) *ImportApiKeysOutput

SetIds sets the Ids field's value.

func (*ImportApiKeysOutput) SetWarnings 

func (s *ImportApiKeysOutput) SetWarnings(v []string) *ImportApiKeysOutput

SetWarnings sets the Warnings field's value.

func (ImportApiKeysOutput) String 

func (s ImportApiKeysOutput) String() string

String returns the string representation

type ImportApiKeysRequest 

type ImportApiKeysRequest struct {
	*aws.Request
	Input *ImportApiKeysInput
}

ImportApiKeysRequest is a API request type for the ImportApiKeys API operation.

func (ImportApiKeysRequest) Send 

func (r ImportApiKeysRequest) Send() (*ImportApiKeysOutput, error)

Send marshals and sends the ImportApiKeys API request.

type ImportDocumentationPartsInput 

type ImportDocumentationPartsInput struct {

	// [Required] Raw byte array representing the to-be-imported documentation parts.
	// To import from a Swagger file, this is a JSON object.
	//
	// Body is a required field
	Body []byte `locationName:"body" type:"blob" required:"true"`

	// A query parameter to specify whether to rollback the documentation importation
	// (true) or not (false) when a warning is encountered. The default value is
	// false.
	FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"`

	// A query parameter to indicate whether to overwrite (OVERWRITE) any existing
	// DocumentationParts definition or to merge (MERGE) the new definition into
	// the existing one. The default value is MERGE.
	Mode PutMode `location:"querystring" locationName:"mode" type:"string" enum:"true"`

	// [Required] The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Import documentation parts from an external (e.g., Swagger) definition file.

func (ImportDocumentationPartsInput) GoString 

func (s ImportDocumentationPartsInput) GoString() string

GoString returns the string representation

func (*ImportDocumentationPartsInput) SetBody 

func (s *ImportDocumentationPartsInput) SetBody(v []byte) *ImportDocumentationPartsInput

SetBody sets the Body field's value.

func (*ImportDocumentationPartsInput) SetFailOnWarnings 

func (s *ImportDocumentationPartsInput) SetFailOnWarnings(v bool) *ImportDocumentationPartsInput

SetFailOnWarnings sets the FailOnWarnings field's value.

func (*ImportDocumentationPartsInput) SetMode 

func (s *ImportDocumentationPartsInput) SetMode(v PutMode) *ImportDocumentationPartsInput

SetMode sets the Mode field's value.

func (*ImportDocumentationPartsInput) SetRestApiId 

func (s *ImportDocumentationPartsInput) SetRestApiId(v string) *ImportDocumentationPartsInput

SetRestApiId sets the RestApiId field's value.

func (ImportDocumentationPartsInput) String 

func (s ImportDocumentationPartsInput) String() string

String returns the string representation

func (*ImportDocumentationPartsInput) Validate 

func (s *ImportDocumentationPartsInput) Validate() error

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

type ImportDocumentationPartsOutput 

type ImportDocumentationPartsOutput struct {

	// A list of the returned documentation part identifiers.
	Ids []string `locationName:"ids" type:"list"`

	// A list of warning messages reported during import of documentation parts.
	Warnings []string `locationName:"warnings" type:"list"`
	// contains filtered or unexported fields
}

A collection of the imported DocumentationPart identifiers.

This is used to return the result when documentation parts in an external (e.g., Swagger) file are imported into Amazon API Gateway Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), documentationpart:import (http://docs.aws.amazon.com/apigateway/api-reference/link-relation/documentationpart-import/), DocumentationPart

func (ImportDocumentationPartsOutput) GoString 

func (s ImportDocumentationPartsOutput) GoString() string

GoString returns the string representation

func (ImportDocumentationPartsOutput) SDKResponseMetadata 

func (s ImportDocumentationPartsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*ImportDocumentationPartsOutput) SetIds 

func (s *ImportDocumentationPartsOutput) SetIds(v []string) *ImportDocumentationPartsOutput

SetIds sets the Ids field's value.

func (*ImportDocumentationPartsOutput) SetWarnings 

func (s *ImportDocumentationPartsOutput) SetWarnings(v []string) *ImportDocumentationPartsOutput

SetWarnings sets the Warnings field's value.

func (ImportDocumentationPartsOutput) String 

func (s ImportDocumentationPartsOutput) String() string

String returns the string representation

type ImportDocumentationPartsRequest 

type ImportDocumentationPartsRequest struct {
	*aws.Request
	Input *ImportDocumentationPartsInput
}

ImportDocumentationPartsRequest is a API request type for the ImportDocumentationParts API operation.

func (ImportDocumentationPartsRequest) Send 

func (r ImportDocumentationPartsRequest) Send() (*ImportDocumentationPartsOutput, error)

Send marshals and sends the ImportDocumentationParts API request.

type ImportRestApiInput 

type ImportRestApiInput struct {

	// The POST request body containing external API definitions. Currently, only
	// Swagger definition JSON files are supported. The maximum size of the API
	// definition file is 2MB.
	//
	// Body is a required field
	Body []byte `locationName:"body" type:"blob" required:"true"`

	// A query parameter to indicate whether to rollback the API creation (true)
	// or not (false) when a warning is encountered. The default value is false.
	FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"`

	// Custom header parameters as part of the request. For example, to exclude
	// DocumentationParts from an imported API, set ignore=documentation as a parameters
	// value, as in the AWS CLI command of aws apigateway import-rest-api --parameters
	// ignore=documentation --body 'file:///path/to/imported-api-body.json.
	Parameters map[string]string `location:"querystring" locationName:"parameters" type:"map"`
	// contains filtered or unexported fields
}

A POST request to import an API to Amazon API Gateway using an input of an API definition file.

func (ImportRestApiInput) GoString 

func (s ImportRestApiInput) GoString() string

GoString returns the string representation

func (*ImportRestApiInput) SetBody 

func (s *ImportRestApiInput) SetBody(v []byte) *ImportRestApiInput

SetBody sets the Body field's value.

func (*ImportRestApiInput) SetFailOnWarnings 

func (s *ImportRestApiInput) SetFailOnWarnings(v bool) *ImportRestApiInput

SetFailOnWarnings sets the FailOnWarnings field's value.

func (*ImportRestApiInput) SetParameters 

func (s *ImportRestApiInput) SetParameters(v map[string]string) *ImportRestApiInput

SetParameters sets the Parameters field's value.

func (ImportRestApiInput) String 

func (s ImportRestApiInput) String() string

String returns the string representation

func (*ImportRestApiInput) Validate 

func (s *ImportRestApiInput) Validate() error

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

type ImportRestApiRequest 

type ImportRestApiRequest struct {
	*aws.Request
	Input *ImportRestApiInput
}

ImportRestApiRequest is a API request type for the ImportRestApi API operation.

func (ImportRestApiRequest) Send 

func (r ImportRestApiRequest) Send() (*UpdateRestApiOutput, error)

Send marshals and sends the ImportRestApi API request.

type IntegrationType 

type IntegrationType string

The integration type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type. 

const (
	IntegrationTypeHttp      IntegrationType = "HTTP"
	IntegrationTypeAws       IntegrationType = "AWS"
	IntegrationTypeMock      IntegrationType = "MOCK"
	IntegrationTypeHttpProxy IntegrationType = "HTTP_PROXY"
	IntegrationTypeAwsProxy  IntegrationType = "AWS_PROXY"
)

Enum values for IntegrationType

type MethodSetting 

type MethodSetting struct {

	// Specifies whether the cached responses are encrypted. The PATCH path for
	// this setting is /{method_setting_key}/caching/dataEncrypted, and the value
	// is a Boolean.
	CacheDataEncrypted *bool `locationName:"cacheDataEncrypted" type:"boolean"`

	// Specifies the time to live (TTL), in seconds, for cached responses. The higher
	// the TTL, the longer the response will be cached. The PATCH path for this
	// setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an
	// integer.
	CacheTtlInSeconds *int64 `locationName:"cacheTtlInSeconds" type:"integer"`

	// Specifies whether responses should be cached and returned for requests. A
	// cache cluster must be enabled on the stage for responses to be cached. The
	// PATCH path for this setting is /{method_setting_key}/caching/enabled, and
	// the value is a Boolean.
	CachingEnabled *bool `locationName:"cachingEnabled" type:"boolean"`

	// Specifies whether data trace logging is enabled for this method, which effects
	// the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this
	// setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.
	DataTraceEnabled *bool `locationName:"dataTraceEnabled" type:"boolean"`

	// Specifies the logging level for this method, which effects the log entries
	// pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel,
	// and the available levels are OFF, ERROR, and INFO.
	LoggingLevel *string `locationName:"loggingLevel" type:"string"`

	// Specifies whether Amazon CloudWatch metrics are enabled for this method.
	// The PATCH path for this setting is /{method_setting_key}/metrics/enabled,
	// and the value is a Boolean.
	MetricsEnabled *bool `locationName:"metricsEnabled" type:"boolean"`

	// Specifies whether authorization is required for a cache invalidation request.
	// The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl,
	// and the value is a Boolean.
	RequireAuthorizationForCacheControl *bool `locationName:"requireAuthorizationForCacheControl" type:"boolean"`

	// Specifies the throttling burst limit. The PATCH path for this setting is
	// /{method_setting_key}/throttling/burstLimit, and the value is an integer.
	ThrottlingBurstLimit *int64 `locationName:"throttlingBurstLimit" type:"integer"`

	// Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit,
	// and the value is a double.
	ThrottlingRateLimit *float64 `locationName:"throttlingRateLimit" type:"double"`

	// Specifies how to handle unauthorized requests for cache invalidation. The
	// PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy,
	// and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER,
	// SUCCEED_WITHOUT_RESPONSE_HEADER.
	UnauthorizedCacheControlHeaderStrategy UnauthorizedCacheControlHeaderStrategy `locationName:"unauthorizedCacheControlHeaderStrategy" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Specifies the method setting properties.

func (MethodSetting) GoString 

func (s MethodSetting) GoString() string

GoString returns the string representation

func (*MethodSetting) SetCacheDataEncrypted 

func (s *MethodSetting) SetCacheDataEncrypted(v bool) *MethodSetting

SetCacheDataEncrypted sets the CacheDataEncrypted field's value.

func (*MethodSetting) SetCacheTtlInSeconds 

func (s *MethodSetting) SetCacheTtlInSeconds(v int64) *MethodSetting

SetCacheTtlInSeconds sets the CacheTtlInSeconds field's value.

func (*MethodSetting) SetCachingEnabled 

func (s *MethodSetting) SetCachingEnabled(v bool) *MethodSetting

SetCachingEnabled sets the CachingEnabled field's value.

func (*MethodSetting) SetDataTraceEnabled 

func (s *MethodSetting) SetDataTraceEnabled(v bool) *MethodSetting

SetDataTraceEnabled sets the DataTraceEnabled field's value.

func (*MethodSetting) SetLoggingLevel 

func (s *MethodSetting) SetLoggingLevel(v string) *MethodSetting

SetLoggingLevel sets the LoggingLevel field's value.

func (*MethodSetting) SetMetricsEnabled 

func (s *MethodSetting) SetMetricsEnabled(v bool) *MethodSetting

SetMetricsEnabled sets the MetricsEnabled field's value.

func (*MethodSetting) SetRequireAuthorizationForCacheControl 

func (s *MethodSetting) SetRequireAuthorizationForCacheControl(v bool) *MethodSetting

SetRequireAuthorizationForCacheControl sets the RequireAuthorizationForCacheControl field's value.

func (*MethodSetting) SetThrottlingBurstLimit 

func (s *MethodSetting) SetThrottlingBurstLimit(v int64) *MethodSetting

SetThrottlingBurstLimit sets the ThrottlingBurstLimit field's value.

func (*MethodSetting) SetThrottlingRateLimit 

func (s *MethodSetting) SetThrottlingRateLimit(v float64) *MethodSetting

SetThrottlingRateLimit sets the ThrottlingRateLimit field's value.

func (*MethodSetting) SetUnauthorizedCacheControlHeaderStrategy 

func (s *MethodSetting) SetUnauthorizedCacheControlHeaderStrategy(v UnauthorizedCacheControlHeaderStrategy) *MethodSetting

SetUnauthorizedCacheControlHeaderStrategy sets the UnauthorizedCacheControlHeaderStrategy field's value.

func (MethodSetting) String 

func (s MethodSetting) String() string

String returns the string representation

type MethodSnapshot 

type MethodSnapshot struct {

	// Specifies whether the method requires a valid ApiKey.
	ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"`

	// The method's authorization type. Valid values are NONE for open access, AWS_IAM
	// for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS
	// for using a Cognito user pool.
	AuthorizationType *string `locationName:"authorizationType" type:"string"`
	// contains filtered or unexported fields
}

Represents a summary of a Method resource, given a particular date and time.

func (MethodSnapshot) GoString 

func (s MethodSnapshot) GoString() string

GoString returns the string representation

func (*MethodSnapshot) SetApiKeyRequired 

func (s *MethodSnapshot) SetApiKeyRequired(v bool) *MethodSnapshot

SetApiKeyRequired sets the ApiKeyRequired field's value.

func (*MethodSnapshot) SetAuthorizationType 

func (s *MethodSnapshot) SetAuthorizationType(v string) *MethodSnapshot

SetAuthorizationType sets the AuthorizationType field's value.

func (MethodSnapshot) String 

func (s MethodSnapshot) String() string

String returns the string representation

type Op 

type Op string
const (
	OpAdd     Op = "add"
	OpRemove  Op = "remove"
	OpReplace Op = "replace"
	OpMove    Op = "move"
	OpCopy    Op = "copy"
	OpTest    Op = "test"
)

Enum values for Op

type PatchOperation 

type PatchOperation struct {

	// Not supported.
	From *string `locationName:"from" type:"string"`

	// An update operation to be performed with this PATCH request. The valid value
	// can be "add", "remove", or "replace". Not all valid operations are supported
	// for a given resource. Support of the operations depends on specific operational
	// contexts. Attempts to apply an unsupported operation on a resource will return
	// an error message.
	Op Op `locationName:"op" type:"string" enum:"true"`

	// The op operation's target, as identified by a JSON Pointer (https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08)
	// value that references a location within the targeted resource. For example,
	// if the target resource has an updateable property of {"name":"value"}, the
	// path for this property is /name. If the name property value is a JSON object
	// (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name
	// property will be /name/child~1name. Any slash ("/") character appearing in
	// path names must be escaped with "~1", as shown in the example above. Each
	// op operation can have only one path associated with it.
	Path *string `locationName:"path" type:"string"`

	// The new target value of the update operation. When using AWS CLI to update
	// a property of a JSON value, enclose the JSON object with a pair of single
	// quotes in a Linux shell, e.g., '{"a": ...}'. In a Windows shell, see Using
	// JSON for Parameters (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json).
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.

func (PatchOperation) GoString 

func (s PatchOperation) GoString() string

GoString returns the string representation

func (*PatchOperation) SetFrom 

func (s *PatchOperation) SetFrom(v string) *PatchOperation

SetFrom sets the From field's value.

func (*PatchOperation) SetOp 

func (s *PatchOperation) SetOp(v Op) *PatchOperation

SetOp sets the Op field's value.

func (*PatchOperation) SetPath 

func (s *PatchOperation) SetPath(v string) *PatchOperation

SetPath sets the Path field's value.

func (*PatchOperation) SetValue 

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

SetValue sets the Value field's value.

func (PatchOperation) String 

func (s PatchOperation) String() string

String returns the string representation

type PutGatewayResponseInput 

type PutGatewayResponseInput struct {

	// Response parameters (paths, query strings and headers) of the GatewayResponse
	// as a string-to-string map of key-value pairs.
	ResponseParameters map[string]string `locationName:"responseParameters" type:"map"`

	// Response templates of the GatewayResponse as a string-to-string map of key-value
	// pairs.
	ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"`

	// The response type of the associated GatewayResponse. Valid values are ACCESS_DENIED
	//
	// API_CONFIGURATION_ERROR
	// AUTHORIZER_FAILURE
	//  AUTHORIZER_CONFIGURATION_ERROR
	// BAD_REQUEST_PARAMETERS
	// BAD_REQUEST_BODY
	// DEFAULT_4XX
	// DEFAULT_5XX
	// EXPIRED_TOKEN
	// INVALID_SIGNATURE
	// INTEGRATION_FAILURE
	// INTEGRATION_TIMEOUT
	// INVALID_API_KEY
	// MISSING_AUTHENTICATION_TOKEN
	//  QUOTA_EXCEEDED
	// REQUEST_TOO_LARGE
	// RESOURCE_NOT_FOUND
	// THROTTLED
	// UNAUTHORIZED
	// UNSUPPORTED_MEDIA_TYPES
	//
	// ResponseType is a required field
	ResponseType GatewayResponseType `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The HTTP status code of the GatewayResponse
	StatusCode *string `locationName:"statusCode" type:"string"`
	// contains filtered or unexported fields
}

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

func (PutGatewayResponseInput) GoString 

func (s PutGatewayResponseInput) GoString() string

GoString returns the string representation

func (*PutGatewayResponseInput) SetResponseParameters 

func (s *PutGatewayResponseInput) SetResponseParameters(v map[string]string) *PutGatewayResponseInput

SetResponseParameters sets the ResponseParameters field's value.

func (*PutGatewayResponseInput) SetResponseTemplates 

func (s *PutGatewayResponseInput) SetResponseTemplates(v map[string]string) *PutGatewayResponseInput

SetResponseTemplates sets the ResponseTemplates field's value.

func (*PutGatewayResponseInput) SetResponseType 

func (s *PutGatewayResponseInput) SetResponseType(v GatewayResponseType) *PutGatewayResponseInput

SetResponseType sets the ResponseType field's value.

func (*PutGatewayResponseInput) SetRestApiId 

func (s *PutGatewayResponseInput) SetRestApiId(v string) *PutGatewayResponseInput

SetRestApiId sets the RestApiId field's value.

func (*PutGatewayResponseInput) SetStatusCode 

func (s *PutGatewayResponseInput) SetStatusCode(v string) *PutGatewayResponseInput

SetStatusCode sets the StatusCode field's value.

func (PutGatewayResponseInput) String 

func (s PutGatewayResponseInput) String() string

String returns the string representation

func (*PutGatewayResponseInput) Validate 

func (s *PutGatewayResponseInput) Validate() error

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

type PutGatewayResponseRequest 

type PutGatewayResponseRequest struct {
	*aws.Request
	Input *PutGatewayResponseInput
}

PutGatewayResponseRequest is a API request type for the PutGatewayResponse API operation.

func (PutGatewayResponseRequest) Send 

func (r PutGatewayResponseRequest) Send() (*UpdateGatewayResponseOutput, error)

Send marshals and sends the PutGatewayResponse API request.

type PutIntegrationInput 

type PutIntegrationInput struct {

	// Specifies a put integration input's cache key parameters.
	CacheKeyParameters []string `locationName:"cacheKeyParameters" type:"list"`

	// Specifies a put integration input's cache namespace.
	CacheNamespace *string `locationName:"cacheNamespace" type:"string"`

	// Specifies how to handle request payload content type conversions. Supported
	// values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
	//
	//    * CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded
	//    string to the corresponding binary blob.
	//
	//    * CONVERT_TO_TEXT: Converts a request payload from a binary blob to a
	//    Base64-encoded string.
	//
	// If this property is not defined, the request payload will be passed through
	// from the method request to integration request without modification, provided
	// that the passthroughBehaviors is configured to support payload pass-through.
	ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"`

	// Specifies whether credentials are required for a put integration.
	Credentials *string `locationName:"credentials" type:"string"`

	// Specifies a put integration request's HTTP method.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// Specifies a put integration HTTP method. When the integration type is HTTP
	// or AWS, this field is required.
	IntegrationHttpMethod *string `locationName:"httpMethod" type:"string"`

	// Specifies the pass-through behavior for incoming requests based on the Content-Type
	// header in the request, and the available mapping templates specified as the
	// requestTemplates property on the Integration resource. There are three valid
	// values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
	//
	//    * WHEN_NO_MATCH passes the request body for unmapped content types through
	//    to the integration back end without transformation.
	//
	//    * NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media
	//    Type' response.
	//
	//    * WHEN_NO_TEMPLATES allows pass-through when the integration has NO content
	//    types mapped to templates. However if there is at least one content type
	//    defined, unmapped content types will be rejected with the same 415 response.
	PassthroughBehavior *string `locationName:"passthroughBehavior" type:"string"`

	// A key-value map specifying request parameters that are passed from the method
	// request to the back end. The key is an integration request parameter name
	// and the associated value is a method request parameter value or static value
	// that must be enclosed within single quotes and pre-encoded as required by
	// the back end. The method request parameter value must match the pattern of
	// method.request.{location}.{name}, where location is querystring, path, or
	// header and name must be a valid and unique method request parameter name.
	RequestParameters map[string]string `locationName:"requestParameters" type:"map"`

	// Represents a map of Velocity templates that are applied on the request payload
	// based on the value of the Content-Type header sent by the client. The content
	// type value is the key in this map, and the template (as a String) is the
	// value.
	RequestTemplates map[string]string `locationName:"requestTemplates" type:"map"`

	// Specifies a put integration request's resource ID.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// Specifies a put integration input's type.
	//
	// Type is a required field
	Type IntegrationType `locationName:"type" type:"string" required:"true" enum:"true"`

	// Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations,
	// the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986
	// specification (https://en.wikipedia.org/wiki/Uniform_Resource_Identifier).
	// For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}.
	// Region, subdomain and service are used to determine the right endpoint. For
	// AWS services that use the Action= query string parameter, service_api should
	// be a valid action for the desired service. For RESTful AWS service APIs,
	// path is used to indicate that the remaining substring in the URI should be
	// treated as the path to the resource, including the initial /.
	Uri *string `locationName:"uri" type:"string"`
	// contains filtered or unexported fields
}

Sets up a method's integration.

func (PutIntegrationInput) GoString 

func (s PutIntegrationInput) GoString() string

GoString returns the string representation

func (*PutIntegrationInput) SetCacheKeyParameters 

func (s *PutIntegrationInput) SetCacheKeyParameters(v []string) *PutIntegrationInput

SetCacheKeyParameters sets the CacheKeyParameters field's value.

func (*PutIntegrationInput) SetCacheNamespace 

func (s *PutIntegrationInput) SetCacheNamespace(v string) *PutIntegrationInput

SetCacheNamespace sets the CacheNamespace field's value.

func (*PutIntegrationInput) SetContentHandling 

func (s *PutIntegrationInput) SetContentHandling(v ContentHandlingStrategy) *PutIntegrationInput

SetContentHandling sets the ContentHandling field's value.

func (*PutIntegrationInput) SetCredentials 

func (s *PutIntegrationInput) SetCredentials(v string) *PutIntegrationInput

SetCredentials sets the Credentials field's value.

func (*PutIntegrationInput) SetHttpMethod 

func (s *PutIntegrationInput) SetHttpMethod(v string) *PutIntegrationInput

SetHttpMethod sets the HttpMethod field's value.

func (*PutIntegrationInput) SetIntegrationHttpMethod 

func (s *PutIntegrationInput) SetIntegrationHttpMethod(v string) *PutIntegrationInput

SetIntegrationHttpMethod sets the IntegrationHttpMethod field's value.

func (*PutIntegrationInput) SetPassthroughBehavior 

func (s *PutIntegrationInput) SetPassthroughBehavior(v string) *PutIntegrationInput

SetPassthroughBehavior sets the PassthroughBehavior field's value.

func (*PutIntegrationInput) SetRequestParameters 

func (s *PutIntegrationInput) SetRequestParameters(v map[string]string) *PutIntegrationInput

SetRequestParameters sets the RequestParameters field's value.

func (*PutIntegrationInput) SetRequestTemplates 

func (s *PutIntegrationInput) SetRequestTemplates(v map[string]string) *PutIntegrationInput

SetRequestTemplates sets the RequestTemplates field's value.

func (*PutIntegrationInput) SetResourceId 

func (s *PutIntegrationInput) SetResourceId(v string) *PutIntegrationInput

SetResourceId sets the ResourceId field's value.

func (*PutIntegrationInput) SetRestApiId 

func (s *PutIntegrationInput) SetRestApiId(v string) *PutIntegrationInput

SetRestApiId sets the RestApiId field's value.

func (*PutIntegrationInput) SetType 

func (s *PutIntegrationInput) SetType(v IntegrationType) *PutIntegrationInput

SetType sets the Type field's value.

func (*PutIntegrationInput) SetUri 

func (s *PutIntegrationInput) SetUri(v string) *PutIntegrationInput

SetUri sets the Uri field's value.

func (PutIntegrationInput) String 

func (s PutIntegrationInput) String() string

String returns the string representation

func (*PutIntegrationInput) Validate 

func (s *PutIntegrationInput) Validate() error

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

type PutIntegrationRequest 

type PutIntegrationRequest struct {
	*aws.Request
	Input *PutIntegrationInput
}

PutIntegrationRequest is a API request type for the PutIntegration API operation.

func (PutIntegrationRequest) Send 

func (r PutIntegrationRequest) Send() (*UpdateIntegrationOutput, error)

Send marshals and sends the PutIntegration API request.

type PutIntegrationResponseInput 

type PutIntegrationResponseInput struct {

	// Specifies how to handle response payload content type conversions. Supported
	// values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
	//
	//    * CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
	//    string to the corresponding binary blob.
	//
	//    * CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
	//    Base64-encoded string.
	//
	// If this property is not defined, the response payload will be passed through
	// from the integration response to the method response without modification.
	ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"`

	// Specifies a put integration response request's HTTP method.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// Specifies a put integration response request's resource identifier.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// A key-value map specifying response parameters that are passed to the method
	// response from the back end. The key is a method response header parameter
	// name and the mapped value is an integration response header value, a static
	// value enclosed within a pair of single quotes, or a JSON expression from
	// the integration response body. The mapping key must match the pattern of
	// method.response.header.{name}, where name is a valid and unique header name.
	// The mapped non-static value must match the pattern of integration.response.header.{name}
	// or integration.response.body.{JSON-expression}, where name must be a valid
	// and unique response header name and JSON-expression a valid JSON expression
	// without the $ prefix.
	ResponseParameters map[string]string `locationName:"responseParameters" type:"map"`

	// Specifies a put integration response's templates.
	ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// Specifies the selection pattern of a put integration response.
	SelectionPattern *string `locationName:"selectionPattern" type:"string"`

	// Specifies the status code that is used to map the integration response to
	// an existing MethodResponse.
	//
	// StatusCode is a required field
	StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a put integration response request.

func (PutIntegrationResponseInput) GoString 

func (s PutIntegrationResponseInput) GoString() string

GoString returns the string representation

func (*PutIntegrationResponseInput) SetContentHandling 

func (s *PutIntegrationResponseInput) SetContentHandling(v ContentHandlingStrategy) *PutIntegrationResponseInput

SetContentHandling sets the ContentHandling field's value.

func (*PutIntegrationResponseInput) SetHttpMethod 

func (s *PutIntegrationResponseInput) SetHttpMethod(v string) *PutIntegrationResponseInput

SetHttpMethod sets the HttpMethod field's value.

func (*PutIntegrationResponseInput) SetResourceId 

func (s *PutIntegrationResponseInput) SetResourceId(v string) *PutIntegrationResponseInput

SetResourceId sets the ResourceId field's value.

func (*PutIntegrationResponseInput) SetResponseParameters 

func (s *PutIntegrationResponseInput) SetResponseParameters(v map[string]string) *PutIntegrationResponseInput

SetResponseParameters sets the ResponseParameters field's value.

func (*PutIntegrationResponseInput) SetResponseTemplates 

func (s *PutIntegrationResponseInput) SetResponseTemplates(v map[string]string) *PutIntegrationResponseInput

SetResponseTemplates sets the ResponseTemplates field's value.

func (*PutIntegrationResponseInput) SetRestApiId 

func (s *PutIntegrationResponseInput) SetRestApiId(v string) *PutIntegrationResponseInput

SetRestApiId sets the RestApiId field's value.

func (*PutIntegrationResponseInput) SetSelectionPattern 

func (s *PutIntegrationResponseInput) SetSelectionPattern(v string) *PutIntegrationResponseInput

SetSelectionPattern sets the SelectionPattern field's value.

func (*PutIntegrationResponseInput) SetStatusCode 

func (s *PutIntegrationResponseInput) SetStatusCode(v string) *PutIntegrationResponseInput

SetStatusCode sets the StatusCode field's value.

func (PutIntegrationResponseInput) String 

func (s PutIntegrationResponseInput) String() string

String returns the string representation

func (*PutIntegrationResponseInput) Validate 

func (s *PutIntegrationResponseInput) Validate() error

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

type PutIntegrationResponseRequest 

type PutIntegrationResponseRequest struct {
	*aws.Request
	Input *PutIntegrationResponseInput
}

PutIntegrationResponseRequest is a API request type for the PutIntegrationResponse API operation.

func (PutIntegrationResponseRequest) Send 

func (r PutIntegrationResponseRequest) Send() (*UpdateIntegrationResponseOutput, error)

Send marshals and sends the PutIntegrationResponse API request.

type PutMethodInput 

type PutMethodInput struct {

	// Specifies whether the method required a valid ApiKey.
	ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"`

	// The method's authorization type. Valid values are NONE for open access, AWS_IAM
	// for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS
	// for using a Cognito user pool.
	//
	// AuthorizationType is a required field
	AuthorizationType *string `locationName:"authorizationType" type:"string" required:"true"`

	// Specifies the identifier of an Authorizer to use on this Method, if the type
	// is CUSTOM.
	AuthorizerId *string `locationName:"authorizerId" type:"string"`

	// Specifies the method request's HTTP method type.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// A human-friendly operation identifier for the method. For example, you can
	// assign the operationName of ListPets for the GET /pets method in PetStore
	// (http://petstore-demo-endpoint.execute-api.com/petstore/pets) example.
	OperationName *string `locationName:"operationName" type:"string"`

	// Specifies the Model resources used for the request's content type. Request
	// models are represented as a key/value map, with a content type as the key
	// and a Model name as the value.
	RequestModels map[string]string `locationName:"requestModels" type:"map"`

	// A key-value map defining required or optional method request parameters that
	// can be accepted by Amazon API Gateway. A key defines a method request parameter
	// name matching the pattern of method.request.{location}.{name}, where location
	// is querystring, path, or header and name is a valid and unique parameter
	// name. The value associated with the key is a Boolean flag indicating whether
	// the parameter is required (true) or optional (false). The method request
	// parameter names defined here are available in Integration to be mapped to
	// integration request parameters or body-mapping templates.
	RequestParameters map[string]bool `locationName:"requestParameters" type:"map"`

	// The identifier of a RequestValidator for validating the method request.
	RequestValidatorId *string `locationName:"requestValidatorId" type:"string"`

	// The Resource identifier for the new Method resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to add a method to an existing Resource resource.

func (PutMethodInput) GoString 

func (s PutMethodInput) GoString() string

GoString returns the string representation

func (*PutMethodInput) SetApiKeyRequired 

func (s *PutMethodInput) SetApiKeyRequired(v bool) *PutMethodInput

SetApiKeyRequired sets the ApiKeyRequired field's value.

func (*PutMethodInput) SetAuthorizationType 

func (s *PutMethodInput) SetAuthorizationType(v string) *PutMethodInput

SetAuthorizationType sets the AuthorizationType field's value.

func (*PutMethodInput) SetAuthorizerId 

func (s *PutMethodInput) SetAuthorizerId(v string) *PutMethodInput

SetAuthorizerId sets the AuthorizerId field's value.

func (*PutMethodInput) SetHttpMethod 

func (s *PutMethodInput) SetHttpMethod(v string) *PutMethodInput

SetHttpMethod sets the HttpMethod field's value.

func (*PutMethodInput) SetOperationName 

func (s *PutMethodInput) SetOperationName(v string) *PutMethodInput

SetOperationName sets the OperationName field's value.

func (*PutMethodInput) SetRequestModels 

func (s *PutMethodInput) SetRequestModels(v map[string]string) *PutMethodInput

SetRequestModels sets the RequestModels field's value.

func (*PutMethodInput) SetRequestParameters 

func (s *PutMethodInput) SetRequestParameters(v map[string]bool) *PutMethodInput

SetRequestParameters sets the RequestParameters field's value.

func (*PutMethodInput) SetRequestValidatorId 

func (s *PutMethodInput) SetRequestValidatorId(v string) *PutMethodInput

SetRequestValidatorId sets the RequestValidatorId field's value.

func (*PutMethodInput) SetResourceId 

func (s *PutMethodInput) SetResourceId(v string) *PutMethodInput

SetResourceId sets the ResourceId field's value.

func (*PutMethodInput) SetRestApiId 

func (s *PutMethodInput) SetRestApiId(v string) *PutMethodInput

SetRestApiId sets the RestApiId field's value.

func (PutMethodInput) String 

func (s PutMethodInput) String() string

String returns the string representation

func (*PutMethodInput) Validate 

func (s *PutMethodInput) Validate() error

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

type PutMethodRequest 

type PutMethodRequest struct {
	*aws.Request
	Input *PutMethodInput
}

PutMethodRequest is a API request type for the PutMethod API operation.

func (PutMethodRequest) Send 

func (r PutMethodRequest) Send() (*UpdateMethodOutput, error)

Send marshals and sends the PutMethod API request.

type PutMethodResponseInput 

type PutMethodResponseInput struct {

	// The HTTP verb of the Method resource.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// The Resource identifier for the Method resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// Specifies the Model resources used for the response's content type. Response
	// models are represented as a key/value map, with a content type as the key
	// and a Model name as the value.
	ResponseModels map[string]string `locationName:"responseModels" type:"map"`

	// A key-value map specifying required or optional response parameters that
	// Amazon API Gateway can send back to the caller. A key defines a method response
	// header name and the associated value is a Boolean flag indicating whether
	// the method response parameter is required or not. The method response header
	// names must match the pattern of method.response.header.{name}, where name
	// is a valid and unique header name. The response parameter names defined here
	// are available in the integration response to be mapped from an integration
	// response header expressed in integration.response.header.{name}, a static
	// value enclosed within a pair of single quotes (e.g., 'application/json'),
	// or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression},
	// where JSON-expression is a valid JSON expression without the $ prefix.)
	ResponseParameters map[string]bool `locationName:"responseParameters" type:"map"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The method response's status code.
	//
	// StatusCode is a required field
	StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to add a MethodResponse to an existing Method resource.

func (PutMethodResponseInput) GoString 

func (s PutMethodResponseInput) GoString() string

GoString returns the string representation

func (*PutMethodResponseInput) SetHttpMethod 

func (s *PutMethodResponseInput) SetHttpMethod(v string) *PutMethodResponseInput

SetHttpMethod sets the HttpMethod field's value.

func (*PutMethodResponseInput) SetResourceId 

func (s *PutMethodResponseInput) SetResourceId(v string) *PutMethodResponseInput

SetResourceId sets the ResourceId field's value.

func (*PutMethodResponseInput) SetResponseModels 

func (s *PutMethodResponseInput) SetResponseModels(v map[string]string) *PutMethodResponseInput

SetResponseModels sets the ResponseModels field's value.

func (*PutMethodResponseInput) SetResponseParameters 

func (s *PutMethodResponseInput) SetResponseParameters(v map[string]bool) *PutMethodResponseInput

SetResponseParameters sets the ResponseParameters field's value.

func (*PutMethodResponseInput) SetRestApiId 

func (s *PutMethodResponseInput) SetRestApiId(v string) *PutMethodResponseInput

SetRestApiId sets the RestApiId field's value.

func (*PutMethodResponseInput) SetStatusCode 

func (s *PutMethodResponseInput) SetStatusCode(v string) *PutMethodResponseInput

SetStatusCode sets the StatusCode field's value.

func (PutMethodResponseInput) String 

func (s PutMethodResponseInput) String() string

String returns the string representation

func (*PutMethodResponseInput) Validate 

func (s *PutMethodResponseInput) Validate() error

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

type PutMethodResponseRequest 

type PutMethodResponseRequest struct {
	*aws.Request
	Input *PutMethodResponseInput
}

PutMethodResponseRequest is a API request type for the PutMethodResponse API operation.

func (PutMethodResponseRequest) Send 

func (r PutMethodResponseRequest) Send() (*UpdateMethodResponseOutput, error)

Send marshals and sends the PutMethodResponse API request.

type PutMode 

type PutMode string
const (
	PutModeMerge     PutMode = "merge"
	PutModeOverwrite PutMode = "overwrite"
)

Enum values for PutMode

type PutRestApiInput 

type PutRestApiInput struct {

	// The PUT request body containing external API definitions. Currently, only
	// Swagger definition JSON files are supported. The maximum size of the API
	// definition file is 2MB.
	//
	// Body is a required field
	Body []byte `locationName:"body" type:"blob" required:"true"`

	// A query parameter to indicate whether to rollback the API update (true) or
	// not (false) when a warning is encountered. The default value is false.
	FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"`

	// The mode query parameter to specify the update mode. Valid values are "merge"
	// and "overwrite". By default, the update mode is "merge".
	Mode PutMode `location:"querystring" locationName:"mode" type:"string" enum:"true"`

	// Custom header parameters as part of the request. For example, to exclude
	// DocumentationParts from an imported API, set ignore=documentation as a parameters
	// value, as in the AWS CLI command of aws apigateway import-rest-api --parameters
	// ignore=documentation --body 'file:///path/to/imported-api-body.json.
	Parameters map[string]string `location:"querystring" locationName:"parameters" type:"map"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A PUT request to update an existing API, with external API definitions specified as the request body.

func (PutRestApiInput) GoString 

func (s PutRestApiInput) GoString() string

GoString returns the string representation

func (*PutRestApiInput) SetBody 

func (s *PutRestApiInput) SetBody(v []byte) *PutRestApiInput

SetBody sets the Body field's value.

func (*PutRestApiInput) SetFailOnWarnings 

func (s *PutRestApiInput) SetFailOnWarnings(v bool) *PutRestApiInput

SetFailOnWarnings sets the FailOnWarnings field's value.

func (*PutRestApiInput) SetMode 

func (s *PutRestApiInput) SetMode(v PutMode) *PutRestApiInput

SetMode sets the Mode field's value.

func (*PutRestApiInput) SetParameters 

func (s *PutRestApiInput) SetParameters(v map[string]string) *PutRestApiInput

SetParameters sets the Parameters field's value.

func (*PutRestApiInput) SetRestApiId 

func (s *PutRestApiInput) SetRestApiId(v string) *PutRestApiInput

SetRestApiId sets the RestApiId field's value.

func (PutRestApiInput) String 

func (s PutRestApiInput) String() string

String returns the string representation

func (*PutRestApiInput) Validate 

func (s *PutRestApiInput) Validate() error

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

type PutRestApiRequest 

type PutRestApiRequest struct {
	*aws.Request
	Input *PutRestApiInput
}

PutRestApiRequest is a API request type for the PutRestApi API operation.

func (PutRestApiRequest) Send 

func (r PutRestApiRequest) Send() (*UpdateRestApiOutput, error)

Send marshals and sends the PutRestApi API request.

type QuotaPeriodType 

type QuotaPeriodType string
const (
	QuotaPeriodTypeDay   QuotaPeriodType = "DAY"
	QuotaPeriodTypeWeek  QuotaPeriodType = "WEEK"
	QuotaPeriodTypeMonth QuotaPeriodType = "MONTH"
)

Enum values for QuotaPeriodType

type QuotaSettings 

type QuotaSettings struct {

	// The maximum number of requests that can be made in a given time period.
	Limit *int64 `locationName:"limit" type:"integer"`

	// The number of requests subtracted from the given limit in the initial time
	// period.
	Offset *int64 `locationName:"offset" type:"integer"`

	// The time period in which the limit applies. Valid values are "DAY", "WEEK"
	// or "MONTH".
	Period QuotaPeriodType `locationName:"period" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Quotas configured for a usage plan.

func (QuotaSettings) GoString 

func (s QuotaSettings) GoString() string

GoString returns the string representation

func (*QuotaSettings) SetLimit 

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

SetLimit sets the Limit field's value.

func (*QuotaSettings) SetOffset 

func (s *QuotaSettings) SetOffset(v int64) *QuotaSettings

SetOffset sets the Offset field's value.

func (*QuotaSettings) SetPeriod 

func (s *QuotaSettings) SetPeriod(v QuotaPeriodType) *QuotaSettings

SetPeriod sets the Period field's value.

func (QuotaSettings) String 

func (s QuotaSettings) String() string

String returns the string representation

type SdkConfigurationProperty 

type SdkConfigurationProperty struct {

	// The default value of an SdkType configuration property.
	DefaultValue *string `locationName:"defaultValue" type:"string"`

	// The description of an SdkType configuration property.
	Description *string `locationName:"description" type:"string"`

	// The user-friendly name of an SdkType configuration property.
	FriendlyName *string `locationName:"friendlyName" type:"string"`

	// The name of a an SdkType configuration property.
	Name *string `locationName:"name" type:"string"`

	// A boolean flag of an SdkType configuration property to indicate if the associated
	// SDK configuration property is required (true) or not (false).
	Required *bool `locationName:"required" type:"boolean"`
	// contains filtered or unexported fields
}

A configuration property of an SDK type.

func (SdkConfigurationProperty) GoString 

func (s SdkConfigurationProperty) GoString() string

GoString returns the string representation

func (*SdkConfigurationProperty) SetDefaultValue 

func (s *SdkConfigurationProperty) SetDefaultValue(v string) *SdkConfigurationProperty

SetDefaultValue sets the DefaultValue field's value.

func (*SdkConfigurationProperty) SetDescription 

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

SetDescription sets the Description field's value.

func (*SdkConfigurationProperty) SetFriendlyName 

func (s *SdkConfigurationProperty) SetFriendlyName(v string) *SdkConfigurationProperty

SetFriendlyName sets the FriendlyName field's value.

func (*SdkConfigurationProperty) SetName 

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

SetName sets the Name field's value.

func (*SdkConfigurationProperty) SetRequired 

func (s *SdkConfigurationProperty) SetRequired(v bool) *SdkConfigurationProperty

SetRequired sets the Required field's value.

func (SdkConfigurationProperty) String 

func (s SdkConfigurationProperty) String() string

String returns the string representation

type StageKey 

type StageKey struct {

	// The string identifier of the associated RestApi.
	RestApiId *string `locationName:"restApiId" type:"string"`

	// The stage name associated with the stage key.
	StageName *string `locationName:"stageName" type:"string"`
	// contains filtered or unexported fields
}

A reference to a unique stage identified in the format {restApiId}/{stage}.

func (StageKey) GoString 

func (s StageKey) GoString() string

GoString returns the string representation

func (*StageKey) SetRestApiId 

func (s *StageKey) SetRestApiId(v string) *StageKey

SetRestApiId sets the RestApiId field's value.

func (*StageKey) SetStageName 

func (s *StageKey) SetStageName(v string) *StageKey

SetStageName sets the StageName field's value.

func (StageKey) String 

func (s StageKey) String() string

String returns the string representation

type TestInvokeAuthorizerInput 

type TestInvokeAuthorizerInput struct {

	// [Optional] A key-value map of additional context variables.
	AdditionalContext map[string]string `locationName:"additionalContext" type:"map"`

	// Specifies a test invoke authorizer request's Authorizer ID.
	//
	// AuthorizerId is a required field
	AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"`

	// [Optional] The simulated request body of an incoming invocation request.
	Body *string `locationName:"body" type:"string"`

	// [Required] A key-value map of headers to simulate an incoming invocation
	// request. This is where the incoming authorization token, or identity source,
	// should be specified.
	Headers map[string]string `locationName:"headers" type:"map"`

	// [Optional] The URI path, including query string, of the simulated invocation
	// request. Use this to specify path parameters and query string parameters.
	PathWithQueryString *string `locationName:"pathWithQueryString" type:"string"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// A key-value map of stage variables to simulate an invocation on a deployed
	// Stage.
	StageVariables map[string]string `locationName:"stageVariables" type:"map"`
	// contains filtered or unexported fields
}

Make a request to simulate the execution of an Authorizer.

func (TestInvokeAuthorizerInput) GoString 

func (s TestInvokeAuthorizerInput) GoString() string

GoString returns the string representation

func (*TestInvokeAuthorizerInput) SetAdditionalContext 

func (s *TestInvokeAuthorizerInput) SetAdditionalContext(v map[string]string) *TestInvokeAuthorizerInput

SetAdditionalContext sets the AdditionalContext field's value.

func (*TestInvokeAuthorizerInput) SetAuthorizerId 

func (s *TestInvokeAuthorizerInput) SetAuthorizerId(v string) *TestInvokeAuthorizerInput

SetAuthorizerId sets the AuthorizerId field's value.

func (*TestInvokeAuthorizerInput) SetBody 

func (s *TestInvokeAuthorizerInput) SetBody(v string) *TestInvokeAuthorizerInput

SetBody sets the Body field's value.

func (*TestInvokeAuthorizerInput) SetHeaders 

func (s *TestInvokeAuthorizerInput) SetHeaders(v map[string]string) *TestInvokeAuthorizerInput

SetHeaders sets the Headers field's value.

func (*TestInvokeAuthorizerInput) SetPathWithQueryString 

func (s *TestInvokeAuthorizerInput) SetPathWithQueryString(v string) *TestInvokeAuthorizerInput

SetPathWithQueryString sets the PathWithQueryString field's value.

func (*TestInvokeAuthorizerInput) SetRestApiId 

func (s *TestInvokeAuthorizerInput) SetRestApiId(v string) *TestInvokeAuthorizerInput

SetRestApiId sets the RestApiId field's value.

func (*TestInvokeAuthorizerInput) SetStageVariables 

func (s *TestInvokeAuthorizerInput) SetStageVariables(v map[string]string) *TestInvokeAuthorizerInput

SetStageVariables sets the StageVariables field's value.

func (TestInvokeAuthorizerInput) String 

func (s TestInvokeAuthorizerInput) String() string

String returns the string representation

func (*TestInvokeAuthorizerInput) Validate 

func (s *TestInvokeAuthorizerInput) Validate() error

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

type TestInvokeAuthorizerOutput 

type TestInvokeAuthorizerOutput struct {
	Authorization map[string][]string `locationName:"authorization" type:"map"`

	// The open identity claims (http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims),
	// with any supported custom attributes, returned from the Cognito Your User
	// Pool configured for the API.
	Claims map[string]string `locationName:"claims" type:"map"`

	// The HTTP status code that the client would have received. Value is 0 if the
	// authorizer succeeded.
	ClientStatus *int64 `locationName:"clientStatus" type:"integer"`

	// The execution latency of the test authorizer request.
	Latency *int64 `locationName:"latency" type:"long"`

	// The Amazon API Gateway execution log for the test authorizer request.
	Log *string `locationName:"log" type:"string"`

	// The JSON policy document returned by the Authorizer
	Policy *string `locationName:"policy" type:"string"`

	// The principal identity returned by the Authorizer
	PrincipalId *string `locationName:"principalId" type:"string"`
	// contains filtered or unexported fields
}

Represents the response of the test invoke request for a custom Authorizer

func (TestInvokeAuthorizerOutput) GoString 

func (s TestInvokeAuthorizerOutput) GoString() string

GoString returns the string representation

func (TestInvokeAuthorizerOutput) SDKResponseMetadata 

func (s TestInvokeAuthorizerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*TestInvokeAuthorizerOutput) SetAuthorization 

func (s *TestInvokeAuthorizerOutput) SetAuthorization(v map[string][]string) *TestInvokeAuthorizerOutput

SetAuthorization sets the Authorization field's value.

func (*TestInvokeAuthorizerOutput) SetClaims 

func (s *TestInvokeAuthorizerOutput) SetClaims(v map[string]string) *TestInvokeAuthorizerOutput

SetClaims sets the Claims field's value.

func (*TestInvokeAuthorizerOutput) SetClientStatus 

func (s *TestInvokeAuthorizerOutput) SetClientStatus(v int64) *TestInvokeAuthorizerOutput

SetClientStatus sets the ClientStatus field's value.

func (*TestInvokeAuthorizerOutput) SetLatency 

func (s *TestInvokeAuthorizerOutput) SetLatency(v int64) *TestInvokeAuthorizerOutput

SetLatency sets the Latency field's value.

func (*TestInvokeAuthorizerOutput) SetLog 

func (s *TestInvokeAuthorizerOutput) SetLog(v string) *TestInvokeAuthorizerOutput

SetLog sets the Log field's value.

func (*TestInvokeAuthorizerOutput) SetPolicy 

func (s *TestInvokeAuthorizerOutput) SetPolicy(v string) *TestInvokeAuthorizerOutput

SetPolicy sets the Policy field's value.

func (*TestInvokeAuthorizerOutput) SetPrincipalId 

func (s *TestInvokeAuthorizerOutput) SetPrincipalId(v string) *TestInvokeAuthorizerOutput

SetPrincipalId sets the PrincipalId field's value.

func (TestInvokeAuthorizerOutput) String 

func (s TestInvokeAuthorizerOutput) String() string

String returns the string representation

type TestInvokeAuthorizerRequest 

type TestInvokeAuthorizerRequest struct {
	*aws.Request
	Input *TestInvokeAuthorizerInput
}

TestInvokeAuthorizerRequest is a API request type for the TestInvokeAuthorizer API operation.

func (TestInvokeAuthorizerRequest) Send 

func (r TestInvokeAuthorizerRequest) Send() (*TestInvokeAuthorizerOutput, error)

Send marshals and sends the TestInvokeAuthorizer API request.

type TestInvokeMethodInput 

type TestInvokeMethodInput struct {

	// The simulated request body of an incoming invocation request.
	Body *string `locationName:"body" type:"string"`

	// A ClientCertificate identifier to use in the test invocation. API Gateway
	// will use the certificate when making the HTTPS request to the defined back-end
	// endpoint.
	ClientCertificateId *string `locationName:"clientCertificateId" type:"string"`

	// A key-value map of headers to simulate an incoming invocation request.
	Headers map[string]string `locationName:"headers" type:"map"`

	// Specifies a test invoke method request's HTTP method.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// The URI path, including query string, of the simulated invocation request.
	// Use this to specify path parameters and query string parameters.
	PathWithQueryString *string `locationName:"pathWithQueryString" type:"string"`

	// Specifies a test invoke method request's resource ID.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// A key-value map of stage variables to simulate an invocation on a deployed
	// Stage.
	StageVariables map[string]string `locationName:"stageVariables" type:"map"`
	// contains filtered or unexported fields
}

Make a request to simulate the execution of a Method.

func (TestInvokeMethodInput) GoString 

func (s TestInvokeMethodInput) GoString() string

GoString returns the string representation

func (*TestInvokeMethodInput) SetBody 

func (s *TestInvokeMethodInput) SetBody(v string) *TestInvokeMethodInput

SetBody sets the Body field's value.

func (*TestInvokeMethodInput) SetClientCertificateId 

func (s *TestInvokeMethodInput) SetClientCertificateId(v string) *TestInvokeMethodInput

SetClientCertificateId sets the ClientCertificateId field's value.

func (*TestInvokeMethodInput) SetHeaders 

func (s *TestInvokeMethodInput) SetHeaders(v map[string]string) *TestInvokeMethodInput

SetHeaders sets the Headers field's value.

func (*TestInvokeMethodInput) SetHttpMethod 

func (s *TestInvokeMethodInput) SetHttpMethod(v string) *TestInvokeMethodInput

SetHttpMethod sets the HttpMethod field's value.

func (*TestInvokeMethodInput) SetPathWithQueryString 

func (s *TestInvokeMethodInput) SetPathWithQueryString(v string) *TestInvokeMethodInput

SetPathWithQueryString sets the PathWithQueryString field's value.

func (*TestInvokeMethodInput) SetResourceId 

func (s *TestInvokeMethodInput) SetResourceId(v string) *TestInvokeMethodInput

SetResourceId sets the ResourceId field's value.

func (*TestInvokeMethodInput) SetRestApiId 

func (s *TestInvokeMethodInput) SetRestApiId(v string) *TestInvokeMethodInput

SetRestApiId sets the RestApiId field's value.

func (*TestInvokeMethodInput) SetStageVariables 

func (s *TestInvokeMethodInput) SetStageVariables(v map[string]string) *TestInvokeMethodInput

SetStageVariables sets the StageVariables field's value.

func (TestInvokeMethodInput) String 

func (s TestInvokeMethodInput) String() string

String returns the string representation

func (*TestInvokeMethodInput) Validate 

func (s *TestInvokeMethodInput) Validate() error

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

type TestInvokeMethodOutput 

type TestInvokeMethodOutput struct {

	// The body of the HTTP response.
	Body *string `locationName:"body" type:"string"`

	// The headers of the HTTP response.
	Headers map[string]string `locationName:"headers" type:"map"`

	// The execution latency of the test invoke request.
	Latency *int64 `locationName:"latency" type:"long"`

	// The Amazon API Gateway execution log for the test invoke request.
	Log *string `locationName:"log" type:"string"`

	// The HTTP status code.
	Status *int64 `locationName:"status" type:"integer"`
	// contains filtered or unexported fields
}

Represents the response of the test invoke request in the HTTP method.

Test API using the API Gateway console (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-test-method.html#how-to-test-method-console)

func (TestInvokeMethodOutput) GoString 

func (s TestInvokeMethodOutput) GoString() string

GoString returns the string representation

func (TestInvokeMethodOutput) SDKResponseMetadata 

func (s TestInvokeMethodOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*TestInvokeMethodOutput) SetBody 

func (s *TestInvokeMethodOutput) SetBody(v string) *TestInvokeMethodOutput

SetBody sets the Body field's value.

func (*TestInvokeMethodOutput) SetHeaders 

func (s *TestInvokeMethodOutput) SetHeaders(v map[string]string) *TestInvokeMethodOutput

SetHeaders sets the Headers field's value.

func (*TestInvokeMethodOutput) SetLatency 

func (s *TestInvokeMethodOutput) SetLatency(v int64) *TestInvokeMethodOutput

SetLatency sets the Latency field's value.

func (*TestInvokeMethodOutput) SetLog 

func (s *TestInvokeMethodOutput) SetLog(v string) *TestInvokeMethodOutput

SetLog sets the Log field's value.

func (*TestInvokeMethodOutput) SetStatus 

func (s *TestInvokeMethodOutput) SetStatus(v int64) *TestInvokeMethodOutput

SetStatus sets the Status field's value.

func (TestInvokeMethodOutput) String 

func (s TestInvokeMethodOutput) String() string

String returns the string representation

type TestInvokeMethodRequest 

type TestInvokeMethodRequest struct {
	*aws.Request
	Input *TestInvokeMethodInput
}

TestInvokeMethodRequest is a API request type for the TestInvokeMethod API operation.

func (TestInvokeMethodRequest) Send 

func (r TestInvokeMethodRequest) Send() (*TestInvokeMethodOutput, error)

Send marshals and sends the TestInvokeMethod API request.

type ThrottleSettings 

type ThrottleSettings struct {

	// The API request burst limit, the maximum rate limit over a time ranging from
	// one to a few seconds, depending upon whether the underlying token bucket
	// is at its full capacity.
	BurstLimit *int64 `locationName:"burstLimit" type:"integer"`

	// The API request steady-state rate limit.
	RateLimit *float64 `locationName:"rateLimit" type:"double"`
	// contains filtered or unexported fields
}

The API request rate limits.

func (ThrottleSettings) GoString 

func (s ThrottleSettings) GoString() string

GoString returns the string representation

func (*ThrottleSettings) SetBurstLimit 

func (s *ThrottleSettings) SetBurstLimit(v int64) *ThrottleSettings

SetBurstLimit sets the BurstLimit field's value.

func (*ThrottleSettings) SetRateLimit 

func (s *ThrottleSettings) SetRateLimit(v float64) *ThrottleSettings

SetRateLimit sets the RateLimit field's value.

func (ThrottleSettings) String 

func (s ThrottleSettings) String() string

String returns the string representation

type UnauthorizedCacheControlHeaderStrategy 

type UnauthorizedCacheControlHeaderStrategy string
const (
	UnauthorizedCacheControlHeaderStrategyFailWith403                  UnauthorizedCacheControlHeaderStrategy = "FAIL_WITH_403"
	UnauthorizedCacheControlHeaderStrategySucceedWithResponseHeader    UnauthorizedCacheControlHeaderStrategy = "SUCCEED_WITH_RESPONSE_HEADER"
	UnauthorizedCacheControlHeaderStrategySucceedWithoutResponseHeader UnauthorizedCacheControlHeaderStrategy = "SUCCEED_WITHOUT_RESPONSE_HEADER"
)

Enum values for UnauthorizedCacheControlHeaderStrategy

type UpdateAccountInput 

type UpdateAccountInput struct {

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to change information about the current Account resource.

func (UpdateAccountInput) GoString 

func (s UpdateAccountInput) GoString() string

GoString returns the string representation

func (*UpdateAccountInput) SetPatchOperations 

func (s *UpdateAccountInput) SetPatchOperations(v []PatchOperation) *UpdateAccountInput

SetPatchOperations sets the PatchOperations field's value.

func (UpdateAccountInput) String 

func (s UpdateAccountInput) String() string

String returns the string representation

type UpdateAccountOutput 

type UpdateAccountOutput struct {

	// The version of the API keys used for the account.
	ApiKeyVersion *string `locationName:"apiKeyVersion" type:"string"`

	// The ARN of an Amazon CloudWatch role for the current Account.
	CloudwatchRoleArn *string `locationName:"cloudwatchRoleArn" type:"string"`

	// A list of features supported for the account. When usage plans are enabled,
	// the features list will include an entry of "UsagePlans".
	Features []string `locationName:"features" type:"list"`

	// Specifies the API request limits configured for the current Account.
	ThrottleSettings *ThrottleSettings `locationName:"throttleSettings" type:"structure"`
	// contains filtered or unexported fields
}

Represents an AWS account that is associated with Amazon API Gateway.

To view the account info, call GET on this resource.

Error Codes

The following exception may be thrown when the request fails.

UnauthorizedException NotFoundException TooManyRequestsException For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes (http://docs.aws.amazon.com/apigateway/api-reference/handling-errors/#api-error-codes)

Example: Get the information about an account.

Request

GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html", "name": "account", "templated": true }, "self": { "href": "/account" }, "account:update": { "href": "/account" } }, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": { "rateLimit": 500, "burstLimit": 1000 } } In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.

API Gateway Limits (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-limits.html)Developer Guide (http://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html), AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html)

func (UpdateAccountOutput) GoString 

func (s UpdateAccountOutput) GoString() string

GoString returns the string representation

func (UpdateAccountOutput) SDKResponseMetadata 

func (s UpdateAccountOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateAccountOutput) SetApiKeyVersion 

func (s *UpdateAccountOutput) SetApiKeyVersion(v string) *UpdateAccountOutput

SetApiKeyVersion sets the ApiKeyVersion field's value.

func (*UpdateAccountOutput) SetCloudwatchRoleArn 

func (s *UpdateAccountOutput) SetCloudwatchRoleArn(v string) *UpdateAccountOutput

SetCloudwatchRoleArn sets the CloudwatchRoleArn field's value.

func (*UpdateAccountOutput) SetFeatures 

func (s *UpdateAccountOutput) SetFeatures(v []string) *UpdateAccountOutput

SetFeatures sets the Features field's value.

func (*UpdateAccountOutput) SetThrottleSettings 

func (s *UpdateAccountOutput) SetThrottleSettings(v *ThrottleSettings) *UpdateAccountOutput

SetThrottleSettings sets the ThrottleSettings field's value.

func (UpdateAccountOutput) String 

func (s UpdateAccountOutput) String() string

String returns the string representation

type UpdateAccountRequest 

type UpdateAccountRequest struct {
	*aws.Request
	Input *UpdateAccountInput
}

UpdateAccountRequest is a API request type for the UpdateAccount API operation.

func (UpdateAccountRequest) Send 

func (r UpdateAccountRequest) Send() (*UpdateAccountOutput, error)

Send marshals and sends the UpdateAccount API request.

type UpdateApiKeyInput 

type UpdateApiKeyInput struct {

	// The identifier of the ApiKey resource to be updated.
	//
	// ApiKey is a required field
	ApiKey *string `location:"uri" locationName:"api_Key" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`
	// contains filtered or unexported fields
}

A request to change information about an ApiKey resource.

func (UpdateApiKeyInput) GoString 

func (s UpdateApiKeyInput) GoString() string

GoString returns the string representation

func (*UpdateApiKeyInput) SetApiKey 

func (s *UpdateApiKeyInput) SetApiKey(v string) *UpdateApiKeyInput

SetApiKey sets the ApiKey field's value.

func (*UpdateApiKeyInput) SetPatchOperations 

func (s *UpdateApiKeyInput) SetPatchOperations(v []PatchOperation) *UpdateApiKeyInput

SetPatchOperations sets the PatchOperations field's value.

func (UpdateApiKeyInput) String 

func (s UpdateApiKeyInput) String() string

String returns the string representation

func (*UpdateApiKeyInput) Validate 

func (s *UpdateApiKeyInput) Validate() error

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

type UpdateApiKeyOutput 

type UpdateApiKeyOutput struct {

	// The timestamp when the API Key was created.
	CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"`

	// An AWS Marketplace customer identifier , when integrating with the AWS SaaS
	// Marketplace.
	CustomerId *string `locationName:"customerId" type:"string"`

	// The description of the API Key.
	Description *string `locationName:"description" type:"string"`

	// Specifies whether the API Key can be used by callers.
	Enabled *bool `locationName:"enabled" type:"boolean"`

	// The identifier of the API Key.
	Id *string `locationName:"id" type:"string"`

	// The timestamp when the API Key was last updated.
	LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp" timestampFormat:"unix"`

	// The name of the API Key.
	Name *string `locationName:"name" type:"string"`

	// A list of Stage resources that are associated with the ApiKey resource.
	StageKeys []string `locationName:"stageKeys" type:"list"`

	// The value of the API Key.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

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 (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html)

func (UpdateApiKeyOutput) GoString 

func (s UpdateApiKeyOutput) GoString() string

GoString returns the string representation

func (UpdateApiKeyOutput) SDKResponseMetadata 

func (s UpdateApiKeyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateApiKeyOutput) SetCreatedDate 

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

SetCreatedDate sets the CreatedDate field's value.

func (*UpdateApiKeyOutput) SetCustomerId 

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

SetCustomerId sets the CustomerId field's value.

func (*UpdateApiKeyOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateApiKeyOutput) SetEnabled 

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

SetEnabled sets the Enabled field's value.

func (*UpdateApiKeyOutput) SetId 

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

SetId sets the Id field's value.

func (*UpdateApiKeyOutput) SetLastUpdatedDate 

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

SetLastUpdatedDate sets the LastUpdatedDate field's value.

func (*UpdateApiKeyOutput) SetName 

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

SetName sets the Name field's value.

func (*UpdateApiKeyOutput) SetStageKeys 

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

SetStageKeys sets the StageKeys field's value.

func (*UpdateApiKeyOutput) SetValue 

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

SetValue sets the Value field's value.

func (UpdateApiKeyOutput) String 

func (s UpdateApiKeyOutput) String() string

String returns the string representation

type UpdateApiKeyRequest 

type UpdateApiKeyRequest struct {
	*aws.Request
	Input *UpdateApiKeyInput
}

UpdateApiKeyRequest is a API request type for the UpdateApiKey API operation.

func (UpdateApiKeyRequest) Send 

func (r UpdateApiKeyRequest) Send() (*UpdateApiKeyOutput, error)

Send marshals and sends the UpdateApiKey API request.

type UpdateAuthorizerInput 

type UpdateAuthorizerInput struct {

	// The identifier of the Authorizer resource.
	//
	// AuthorizerId is a required field
	AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to update an existing Authorizer resource.

func (UpdateAuthorizerInput) GoString 

func (s UpdateAuthorizerInput) GoString() string

GoString returns the string representation

func (*UpdateAuthorizerInput) SetAuthorizerId 

func (s *UpdateAuthorizerInput) SetAuthorizerId(v string) *UpdateAuthorizerInput

SetAuthorizerId sets the AuthorizerId field's value.

func (*UpdateAuthorizerInput) SetPatchOperations 

func (s *UpdateAuthorizerInput) SetPatchOperations(v []PatchOperation) *UpdateAuthorizerInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateAuthorizerInput) SetRestApiId 

func (s *UpdateAuthorizerInput) SetRestApiId(v string) *UpdateAuthorizerInput

SetRestApiId sets the RestApiId field's value.

func (UpdateAuthorizerInput) String 

func (s UpdateAuthorizerInput) String() string

String returns the string representation

func (*UpdateAuthorizerInput) Validate 

func (s *UpdateAuthorizerInput) Validate() error

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

type UpdateAuthorizerOutput 

type UpdateAuthorizerOutput struct {

	// Optional customer-defined field, used in Swagger imports and exports without
	// functional impact.
	AuthType *string `locationName:"authType" type:"string"`

	// Specifies the required credentials as an IAM role for Amazon API Gateway
	// to invoke the authorizer. To specify an IAM role for Amazon API Gateway to
	// assume, use the role's Amazon Resource Name (ARN). To use resource-based
	// permissions on the Lambda function, specify null.
	AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"`

	// The TTL in seconds of cached authorizer results. If it equals 0, authorization
	// caching is disabled. If it is greater than 0, API Gateway will cache authorizer
	// responses. If this field is not set, the default value is 300. The maximum
	// value is 3600, or 1 hour.
	AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"`

	// Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or
	// REQUEST authorizers, this must be a well-formed Lambda function URI, for
	// example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.
	// In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api},
	// where {region} is the same as the region hosting the Lambda function, path
	// indicates that the remaining substring in the URI should be treated as the
	// path to the resource, including the initial /. For Lambda functions, this
	// is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
	AuthorizerUri *string `locationName:"authorizerUri" type:"string"`

	// The identifier for the authorizer resource.
	Id *string `locationName:"id" type:"string"`

	// The identity source for which authorization is requested. For a TOKEN authorizer,
	// this is required and specifies the request header mapping expression for
	// the custom header holding the authorization token submitted by the client.
	// For example, if the token header name is Auth, the header mapping expression
	// is method.request.header.Auth.
	// For the REQUEST authorizer, this is required when authorization caching is
	// enabled. The value is a comma-separated string of one or more mapping expressions
	// of the specified request parameters. For example, if an Auth header, a Name
	// query string parameter are defined as identity sources, this value is method.request.header.Auth,
	// method.request.querystring.Name. These parameters will be used to derive
	// the authorization caching key and to perform runtime validation of the REQUEST
	// authorizer by verifying all of the identity-related request parameters are
	// present, not null and non-empty. Only when this is true does the authorizer
	// invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized
	// response without calling the Lambda function. The valid value is a string
	// of comma-separated mapping expressions of the specified request parameters.
	// When the authorization caching is not enabled, this property is optional.
	//
	// For a COGNITO_USER_POOLS authorizer, this property is not used.
	IdentitySource *string `locationName:"identitySource" type:"string"`

	// A validation expression for the incoming identity token. For TOKEN authorizers,
	// this value is a regular expression. Amazon API Gateway will match the incoming
	// token from the client against the specified regular expression. It will invoke
	// the authorizer's Lambda function there is a match. Otherwise, it will return
	// a 401 Unauthorized response without calling the Lambda function. The validation
	// expression does not apply to the REQUEST authorizer.
	IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"`

	// [Required] The name of the authorizer.
	Name *string `locationName:"name" type:"string"`

	// A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
	// Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.
	// For a TOKEN or REQUEST authorizer, this is not defined.
	ProviderARNs []string `locationName:"providerARNs" type:"list"`

	// [Required] The authorizer type. Valid values are TOKEN for a Lambda function
	// using a single authorization token submitted in a custom header, REQUEST
	// for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS
	// for using an Amazon Cognito user pool.
	Type AuthorizerType `locationName:"type" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

Enable custom authorization (http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html)

func (UpdateAuthorizerOutput) GoString 

func (s UpdateAuthorizerOutput) GoString() string

GoString returns the string representation

func (UpdateAuthorizerOutput) SDKResponseMetadata 

func (s UpdateAuthorizerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateAuthorizerOutput) SetAuthType 

func (s *UpdateAuthorizerOutput) SetAuthType(v string) *UpdateAuthorizerOutput

SetAuthType sets the AuthType field's value.

func (*UpdateAuthorizerOutput) SetAuthorizerCredentials 

func (s *UpdateAuthorizerOutput) SetAuthorizerCredentials(v string) *UpdateAuthorizerOutput

SetAuthorizerCredentials sets the AuthorizerCredentials field's value.

func (*UpdateAuthorizerOutput) SetAuthorizerResultTtlInSeconds 

func (s *UpdateAuthorizerOutput) SetAuthorizerResultTtlInSeconds(v int64) *UpdateAuthorizerOutput

SetAuthorizerResultTtlInSeconds sets the AuthorizerResultTtlInSeconds field's value.

func (*UpdateAuthorizerOutput) SetAuthorizerUri 

func (s *UpdateAuthorizerOutput) SetAuthorizerUri(v string) *UpdateAuthorizerOutput

SetAuthorizerUri sets the AuthorizerUri field's value.

func (*UpdateAuthorizerOutput) SetId 

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

SetId sets the Id field's value.

func (*UpdateAuthorizerOutput) SetIdentitySource 

func (s *UpdateAuthorizerOutput) SetIdentitySource(v string) *UpdateAuthorizerOutput

SetIdentitySource sets the IdentitySource field's value.

func (*UpdateAuthorizerOutput) SetIdentityValidationExpression 

func (s *UpdateAuthorizerOutput) SetIdentityValidationExpression(v string) *UpdateAuthorizerOutput

SetIdentityValidationExpression sets the IdentityValidationExpression field's value.

func (*UpdateAuthorizerOutput) SetName 

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

SetName sets the Name field's value.

func (*UpdateAuthorizerOutput) SetProviderARNs 

func (s *UpdateAuthorizerOutput) SetProviderARNs(v []string) *UpdateAuthorizerOutput

SetProviderARNs sets the ProviderARNs field's value.

func (*UpdateAuthorizerOutput) SetType 

func (s *UpdateAuthorizerOutput) SetType(v AuthorizerType) *UpdateAuthorizerOutput

SetType sets the Type field's value.

func (UpdateAuthorizerOutput) String 

func (s UpdateAuthorizerOutput) String() string

String returns the string representation

type UpdateAuthorizerRequest 

type UpdateAuthorizerRequest struct {
	*aws.Request
	Input *UpdateAuthorizerInput
}

UpdateAuthorizerRequest is a API request type for the UpdateAuthorizer API operation.

func (UpdateAuthorizerRequest) Send 

func (r UpdateAuthorizerRequest) Send() (*UpdateAuthorizerOutput, error)

Send marshals and sends the UpdateAuthorizer API request.

type UpdateBasePathMappingInput 

type UpdateBasePathMappingInput struct {

	// The base path of the BasePathMapping resource to change.
	//
	// BasePath is a required field
	BasePath *string `location:"uri" locationName:"base_path" type:"string" required:"true"`

	// The domain name of the BasePathMapping resource to change.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`
	// contains filtered or unexported fields
}

A request to change information about the BasePathMapping resource.

func (UpdateBasePathMappingInput) GoString 

func (s UpdateBasePathMappingInput) GoString() string

GoString returns the string representation

func (*UpdateBasePathMappingInput) SetBasePath 

func (s *UpdateBasePathMappingInput) SetBasePath(v string) *UpdateBasePathMappingInput

SetBasePath sets the BasePath field's value.

func (*UpdateBasePathMappingInput) SetDomainName 

func (s *UpdateBasePathMappingInput) SetDomainName(v string) *UpdateBasePathMappingInput

SetDomainName sets the DomainName field's value.

func (*UpdateBasePathMappingInput) SetPatchOperations 

func (s *UpdateBasePathMappingInput) SetPatchOperations(v []PatchOperation) *UpdateBasePathMappingInput

SetPatchOperations sets the PatchOperations field's value.

func (UpdateBasePathMappingInput) String 

func (s UpdateBasePathMappingInput) String() string

String returns the string representation

func (*UpdateBasePathMappingInput) Validate 

func (s *UpdateBasePathMappingInput) Validate() error

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

type UpdateBasePathMappingOutput 

type UpdateBasePathMappingOutput struct {

	// The base path name that callers of the API must provide as part of the URL
	// after the domain name.
	BasePath *string `locationName:"basePath" type:"string"`

	// The string identifier of the associated RestApi.
	RestApiId *string `locationName:"restApiId" type:"string"`

	// The name of the associated stage.
	Stage *string `locationName:"stage" type:"string"`
	// contains filtered or unexported fields
}

Represents the base path that callers of the API must provide as part of the URL after the domain name.

A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account. Use Custom Domain Names (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)

func (UpdateBasePathMappingOutput) GoString 

func (s UpdateBasePathMappingOutput) GoString() string

GoString returns the string representation

func (UpdateBasePathMappingOutput) SDKResponseMetadata 

func (s UpdateBasePathMappingOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateBasePathMappingOutput) SetBasePath 

func (s *UpdateBasePathMappingOutput) SetBasePath(v string) *UpdateBasePathMappingOutput

SetBasePath sets the BasePath field's value.

func (*UpdateBasePathMappingOutput) SetRestApiId 

func (s *UpdateBasePathMappingOutput) SetRestApiId(v string) *UpdateBasePathMappingOutput

SetRestApiId sets the RestApiId field's value.

func (*UpdateBasePathMappingOutput) SetStage 

func (s *UpdateBasePathMappingOutput) SetStage(v string) *UpdateBasePathMappingOutput

SetStage sets the Stage field's value.

func (UpdateBasePathMappingOutput) String 

func (s UpdateBasePathMappingOutput) String() string

String returns the string representation

type UpdateBasePathMappingRequest 

type UpdateBasePathMappingRequest struct {
	*aws.Request
	Input *UpdateBasePathMappingInput
}

UpdateBasePathMappingRequest is a API request type for the UpdateBasePathMapping API operation.

func (UpdateBasePathMappingRequest) Send 

func (r UpdateBasePathMappingRequest) Send() (*UpdateBasePathMappingOutput, error)

Send marshals and sends the UpdateBasePathMapping API request.

type UpdateClientCertificateInput 

type UpdateClientCertificateInput struct {

	// The identifier of the ClientCertificate resource to be updated.
	//
	// ClientCertificateId is a required field
	ClientCertificateId *string `location:"uri" locationName:"clientcertificate_id" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`
	// contains filtered or unexported fields
}

A request to change information about an ClientCertificate resource.

func (UpdateClientCertificateInput) GoString 

func (s UpdateClientCertificateInput) GoString() string

GoString returns the string representation

func (*UpdateClientCertificateInput) SetClientCertificateId 

func (s *UpdateClientCertificateInput) SetClientCertificateId(v string) *UpdateClientCertificateInput

SetClientCertificateId sets the ClientCertificateId field's value.

func (*UpdateClientCertificateInput) SetPatchOperations 

func (s *UpdateClientCertificateInput) SetPatchOperations(v []PatchOperation) *UpdateClientCertificateInput

SetPatchOperations sets the PatchOperations field's value.

func (UpdateClientCertificateInput) String 

func (s UpdateClientCertificateInput) String() string

String returns the string representation

func (*UpdateClientCertificateInput) Validate 

func (s *UpdateClientCertificateInput) Validate() error

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

type UpdateClientCertificateOutput 

type UpdateClientCertificateOutput struct {

	// The identifier of the client certificate.
	ClientCertificateId *string `locationName:"clientCertificateId" type:"string"`

	// The timestamp when the client certificate was created.
	CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"`

	// The description of the client certificate.
	Description *string `locationName:"description" type:"string"`

	// The timestamp when the client certificate will expire.
	ExpirationDate *time.Time `locationName:"expirationDate" type:"timestamp" timestampFormat:"unix"`

	// The PEM-encoded public key of the client certificate, which can be used to
	// configure certificate authentication in the integration endpoint .
	PemEncodedCertificate *string `locationName:"pemEncodedCertificate" type:"string"`
	// contains filtered or unexported fields
}

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool. Use Client-Side Certificate (http://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)

func (UpdateClientCertificateOutput) GoString 

func (s UpdateClientCertificateOutput) GoString() string

GoString returns the string representation

func (UpdateClientCertificateOutput) SDKResponseMetadata 

func (s UpdateClientCertificateOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateClientCertificateOutput) SetClientCertificateId 

func (s *UpdateClientCertificateOutput) SetClientCertificateId(v string) *UpdateClientCertificateOutput

SetClientCertificateId sets the ClientCertificateId field's value.

func (*UpdateClientCertificateOutput) SetCreatedDate 

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

SetCreatedDate sets the CreatedDate field's value.

func (*UpdateClientCertificateOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateClientCertificateOutput) SetExpirationDate 

func (s *UpdateClientCertificateOutput) SetExpirationDate(v time.Time) *UpdateClientCertificateOutput

SetExpirationDate sets the ExpirationDate field's value.

func (*UpdateClientCertificateOutput) SetPemEncodedCertificate 

func (s *UpdateClientCertificateOutput) SetPemEncodedCertificate(v string) *UpdateClientCertificateOutput

SetPemEncodedCertificate sets the PemEncodedCertificate field's value.

func (UpdateClientCertificateOutput) String 

func (s UpdateClientCertificateOutput) String() string

String returns the string representation

type UpdateClientCertificateRequest 

type UpdateClientCertificateRequest struct {
	*aws.Request
	Input *UpdateClientCertificateInput
}

UpdateClientCertificateRequest is a API request type for the UpdateClientCertificate API operation.

func (UpdateClientCertificateRequest) Send 

func (r UpdateClientCertificateRequest) Send() (*UpdateClientCertificateOutput, error)

Send marshals and sends the UpdateClientCertificate API request.

type UpdateDeploymentInput 

type UpdateDeploymentInput struct {

	// The replacement identifier for the Deployment resource to change information
	// about.
	//
	// DeploymentId is a required field
	DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to change information about a Deployment resource.

func (UpdateDeploymentInput) GoString 

func (s UpdateDeploymentInput) GoString() string

GoString returns the string representation

func (*UpdateDeploymentInput) SetDeploymentId 

func (s *UpdateDeploymentInput) SetDeploymentId(v string) *UpdateDeploymentInput

SetDeploymentId sets the DeploymentId field's value.

func (*UpdateDeploymentInput) SetPatchOperations 

func (s *UpdateDeploymentInput) SetPatchOperations(v []PatchOperation) *UpdateDeploymentInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateDeploymentInput) SetRestApiId 

func (s *UpdateDeploymentInput) SetRestApiId(v string) *UpdateDeploymentInput

SetRestApiId sets the RestApiId field's value.

func (UpdateDeploymentInput) String 

func (s UpdateDeploymentInput) String() string

String returns the string representation

func (*UpdateDeploymentInput) Validate 

func (s *UpdateDeploymentInput) Validate() error

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

type UpdateDeploymentOutput 

type UpdateDeploymentOutput struct {

	// A summary of the RestApi at the date and time that the deployment resource
	// was created.
	ApiSummary map[string]map[string]MethodSnapshot `locationName:"apiSummary" type:"map"`

	// The date and time that the deployment resource was created.
	CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"`

	// The description for the deployment resource.
	Description *string `locationName:"description" type:"string"`

	// The identifier for the deployment resource.
	Id *string `locationName:"id" type:"string"`
	// contains filtered or unexported fields
}

An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

To create a deployment, call POST on the Deployments resource of a RestApi. To view, update, or delete a deployment, call GET, PATCH, or DELETE on the specified deployment resource (/restapis/{restapi_id}/deployments/{deployment_id}).

RestApi, Deployments, Stage, AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html), AWS SDKs (https://aws.amazon.com/tools/)

func (UpdateDeploymentOutput) GoString 

func (s UpdateDeploymentOutput) GoString() string

GoString returns the string representation

func (UpdateDeploymentOutput) SDKResponseMetadata 

func (s UpdateDeploymentOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateDeploymentOutput) SetApiSummary 

func (s *UpdateDeploymentOutput) SetApiSummary(v map[string]map[string]MethodSnapshot) *UpdateDeploymentOutput

SetApiSummary sets the ApiSummary field's value.

func (*UpdateDeploymentOutput) SetCreatedDate 

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

SetCreatedDate sets the CreatedDate field's value.

func (*UpdateDeploymentOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateDeploymentOutput) SetId 

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

SetId sets the Id field's value.

func (UpdateDeploymentOutput) String 

func (s UpdateDeploymentOutput) String() string

String returns the string representation

type UpdateDeploymentRequest 

type UpdateDeploymentRequest struct {
	*aws.Request
	Input *UpdateDeploymentInput
}

UpdateDeploymentRequest is a API request type for the UpdateDeployment API operation.

func (UpdateDeploymentRequest) Send 

func (r UpdateDeploymentRequest) Send() (*UpdateDeploymentOutput, error)

Send marshals and sends the UpdateDeployment API request.

type UpdateDocumentationPartInput 

type UpdateDocumentationPartInput struct {

	// [Required] The identifier of the to-be-updated documentation part.
	//
	// DocumentationPartId is a required field
	DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// [Required] The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Updates an existing documentation part of a given API.

func (UpdateDocumentationPartInput) GoString 

func (s UpdateDocumentationPartInput) GoString() string

GoString returns the string representation

func (*UpdateDocumentationPartInput) SetDocumentationPartId 

func (s *UpdateDocumentationPartInput) SetDocumentationPartId(v string) *UpdateDocumentationPartInput

SetDocumentationPartId sets the DocumentationPartId field's value.

func (*UpdateDocumentationPartInput) SetPatchOperations 

func (s *UpdateDocumentationPartInput) SetPatchOperations(v []PatchOperation) *UpdateDocumentationPartInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateDocumentationPartInput) SetRestApiId 

func (s *UpdateDocumentationPartInput) SetRestApiId(v string) *UpdateDocumentationPartInput

SetRestApiId sets the RestApiId field's value.

func (UpdateDocumentationPartInput) String 

func (s UpdateDocumentationPartInput) String() string

String returns the string representation

func (*UpdateDocumentationPartInput) Validate 

func (s *UpdateDocumentationPartInput) Validate() error

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

type UpdateDocumentationPartOutput 

type UpdateDocumentationPartOutput struct {

	// The DocumentationPart identifier, generated by Amazon API Gateway when the
	// DocumentationPart is created.
	Id *string `locationName:"id" type:"string"`

	// The location of the API entity to which the documentation applies. Valid
	// fields depend on the targeted API entity type. All the valid location fields
	// are not required. If not explicitly specified, a valid location field is
	// treated as a wildcard and associated documentation content may be inherited
	// by matching entities, unless overridden.
	Location *DocumentationPartLocation `locationName:"location" type:"structure"`

	// A content map of API-specific key-value pairs describing the targeted API
	// entity. The map must be encoded as a JSON string, e.g., "{ \"description\":
	// \"The API does ...\" }". Only Swagger-compliant documentation-related fields
	// from the properties map are exported and, hence, published as part of the
	// API entity definitions, while the original documentation parts are exported
	// in a Swagger extension of x-amazon-apigateway-documentation.
	Properties *string `locationName:"properties" type:"string"`
	// contains filtered or unexported fields
}

A documentation part for a targeted API entity.

A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.

The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.

Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationParts

func (UpdateDocumentationPartOutput) GoString 

func (s UpdateDocumentationPartOutput) GoString() string

GoString returns the string representation

func (UpdateDocumentationPartOutput) SDKResponseMetadata 

func (s UpdateDocumentationPartOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateDocumentationPartOutput) SetId 

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

SetId sets the Id field's value.

func (*UpdateDocumentationPartOutput) SetLocation 

func (s *UpdateDocumentationPartOutput) SetLocation(v *DocumentationPartLocation) *UpdateDocumentationPartOutput

SetLocation sets the Location field's value.

func (*UpdateDocumentationPartOutput) SetProperties 

func (s *UpdateDocumentationPartOutput) SetProperties(v string) *UpdateDocumentationPartOutput

SetProperties sets the Properties field's value.

func (UpdateDocumentationPartOutput) String 

func (s UpdateDocumentationPartOutput) String() string

String returns the string representation

type UpdateDocumentationPartRequest 

type UpdateDocumentationPartRequest struct {
	*aws.Request
	Input *UpdateDocumentationPartInput
}

UpdateDocumentationPartRequest is a API request type for the UpdateDocumentationPart API operation.

func (UpdateDocumentationPartRequest) Send 

func (r UpdateDocumentationPartRequest) Send() (*UpdateDocumentationPartOutput, error)

Send marshals and sends the UpdateDocumentationPart API request.

type UpdateDocumentationVersionInput 

type UpdateDocumentationVersionInput struct {

	// [Required] The version identifier of the to-be-updated documentation version.
	//
	// DocumentationVersion is a required field
	DocumentationVersion *string `location:"uri" locationName:"doc_version" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// [Required] The string identifier of the associated RestApi..
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Updates an existing documentation version of an API.

func (UpdateDocumentationVersionInput) GoString 

func (s UpdateDocumentationVersionInput) GoString() string

GoString returns the string representation

func (*UpdateDocumentationVersionInput) SetDocumentationVersion 

func (s *UpdateDocumentationVersionInput) SetDocumentationVersion(v string) *UpdateDocumentationVersionInput

SetDocumentationVersion sets the DocumentationVersion field's value.

func (*UpdateDocumentationVersionInput) SetPatchOperations 

func (s *UpdateDocumentationVersionInput) SetPatchOperations(v []PatchOperation) *UpdateDocumentationVersionInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateDocumentationVersionInput) SetRestApiId 

func (s *UpdateDocumentationVersionInput) SetRestApiId(v string) *UpdateDocumentationVersionInput

SetRestApiId sets the RestApiId field's value.

func (UpdateDocumentationVersionInput) String 

func (s UpdateDocumentationVersionInput) String() string

String returns the string representation

func (*UpdateDocumentationVersionInput) Validate 

func (s *UpdateDocumentationVersionInput) Validate() error

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

type UpdateDocumentationVersionOutput 

type UpdateDocumentationVersionOutput struct {

	// The date when the API documentation snapshot is created.
	CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"`

	// The description of the API documentation snapshot.
	Description *string `locationName:"description" type:"string"`

	// The version identifier of the API documentation snapshot.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

A snapshot of the documentation of an API.

Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.

Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart, DocumentationVersions

func (UpdateDocumentationVersionOutput) GoString 

func (s UpdateDocumentationVersionOutput) GoString() string

GoString returns the string representation

func (UpdateDocumentationVersionOutput) SDKResponseMetadata 

func (s UpdateDocumentationVersionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateDocumentationVersionOutput) SetCreatedDate 

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

SetCreatedDate sets the CreatedDate field's value.

func (*UpdateDocumentationVersionOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateDocumentationVersionOutput) SetVersion 

func (s *UpdateDocumentationVersionOutput) SetVersion(v string) *UpdateDocumentationVersionOutput

SetVersion sets the Version field's value.

func (UpdateDocumentationVersionOutput) String 

func (s UpdateDocumentationVersionOutput) String() string

String returns the string representation

type UpdateDocumentationVersionRequest 

type UpdateDocumentationVersionRequest struct {
	*aws.Request
	Input *UpdateDocumentationVersionInput
}

UpdateDocumentationVersionRequest is a API request type for the UpdateDocumentationVersion API operation.

func (UpdateDocumentationVersionRequest) Send 

func (r UpdateDocumentationVersionRequest) Send() (*UpdateDocumentationVersionOutput, error)

Send marshals and sends the UpdateDocumentationVersion API request.

type UpdateDomainNameInput 

type UpdateDomainNameInput struct {

	// The name of the DomainName resource to be changed.
	//
	// DomainName is a required field
	DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`
	// contains filtered or unexported fields
}

A request to change information about the DomainName resource.

func (UpdateDomainNameInput) GoString 

func (s UpdateDomainNameInput) GoString() string

GoString returns the string representation

func (*UpdateDomainNameInput) SetDomainName 

func (s *UpdateDomainNameInput) SetDomainName(v string) *UpdateDomainNameInput

SetDomainName sets the DomainName field's value.

func (*UpdateDomainNameInput) SetPatchOperations 

func (s *UpdateDomainNameInput) SetPatchOperations(v []PatchOperation) *UpdateDomainNameInput

SetPatchOperations sets the PatchOperations field's value.

func (UpdateDomainNameInput) String 

func (s UpdateDomainNameInput) String() string

String returns the string representation

func (*UpdateDomainNameInput) Validate 

func (s *UpdateDomainNameInput) Validate() error

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

type UpdateDomainNameOutput 

type UpdateDomainNameOutput struct {

	// The reference to an AWS-managed certificate. AWS Certificate Manager is the
	// only supported source.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// The name of the certificate.
	CertificateName *string `locationName:"certificateName" type:"string"`

	// The timestamp when the certificate was uploaded.
	CertificateUploadDate *time.Time `locationName:"certificateUploadDate" type:"timestamp" timestampFormat:"unix"`

	// The domain name of the Amazon CloudFront distribution. For more information,
	// see the Amazon CloudFront documentation (http://aws.amazon.com/documentation/cloudfront/).
	DistributionDomainName *string `locationName:"distributionDomainName" type:"string"`

	// The name of the DomainName resource.
	DomainName *string `locationName:"domainName" type:"string"`
	// contains filtered or unexported fields
}

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

Use Client-Side Certificate (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)

func (UpdateDomainNameOutput) GoString 

func (s UpdateDomainNameOutput) GoString() string

GoString returns the string representation

func (UpdateDomainNameOutput) SDKResponseMetadata 

func (s UpdateDomainNameOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateDomainNameOutput) SetCertificateArn 

func (s *UpdateDomainNameOutput) SetCertificateArn(v string) *UpdateDomainNameOutput

SetCertificateArn sets the CertificateArn field's value.

func (*UpdateDomainNameOutput) SetCertificateName 

func (s *UpdateDomainNameOutput) SetCertificateName(v string) *UpdateDomainNameOutput

SetCertificateName sets the CertificateName field's value.

func (*UpdateDomainNameOutput) SetCertificateUploadDate 

func (s *UpdateDomainNameOutput) SetCertificateUploadDate(v time.Time) *UpdateDomainNameOutput

SetCertificateUploadDate sets the CertificateUploadDate field's value.

func (*UpdateDomainNameOutput) SetDistributionDomainName 

func (s *UpdateDomainNameOutput) SetDistributionDomainName(v string) *UpdateDomainNameOutput

SetDistributionDomainName sets the DistributionDomainName field's value.

func (*UpdateDomainNameOutput) SetDomainName 

func (s *UpdateDomainNameOutput) SetDomainName(v string) *UpdateDomainNameOutput

SetDomainName sets the DomainName field's value.

func (UpdateDomainNameOutput) String 

func (s UpdateDomainNameOutput) String() string

String returns the string representation

type UpdateDomainNameRequest 

type UpdateDomainNameRequest struct {
	*aws.Request
	Input *UpdateDomainNameInput
}

UpdateDomainNameRequest is a API request type for the UpdateDomainName API operation.

func (UpdateDomainNameRequest) Send 

func (r UpdateDomainNameRequest) Send() (*UpdateDomainNameOutput, error)

Send marshals and sends the UpdateDomainName API request.

type UpdateGatewayResponseInput 

type UpdateGatewayResponseInput struct {

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// The response type of the associated GatewayResponse. Valid values are ACCESS_DENIED
	//
	// API_CONFIGURATION_ERROR
	// AUTHORIZER_FAILURE
	//  AUTHORIZER_CONFIGURATION_ERROR
	// BAD_REQUEST_PARAMETERS
	// BAD_REQUEST_BODY
	// DEFAULT_4XX
	// DEFAULT_5XX
	// EXPIRED_TOKEN
	// INVALID_SIGNATURE
	// INTEGRATION_FAILURE
	// INTEGRATION_TIMEOUT
	// INVALID_API_KEY
	// MISSING_AUTHENTICATION_TOKEN
	//  QUOTA_EXCEEDED
	// REQUEST_TOO_LARGE
	// RESOURCE_NOT_FOUND
	// THROTTLED
	// UNAUTHORIZED
	// UNSUPPORTED_MEDIA_TYPES
	//
	// ResponseType is a required field
	ResponseType GatewayResponseType `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Updates a GatewayResponse of a specified response type on the given RestApi.

func (UpdateGatewayResponseInput) GoString 

func (s UpdateGatewayResponseInput) GoString() string

GoString returns the string representation

func (*UpdateGatewayResponseInput) SetPatchOperations 

func (s *UpdateGatewayResponseInput) SetPatchOperations(v []PatchOperation) *UpdateGatewayResponseInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateGatewayResponseInput) SetResponseType 

func (s *UpdateGatewayResponseInput) SetResponseType(v GatewayResponseType) *UpdateGatewayResponseInput

SetResponseType sets the ResponseType field's value.

func (*UpdateGatewayResponseInput) SetRestApiId 

func (s *UpdateGatewayResponseInput) SetRestApiId(v string) *UpdateGatewayResponseInput

SetRestApiId sets the RestApiId field's value.

func (UpdateGatewayResponseInput) String 

func (s UpdateGatewayResponseInput) String() string

String returns the string representation

func (*UpdateGatewayResponseInput) Validate 

func (s *UpdateGatewayResponseInput) Validate() error

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

type UpdateGatewayResponseOutput 

type UpdateGatewayResponseOutput struct {

	// A Boolean flag to indicate whether this GatewayResponse is the default gateway
	// response (true) or not (false). A default gateway response is one generated
	// by Amazon API Gateway without any customization by an API developer.
	DefaultResponse *bool `locationName:"defaultResponse" type:"boolean"`

	// Response parameters (paths, query strings and headers) of the GatewayResponse
	// as a string-to-string map of key-value pairs.
	ResponseParameters map[string]string `locationName:"responseParameters" type:"map"`

	// Response templates of the GatewayResponse as a string-to-string map of key-value
	// pairs.
	ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"`

	// The response type of the associated GatewayResponse. Valid values are ACCESS_DENIED
	//
	// API_CONFIGURATION_ERROR
	// AUTHORIZER_FAILURE
	//  AUTHORIZER_CONFIGURATION_ERROR
	// BAD_REQUEST_PARAMETERS
	// BAD_REQUEST_BODY
	// DEFAULT_4XX
	// DEFAULT_5XX
	// EXPIRED_TOKEN
	// INVALID_SIGNATURE
	// INTEGRATION_FAILURE
	// INTEGRATION_TIMEOUT
	// INVALID_API_KEY
	// MISSING_AUTHENTICATION_TOKEN
	//  QUOTA_EXCEEDED
	// REQUEST_TOO_LARGE
	// RESOURCE_NOT_FOUND
	// THROTTLED
	// UNAUTHORIZED
	// UNSUPPORTED_MEDIA_TYPES
	ResponseType GatewayResponseType `locationName:"responseType" type:"string" enum:"true"`

	// The HTTP status code for this GatewayResponse.
	StatusCode *string `locationName:"statusCode" type:"string"`
	// contains filtered or unexported fields
}

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

For more information about valid gateway response types, see Gateway Response Types Supported by Amazon API Gateway (http://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html)Example: Get a Gateway Response of a given response type

Request

This example shows how to get a gateway response of the MISSING_AUTHNETICATION_TOKEN type.

GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45

The response type is specified as a URL path.

Response

The successful operation returns the 200 OK status code and a payload similar to the following:

{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{\n \"message\": $context.error.messageString,\n \"type\": \"$context.error.responseType\",\n \"stage\": \"$context.stage\",\n \"resourcePath\": \"$context.resourcePath\",\n \"stageVariables.a\": \"$stageVariables.a\",\n \"statusCode\": \"'404'\"\n}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404" }

Customize Gateway Responses (http://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html)

func (UpdateGatewayResponseOutput) GoString 

func (s UpdateGatewayResponseOutput) GoString() string

GoString returns the string representation

func (UpdateGatewayResponseOutput) SDKResponseMetadata 

func (s UpdateGatewayResponseOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateGatewayResponseOutput) SetDefaultResponse 

func (s *UpdateGatewayResponseOutput) SetDefaultResponse(v bool) *UpdateGatewayResponseOutput

SetDefaultResponse sets the DefaultResponse field's value.

func (*UpdateGatewayResponseOutput) SetResponseParameters 

func (s *UpdateGatewayResponseOutput) SetResponseParameters(v map[string]string) *UpdateGatewayResponseOutput

SetResponseParameters sets the ResponseParameters field's value.

func (*UpdateGatewayResponseOutput) SetResponseTemplates 

func (s *UpdateGatewayResponseOutput) SetResponseTemplates(v map[string]string) *UpdateGatewayResponseOutput

SetResponseTemplates sets the ResponseTemplates field's value.

func (*UpdateGatewayResponseOutput) SetResponseType 

func (s *UpdateGatewayResponseOutput) SetResponseType(v GatewayResponseType) *UpdateGatewayResponseOutput

SetResponseType sets the ResponseType field's value.

func (*UpdateGatewayResponseOutput) SetStatusCode 

func (s *UpdateGatewayResponseOutput) SetStatusCode(v string) *UpdateGatewayResponseOutput

SetStatusCode sets the StatusCode field's value.

func (UpdateGatewayResponseOutput) String 

func (s UpdateGatewayResponseOutput) String() string

String returns the string representation

type UpdateGatewayResponseRequest 

type UpdateGatewayResponseRequest struct {
	*aws.Request
	Input *UpdateGatewayResponseInput
}

UpdateGatewayResponseRequest is a API request type for the UpdateGatewayResponse API operation.

func (UpdateGatewayResponseRequest) Send 

func (r UpdateGatewayResponseRequest) Send() (*UpdateGatewayResponseOutput, error)

Send marshals and sends the UpdateGatewayResponse API request.

type UpdateIntegrationInput 

type UpdateIntegrationInput struct {

	// Represents an update integration request's HTTP method.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// Represents an update integration request's resource identifier.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents an update integration request.

func (UpdateIntegrationInput) GoString 

func (s UpdateIntegrationInput) GoString() string

GoString returns the string representation

func (*UpdateIntegrationInput) SetHttpMethod 

func (s *UpdateIntegrationInput) SetHttpMethod(v string) *UpdateIntegrationInput

SetHttpMethod sets the HttpMethod field's value.

func (*UpdateIntegrationInput) SetPatchOperations 

func (s *UpdateIntegrationInput) SetPatchOperations(v []PatchOperation) *UpdateIntegrationInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateIntegrationInput) SetResourceId 

func (s *UpdateIntegrationInput) SetResourceId(v string) *UpdateIntegrationInput

SetResourceId sets the ResourceId field's value.

func (*UpdateIntegrationInput) SetRestApiId 

func (s *UpdateIntegrationInput) SetRestApiId(v string) *UpdateIntegrationInput

SetRestApiId sets the RestApiId field's value.

func (UpdateIntegrationInput) String 

func (s UpdateIntegrationInput) String() string

String returns the string representation

func (*UpdateIntegrationInput) Validate 

func (s *UpdateIntegrationInput) Validate() error

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

type UpdateIntegrationOutput 

type UpdateIntegrationOutput struct {

	// Specifies the integration's cache key parameters.
	CacheKeyParameters []string `locationName:"cacheKeyParameters" type:"list"`

	// Specifies the integration's cache namespace.
	CacheNamespace *string `locationName:"cacheNamespace" type:"string"`

	// Specifies how to handle request payload content type conversions. Supported
	// values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
	//
	//    * CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded
	//    string to the corresponding binary blob.
	//
	//    * CONVERT_TO_TEXT: Converts a request payload from a binary blob to a
	//    Base64-encoded string.
	//
	// If this property is not defined, the request payload will be passed through
	// from the method request to integration request without modification, provided
	// that the passthroughBehaviors is configured to support payload pass-through.
	ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"`

	// Specifies the credentials required for the integration, if any. For AWS integrations,
	// three options are available. To specify an IAM Role for Amazon API Gateway
	// to assume, use the role's Amazon Resource Name (ARN). To require that the
	// caller's identity be passed through from the request, specify the string
	// arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS
	// services, specify null.
	Credentials *string `locationName:"credentials" type:"string"`

	// Specifies the integration's HTTP method type.
	HttpMethod *string `locationName:"httpMethod" type:"string"`

	// Specifies the integration's responses.
	//
	// Example: Get integration responses of a method
	//
	// Request
	//
	// GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
	// HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
	// X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
	// SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
	// Response
	//
	// The successful response returns 200 OKstatus and a payload as follows:
	//
	// { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
	// "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
	// "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
	// }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
	// } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'"
	// }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream
	// in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n"
	// }, "statusCode": "200" }
	IntegrationResponses map[string]UpdateIntegrationResponseOutput `locationName:"integrationResponses" type:"map"`

	// Specifies how the method request body of an unmapped content type will be
	// passed through the integration request to the back end without transformation.
	// A content type is unmapped if no mapping template is defined in the integration
	// or the content type does not match any of the mapped content types, as specified
	// in requestTemplates. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES,
	// and NEVER.
	//
	// WHEN_NO_MATCH passes the method request body through the integration request
	// to the back end without transformation when the method request content type
	// does not match any content type associated with the mapping templates defined
	// in the integration request.
	// WHEN_NO_TEMPLATES passes the method request body through the integration
	// request to the back end without transformation when no mapping template is
	// defined in the integration request. If a template is defined when this option
	// is selected, the method request of an unmapped content-type will be rejected
	// with an HTTP 415 Unsupported Media Type response.
	// NEVER rejects the method request with an HTTP 415 Unsupported Media Type
	// response when either the method request content type does not match any content
	// type associated with the mapping templates defined in the integration request
	// or no mapping template is defined in the integration request.
	PassthroughBehavior *string `locationName:"passthroughBehavior" type:"string"`

	// A key-value map specifying request parameters that are passed from the method
	// request to the back end. The key is an integration request parameter name
	// and the associated value is a method request parameter value or static value
	// that must be enclosed within single quotes and pre-encoded as required by
	// the back end. The method request parameter value must match the pattern of
	// method.request.{location}.{name}, where location is querystring, path, or
	// header and name must be a valid and unique method request parameter name.
	RequestParameters map[string]string `locationName:"requestParameters" type:"map"`

	// Represents a map of Velocity templates that are applied on the request payload
	// based on the value of the Content-Type header sent by the client. The content
	// type value is the key in this map, and the template (as a String) is the
	// value.
	RequestTemplates map[string]string `locationName:"requestTemplates" type:"map"`

	// Specifies the integration's type. The valid value is HTTP for integrating
	// with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing
	// without actually invoking the back end, HTTP_PROXY for integrating with the
	// HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy
	// integration type.
	Type IntegrationType `locationName:"type" type:"string" enum:"true"`

	// Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations,
	// the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986
	// specification (https://en.wikipedia.org/wiki/Uniform_Resource_Identifier).
	// For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}.
	// Region, subdomain and service are used to determine the right endpoint. For
	// AWS services that use the Action= query string parameter, service_api should
	// be a valid action for the desired service. For RESTful AWS service APIs,
	// path is used to indicate that the remaining substring in the URI should be
	// treated as the path to the resource, including the initial /.
	Uri *string `locationName:"uri" type:"string"`
	// contains filtered or unexported fields
}

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

In the API Gateway console, the built-in Lambda integration is an AWS integration.

Creating an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)

func (UpdateIntegrationOutput) GoString 

func (s UpdateIntegrationOutput) GoString() string

GoString returns the string representation

func (UpdateIntegrationOutput) SDKResponseMetadata 

func (s UpdateIntegrationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateIntegrationOutput) SetCacheKeyParameters 

func (s *UpdateIntegrationOutput) SetCacheKeyParameters(v []string) *UpdateIntegrationOutput

SetCacheKeyParameters sets the CacheKeyParameters field's value.

func (*UpdateIntegrationOutput) SetCacheNamespace 

func (s *UpdateIntegrationOutput) SetCacheNamespace(v string) *UpdateIntegrationOutput

SetCacheNamespace sets the CacheNamespace field's value.

func (*UpdateIntegrationOutput) SetContentHandling 

func (s *UpdateIntegrationOutput) SetContentHandling(v ContentHandlingStrategy) *UpdateIntegrationOutput

SetContentHandling sets the ContentHandling field's value.

func (*UpdateIntegrationOutput) SetCredentials 

func (s *UpdateIntegrationOutput) SetCredentials(v string) *UpdateIntegrationOutput

SetCredentials sets the Credentials field's value.

func (*UpdateIntegrationOutput) SetHttpMethod 

func (s *UpdateIntegrationOutput) SetHttpMethod(v string) *UpdateIntegrationOutput

SetHttpMethod sets the HttpMethod field's value.

func (*UpdateIntegrationOutput) SetIntegrationResponses 

func (s *UpdateIntegrationOutput) SetIntegrationResponses(v map[string]UpdateIntegrationResponseOutput) *UpdateIntegrationOutput

SetIntegrationResponses sets the IntegrationResponses field's value.

func (*UpdateIntegrationOutput) SetPassthroughBehavior 

func (s *UpdateIntegrationOutput) SetPassthroughBehavior(v string) *UpdateIntegrationOutput

SetPassthroughBehavior sets the PassthroughBehavior field's value.

func (*UpdateIntegrationOutput) SetRequestParameters 

func (s *UpdateIntegrationOutput) SetRequestParameters(v map[string]string) *UpdateIntegrationOutput

SetRequestParameters sets the RequestParameters field's value.

func (*UpdateIntegrationOutput) SetRequestTemplates 

func (s *UpdateIntegrationOutput) SetRequestTemplates(v map[string]string) *UpdateIntegrationOutput

SetRequestTemplates sets the RequestTemplates field's value.

func (*UpdateIntegrationOutput) SetType 

func (s *UpdateIntegrationOutput) SetType(v IntegrationType) *UpdateIntegrationOutput

SetType sets the Type field's value.

func (*UpdateIntegrationOutput) SetUri 

func (s *UpdateIntegrationOutput) SetUri(v string) *UpdateIntegrationOutput

SetUri sets the Uri field's value.

func (UpdateIntegrationOutput) String 

func (s UpdateIntegrationOutput) String() string

String returns the string representation

type UpdateIntegrationRequest 

type UpdateIntegrationRequest struct {
	*aws.Request
	Input *UpdateIntegrationInput
}

UpdateIntegrationRequest is a API request type for the UpdateIntegration API operation.

func (UpdateIntegrationRequest) Send 

func (r UpdateIntegrationRequest) Send() (*UpdateIntegrationOutput, error)

Send marshals and sends the UpdateIntegration API request.

type UpdateIntegrationResponseInput 

type UpdateIntegrationResponseInput struct {

	// Specifies an update integration response request's HTTP method.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// Specifies an update integration response request's resource identifier.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// Specifies an update integration response request's status code.
	//
	// StatusCode is a required field
	StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents an update integration response request.

func (UpdateIntegrationResponseInput) GoString 

func (s UpdateIntegrationResponseInput) GoString() string

GoString returns the string representation

func (*UpdateIntegrationResponseInput) SetHttpMethod 

func (s *UpdateIntegrationResponseInput) SetHttpMethod(v string) *UpdateIntegrationResponseInput

SetHttpMethod sets the HttpMethod field's value.

func (*UpdateIntegrationResponseInput) SetPatchOperations 

func (s *UpdateIntegrationResponseInput) SetPatchOperations(v []PatchOperation) *UpdateIntegrationResponseInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateIntegrationResponseInput) SetResourceId 

func (s *UpdateIntegrationResponseInput) SetResourceId(v string) *UpdateIntegrationResponseInput

SetResourceId sets the ResourceId field's value.

func (*UpdateIntegrationResponseInput) SetRestApiId 

func (s *UpdateIntegrationResponseInput) SetRestApiId(v string) *UpdateIntegrationResponseInput

SetRestApiId sets the RestApiId field's value.

func (*UpdateIntegrationResponseInput) SetStatusCode 

func (s *UpdateIntegrationResponseInput) SetStatusCode(v string) *UpdateIntegrationResponseInput

SetStatusCode sets the StatusCode field's value.

func (UpdateIntegrationResponseInput) String 

func (s UpdateIntegrationResponseInput) String() string

String returns the string representation

func (*UpdateIntegrationResponseInput) Validate 

func (s *UpdateIntegrationResponseInput) Validate() error

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

type UpdateIntegrationResponseOutput 

type UpdateIntegrationResponseOutput struct {

	// Specifies how to handle response payload content type conversions. Supported
	// values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
	//
	//    * CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
	//    string to the corresponding binary blob.
	//
	//    * CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
	//    Base64-encoded string.
	//
	// If this property is not defined, the response payload will be passed through
	// from the integration response to the method response without modification.
	ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"`

	// A key-value map specifying response parameters that are passed to the method
	// response from the back end. The key is a method response header parameter
	// name and the mapped value is an integration response header value, a static
	// value enclosed within a pair of single quotes, or a JSON expression from
	// the integration response body. The mapping key must match the pattern of
	// method.response.header.{name}, where name is a valid and unique header name.
	// The mapped non-static value must match the pattern of integration.response.header.{name}
	// or integration.response.body.{JSON-expression}, where name is a valid and
	// unique response header name and JSON-expression is a valid JSON expression
	// without the $ prefix.
	ResponseParameters map[string]string `locationName:"responseParameters" type:"map"`

	// Specifies the templates used to transform the integration response body.
	// Response templates are represented as a key/value map, with a content-type
	// as the key and a template as the value.
	ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"`

	// Specifies the regular expression (regex) pattern used to choose an integration
	// response based on the response from the back end. For example, if the success
	// response returns nothing and the error response returns some string, you
	// could use the .+ regex to match error response. However, make sure that the
	// error response does not contain any newline (\n) character in such cases.
	// If the back end is an AWS Lambda function, the AWS Lambda function error
	// header is matched. For all other HTTP and AWS back ends, the HTTP status
	// code is matched.
	SelectionPattern *string `locationName:"selectionPattern" type:"string"`

	// Specifies the status code that is used to map the integration response to
	// an existing MethodResponse.
	StatusCode *string `locationName:"statusCode" type:"string"`
	// contains filtered or unexported fields
}

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

Creating an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)

func (UpdateIntegrationResponseOutput) GoString 

func (s UpdateIntegrationResponseOutput) GoString() string

GoString returns the string representation

func (UpdateIntegrationResponseOutput) SDKResponseMetadata 

func (s UpdateIntegrationResponseOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateIntegrationResponseOutput) SetContentHandling 

func (s *UpdateIntegrationResponseOutput) SetContentHandling(v ContentHandlingStrategy) *UpdateIntegrationResponseOutput

SetContentHandling sets the ContentHandling field's value.

func (*UpdateIntegrationResponseOutput) SetResponseParameters 

func (s *UpdateIntegrationResponseOutput) SetResponseParameters(v map[string]string) *UpdateIntegrationResponseOutput

SetResponseParameters sets the ResponseParameters field's value.

func (*UpdateIntegrationResponseOutput) SetResponseTemplates 

func (s *UpdateIntegrationResponseOutput) SetResponseTemplates(v map[string]string) *UpdateIntegrationResponseOutput

SetResponseTemplates sets the ResponseTemplates field's value.

func (*UpdateIntegrationResponseOutput) SetSelectionPattern 

func (s *UpdateIntegrationResponseOutput) SetSelectionPattern(v string) *UpdateIntegrationResponseOutput

SetSelectionPattern sets the SelectionPattern field's value.

func (*UpdateIntegrationResponseOutput) SetStatusCode 

func (s *UpdateIntegrationResponseOutput) SetStatusCode(v string) *UpdateIntegrationResponseOutput

SetStatusCode sets the StatusCode field's value.

func (UpdateIntegrationResponseOutput) String 

func (s UpdateIntegrationResponseOutput) String() string

String returns the string representation

type UpdateIntegrationResponseRequest 

type UpdateIntegrationResponseRequest struct {
	*aws.Request
	Input *UpdateIntegrationResponseInput
}

UpdateIntegrationResponseRequest is a API request type for the UpdateIntegrationResponse API operation.

func (UpdateIntegrationResponseRequest) Send 

func (r UpdateIntegrationResponseRequest) Send() (*UpdateIntegrationResponseOutput, error)

Send marshals and sends the UpdateIntegrationResponse API request.

type UpdateMethodInput 

type UpdateMethodInput struct {

	// The HTTP verb of the Method resource.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// The Resource identifier for the Method resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to update an existing Method resource.

func (UpdateMethodInput) GoString 

func (s UpdateMethodInput) GoString() string

GoString returns the string representation

func (*UpdateMethodInput) SetHttpMethod 

func (s *UpdateMethodInput) SetHttpMethod(v string) *UpdateMethodInput

SetHttpMethod sets the HttpMethod field's value.

func (*UpdateMethodInput) SetPatchOperations 

func (s *UpdateMethodInput) SetPatchOperations(v []PatchOperation) *UpdateMethodInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateMethodInput) SetResourceId 

func (s *UpdateMethodInput) SetResourceId(v string) *UpdateMethodInput

SetResourceId sets the ResourceId field's value.

func (*UpdateMethodInput) SetRestApiId 

func (s *UpdateMethodInput) SetRestApiId(v string) *UpdateMethodInput

SetRestApiId sets the RestApiId field's value.

func (UpdateMethodInput) String 

func (s UpdateMethodInput) String() string

String returns the string representation

func (*UpdateMethodInput) Validate 

func (s *UpdateMethodInput) Validate() error

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

type UpdateMethodOutput 

type UpdateMethodOutput struct {

	// A boolean flag specifying whether a valid ApiKey is required to invoke this
	// method.
	ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"`

	// The method's authorization type. Valid values are NONE for open access, AWS_IAM
	// for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS
	// for using a Cognito user pool.
	AuthorizationType *string `locationName:"authorizationType" type:"string"`

	// The identifier of an Authorizer to use on this method. The authorizationType
	// must be CUSTOM.
	AuthorizerId *string `locationName:"authorizerId" type:"string"`

	// The method's HTTP verb.
	HttpMethod *string `locationName:"httpMethod" type:"string"`

	// Gets the method's integration responsible for passing the client-submitted
	// request to the back end and performing necessary transformations to make
	// the request compliant with the back end.
	//
	// Example:
	//
	// Request
	//
	// GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1
	// Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length:
	// 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
	// SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
	// Response
	//
	// The successful response returns a 200 OKstatus code and a payload similar to the following:
	//
	// { "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
	// "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
	// "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration"
	// }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration"
	// }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200",
	// "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration"
	// }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}",
	// "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch",
	// "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod":
	// "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json":
	// "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\",
	// \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations",
	// "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200",
	// "name": "200", "title": "200" }, "integrationresponse:delete": { "href":
	// "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200"
	// }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200"
	// } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op",
	// "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1":
	// "integration.response.body.a" }, "responseTemplates": { "application/json":
	// "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op
	// => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n
	// \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } }
	// }
	MethodIntegration *UpdateIntegrationOutput `locationName:"methodIntegration" type:"structure"`

	// Gets a method response associated with a given HTTP status code.
	//
	// The collection of method responses are encapsulated in a key-value map, where
	// the key is a response's HTTP status code and the value is a MethodResponse
	// resource that specifies the response returned to the caller from the back
	// end through the integration response.
	//
	// Example: Get a 200 OK response of a GET method
	//
	// Request
	//
	//    GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
	//    Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
	//    Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
	//    Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
	//    SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
	// Response
	//
	// The successful response returns a 200 OK status code and a payload similar
	// to the following:
	//
	//    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
	//    "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200",
	//    "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200"
	//    }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200"
	//    } }, "responseModels": { "application/json": "Empty" }, "responseParameters":
	//    { "method.response.header.operator": false, "method.response.header.operand_2":
	//    false, "method.response.header.operand_1": false }, "statusCode": "200"
	//    }
	MethodResponses map[string]UpdateMethodResponseOutput `locationName:"methodResponses" type:"map"`

	// A human-friendly operation identifier for the method. For example, you can
	// assign the operationName of ListPets for the GET /pets method in PetStore
	// (http://petstore-demo-endpoint.execute-api.com/petstore/pets) example.
	OperationName *string `locationName:"operationName" type:"string"`

	// A key-value map specifying data schemas, represented by Model resources,
	// (as the mapped value) of the request payloads of given content types (as
	// the mapping key).
	RequestModels map[string]string `locationName:"requestModels" type:"map"`

	// A key-value map defining required or optional method request parameters that
	// can be accepted by Amazon API Gateway. A key is a method request parameter
	// name matching the pattern of method.request.{location}.{name}, where location
	// is querystring, path, or header and name is a valid and unique parameter
	// name. The value associated with the key is a Boolean flag indicating whether
	// the parameter is required (true) or optional (false). The method request
	// parameter names defined here are available in Integration to be mapped to
	// integration request parameters or templates.
	RequestParameters map[string]bool `locationName:"requestParameters" type:"map"`

	// The identifier of a RequestValidator for request validation.
	RequestValidatorId *string `locationName:"requestValidatorId" type:"string"`
	// contains filtered or unexported fields
}

Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.

Example: Retrive the GET method on a specified resource

Request

The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri). 

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

Response

The successful response returns a 200 OK status code and a payload similar to the following: 

{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
"name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
"name": "method", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET",
"name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
}, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET"
}, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
}, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200",
"name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET"
}, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}",
"templated": true } }, "apiKeyRequired": true, "authorizationType": "NONE",
"httpMethod": "GET", "_embedded": { "method:integration": { "_links":
{ "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
}, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
}, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
}, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}",
"templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2",
"credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod":
"POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": {
"integration.request.header.Content-Type": "'application/x-amz-json-1.1'"
}, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS",
"uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded":
{ "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"name": "200", "title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'"
}, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E\")"
}, "statusCode": "200" } } }, "method:responses": { "_links": { "self":
{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200",
"name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200"
}, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200"
} }, "responseModels": { "application/json": "Empty" }, "responseParameters":
{ "method.response.header.Content-Type": false }, "statusCode": "200"
} } }

In the example above, the response template for the 200 OK response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E and the output is decoded using the $util.urlDecode() (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#util-templat-reference) helper function.

MethodResponse, Integration, IntegrationResponse, Resource, Set up an API's method (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html)

func (UpdateMethodOutput) GoString 

func (s UpdateMethodOutput) GoString() string

GoString returns the string representation

func (UpdateMethodOutput) SDKResponseMetadata 

func (s UpdateMethodOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateMethodOutput) SetApiKeyRequired 

func (s *UpdateMethodOutput) SetApiKeyRequired(v bool) *UpdateMethodOutput

SetApiKeyRequired sets the ApiKeyRequired field's value.

func (*UpdateMethodOutput) SetAuthorizationType 

func (s *UpdateMethodOutput) SetAuthorizationType(v string) *UpdateMethodOutput

SetAuthorizationType sets the AuthorizationType field's value.

func (*UpdateMethodOutput) SetAuthorizerId 

func (s *UpdateMethodOutput) SetAuthorizerId(v string) *UpdateMethodOutput

SetAuthorizerId sets the AuthorizerId field's value.

func (*UpdateMethodOutput) SetHttpMethod 

func (s *UpdateMethodOutput) SetHttpMethod(v string) *UpdateMethodOutput

SetHttpMethod sets the HttpMethod field's value.

func (*UpdateMethodOutput) SetMethodIntegration 

func (s *UpdateMethodOutput) SetMethodIntegration(v *UpdateIntegrationOutput) *UpdateMethodOutput

SetMethodIntegration sets the MethodIntegration field's value.

func (*UpdateMethodOutput) SetMethodResponses 

func (s *UpdateMethodOutput) SetMethodResponses(v map[string]UpdateMethodResponseOutput) *UpdateMethodOutput

SetMethodResponses sets the MethodResponses field's value.

func (*UpdateMethodOutput) SetOperationName 

func (s *UpdateMethodOutput) SetOperationName(v string) *UpdateMethodOutput

SetOperationName sets the OperationName field's value.

func (*UpdateMethodOutput) SetRequestModels 

func (s *UpdateMethodOutput) SetRequestModels(v map[string]string) *UpdateMethodOutput

SetRequestModels sets the RequestModels field's value.

func (*UpdateMethodOutput) SetRequestParameters 

func (s *UpdateMethodOutput) SetRequestParameters(v map[string]bool) *UpdateMethodOutput

SetRequestParameters sets the RequestParameters field's value.

func (*UpdateMethodOutput) SetRequestValidatorId 

func (s *UpdateMethodOutput) SetRequestValidatorId(v string) *UpdateMethodOutput

SetRequestValidatorId sets the RequestValidatorId field's value.

func (UpdateMethodOutput) String 

func (s UpdateMethodOutput) String() string

String returns the string representation

type UpdateMethodRequest 

type UpdateMethodRequest struct {
	*aws.Request
	Input *UpdateMethodInput
}

UpdateMethodRequest is a API request type for the UpdateMethod API operation.

func (UpdateMethodRequest) Send 

func (r UpdateMethodRequest) Send() (*UpdateMethodOutput, error)

Send marshals and sends the UpdateMethod API request.

type UpdateMethodResponseInput 

type UpdateMethodResponseInput struct {

	// The HTTP verb of the Method resource.
	//
	// HttpMethod is a required field
	HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// The Resource identifier for the MethodResponse resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The status code for the MethodResponse resource.
	//
	// StatusCode is a required field
	StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request to update an existing MethodResponse resource.

func (UpdateMethodResponseInput) GoString 

func (s UpdateMethodResponseInput) GoString() string

GoString returns the string representation

func (*UpdateMethodResponseInput) SetHttpMethod 

func (s *UpdateMethodResponseInput) SetHttpMethod(v string) *UpdateMethodResponseInput

SetHttpMethod sets the HttpMethod field's value.

func (*UpdateMethodResponseInput) SetPatchOperations 

func (s *UpdateMethodResponseInput) SetPatchOperations(v []PatchOperation) *UpdateMethodResponseInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateMethodResponseInput) SetResourceId 

func (s *UpdateMethodResponseInput) SetResourceId(v string) *UpdateMethodResponseInput

SetResourceId sets the ResourceId field's value.

func (*UpdateMethodResponseInput) SetRestApiId 

func (s *UpdateMethodResponseInput) SetRestApiId(v string) *UpdateMethodResponseInput

SetRestApiId sets the RestApiId field's value.

func (*UpdateMethodResponseInput) SetStatusCode 

func (s *UpdateMethodResponseInput) SetStatusCode(v string) *UpdateMethodResponseInput

SetStatusCode sets the StatusCode field's value.

func (UpdateMethodResponseInput) String 

func (s UpdateMethodResponseInput) String() string

String returns the string representation

func (*UpdateMethodResponseInput) Validate 

func (s *UpdateMethodResponseInput) Validate() error

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

type UpdateMethodResponseOutput 

type UpdateMethodResponseOutput struct {

	// Specifies the Model resources used for the response's content-type. Response
	// models are represented as a key/value map, with a content-type as the key
	// and a Model name as the value.
	ResponseModels map[string]string `locationName:"responseModels" type:"map"`

	// A key-value map specifying required or optional response parameters that
	// Amazon API Gateway can send back to the caller. A key defines a method response
	// header and the value specifies whether the associated method response header
	// is required or not. The expression of the key must match the pattern method.response.header.{name},
	// where name is a valid and unique header name. Amazon API Gateway passes certain
	// integration response data to the method response headers specified here according
	// to the mapping you prescribe in the API's IntegrationResponse. The integration
	// response data that can be mapped include an integration response header expressed
	// in integration.response.header.{name}, a static value enclosed within a pair
	// of single quotes (e.g., 'application/json'), or a JSON expression from the
	// back-end response payload in the form of integration.response.body.{JSON-expression},
	// where JSON-expression is a valid JSON expression without the $ prefix.)
	ResponseParameters map[string]bool `locationName:"responseParameters" type:"map"`

	// The method response's status code.
	StatusCode *string `locationName:"statusCode" type:"string"`
	// contains filtered or unexported fields
}

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

Example: A MethodResponse instance of an API

Request

The example request retrieves a MethodResponse of the 200 status code. 

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

Response

The successful response returns 200 OK status and a payload as follows: 

{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200",
"title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200"
}, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200"
} }, "responseModels": { "application/json": "Empty" }, "responseParameters":
{ "method.response.header.Content-Type": false }, "statusCode": "200"
}

func (UpdateMethodResponseOutput) GoString 

func (s UpdateMethodResponseOutput) GoString() string

GoString returns the string representation

func (UpdateMethodResponseOutput) SDKResponseMetadata 

func (s UpdateMethodResponseOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateMethodResponseOutput) SetResponseModels 

func (s *UpdateMethodResponseOutput) SetResponseModels(v map[string]string) *UpdateMethodResponseOutput

SetResponseModels sets the ResponseModels field's value.

func (*UpdateMethodResponseOutput) SetResponseParameters 

func (s *UpdateMethodResponseOutput) SetResponseParameters(v map[string]bool) *UpdateMethodResponseOutput

SetResponseParameters sets the ResponseParameters field's value.

func (*UpdateMethodResponseOutput) SetStatusCode 

func (s *UpdateMethodResponseOutput) SetStatusCode(v string) *UpdateMethodResponseOutput

SetStatusCode sets the StatusCode field's value.

func (UpdateMethodResponseOutput) String 

func (s UpdateMethodResponseOutput) String() string

String returns the string representation

type UpdateMethodResponseRequest 

type UpdateMethodResponseRequest struct {
	*aws.Request
	Input *UpdateMethodResponseInput
}

UpdateMethodResponseRequest is a API request type for the UpdateMethodResponse API operation.

func (UpdateMethodResponseRequest) Send 

func (r UpdateMethodResponseRequest) Send() (*UpdateMethodResponseOutput, error)

Send marshals and sends the UpdateMethodResponse API request.

type UpdateModelInput 

type UpdateModelInput struct {

	// The name of the model to update.
	//
	// ModelName is a required field
	ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to update an existing model in an existing RestApi resource.

func (UpdateModelInput) GoString 

func (s UpdateModelInput) GoString() string

GoString returns the string representation

func (*UpdateModelInput) SetModelName 

func (s *UpdateModelInput) SetModelName(v string) *UpdateModelInput

SetModelName sets the ModelName field's value.

func (*UpdateModelInput) SetPatchOperations 

func (s *UpdateModelInput) SetPatchOperations(v []PatchOperation) *UpdateModelInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateModelInput) SetRestApiId 

func (s *UpdateModelInput) SetRestApiId(v string) *UpdateModelInput

SetRestApiId sets the RestApiId field's value.

func (UpdateModelInput) String 

func (s UpdateModelInput) String() string

String returns the string representation

func (*UpdateModelInput) Validate 

func (s *UpdateModelInput) Validate() error

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

type UpdateModelOutput 

type UpdateModelOutput struct {

	// The content-type for the model.
	ContentType *string `locationName:"contentType" type:"string"`

	// The description of the model.
	Description *string `locationName:"description" type:"string"`

	// The identifier for the model resource.
	Id *string `locationName:"id" type:"string"`

	// The name of the model. Must be an alphanumeric string.
	Name *string `locationName:"name" type:"string"`

	// The schema for the model. For application/json models, this should be JSON-schema
	// draft v4 (http://json-schema.org/documentation.html) model. Do not include
	// "\*/" characters in the description of any properties because such "\*/"
	// characters may be interpreted as the closing marker for comments in some
	// languages, such as Java or JavaScript, causing the installation of your API's
	// SDK generated by API Gateway to fail.
	Schema *string `locationName:"schema" type:"string"`
	// contains filtered or unexported fields
}

Represents the data structure of a method's request or response payload.

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.

A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

Method, MethodResponse, Models and Mappings (http://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html)

func (UpdateModelOutput) GoString 

func (s UpdateModelOutput) GoString() string

GoString returns the string representation

func (UpdateModelOutput) SDKResponseMetadata 

func (s UpdateModelOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateModelOutput) SetContentType 

func (s *UpdateModelOutput) SetContentType(v string) *UpdateModelOutput

SetContentType sets the ContentType field's value.

func (*UpdateModelOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateModelOutput) SetId 

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

SetId sets the Id field's value.

func (*UpdateModelOutput) SetName 

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

SetName sets the Name field's value.

func (*UpdateModelOutput) SetSchema 

func (s *UpdateModelOutput) SetSchema(v string) *UpdateModelOutput

SetSchema sets the Schema field's value.

func (UpdateModelOutput) String 

func (s UpdateModelOutput) String() string

String returns the string representation

type UpdateModelRequest 

type UpdateModelRequest struct {
	*aws.Request
	Input *UpdateModelInput
}

UpdateModelRequest is a API request type for the UpdateModel API operation.

func (UpdateModelRequest) Send 

func (r UpdateModelRequest) Send() (*UpdateModelOutput, error)

Send marshals and sends the UpdateModel API request.

type UpdateRequestValidatorInput 

type UpdateRequestValidatorInput struct {

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// [Required] The identifier of RequestValidator to be updated.
	//
	// RequestValidatorId is a required field
	RequestValidatorId *string `location:"uri" locationName:"requestvalidator_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Updates a RequestValidator of a given RestApi.

func (UpdateRequestValidatorInput) GoString 

func (s UpdateRequestValidatorInput) GoString() string

GoString returns the string representation

func (*UpdateRequestValidatorInput) SetPatchOperations 

func (s *UpdateRequestValidatorInput) SetPatchOperations(v []PatchOperation) *UpdateRequestValidatorInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateRequestValidatorInput) SetRequestValidatorId 

func (s *UpdateRequestValidatorInput) SetRequestValidatorId(v string) *UpdateRequestValidatorInput

SetRequestValidatorId sets the RequestValidatorId field's value.

func (*UpdateRequestValidatorInput) SetRestApiId 

func (s *UpdateRequestValidatorInput) SetRestApiId(v string) *UpdateRequestValidatorInput

SetRestApiId sets the RestApiId field's value.

func (UpdateRequestValidatorInput) String 

func (s UpdateRequestValidatorInput) String() string

String returns the string representation

func (*UpdateRequestValidatorInput) Validate 

func (s *UpdateRequestValidatorInput) Validate() error

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

type UpdateRequestValidatorOutput 

type UpdateRequestValidatorOutput struct {

	// The identifier of this RequestValidator.
	Id *string `locationName:"id" type:"string"`

	// The name of this RequestValidator
	Name *string `locationName:"name" type:"string"`

	// A Boolean flag to indicate whether to validate a request body according to
	// the configured Model schema.
	ValidateRequestBody *bool `locationName:"validateRequestBody" type:"boolean"`

	// A Boolean flag to indicate whether to validate request parameters (true)
	// or not (false).
	ValidateRequestParameters *bool `locationName:"validateRequestParameters" type:"boolean"`
	// contains filtered or unexported fields
}

A set of validation rules for incoming Method requests.

In Swagger, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html) object. It the referenced using the x-amazon-apigateway-request-validator (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator) property.

Enable Basic Request Validation in API Gateway (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html)

func (UpdateRequestValidatorOutput) GoString 

func (s UpdateRequestValidatorOutput) GoString() string

GoString returns the string representation

func (UpdateRequestValidatorOutput) SDKResponseMetadata 

func (s UpdateRequestValidatorOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateRequestValidatorOutput) SetId 

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

SetId sets the Id field's value.

func (*UpdateRequestValidatorOutput) SetName 

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

SetName sets the Name field's value.

func (*UpdateRequestValidatorOutput) SetValidateRequestBody 

func (s *UpdateRequestValidatorOutput) SetValidateRequestBody(v bool) *UpdateRequestValidatorOutput

SetValidateRequestBody sets the ValidateRequestBody field's value.

func (*UpdateRequestValidatorOutput) SetValidateRequestParameters 

func (s *UpdateRequestValidatorOutput) SetValidateRequestParameters(v bool) *UpdateRequestValidatorOutput

SetValidateRequestParameters sets the ValidateRequestParameters field's value.

func (UpdateRequestValidatorOutput) String 

func (s UpdateRequestValidatorOutput) String() string

String returns the string representation

type UpdateRequestValidatorRequest 

type UpdateRequestValidatorRequest struct {
	*aws.Request
	Input *UpdateRequestValidatorInput
}

UpdateRequestValidatorRequest is a API request type for the UpdateRequestValidator API operation.

func (UpdateRequestValidatorRequest) Send 

func (r UpdateRequestValidatorRequest) Send() (*UpdateRequestValidatorOutput, error)

Send marshals and sends the UpdateRequestValidator API request.

type UpdateResourceInput 

type UpdateResourceInput struct {

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// The identifier of the Resource resource.
	//
	// ResourceId is a required field
	ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to change information about a Resource resource.

func (UpdateResourceInput) GoString 

func (s UpdateResourceInput) GoString() string

GoString returns the string representation

func (*UpdateResourceInput) SetPatchOperations 

func (s *UpdateResourceInput) SetPatchOperations(v []PatchOperation) *UpdateResourceInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateResourceInput) SetResourceId 

func (s *UpdateResourceInput) SetResourceId(v string) *UpdateResourceInput

SetResourceId sets the ResourceId field's value.

func (*UpdateResourceInput) SetRestApiId 

func (s *UpdateResourceInput) SetRestApiId(v string) *UpdateResourceInput

SetRestApiId sets the RestApiId field's value.

func (UpdateResourceInput) String 

func (s UpdateResourceInput) String() string

String returns the string representation

func (*UpdateResourceInput) Validate 

func (s *UpdateResourceInput) Validate() error

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

type UpdateResourceOutput 

type UpdateResourceOutput struct {

	// The resource's identifier.
	Id *string `locationName:"id" type:"string"`

	// The parent resource's identifier.
	ParentId *string `locationName:"parentId" type:"string"`

	// The full path for this resource.
	Path *string `locationName:"path" type:"string"`

	// The last path segment for this resource.
	PathPart *string `locationName:"pathPart" type:"string"`

	// Gets an API resource's method of a given HTTP verb.
	//
	// The resource methods are a map of methods indexed by methods' HTTP verbs
	// enabled on the resource. This method map is included in the 200 OK response
	// of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods
	// request.
	//
	// Example: Get the GET method of an API resource
	//
	// Request
	//
	// GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
	// application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z
	// Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request,
	// SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
	// Response
	//
	// { "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
	// "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
	// "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
	// "name": "method", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
	// "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET",
	// "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
	// }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET"
	// }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
	// }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200",
	// "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET"
	// }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}",
	// "templated": true } }, "apiKeyRequired": false, "authorizationType": "NONE",
	// "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self":
	// { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
	// }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
	// }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
	// "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
	// }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}",
	// "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2",
	// "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod":
	// "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type":
	// "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json":
	// "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams",
	// "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
	// "name": "200", "title": "200" }, "integrationresponse:delete": { "href":
	// "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
	// }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
	// } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'"
	// }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream
	// in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n"
	// }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": {
	// "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200",
	// "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200"
	// }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200"
	// } }, "responseModels": { "application/json": "Empty" }, "responseParameters":
	// { "method.response.header.Content-Type": false }, "statusCode": "200" } }
	// }
	// If the OPTIONS is enabled on the resource, you can follow the example here
	// to get that method. Just replace the GET of the last path segment in the
	// request URL with OPTIONS.
	ResourceMethods map[string]UpdateMethodOutput `locationName:"resourceMethods" type:"map"`
	// contains filtered or unexported fields
}

Represents an API resource.

Create an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)

func (UpdateResourceOutput) GoString 

func (s UpdateResourceOutput) GoString() string

GoString returns the string representation

func (UpdateResourceOutput) SDKResponseMetadata 

func (s UpdateResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateResourceOutput) SetId 

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

SetId sets the Id field's value.

func (*UpdateResourceOutput) SetParentId 

func (s *UpdateResourceOutput) SetParentId(v string) *UpdateResourceOutput

SetParentId sets the ParentId field's value.

func (*UpdateResourceOutput) SetPath 

func (s *UpdateResourceOutput) SetPath(v string) *UpdateResourceOutput

SetPath sets the Path field's value.

func (*UpdateResourceOutput) SetPathPart 

func (s *UpdateResourceOutput) SetPathPart(v string) *UpdateResourceOutput

SetPathPart sets the PathPart field's value.

func (*UpdateResourceOutput) SetResourceMethods 

func (s *UpdateResourceOutput) SetResourceMethods(v map[string]UpdateMethodOutput) *UpdateResourceOutput

SetResourceMethods sets the ResourceMethods field's value.

func (UpdateResourceOutput) String 

func (s UpdateResourceOutput) String() string

String returns the string representation

type UpdateResourceRequest 

type UpdateResourceRequest struct {
	*aws.Request
	Input *UpdateResourceInput
}

UpdateResourceRequest is a API request type for the UpdateResource API operation.

func (UpdateResourceRequest) Send 

func (r UpdateResourceRequest) Send() (*UpdateResourceOutput, error)

Send marshals and sends the UpdateResource API request.

type UpdateRestApiInput 

type UpdateRestApiInput struct {

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request to update an existing RestApi resource in your collection.

func (UpdateRestApiInput) GoString 

func (s UpdateRestApiInput) GoString() string

GoString returns the string representation

func (*UpdateRestApiInput) SetPatchOperations 

func (s *UpdateRestApiInput) SetPatchOperations(v []PatchOperation) *UpdateRestApiInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateRestApiInput) SetRestApiId 

func (s *UpdateRestApiInput) SetRestApiId(v string) *UpdateRestApiInput

SetRestApiId sets the RestApiId field's value.

func (UpdateRestApiInput) String 

func (s UpdateRestApiInput) String() string

String returns the string representation

func (*UpdateRestApiInput) Validate 

func (s *UpdateRestApiInput) Validate() error

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

type UpdateRestApiOutput 

type UpdateRestApiOutput struct {

	// The list of binary media types supported by the RestApi. By default, the
	// RestApi supports only UTF-8-encoded text payloads.
	BinaryMediaTypes []string `locationName:"binaryMediaTypes" type:"list"`

	// The timestamp when the API was created.
	CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"`

	// The API's description.
	Description *string `locationName:"description" type:"string"`

	// The API's identifier. This identifier is unique across all of your APIs in
	// Amazon API Gateway.
	Id *string `locationName:"id" type:"string"`

	// The API's name.
	Name *string `locationName:"name" type:"string"`

	// A version identifier for the API.
	Version *string `locationName:"version" type:"string"`

	// The warning messages reported when failonwarnings is turned on during API
	// import.
	Warnings []string `locationName:"warnings" type:"list"`
	// contains filtered or unexported fields
}

Represents a REST API.

Create an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)

func (UpdateRestApiOutput) GoString 

func (s UpdateRestApiOutput) GoString() string

GoString returns the string representation

func (UpdateRestApiOutput) SDKResponseMetadata 

func (s UpdateRestApiOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateRestApiOutput) SetBinaryMediaTypes 

func (s *UpdateRestApiOutput) SetBinaryMediaTypes(v []string) *UpdateRestApiOutput

SetBinaryMediaTypes sets the BinaryMediaTypes field's value.

func (*UpdateRestApiOutput) SetCreatedDate 

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

SetCreatedDate sets the CreatedDate field's value.

func (*UpdateRestApiOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateRestApiOutput) SetId 

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

SetId sets the Id field's value.

func (*UpdateRestApiOutput) SetName 

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

SetName sets the Name field's value.

func (*UpdateRestApiOutput) SetVersion 

func (s *UpdateRestApiOutput) SetVersion(v string) *UpdateRestApiOutput

SetVersion sets the Version field's value.

func (*UpdateRestApiOutput) SetWarnings 

func (s *UpdateRestApiOutput) SetWarnings(v []string) *UpdateRestApiOutput

SetWarnings sets the Warnings field's value.

func (UpdateRestApiOutput) String 

func (s UpdateRestApiOutput) String() string

String returns the string representation

type UpdateRestApiRequest 

type UpdateRestApiRequest struct {
	*aws.Request
	Input *UpdateRestApiInput
}

UpdateRestApiRequest is a API request type for the UpdateRestApi API operation.

func (UpdateRestApiRequest) Send 

func (r UpdateRestApiRequest) Send() (*UpdateRestApiOutput, error)

Send marshals and sends the UpdateRestApi API request.

type UpdateStageInput 

type UpdateStageInput struct {

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// The string identifier of the associated RestApi.
	//
	// RestApiId is a required field
	RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`

	// The name of the Stage resource to change information about.
	//
	// StageName is a required field
	StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Requests Amazon API Gateway to change information about a Stage resource.

func (UpdateStageInput) GoString 

func (s UpdateStageInput) GoString() string

GoString returns the string representation

func (*UpdateStageInput) SetPatchOperations 

func (s *UpdateStageInput) SetPatchOperations(v []PatchOperation) *UpdateStageInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateStageInput) SetRestApiId 

func (s *UpdateStageInput) SetRestApiId(v string) *UpdateStageInput

SetRestApiId sets the RestApiId field's value.

func (*UpdateStageInput) SetStageName 

func (s *UpdateStageInput) SetStageName(v string) *UpdateStageInput

SetStageName sets the StageName field's value.

func (UpdateStageInput) String 

func (s UpdateStageInput) String() string

String returns the string representation

func (*UpdateStageInput) Validate 

func (s *UpdateStageInput) Validate() error

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

type UpdateStageOutput 

type UpdateStageOutput struct {

	// Specifies whether a cache cluster is enabled for the stage.
	CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"`

	// The size of the cache cluster for the stage, if enabled.
	CacheClusterSize CacheClusterSize `locationName:"cacheClusterSize" type:"string" enum:"true"`

	// The status of the cache cluster for the stage, if enabled.
	CacheClusterStatus CacheClusterStatus `locationName:"cacheClusterStatus" type:"string" enum:"true"`

	// The identifier of a client certificate for an API stage.
	ClientCertificateId *string `locationName:"clientCertificateId" type:"string"`

	// The timestamp when the stage was created.
	CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"`

	// The identifier of the Deployment that the stage points to.
	DeploymentId *string `locationName:"deploymentId" type:"string"`

	// The stage's description.
	Description *string `locationName:"description" type:"string"`

	// The version of the associated API documentation.
	DocumentationVersion *string `locationName:"documentationVersion" type:"string"`

	// The timestamp when the stage last updated.
	LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp" timestampFormat:"unix"`

	// A map that defines the method settings for a Stage resource. Keys (designated
	// as /{method_setting_key below) are method paths defined as {resource_path}/{http_method}
	// for an individual method override, or /\*/\* for overriding all methods in
	// the stage.
	MethodSettings map[string]MethodSetting `locationName:"methodSettings" type:"map"`

	// The name of the stage is the first path segment in the Uniform Resource Identifier
	// (URI) of a call to Amazon API Gateway.
	StageName *string `locationName:"stageName" type:"string"`

	// A map that defines the stage variables for a Stage resource. Variable names
	// can have alphanumeric and underscore characters, and the values must match
	// [A-Za-z0-9-._~:/?#&=,]+.
	Variables map[string]string `locationName:"variables" type:"map"`
	// contains filtered or unexported fields
}

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

Deploy an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html)

func (UpdateStageOutput) GoString 

func (s UpdateStageOutput) GoString() string

GoString returns the string representation

func (UpdateStageOutput) SDKResponseMetadata 

func (s UpdateStageOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateStageOutput) SetCacheClusterEnabled 

func (s *UpdateStageOutput) SetCacheClusterEnabled(v bool) *UpdateStageOutput

SetCacheClusterEnabled sets the CacheClusterEnabled field's value.

func (*UpdateStageOutput) SetCacheClusterSize 

func (s *UpdateStageOutput) SetCacheClusterSize(v CacheClusterSize) *UpdateStageOutput

SetCacheClusterSize sets the CacheClusterSize field's value.

func (*UpdateStageOutput) SetCacheClusterStatus 

func (s *UpdateStageOutput) SetCacheClusterStatus(v CacheClusterStatus) *UpdateStageOutput

SetCacheClusterStatus sets the CacheClusterStatus field's value.

func (*UpdateStageOutput) SetClientCertificateId 

func (s *UpdateStageOutput) SetClientCertificateId(v string) *UpdateStageOutput

SetClientCertificateId sets the ClientCertificateId field's value.

func (*UpdateStageOutput) SetCreatedDate 

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

SetCreatedDate sets the CreatedDate field's value.

func (*UpdateStageOutput) SetDeploymentId 

func (s *UpdateStageOutput) SetDeploymentId(v string) *UpdateStageOutput

SetDeploymentId sets the DeploymentId field's value.

func (*UpdateStageOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateStageOutput) SetDocumentationVersion 

func (s *UpdateStageOutput) SetDocumentationVersion(v string) *UpdateStageOutput

SetDocumentationVersion sets the DocumentationVersion field's value.

func (*UpdateStageOutput) SetLastUpdatedDate 

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

SetLastUpdatedDate sets the LastUpdatedDate field's value.

func (*UpdateStageOutput) SetMethodSettings 

func (s *UpdateStageOutput) SetMethodSettings(v map[string]MethodSetting) *UpdateStageOutput

SetMethodSettings sets the MethodSettings field's value.

func (*UpdateStageOutput) SetStageName 

func (s *UpdateStageOutput) SetStageName(v string) *UpdateStageOutput

SetStageName sets the StageName field's value.

func (*UpdateStageOutput) SetVariables 

func (s *UpdateStageOutput) SetVariables(v map[string]string) *UpdateStageOutput

SetVariables sets the Variables field's value.

func (UpdateStageOutput) String 

func (s UpdateStageOutput) String() string

String returns the string representation

type UpdateStageRequest 

type UpdateStageRequest struct {
	*aws.Request
	Input *UpdateStageInput
}

UpdateStageRequest is a API request type for the UpdateStage API operation.

func (UpdateStageRequest) Send 

func (r UpdateStageRequest) Send() (*UpdateStageOutput, error)

Send marshals and sends the UpdateStage API request.

type UpdateUsageInput 

type UpdateUsageInput struct {

	// The identifier of the API key associated with the usage plan in which a temporary
	// extension is granted to the remaining quota.
	//
	// KeyId is a required field
	KeyId *string `location:"uri" locationName:"keyId" type:"string" required:"true"`

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// The Id of the usage plan associated with the usage data.
	//
	// UsagePlanId is a required field
	UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.

func (UpdateUsageInput) GoString 

func (s UpdateUsageInput) GoString() string

GoString returns the string representation

func (*UpdateUsageInput) SetKeyId 

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

SetKeyId sets the KeyId field's value.

func (*UpdateUsageInput) SetPatchOperations 

func (s *UpdateUsageInput) SetPatchOperations(v []PatchOperation) *UpdateUsageInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateUsageInput) SetUsagePlanId 

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

SetUsagePlanId sets the UsagePlanId field's value.

func (UpdateUsageInput) String 

func (s UpdateUsageInput) String() string

String returns the string representation

func (*UpdateUsageInput) Validate 

func (s *UpdateUsageInput) Validate() error

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

type UpdateUsageOutput 

type UpdateUsageOutput struct {

	// The ending date of the usage data.
	EndDate *string `locationName:"endDate" type:"string"`

	// 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].
	Items map[string][][]int64 `locationName:"values" type:"map"`

	Position *string `locationName:"position" type:"string"`

	// The starting date of the usage data.
	StartDate *string `locationName:"startDate" type:"string"`

	// The plan Id associated with this usage data.
	UsagePlanId *string `locationName:"usagePlanId" type:"string"`
	// contains filtered or unexported fields
}

Represents the usage data of a usage plan.

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

func (UpdateUsageOutput) GoString 

func (s UpdateUsageOutput) GoString() string

GoString returns the string representation

func (UpdateUsageOutput) SDKResponseMetadata 

func (s UpdateUsageOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateUsageOutput) SetEndDate 

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

SetEndDate sets the EndDate field's value.

func (*UpdateUsageOutput) SetItems 

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

SetItems sets the Items field's value.

func (*UpdateUsageOutput) SetPosition 

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

SetPosition sets the Position field's value.

func (*UpdateUsageOutput) SetStartDate 

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

SetStartDate sets the StartDate field's value.

func (*UpdateUsageOutput) SetUsagePlanId 

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

SetUsagePlanId sets the UsagePlanId field's value.

func (UpdateUsageOutput) String 

func (s UpdateUsageOutput) String() string

String returns the string representation

type UpdateUsagePlanInput 

type UpdateUsagePlanInput struct {

	// A list of update operations to be applied to the specified resource and in
	// the order specified in this list.
	PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`

	// The Id of the to-be-updated usage plan.
	//
	// UsagePlanId is a required field
	UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The PATCH request to update a usage plan of a given plan Id.

func (UpdateUsagePlanInput) GoString 

func (s UpdateUsagePlanInput) GoString() string

GoString returns the string representation

func (*UpdateUsagePlanInput) SetPatchOperations 

func (s *UpdateUsagePlanInput) SetPatchOperations(v []PatchOperation) *UpdateUsagePlanInput

SetPatchOperations sets the PatchOperations field's value.

func (*UpdateUsagePlanInput) SetUsagePlanId 

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

SetUsagePlanId sets the UsagePlanId field's value.

func (UpdateUsagePlanInput) String 

func (s UpdateUsagePlanInput) String() string

String returns the string representation

func (*UpdateUsagePlanInput) Validate 

func (s *UpdateUsagePlanInput) Validate() error

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

type UpdateUsagePlanOutput 

type UpdateUsagePlanOutput struct {

	// The associated API stages of a usage plan.
	ApiStages []ApiStage `locationName:"apiStages" type:"list"`

	// The description of a usage plan.
	Description *string `locationName:"description" type:"string"`

	// The identifier of a UsagePlan resource.
	Id *string `locationName:"id" type:"string"`

	// The name of a usage plan.
	Name *string `locationName:"name" type:"string"`

	// The AWS Markeplace product identifier to associate with the usage plan as
	// a SaaS product on AWS Marketplace.
	ProductCode *string `locationName:"productCode" type:"string"`

	// The maximum number of permitted requests per a given unit time interval.
	Quota *QuotaSettings `locationName:"quota" type:"structure"`

	// The request throttle limits of a usage plan.
	Throttle *ThrottleSettings `locationName:"throttle" type:"structure"`
	// contains filtered or unexported fields
}

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 (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)

func (UpdateUsagePlanOutput) GoString 

func (s UpdateUsagePlanOutput) GoString() string

GoString returns the string representation

func (UpdateUsagePlanOutput) SDKResponseMetadata 

func (s UpdateUsagePlanOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateUsagePlanOutput) SetApiStages 

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

SetApiStages sets the ApiStages field's value.

func (*UpdateUsagePlanOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateUsagePlanOutput) SetId 

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

SetId sets the Id field's value.

func (*UpdateUsagePlanOutput) SetName 

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

SetName sets the Name field's value.

func (*UpdateUsagePlanOutput) SetProductCode 

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

SetProductCode sets the ProductCode field's value.

func (*UpdateUsagePlanOutput) SetQuota 

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

SetQuota sets the Quota field's value.

func (*UpdateUsagePlanOutput) SetThrottle 

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

SetThrottle sets the Throttle field's value.

func (UpdateUsagePlanOutput) String 

func (s UpdateUsagePlanOutput) String() string

String returns the string representation

type UpdateUsagePlanRequest 

type UpdateUsagePlanRequest struct {
	*aws.Request
	Input *UpdateUsagePlanInput
}

UpdateUsagePlanRequest is a API request type for the UpdateUsagePlan API operation.

func (UpdateUsagePlanRequest) Send 

func (r UpdateUsagePlanRequest) Send() (*UpdateUsagePlanOutput, error)

Send marshals and sends the UpdateUsagePlan API request.

type UpdateUsageRequest 

type UpdateUsageRequest struct {
	*aws.Request
	Input *UpdateUsageInput
}

UpdateUsageRequest is a API request type for the UpdateUsage API operation.

func (UpdateUsageRequest) Send 

func (r UpdateUsageRequest) Send() (*UpdateUsageOutput, error)

Send marshals and sends the UpdateUsage API request.

Source Files

View all Source files

Directories

Path Synopsis
Package apigatewayiface provides an interface to enable mocking the Amazon API Gateway service client for testing your code.
 Package apigatewayiface provides an interface to enable mocking the Amazon API Gateway service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.