Package apigateway
Overview ▹
Index ▹
Constants
The authorizer type. the current value is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito Your User Pool.
const ( // AuthorizerTypeToken is a AuthorizerType enum value AuthorizerTypeToken = "TOKEN" // AuthorizerTypeCognitoUserPools is a AuthorizerType enum value AuthorizerTypeCognitoUserPools = "COGNITO_USER_POOLS" )
Returns the size of the CacheCluster.
const ( // CacheClusterSize05 is a CacheClusterSize enum value CacheClusterSize05 = "0.5" // CacheClusterSize16 is a CacheClusterSize enum value CacheClusterSize16 = "1.6" // CacheClusterSize61 is a CacheClusterSize enum value CacheClusterSize61 = "6.1" // CacheClusterSize135 is a CacheClusterSize enum value CacheClusterSize135 = "13.5" // CacheClusterSize284 is a CacheClusterSize enum value CacheClusterSize284 = "28.4" // CacheClusterSize582 is a CacheClusterSize enum value CacheClusterSize582 = "58.2" // CacheClusterSize118 is a CacheClusterSize enum value CacheClusterSize118 = "118" // CacheClusterSize237 is a CacheClusterSize enum value CacheClusterSize237 = "237" )
Returns the status of the CacheCluster.
const ( // CacheClusterStatusCreateInProgress is a CacheClusterStatus enum value CacheClusterStatusCreateInProgress = "CREATE_IN_PROGRESS" // CacheClusterStatusAvailable is a CacheClusterStatus enum value CacheClusterStatusAvailable = "AVAILABLE" // CacheClusterStatusDeleteInProgress is a CacheClusterStatus enum value CacheClusterStatusDeleteInProgress = "DELETE_IN_PROGRESS" // CacheClusterStatusNotAvailable is a CacheClusterStatus enum value CacheClusterStatusNotAvailable = "NOT_AVAILABLE" // CacheClusterStatusFlushInProgress is a CacheClusterStatus enum value CacheClusterStatusFlushInProgress = "FLUSH_IN_PROGRESS" )
const ( // ContentHandlingStrategyConvertToBinary is a ContentHandlingStrategy enum value ContentHandlingStrategyConvertToBinary = "CONVERT_TO_BINARY" // ContentHandlingStrategyConvertToText is a ContentHandlingStrategy enum value ContentHandlingStrategyConvertToText = "CONVERT_TO_TEXT" )
const ( // DocumentationPartTypeApi is a DocumentationPartType enum value DocumentationPartTypeApi = "API" // DocumentationPartTypeAuthorizer is a DocumentationPartType enum value DocumentationPartTypeAuthorizer = "AUTHORIZER" // DocumentationPartTypeModel is a DocumentationPartType enum value DocumentationPartTypeModel = "MODEL" // DocumentationPartTypeResource is a DocumentationPartType enum value DocumentationPartTypeResource = "RESOURCE" // DocumentationPartTypeMethod is a DocumentationPartType enum value DocumentationPartTypeMethod = "METHOD" // DocumentationPartTypePathParameter is a DocumentationPartType enum value DocumentationPartTypePathParameter = "PATH_PARAMETER" // DocumentationPartTypeQueryParameter is a DocumentationPartType enum value DocumentationPartTypeQueryParameter = "QUERY_PARAMETER" // DocumentationPartTypeRequestHeader is a DocumentationPartType enum value DocumentationPartTypeRequestHeader = "REQUEST_HEADER" // DocumentationPartTypeRequestBody is a DocumentationPartType enum value DocumentationPartTypeRequestBody = "REQUEST_BODY" // DocumentationPartTypeResponse is a DocumentationPartType enum value DocumentationPartTypeResponse = "RESPONSE" // DocumentationPartTypeResponseHeader is a DocumentationPartType enum value DocumentationPartTypeResponseHeader = "RESPONSE_HEADER" // DocumentationPartTypeResponseBody is a DocumentationPartType enum value DocumentationPartTypeResponseBody = "RESPONSE_BODY" )
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 is a IntegrationType enum value IntegrationTypeHttp = "HTTP" // IntegrationTypeAws is a IntegrationType enum value IntegrationTypeAws = "AWS" // IntegrationTypeMock is a IntegrationType enum value IntegrationTypeMock = "MOCK" // IntegrationTypeHttpProxy is a IntegrationType enum value IntegrationTypeHttpProxy = "HTTP_PROXY" // IntegrationTypeAwsProxy is a IntegrationType enum value IntegrationTypeAwsProxy = "AWS_PROXY" )
const ( // OpAdd is a Op enum value OpAdd = "add" // OpRemove is a Op enum value OpRemove = "remove" // OpReplace is a Op enum value OpReplace = "replace" // OpMove is a Op enum value OpMove = "move" // OpCopy is a Op enum value OpCopy = "copy" // OpTest is a Op enum value OpTest = "test" )
const ( // PutModeMerge is a PutMode enum value PutModeMerge = "merge" // PutModeOverwrite is a PutMode enum value PutModeOverwrite = "overwrite" )
const ( // QuotaPeriodTypeDay is a QuotaPeriodType enum value QuotaPeriodTypeDay = "DAY" // QuotaPeriodTypeWeek is a QuotaPeriodType enum value QuotaPeriodTypeWeek = "WEEK" // QuotaPeriodTypeMonth is a QuotaPeriodType enum value QuotaPeriodTypeMonth = "MONTH" )
const ( // UnauthorizedCacheControlHeaderStrategyFailWith403 is a UnauthorizedCacheControlHeaderStrategy enum value UnauthorizedCacheControlHeaderStrategyFailWith403 = "FAIL_WITH_403" // UnauthorizedCacheControlHeaderStrategySucceedWithResponseHeader is a UnauthorizedCacheControlHeaderStrategy enum value UnauthorizedCacheControlHeaderStrategySucceedWithResponseHeader = "SUCCEED_WITH_RESPONSE_HEADER" // UnauthorizedCacheControlHeaderStrategySucceedWithoutResponseHeader is a UnauthorizedCacheControlHeaderStrategy enum value UnauthorizedCacheControlHeaderStrategySucceedWithoutResponseHeader = "SUCCEED_WITHOUT_RESPONSE_HEADER" )
const ( // ErrCodeBadRequestException for service response error code // "BadRequestException". ErrCodeBadRequestException = "BadRequestException" // ErrCodeConflictException for service response error code // "ConflictException". ErrCodeConflictException = "ConflictException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeNotFoundException for service response error code // "NotFoundException". ErrCodeNotFoundException = "NotFoundException" // ErrCodeServiceUnavailableException for service response error code // "ServiceUnavailableException". ErrCodeServiceUnavailableException = "ServiceUnavailableException" // ErrCodeTooManyRequestsException for service response error code // "TooManyRequestsException". ErrCodeTooManyRequestsException = "TooManyRequestsException" // ErrCodeUnauthorizedException for service response error code // "UnauthorizedException". ErrCodeUnauthorizedException = "UnauthorizedException" )
Service information constants
const ( ServiceName = "apigateway" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
const (
// ApiKeysFormatCsv is a ApiKeysFormat enum value
ApiKeysFormatCsv = "csv"
)
type APIGateway ¶
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.
type APIGateway struct { *client.Client }
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *APIGateway
New creates a new instance of the APIGateway client with a session. 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 session. svc := apigateway.New(mySession) // Create a APIGateway client with additional configuration svc := apigateway.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*APIGateway) CreateApiKey ¶
func (c *APIGateway) CreateApiKey(input *CreateApiKeyInput) (*ApiKey, error)
CreateApiKey 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)
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateApiKey for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) CreateApiKeyRequest ¶
func (c *APIGateway) CreateApiKeyRequest(input *CreateApiKeyInput) (req *request.Request, output *ApiKey)
CreateApiKeyRequest generates a "aws/request.Request" representing the client's request for the CreateApiKey operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateApiKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateApiKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateApiKeyRequest method. req, resp := client.CreateApiKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateApiKeyWithContext ¶
func (c *APIGateway) CreateApiKeyWithContext(ctx aws.Context, input *CreateApiKeyInput, opts ...request.Option) (*ApiKey, error)
CreateApiKeyWithContext is the same as CreateApiKey with the addition of the ability to pass a context and additional request options.
See CreateApiKey for details on how to use this API operation.
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) CreateAuthorizer ¶
func (c *APIGateway) CreateAuthorizer(input *CreateAuthorizerInput) (*Authorizer, error)
CreateAuthorizer 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)
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateAuthorizer for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) CreateAuthorizerRequest ¶
func (c *APIGateway) CreateAuthorizerRequest(input *CreateAuthorizerInput) (req *request.Request, output *Authorizer)
CreateAuthorizerRequest generates a "aws/request.Request" representing the client's request for the CreateAuthorizer operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateAuthorizer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateAuthorizerRequest method. req, resp := client.CreateAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateAuthorizerWithContext ¶
func (c *APIGateway) CreateAuthorizerWithContext(ctx aws.Context, input *CreateAuthorizerInput, opts ...request.Option) (*Authorizer, error)
CreateAuthorizerWithContext is the same as CreateAuthorizer with the addition of the ability to pass a context and additional request options.
See CreateAuthorizer for details on how to use this API operation.
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) CreateBasePathMapping ¶
func (c *APIGateway) CreateBasePathMapping(input *CreateBasePathMappingInput) (*BasePathMapping, error)
CreateBasePathMapping API operation for Amazon API Gateway.
Creates a new BasePathMapping resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateBasePathMapping for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeConflictException "ConflictException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) CreateBasePathMappingRequest ¶
func (c *APIGateway) CreateBasePathMappingRequest(input *CreateBasePathMappingInput) (req *request.Request, output *BasePathMapping)
CreateBasePathMappingRequest generates a "aws/request.Request" representing the client's request for the CreateBasePathMapping operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateBasePathMapping for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateBasePathMapping method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateBasePathMappingRequest method. req, resp := client.CreateBasePathMappingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateBasePathMappingWithContext ¶
func (c *APIGateway) CreateBasePathMappingWithContext(ctx aws.Context, input *CreateBasePathMappingInput, opts ...request.Option) (*BasePathMapping, error)
CreateBasePathMappingWithContext is the same as CreateBasePathMapping with the addition of the ability to pass a context and additional request options.
See CreateBasePathMapping for details on how to use this API operation.
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) CreateDeployment ¶
func (c *APIGateway) CreateDeployment(input *CreateDeploymentInput) (*Deployment, error)
CreateDeployment API operation for Amazon API Gateway.
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateDeployment for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeServiceUnavailableException "ServiceUnavailableException"
func (*APIGateway) CreateDeploymentRequest ¶
func (c *APIGateway) CreateDeploymentRequest(input *CreateDeploymentInput) (req *request.Request, output *Deployment)
CreateDeploymentRequest generates a "aws/request.Request" representing the client's request for the CreateDeployment operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateDeployment for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDeployment method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateDeploymentRequest method. req, resp := client.CreateDeploymentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateDeploymentWithContext ¶
func (c *APIGateway) CreateDeploymentWithContext(ctx aws.Context, input *CreateDeploymentInput, opts ...request.Option) (*Deployment, error)
CreateDeploymentWithContext is the same as CreateDeployment with the addition of the ability to pass a context and additional request options.
See CreateDeployment for details on how to use this API operation.
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) CreateDocumentationPart ¶
func (c *APIGateway) CreateDocumentationPart(input *CreateDocumentationPartInput) (*DocumentationPart, error)
CreateDocumentationPart API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateDocumentationPart for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) CreateDocumentationPartRequest ¶
func (c *APIGateway) CreateDocumentationPartRequest(input *CreateDocumentationPartInput) (req *request.Request, output *DocumentationPart)
CreateDocumentationPartRequest generates a "aws/request.Request" representing the client's request for the CreateDocumentationPart operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateDocumentationPart for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDocumentationPart method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateDocumentationPartRequest method. req, resp := client.CreateDocumentationPartRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateDocumentationPartWithContext ¶
func (c *APIGateway) CreateDocumentationPartWithContext(ctx aws.Context, input *CreateDocumentationPartInput, opts ...request.Option) (*DocumentationPart, error)
CreateDocumentationPartWithContext is the same as CreateDocumentationPart with the addition of the ability to pass a context and additional request options.
See CreateDocumentationPart for details on how to use this API operation.
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) CreateDocumentationVersion ¶
func (c *APIGateway) CreateDocumentationVersion(input *CreateDocumentationVersionInput) (*DocumentationVersion, error)
CreateDocumentationVersion API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateDocumentationVersion for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) CreateDocumentationVersionRequest ¶
func (c *APIGateway) CreateDocumentationVersionRequest(input *CreateDocumentationVersionInput) (req *request.Request, output *DocumentationVersion)
CreateDocumentationVersionRequest generates a "aws/request.Request" representing the client's request for the CreateDocumentationVersion operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateDocumentationVersion for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDocumentationVersion method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateDocumentationVersionRequest method. req, resp := client.CreateDocumentationVersionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateDocumentationVersionWithContext ¶
func (c *APIGateway) CreateDocumentationVersionWithContext(ctx aws.Context, input *CreateDocumentationVersionInput, opts ...request.Option) (*DocumentationVersion, error)
CreateDocumentationVersionWithContext is the same as CreateDocumentationVersion with the addition of the ability to pass a context and additional request options.
See CreateDocumentationVersion for details on how to use this API operation.
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) CreateDomainName ¶
func (c *APIGateway) CreateDomainName(input *CreateDomainNameInput) (*DomainName, error)
CreateDomainName API operation for Amazon API Gateway.
Creates a new domain name.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateDomainName for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) CreateDomainNameRequest ¶
func (c *APIGateway) CreateDomainNameRequest(input *CreateDomainNameInput) (req *request.Request, output *DomainName)
CreateDomainNameRequest generates a "aws/request.Request" representing the client's request for the CreateDomainName operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateDomainName for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDomainName method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateDomainNameRequest method. req, resp := client.CreateDomainNameRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateDomainNameWithContext ¶
func (c *APIGateway) CreateDomainNameWithContext(ctx aws.Context, input *CreateDomainNameInput, opts ...request.Option) (*DomainName, error)
CreateDomainNameWithContext is the same as CreateDomainName with the addition of the ability to pass a context and additional request options.
See CreateDomainName for details on how to use this API operation.
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) CreateModel ¶
func (c *APIGateway) CreateModel(input *CreateModelInput) (*Model, error)
CreateModel API operation for Amazon API Gateway.
Adds a new Model resource to an existing RestApi resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateModel for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) CreateModelRequest ¶
func (c *APIGateway) CreateModelRequest(input *CreateModelInput) (req *request.Request, output *Model)
CreateModelRequest generates a "aws/request.Request" representing the client's request for the CreateModel operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateModel for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateModel method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateModelRequest method. req, resp := client.CreateModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateModelWithContext ¶
func (c *APIGateway) CreateModelWithContext(ctx aws.Context, input *CreateModelInput, opts ...request.Option) (*Model, error)
CreateModelWithContext is the same as CreateModel with the addition of the ability to pass a context and additional request options.
See CreateModel for details on how to use this API operation.
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) CreateRequestValidator ¶
func (c *APIGateway) CreateRequestValidator(input *CreateRequestValidatorInput) (*UpdateRequestValidatorOutput, error)
CreateRequestValidator API operation for Amazon API Gateway.
Creates a ReqeustValidator of a given RestApi.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateRequestValidator for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) CreateRequestValidatorRequest ¶
func (c *APIGateway) CreateRequestValidatorRequest(input *CreateRequestValidatorInput) (req *request.Request, output *UpdateRequestValidatorOutput)
CreateRequestValidatorRequest generates a "aws/request.Request" representing the client's request for the CreateRequestValidator operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateRequestValidator for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateRequestValidator method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateRequestValidatorRequest method. req, resp := client.CreateRequestValidatorRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateRequestValidatorWithContext ¶
func (c *APIGateway) CreateRequestValidatorWithContext(ctx aws.Context, input *CreateRequestValidatorInput, opts ...request.Option) (*UpdateRequestValidatorOutput, error)
CreateRequestValidatorWithContext is the same as CreateRequestValidator with the addition of the ability to pass a context and additional request options.
See CreateRequestValidator for details on how to use this API operation.
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) CreateResource ¶
func (c *APIGateway) CreateResource(input *CreateResourceInput) (*Resource, error)
CreateResource API operation for Amazon API Gateway.
Creates a Resource resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateResource for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) CreateResourceRequest ¶
func (c *APIGateway) CreateResourceRequest(input *CreateResourceInput) (req *request.Request, output *Resource)
CreateResourceRequest generates a "aws/request.Request" representing the client's request for the CreateResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateResourceRequest method. req, resp := client.CreateResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateResourceWithContext ¶
func (c *APIGateway) CreateResourceWithContext(ctx aws.Context, input *CreateResourceInput, opts ...request.Option) (*Resource, error)
CreateResourceWithContext is the same as CreateResource with the addition of the ability to pass a context and additional request options.
See CreateResource for details on how to use this API operation.
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) CreateRestApi ¶
func (c *APIGateway) CreateRestApi(input *CreateRestApiInput) (*RestApi, error)
CreateRestApi API operation for Amazon API Gateway.
Creates a new RestApi resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateRestApi for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) CreateRestApiRequest ¶
func (c *APIGateway) CreateRestApiRequest(input *CreateRestApiInput) (req *request.Request, output *RestApi)
CreateRestApiRequest generates a "aws/request.Request" representing the client's request for the CreateRestApi operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateRestApi for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateRestApiRequest method. req, resp := client.CreateRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateRestApiWithContext ¶
func (c *APIGateway) CreateRestApiWithContext(ctx aws.Context, input *CreateRestApiInput, opts ...request.Option) (*RestApi, error)
CreateRestApiWithContext is the same as CreateRestApi with the addition of the ability to pass a context and additional request options.
See CreateRestApi for details on how to use this API operation.
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) CreateStage ¶
func (c *APIGateway) CreateStage(input *CreateStageInput) (*Stage, error)
CreateStage API operation for Amazon API Gateway.
Creates a new Stage resource that references a pre-existing Deployment for the API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateStage for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) CreateStageRequest ¶
func (c *APIGateway) CreateStageRequest(input *CreateStageInput) (req *request.Request, output *Stage)
CreateStageRequest generates a "aws/request.Request" representing the client's request for the CreateStage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateStage for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateStage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateStageRequest method. req, resp := client.CreateStageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateStageWithContext ¶
func (c *APIGateway) CreateStageWithContext(ctx aws.Context, input *CreateStageInput, opts ...request.Option) (*Stage, error)
CreateStageWithContext is the same as CreateStage with the addition of the ability to pass a context and additional request options.
See CreateStage for details on how to use this API operation.
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) CreateUsagePlan ¶
func (c *APIGateway) CreateUsagePlan(input *CreateUsagePlanInput) (*UsagePlan, error)
CreateUsagePlan 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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateUsagePlan for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeConflictException "ConflictException" * ErrCodeNotFoundException "NotFoundException"
func (*APIGateway) CreateUsagePlanKey ¶
func (c *APIGateway) CreateUsagePlanKey(input *CreateUsagePlanKeyInput) (*UsagePlanKey, error)
CreateUsagePlanKey API operation for Amazon API Gateway.
Creates a usage plan key for adding an existing API key to a usage plan.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation CreateUsagePlanKey for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) CreateUsagePlanKeyRequest ¶
func (c *APIGateway) CreateUsagePlanKeyRequest(input *CreateUsagePlanKeyInput) (req *request.Request, output *UsagePlanKey)
CreateUsagePlanKeyRequest generates a "aws/request.Request" representing the client's request for the CreateUsagePlanKey operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateUsagePlanKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateUsagePlanKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateUsagePlanKeyRequest method. req, resp := client.CreateUsagePlanKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateUsagePlanKeyWithContext ¶
func (c *APIGateway) CreateUsagePlanKeyWithContext(ctx aws.Context, input *CreateUsagePlanKeyInput, opts ...request.Option) (*UsagePlanKey, error)
CreateUsagePlanKeyWithContext is the same as CreateUsagePlanKey with the addition of the ability to pass a context and additional request options.
See CreateUsagePlanKey for details on how to use this API operation.
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) CreateUsagePlanRequest ¶
func (c *APIGateway) CreateUsagePlanRequest(input *CreateUsagePlanInput) (req *request.Request, output *UsagePlan)
CreateUsagePlanRequest generates a "aws/request.Request" representing the client's request for the CreateUsagePlan operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateUsagePlan for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateUsagePlan method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateUsagePlanRequest method. req, resp := client.CreateUsagePlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateUsagePlanWithContext ¶
func (c *APIGateway) CreateUsagePlanWithContext(ctx aws.Context, input *CreateUsagePlanInput, opts ...request.Option) (*UsagePlan, error)
CreateUsagePlanWithContext is the same as CreateUsagePlan with the addition of the ability to pass a context and additional request options.
See CreateUsagePlan for details on how to use this API operation.
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) DeleteApiKey ¶
func (c *APIGateway) DeleteApiKey(input *DeleteApiKeyInput) (*DeleteApiKeyOutput, error)
DeleteApiKey API operation for Amazon API Gateway.
Deletes the ApiKey resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteApiKey for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) DeleteApiKeyRequest ¶
func (c *APIGateway) DeleteApiKeyRequest(input *DeleteApiKeyInput) (req *request.Request, output *DeleteApiKeyOutput)
DeleteApiKeyRequest generates a "aws/request.Request" representing the client's request for the DeleteApiKey operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteApiKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteApiKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteApiKeyRequest method. req, resp := client.DeleteApiKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteApiKeyWithContext ¶
func (c *APIGateway) DeleteApiKeyWithContext(ctx aws.Context, input *DeleteApiKeyInput, opts ...request.Option) (*DeleteApiKeyOutput, error)
DeleteApiKeyWithContext is the same as DeleteApiKey with the addition of the ability to pass a context and additional request options.
See DeleteApiKey for details on how to use this API operation.
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) DeleteAuthorizer ¶
func (c *APIGateway) DeleteAuthorizer(input *DeleteAuthorizerInput) (*DeleteAuthorizerOutput, error)
DeleteAuthorizer 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)
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteAuthorizer for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) DeleteAuthorizerRequest ¶
func (c *APIGateway) DeleteAuthorizerRequest(input *DeleteAuthorizerInput) (req *request.Request, output *DeleteAuthorizerOutput)
DeleteAuthorizerRequest generates a "aws/request.Request" representing the client's request for the DeleteAuthorizer operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteAuthorizer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteAuthorizerRequest method. req, resp := client.DeleteAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteAuthorizerWithContext ¶
func (c *APIGateway) DeleteAuthorizerWithContext(ctx aws.Context, input *DeleteAuthorizerInput, opts ...request.Option) (*DeleteAuthorizerOutput, error)
DeleteAuthorizerWithContext is the same as DeleteAuthorizer with the addition of the ability to pass a context and additional request options.
See DeleteAuthorizer for details on how to use this API operation.
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) DeleteBasePathMapping ¶
func (c *APIGateway) DeleteBasePathMapping(input *DeleteBasePathMappingInput) (*DeleteBasePathMappingOutput, error)
DeleteBasePathMapping API operation for Amazon API Gateway.
Deletes the BasePathMapping resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteBasePathMapping for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) DeleteBasePathMappingRequest ¶
func (c *APIGateway) DeleteBasePathMappingRequest(input *DeleteBasePathMappingInput) (req *request.Request, output *DeleteBasePathMappingOutput)
DeleteBasePathMappingRequest generates a "aws/request.Request" representing the client's request for the DeleteBasePathMapping operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteBasePathMapping for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteBasePathMapping method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteBasePathMappingRequest method. req, resp := client.DeleteBasePathMappingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteBasePathMappingWithContext ¶
func (c *APIGateway) DeleteBasePathMappingWithContext(ctx aws.Context, input *DeleteBasePathMappingInput, opts ...request.Option) (*DeleteBasePathMappingOutput, error)
DeleteBasePathMappingWithContext is the same as DeleteBasePathMapping with the addition of the ability to pass a context and additional request options.
See DeleteBasePathMapping for details on how to use this API operation.
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) DeleteClientCertificate ¶
func (c *APIGateway) DeleteClientCertificate(input *DeleteClientCertificateInput) (*DeleteClientCertificateOutput, error)
DeleteClientCertificate API operation for Amazon API Gateway.
Deletes the ClientCertificate resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteClientCertificate for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeNotFoundException "NotFoundException"
func (*APIGateway) DeleteClientCertificateRequest ¶
func (c *APIGateway) DeleteClientCertificateRequest(input *DeleteClientCertificateInput) (req *request.Request, output *DeleteClientCertificateOutput)
DeleteClientCertificateRequest generates a "aws/request.Request" representing the client's request for the DeleteClientCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteClientCertificate for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteClientCertificate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteClientCertificateRequest method. req, resp := client.DeleteClientCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteClientCertificateWithContext ¶
func (c *APIGateway) DeleteClientCertificateWithContext(ctx aws.Context, input *DeleteClientCertificateInput, opts ...request.Option) (*DeleteClientCertificateOutput, error)
DeleteClientCertificateWithContext is the same as DeleteClientCertificate with the addition of the ability to pass a context and additional request options.
See DeleteClientCertificate for details on how to use this API operation.
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) DeleteDeployment ¶
func (c *APIGateway) DeleteDeployment(input *DeleteDeploymentInput) (*DeleteDeploymentOutput, error)
DeleteDeployment 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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteDeployment for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) DeleteDeploymentRequest ¶
func (c *APIGateway) DeleteDeploymentRequest(input *DeleteDeploymentInput) (req *request.Request, output *DeleteDeploymentOutput)
DeleteDeploymentRequest generates a "aws/request.Request" representing the client's request for the DeleteDeployment operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteDeployment for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDeployment method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteDeploymentRequest method. req, resp := client.DeleteDeploymentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteDeploymentWithContext ¶
func (c *APIGateway) DeleteDeploymentWithContext(ctx aws.Context, input *DeleteDeploymentInput, opts ...request.Option) (*DeleteDeploymentOutput, error)
DeleteDeploymentWithContext is the same as DeleteDeployment with the addition of the ability to pass a context and additional request options.
See DeleteDeployment for details on how to use this API operation.
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) DeleteDocumentationPart ¶
func (c *APIGateway) DeleteDocumentationPart(input *DeleteDocumentationPartInput) (*DeleteDocumentationPartOutput, error)
DeleteDocumentationPart API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteDocumentationPart for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeConflictException "ConflictException" * ErrCodeBadRequestException "BadRequestException"
func (*APIGateway) DeleteDocumentationPartRequest ¶
func (c *APIGateway) DeleteDocumentationPartRequest(input *DeleteDocumentationPartInput) (req *request.Request, output *DeleteDocumentationPartOutput)
DeleteDocumentationPartRequest generates a "aws/request.Request" representing the client's request for the DeleteDocumentationPart operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteDocumentationPart for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDocumentationPart method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteDocumentationPartRequest method. req, resp := client.DeleteDocumentationPartRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteDocumentationPartWithContext ¶
func (c *APIGateway) DeleteDocumentationPartWithContext(ctx aws.Context, input *DeleteDocumentationPartInput, opts ...request.Option) (*DeleteDocumentationPartOutput, error)
DeleteDocumentationPartWithContext is the same as DeleteDocumentationPart with the addition of the ability to pass a context and additional request options.
See DeleteDocumentationPart for details on how to use this API operation.
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) DeleteDocumentationVersion ¶
func (c *APIGateway) DeleteDocumentationVersion(input *DeleteDocumentationVersionInput) (*DeleteDocumentationVersionOutput, error)
DeleteDocumentationVersion API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteDocumentationVersion for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) DeleteDocumentationVersionRequest ¶
func (c *APIGateway) DeleteDocumentationVersionRequest(input *DeleteDocumentationVersionInput) (req *request.Request, output *DeleteDocumentationVersionOutput)
DeleteDocumentationVersionRequest generates a "aws/request.Request" representing the client's request for the DeleteDocumentationVersion operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteDocumentationVersion for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDocumentationVersion method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteDocumentationVersionRequest method. req, resp := client.DeleteDocumentationVersionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteDocumentationVersionWithContext ¶
func (c *APIGateway) DeleteDocumentationVersionWithContext(ctx aws.Context, input *DeleteDocumentationVersionInput, opts ...request.Option) (*DeleteDocumentationVersionOutput, error)
DeleteDocumentationVersionWithContext is the same as DeleteDocumentationVersion with the addition of the ability to pass a context and additional request options.
See DeleteDocumentationVersion for details on how to use this API operation.
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) DeleteDomainName ¶
func (c *APIGateway) DeleteDomainName(input *DeleteDomainNameInput) (*DeleteDomainNameOutput, error)
DeleteDomainName API operation for Amazon API Gateway.
Deletes the DomainName resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteDomainName for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) DeleteDomainNameRequest ¶
func (c *APIGateway) DeleteDomainNameRequest(input *DeleteDomainNameInput) (req *request.Request, output *DeleteDomainNameOutput)
DeleteDomainNameRequest generates a "aws/request.Request" representing the client's request for the DeleteDomainName operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteDomainName for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDomainName method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteDomainNameRequest method. req, resp := client.DeleteDomainNameRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteDomainNameWithContext ¶
func (c *APIGateway) DeleteDomainNameWithContext(ctx aws.Context, input *DeleteDomainNameInput, opts ...request.Option) (*DeleteDomainNameOutput, error)
DeleteDomainNameWithContext is the same as DeleteDomainName with the addition of the ability to pass a context and additional request options.
See DeleteDomainName for details on how to use this API operation.
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) DeleteIntegration ¶
func (c *APIGateway) DeleteIntegration(input *DeleteIntegrationInput) (*DeleteIntegrationOutput, error)
DeleteIntegration API operation for Amazon API Gateway.
Represents a delete integration.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteIntegration for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) DeleteIntegrationRequest ¶
func (c *APIGateway) DeleteIntegrationRequest(input *DeleteIntegrationInput) (req *request.Request, output *DeleteIntegrationOutput)
DeleteIntegrationRequest generates a "aws/request.Request" representing the client's request for the DeleteIntegration operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteIntegration for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteIntegration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteIntegrationRequest method. req, resp := client.DeleteIntegrationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteIntegrationResponse ¶
func (c *APIGateway) DeleteIntegrationResponse(input *DeleteIntegrationResponseInput) (*DeleteIntegrationResponseOutput, error)
DeleteIntegrationResponse API operation for Amazon API Gateway.
Represents a delete integration response.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteIntegrationResponse for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) DeleteIntegrationResponseRequest ¶
func (c *APIGateway) DeleteIntegrationResponseRequest(input *DeleteIntegrationResponseInput) (req *request.Request, output *DeleteIntegrationResponseOutput)
DeleteIntegrationResponseRequest generates a "aws/request.Request" representing the client's request for the DeleteIntegrationResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteIntegrationResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteIntegrationResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteIntegrationResponseRequest method. req, resp := client.DeleteIntegrationResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteIntegrationResponseWithContext ¶
func (c *APIGateway) DeleteIntegrationResponseWithContext(ctx aws.Context, input *DeleteIntegrationResponseInput, opts ...request.Option) (*DeleteIntegrationResponseOutput, error)
DeleteIntegrationResponseWithContext is the same as DeleteIntegrationResponse with the addition of the ability to pass a context and additional request options.
See DeleteIntegrationResponse for details on how to use this API operation.
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) DeleteIntegrationWithContext ¶
func (c *APIGateway) DeleteIntegrationWithContext(ctx aws.Context, input *DeleteIntegrationInput, opts ...request.Option) (*DeleteIntegrationOutput, error)
DeleteIntegrationWithContext is the same as DeleteIntegration with the addition of the ability to pass a context and additional request options.
See DeleteIntegration for details on how to use this API operation.
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) DeleteMethod ¶
func (c *APIGateway) DeleteMethod(input *DeleteMethodInput) (*DeleteMethodOutput, error)
DeleteMethod API operation for Amazon API Gateway.
Deletes an existing Method resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteMethod for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) DeleteMethodRequest ¶
func (c *APIGateway) DeleteMethodRequest(input *DeleteMethodInput) (req *request.Request, output *DeleteMethodOutput)
DeleteMethodRequest generates a "aws/request.Request" representing the client's request for the DeleteMethod operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteMethod for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteMethodRequest method. req, resp := client.DeleteMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteMethodResponse ¶
func (c *APIGateway) DeleteMethodResponse(input *DeleteMethodResponseInput) (*DeleteMethodResponseOutput, error)
DeleteMethodResponse API operation for Amazon API Gateway.
Deletes an existing MethodResponse resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteMethodResponse for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) DeleteMethodResponseRequest ¶
func (c *APIGateway) DeleteMethodResponseRequest(input *DeleteMethodResponseInput) (req *request.Request, output *DeleteMethodResponseOutput)
DeleteMethodResponseRequest generates a "aws/request.Request" representing the client's request for the DeleteMethodResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteMethodResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteMethodResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteMethodResponseRequest method. req, resp := client.DeleteMethodResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteMethodResponseWithContext ¶
func (c *APIGateway) DeleteMethodResponseWithContext(ctx aws.Context, input *DeleteMethodResponseInput, opts ...request.Option) (*DeleteMethodResponseOutput, error)
DeleteMethodResponseWithContext is the same as DeleteMethodResponse with the addition of the ability to pass a context and additional request options.
See DeleteMethodResponse for details on how to use this API operation.
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) DeleteMethodWithContext ¶
func (c *APIGateway) DeleteMethodWithContext(ctx aws.Context, input *DeleteMethodInput, opts ...request.Option) (*DeleteMethodOutput, error)
DeleteMethodWithContext is the same as DeleteMethod with the addition of the ability to pass a context and additional request options.
See DeleteMethod for details on how to use this API operation.
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) DeleteModel ¶
func (c *APIGateway) DeleteModel(input *DeleteModelInput) (*DeleteModelOutput, error)
DeleteModel API operation for Amazon API Gateway.
Deletes a model.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteModel for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) DeleteModelRequest ¶
func (c *APIGateway) DeleteModelRequest(input *DeleteModelInput) (req *request.Request, output *DeleteModelOutput)
DeleteModelRequest generates a "aws/request.Request" representing the client's request for the DeleteModel operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteModel for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteModel method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteModelRequest method. req, resp := client.DeleteModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteModelWithContext ¶
func (c *APIGateway) DeleteModelWithContext(ctx aws.Context, input *DeleteModelInput, opts ...request.Option) (*DeleteModelOutput, error)
DeleteModelWithContext is the same as DeleteModel with the addition of the ability to pass a context and additional request options.
See DeleteModel for details on how to use this API operation.
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) DeleteRequestValidator ¶
func (c *APIGateway) DeleteRequestValidator(input *DeleteRequestValidatorInput) (*DeleteRequestValidatorOutput, error)
DeleteRequestValidator API operation for Amazon API Gateway.
Deletes a RequestValidator of a given RestApi.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteRequestValidator for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) DeleteRequestValidatorRequest ¶
func (c *APIGateway) DeleteRequestValidatorRequest(input *DeleteRequestValidatorInput) (req *request.Request, output *DeleteRequestValidatorOutput)
DeleteRequestValidatorRequest generates a "aws/request.Request" representing the client's request for the DeleteRequestValidator operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteRequestValidator for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteRequestValidator method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteRequestValidatorRequest method. req, resp := client.DeleteRequestValidatorRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteRequestValidatorWithContext ¶
func (c *APIGateway) DeleteRequestValidatorWithContext(ctx aws.Context, input *DeleteRequestValidatorInput, opts ...request.Option) (*DeleteRequestValidatorOutput, error)
DeleteRequestValidatorWithContext is the same as DeleteRequestValidator with the addition of the ability to pass a context and additional request options.
See DeleteRequestValidator for details on how to use this API operation.
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) DeleteResource ¶
func (c *APIGateway) DeleteResource(input *DeleteResourceInput) (*DeleteResourceOutput, error)
DeleteResource API operation for Amazon API Gateway.
Deletes a Resource resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteResource for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) DeleteResourceRequest ¶
func (c *APIGateway) DeleteResourceRequest(input *DeleteResourceInput) (req *request.Request, output *DeleteResourceOutput)
DeleteResourceRequest generates a "aws/request.Request" representing the client's request for the DeleteResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteResourceRequest method. req, resp := client.DeleteResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteResourceWithContext ¶
func (c *APIGateway) DeleteResourceWithContext(ctx aws.Context, input *DeleteResourceInput, opts ...request.Option) (*DeleteResourceOutput, error)
DeleteResourceWithContext is the same as DeleteResource with the addition of the ability to pass a context and additional request options.
See DeleteResource for details on how to use this API operation.
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) DeleteRestApi ¶
func (c *APIGateway) DeleteRestApi(input *DeleteRestApiInput) (*DeleteRestApiOutput, error)
DeleteRestApi API operation for Amazon API Gateway.
Deletes the specified API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteRestApi for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeBadRequestException "BadRequestException"
func (*APIGateway) DeleteRestApiRequest ¶
func (c *APIGateway) DeleteRestApiRequest(input *DeleteRestApiInput) (req *request.Request, output *DeleteRestApiOutput)
DeleteRestApiRequest generates a "aws/request.Request" representing the client's request for the DeleteRestApi operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteRestApi for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteRestApiRequest method. req, resp := client.DeleteRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteRestApiWithContext ¶
func (c *APIGateway) DeleteRestApiWithContext(ctx aws.Context, input *DeleteRestApiInput, opts ...request.Option) (*DeleteRestApiOutput, error)
DeleteRestApiWithContext is the same as DeleteRestApi with the addition of the ability to pass a context and additional request options.
See DeleteRestApi for details on how to use this API operation.
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) DeleteStage ¶
func (c *APIGateway) DeleteStage(input *DeleteStageInput) (*DeleteStageOutput, error)
DeleteStage API operation for Amazon API Gateway.
Deletes a Stage resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteStage for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeBadRequestException "BadRequestException"
func (*APIGateway) DeleteStageRequest ¶
func (c *APIGateway) DeleteStageRequest(input *DeleteStageInput) (req *request.Request, output *DeleteStageOutput)
DeleteStageRequest generates a "aws/request.Request" representing the client's request for the DeleteStage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteStage for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteStage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteStageRequest method. req, resp := client.DeleteStageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteStageWithContext ¶
func (c *APIGateway) DeleteStageWithContext(ctx aws.Context, input *DeleteStageInput, opts ...request.Option) (*DeleteStageOutput, error)
DeleteStageWithContext is the same as DeleteStage with the addition of the ability to pass a context and additional request options.
See DeleteStage for details on how to use this API operation.
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) DeleteUsagePlan ¶
func (c *APIGateway) DeleteUsagePlan(input *DeleteUsagePlanInput) (*DeleteUsagePlanOutput, error)
DeleteUsagePlan API operation for Amazon API Gateway.
Deletes a usage plan of a given plan Id.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteUsagePlan for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeNotFoundException "NotFoundException"
func (*APIGateway) DeleteUsagePlanKey ¶
func (c *APIGateway) DeleteUsagePlanKey(input *DeleteUsagePlanKeyInput) (*DeleteUsagePlanKeyOutput, error)
DeleteUsagePlanKey API operation for Amazon API Gateway.
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation DeleteUsagePlanKey for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) DeleteUsagePlanKeyRequest ¶
func (c *APIGateway) DeleteUsagePlanKeyRequest(input *DeleteUsagePlanKeyInput) (req *request.Request, output *DeleteUsagePlanKeyOutput)
DeleteUsagePlanKeyRequest generates a "aws/request.Request" representing the client's request for the DeleteUsagePlanKey operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteUsagePlanKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteUsagePlanKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteUsagePlanKeyRequest method. req, resp := client.DeleteUsagePlanKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteUsagePlanKeyWithContext ¶
func (c *APIGateway) DeleteUsagePlanKeyWithContext(ctx aws.Context, input *DeleteUsagePlanKeyInput, opts ...request.Option) (*DeleteUsagePlanKeyOutput, error)
DeleteUsagePlanKeyWithContext is the same as DeleteUsagePlanKey with the addition of the ability to pass a context and additional request options.
See DeleteUsagePlanKey for details on how to use this API operation.
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) DeleteUsagePlanRequest ¶
func (c *APIGateway) DeleteUsagePlanRequest(input *DeleteUsagePlanInput) (req *request.Request, output *DeleteUsagePlanOutput)
DeleteUsagePlanRequest generates a "aws/request.Request" representing the client's request for the DeleteUsagePlan operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteUsagePlan for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteUsagePlan method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteUsagePlanRequest method. req, resp := client.DeleteUsagePlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteUsagePlanWithContext ¶
func (c *APIGateway) DeleteUsagePlanWithContext(ctx aws.Context, input *DeleteUsagePlanInput, opts ...request.Option) (*DeleteUsagePlanOutput, error)
DeleteUsagePlanWithContext is the same as DeleteUsagePlan with the addition of the ability to pass a context and additional request options.
See DeleteUsagePlan for details on how to use this API operation.
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) FlushStageAuthorizersCache ¶
func (c *APIGateway) FlushStageAuthorizersCache(input *FlushStageAuthorizersCacheInput) (*FlushStageAuthorizersCacheOutput, error)
FlushStageAuthorizersCache API operation for Amazon API Gateway.
Flushes all authorizer cache entries on a stage.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation FlushStageAuthorizersCache for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) FlushStageAuthorizersCacheRequest ¶
func (c *APIGateway) FlushStageAuthorizersCacheRequest(input *FlushStageAuthorizersCacheInput) (req *request.Request, output *FlushStageAuthorizersCacheOutput)
FlushStageAuthorizersCacheRequest generates a "aws/request.Request" representing the client's request for the FlushStageAuthorizersCache operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See FlushStageAuthorizersCache for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the FlushStageAuthorizersCache method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the FlushStageAuthorizersCacheRequest method. req, resp := client.FlushStageAuthorizersCacheRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) FlushStageAuthorizersCacheWithContext ¶
func (c *APIGateway) FlushStageAuthorizersCacheWithContext(ctx aws.Context, input *FlushStageAuthorizersCacheInput, opts ...request.Option) (*FlushStageAuthorizersCacheOutput, error)
FlushStageAuthorizersCacheWithContext is the same as FlushStageAuthorizersCache with the addition of the ability to pass a context and additional request options.
See FlushStageAuthorizersCache for details on how to use this API operation.
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) FlushStageCache ¶
func (c *APIGateway) FlushStageCache(input *FlushStageCacheInput) (*FlushStageCacheOutput, error)
FlushStageCache API operation for Amazon API Gateway.
Flushes a stage's cache.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation FlushStageCache for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) FlushStageCacheRequest ¶
func (c *APIGateway) FlushStageCacheRequest(input *FlushStageCacheInput) (req *request.Request, output *FlushStageCacheOutput)
FlushStageCacheRequest generates a "aws/request.Request" representing the client's request for the FlushStageCache operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See FlushStageCache for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the FlushStageCache method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the FlushStageCacheRequest method. req, resp := client.FlushStageCacheRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) FlushStageCacheWithContext ¶
func (c *APIGateway) FlushStageCacheWithContext(ctx aws.Context, input *FlushStageCacheInput, opts ...request.Option) (*FlushStageCacheOutput, error)
FlushStageCacheWithContext is the same as FlushStageCache with the addition of the ability to pass a context and additional request options.
See FlushStageCache for details on how to use this API operation.
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) GenerateClientCertificate ¶
func (c *APIGateway) GenerateClientCertificate(input *GenerateClientCertificateInput) (*ClientCertificate, error)
GenerateClientCertificate API operation for Amazon API Gateway.
Generates a ClientCertificate resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GenerateClientCertificate for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeLimitExceededException "LimitExceededException"
func (*APIGateway) GenerateClientCertificateRequest ¶
func (c *APIGateway) GenerateClientCertificateRequest(input *GenerateClientCertificateInput) (req *request.Request, output *ClientCertificate)
GenerateClientCertificateRequest generates a "aws/request.Request" representing the client's request for the GenerateClientCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GenerateClientCertificate for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GenerateClientCertificate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GenerateClientCertificateRequest method. req, resp := client.GenerateClientCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GenerateClientCertificateWithContext ¶
func (c *APIGateway) GenerateClientCertificateWithContext(ctx aws.Context, input *GenerateClientCertificateInput, opts ...request.Option) (*ClientCertificate, error)
GenerateClientCertificateWithContext is the same as GenerateClientCertificate with the addition of the ability to pass a context and additional request options.
See GenerateClientCertificate for details on how to use this API operation.
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) GetAccount ¶
func (c *APIGateway) GetAccount(input *GetAccountInput) (*Account, error)
GetAccount API operation for Amazon API Gateway.
Gets information about the current Account resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetAccount for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetAccountRequest ¶
func (c *APIGateway) GetAccountRequest(input *GetAccountInput) (req *request.Request, output *Account)
GetAccountRequest generates a "aws/request.Request" representing the client's request for the GetAccount operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetAccount for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetAccount method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetAccountRequest method. req, resp := client.GetAccountRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetAccountWithContext ¶
func (c *APIGateway) GetAccountWithContext(ctx aws.Context, input *GetAccountInput, opts ...request.Option) (*Account, error)
GetAccountWithContext is the same as GetAccount with the addition of the ability to pass a context and additional request options.
See GetAccount for details on how to use this API operation.
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) GetApiKey ¶
func (c *APIGateway) GetApiKey(input *GetApiKeyInput) (*ApiKey, error)
GetApiKey API operation for Amazon API Gateway.
Gets information about the current ApiKey resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetApiKey for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetApiKeyRequest ¶
func (c *APIGateway) GetApiKeyRequest(input *GetApiKeyInput) (req *request.Request, output *ApiKey)
GetApiKeyRequest generates a "aws/request.Request" representing the client's request for the GetApiKey operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetApiKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetApiKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetApiKeyRequest method. req, resp := client.GetApiKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetApiKeyWithContext ¶
func (c *APIGateway) GetApiKeyWithContext(ctx aws.Context, input *GetApiKeyInput, opts ...request.Option) (*ApiKey, error)
GetApiKeyWithContext is the same as GetApiKey with the addition of the ability to pass a context and additional request options.
See GetApiKey for details on how to use this API operation.
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) GetApiKeys ¶
func (c *APIGateway) GetApiKeys(input *GetApiKeysInput) (*GetApiKeysOutput, error)
GetApiKeys API operation for Amazon API Gateway.
Gets information about the current ApiKeys resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetApiKeys for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
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 ...request.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) (req *request.Request, output *GetApiKeysOutput)
GetApiKeysRequest generates a "aws/request.Request" representing the client's request for the GetApiKeys operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetApiKeys for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetApiKeys method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetApiKeysRequest method. req, resp := client.GetApiKeysRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetApiKeysWithContext ¶
func (c *APIGateway) GetApiKeysWithContext(ctx aws.Context, input *GetApiKeysInput, opts ...request.Option) (*GetApiKeysOutput, error)
GetApiKeysWithContext is the same as GetApiKeys with the addition of the ability to pass a context and additional request options.
See GetApiKeys for details on how to use this API operation.
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) GetAuthorizer ¶
func (c *APIGateway) GetAuthorizer(input *GetAuthorizerInput) (*Authorizer, error)
GetAuthorizer 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)
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetAuthorizer for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetAuthorizerRequest ¶
func (c *APIGateway) GetAuthorizerRequest(input *GetAuthorizerInput) (req *request.Request, output *Authorizer)
GetAuthorizerRequest generates a "aws/request.Request" representing the client's request for the GetAuthorizer operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetAuthorizer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetAuthorizerRequest method. req, resp := client.GetAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetAuthorizerWithContext ¶
func (c *APIGateway) GetAuthorizerWithContext(ctx aws.Context, input *GetAuthorizerInput, opts ...request.Option) (*Authorizer, error)
GetAuthorizerWithContext is the same as GetAuthorizer with the addition of the ability to pass a context and additional request options.
See GetAuthorizer for details on how to use this API operation.
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) GetAuthorizers ¶
func (c *APIGateway) GetAuthorizers(input *GetAuthorizersInput) (*GetAuthorizersOutput, error)
GetAuthorizers 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)
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetAuthorizers for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetAuthorizersRequest ¶
func (c *APIGateway) GetAuthorizersRequest(input *GetAuthorizersInput) (req *request.Request, output *GetAuthorizersOutput)
GetAuthorizersRequest generates a "aws/request.Request" representing the client's request for the GetAuthorizers operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetAuthorizers for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetAuthorizers method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetAuthorizersRequest method. req, resp := client.GetAuthorizersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetAuthorizersWithContext ¶
func (c *APIGateway) GetAuthorizersWithContext(ctx aws.Context, input *GetAuthorizersInput, opts ...request.Option) (*GetAuthorizersOutput, error)
GetAuthorizersWithContext is the same as GetAuthorizers with the addition of the ability to pass a context and additional request options.
See GetAuthorizers for details on how to use this API operation.
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) GetBasePathMapping ¶
func (c *APIGateway) GetBasePathMapping(input *GetBasePathMappingInput) (*BasePathMapping, error)
GetBasePathMapping API operation for Amazon API Gateway.
Describe a BasePathMapping resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetBasePathMapping for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetBasePathMappingRequest ¶
func (c *APIGateway) GetBasePathMappingRequest(input *GetBasePathMappingInput) (req *request.Request, output *BasePathMapping)
GetBasePathMappingRequest generates a "aws/request.Request" representing the client's request for the GetBasePathMapping operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetBasePathMapping for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetBasePathMapping method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetBasePathMappingRequest method. req, resp := client.GetBasePathMappingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetBasePathMappingWithContext ¶
func (c *APIGateway) GetBasePathMappingWithContext(ctx aws.Context, input *GetBasePathMappingInput, opts ...request.Option) (*BasePathMapping, error)
GetBasePathMappingWithContext is the same as GetBasePathMapping with the addition of the ability to pass a context and additional request options.
See GetBasePathMapping for details on how to use this API operation.
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) GetBasePathMappings ¶
func (c *APIGateway) GetBasePathMappings(input *GetBasePathMappingsInput) (*GetBasePathMappingsOutput, error)
GetBasePathMappings API operation for Amazon API Gateway.
Represents a collection of BasePathMapping resources.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetBasePathMappings for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
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 ...request.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) (req *request.Request, output *GetBasePathMappingsOutput)
GetBasePathMappingsRequest generates a "aws/request.Request" representing the client's request for the GetBasePathMappings operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetBasePathMappings for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetBasePathMappings method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetBasePathMappingsRequest method. req, resp := client.GetBasePathMappingsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetBasePathMappingsWithContext ¶
func (c *APIGateway) GetBasePathMappingsWithContext(ctx aws.Context, input *GetBasePathMappingsInput, opts ...request.Option) (*GetBasePathMappingsOutput, error)
GetBasePathMappingsWithContext is the same as GetBasePathMappings with the addition of the ability to pass a context and additional request options.
See GetBasePathMappings for details on how to use this API operation.
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) GetClientCertificate ¶
func (c *APIGateway) GetClientCertificate(input *GetClientCertificateInput) (*ClientCertificate, error)
GetClientCertificate API operation for Amazon API Gateway.
Gets information about the current ClientCertificate resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetClientCertificate for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetClientCertificateRequest ¶
func (c *APIGateway) GetClientCertificateRequest(input *GetClientCertificateInput) (req *request.Request, output *ClientCertificate)
GetClientCertificateRequest generates a "aws/request.Request" representing the client's request for the GetClientCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetClientCertificate for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetClientCertificate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetClientCertificateRequest method. req, resp := client.GetClientCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetClientCertificateWithContext ¶
func (c *APIGateway) GetClientCertificateWithContext(ctx aws.Context, input *GetClientCertificateInput, opts ...request.Option) (*ClientCertificate, error)
GetClientCertificateWithContext is the same as GetClientCertificate with the addition of the ability to pass a context and additional request options.
See GetClientCertificate for details on how to use this API operation.
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) GetClientCertificates ¶
func (c *APIGateway) GetClientCertificates(input *GetClientCertificatesInput) (*GetClientCertificatesOutput, error)
GetClientCertificates API operation for Amazon API Gateway.
Gets a collection of ClientCertificate resources.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetClientCertificates for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
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 ...request.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) (req *request.Request, output *GetClientCertificatesOutput)
GetClientCertificatesRequest generates a "aws/request.Request" representing the client's request for the GetClientCertificates operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetClientCertificates for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetClientCertificates method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetClientCertificatesRequest method. req, resp := client.GetClientCertificatesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetClientCertificatesWithContext ¶
func (c *APIGateway) GetClientCertificatesWithContext(ctx aws.Context, input *GetClientCertificatesInput, opts ...request.Option) (*GetClientCertificatesOutput, error)
GetClientCertificatesWithContext is the same as GetClientCertificates with the addition of the ability to pass a context and additional request options.
See GetClientCertificates for details on how to use this API operation.
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) GetDeployment ¶
func (c *APIGateway) GetDeployment(input *GetDeploymentInput) (*Deployment, error)
GetDeployment API operation for Amazon API Gateway.
Gets information about a Deployment resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetDeployment for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeServiceUnavailableException "ServiceUnavailableException"
func (*APIGateway) GetDeploymentRequest ¶
func (c *APIGateway) GetDeploymentRequest(input *GetDeploymentInput) (req *request.Request, output *Deployment)
GetDeploymentRequest generates a "aws/request.Request" representing the client's request for the GetDeployment operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetDeployment for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDeployment method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDeploymentRequest method. req, resp := client.GetDeploymentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDeploymentWithContext ¶
func (c *APIGateway) GetDeploymentWithContext(ctx aws.Context, input *GetDeploymentInput, opts ...request.Option) (*Deployment, error)
GetDeploymentWithContext is the same as GetDeployment with the addition of the ability to pass a context and additional request options.
See GetDeployment for details on how to use this API operation.
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) GetDeployments ¶
func (c *APIGateway) GetDeployments(input *GetDeploymentsInput) (*GetDeploymentsOutput, error)
GetDeployments API operation for Amazon API Gateway.
Gets information about a Deployments collection.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetDeployments for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeServiceUnavailableException "ServiceUnavailableException"
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 ...request.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) (req *request.Request, output *GetDeploymentsOutput)
GetDeploymentsRequest generates a "aws/request.Request" representing the client's request for the GetDeployments operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetDeployments for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDeployments method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDeploymentsRequest method. req, resp := client.GetDeploymentsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDeploymentsWithContext ¶
func (c *APIGateway) GetDeploymentsWithContext(ctx aws.Context, input *GetDeploymentsInput, opts ...request.Option) (*GetDeploymentsOutput, error)
GetDeploymentsWithContext is the same as GetDeployments with the addition of the ability to pass a context and additional request options.
See GetDeployments for details on how to use this API operation.
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) GetDocumentationPart ¶
func (c *APIGateway) GetDocumentationPart(input *GetDocumentationPartInput) (*DocumentationPart, error)
GetDocumentationPart API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetDocumentationPart for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetDocumentationPartRequest ¶
func (c *APIGateway) GetDocumentationPartRequest(input *GetDocumentationPartInput) (req *request.Request, output *DocumentationPart)
GetDocumentationPartRequest generates a "aws/request.Request" representing the client's request for the GetDocumentationPart operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetDocumentationPart for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDocumentationPart method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDocumentationPartRequest method. req, resp := client.GetDocumentationPartRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDocumentationPartWithContext ¶
func (c *APIGateway) GetDocumentationPartWithContext(ctx aws.Context, input *GetDocumentationPartInput, opts ...request.Option) (*DocumentationPart, error)
GetDocumentationPartWithContext is the same as GetDocumentationPart with the addition of the ability to pass a context and additional request options.
See GetDocumentationPart for details on how to use this API operation.
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) GetDocumentationParts ¶
func (c *APIGateway) GetDocumentationParts(input *GetDocumentationPartsInput) (*GetDocumentationPartsOutput, error)
GetDocumentationParts API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetDocumentationParts for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetDocumentationPartsRequest ¶
func (c *APIGateway) GetDocumentationPartsRequest(input *GetDocumentationPartsInput) (req *request.Request, output *GetDocumentationPartsOutput)
GetDocumentationPartsRequest generates a "aws/request.Request" representing the client's request for the GetDocumentationParts operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetDocumentationParts for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDocumentationParts method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDocumentationPartsRequest method. req, resp := client.GetDocumentationPartsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDocumentationPartsWithContext ¶
func (c *APIGateway) GetDocumentationPartsWithContext(ctx aws.Context, input *GetDocumentationPartsInput, opts ...request.Option) (*GetDocumentationPartsOutput, error)
GetDocumentationPartsWithContext is the same as GetDocumentationParts with the addition of the ability to pass a context and additional request options.
See GetDocumentationParts for details on how to use this API operation.
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) GetDocumentationVersion ¶
func (c *APIGateway) GetDocumentationVersion(input *GetDocumentationVersionInput) (*DocumentationVersion, error)
GetDocumentationVersion API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetDocumentationVersion for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetDocumentationVersionRequest ¶
func (c *APIGateway) GetDocumentationVersionRequest(input *GetDocumentationVersionInput) (req *request.Request, output *DocumentationVersion)
GetDocumentationVersionRequest generates a "aws/request.Request" representing the client's request for the GetDocumentationVersion operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetDocumentationVersion for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDocumentationVersion method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDocumentationVersionRequest method. req, resp := client.GetDocumentationVersionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDocumentationVersionWithContext ¶
func (c *APIGateway) GetDocumentationVersionWithContext(ctx aws.Context, input *GetDocumentationVersionInput, opts ...request.Option) (*DocumentationVersion, error)
GetDocumentationVersionWithContext is the same as GetDocumentationVersion with the addition of the ability to pass a context and additional request options.
See GetDocumentationVersion for details on how to use this API operation.
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) GetDocumentationVersions ¶
func (c *APIGateway) GetDocumentationVersions(input *GetDocumentationVersionsInput) (*GetDocumentationVersionsOutput, error)
GetDocumentationVersions API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetDocumentationVersions for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetDocumentationVersionsRequest ¶
func (c *APIGateway) GetDocumentationVersionsRequest(input *GetDocumentationVersionsInput) (req *request.Request, output *GetDocumentationVersionsOutput)
GetDocumentationVersionsRequest generates a "aws/request.Request" representing the client's request for the GetDocumentationVersions operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetDocumentationVersions for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDocumentationVersions method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDocumentationVersionsRequest method. req, resp := client.GetDocumentationVersionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDocumentationVersionsWithContext ¶
func (c *APIGateway) GetDocumentationVersionsWithContext(ctx aws.Context, input *GetDocumentationVersionsInput, opts ...request.Option) (*GetDocumentationVersionsOutput, error)
GetDocumentationVersionsWithContext is the same as GetDocumentationVersions with the addition of the ability to pass a context and additional request options.
See GetDocumentationVersions for details on how to use this API operation.
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) GetDomainName ¶
func (c *APIGateway) GetDomainName(input *GetDomainNameInput) (*DomainName, error)
GetDomainName API operation for Amazon API Gateway.
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetDomainName for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeServiceUnavailableException "ServiceUnavailableException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetDomainNameRequest ¶
func (c *APIGateway) GetDomainNameRequest(input *GetDomainNameInput) (req *request.Request, output *DomainName)
GetDomainNameRequest generates a "aws/request.Request" representing the client's request for the GetDomainName operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetDomainName for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDomainName method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDomainNameRequest method. req, resp := client.GetDomainNameRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDomainNameWithContext ¶
func (c *APIGateway) GetDomainNameWithContext(ctx aws.Context, input *GetDomainNameInput, opts ...request.Option) (*DomainName, error)
GetDomainNameWithContext is the same as GetDomainName with the addition of the ability to pass a context and additional request options.
See GetDomainName for details on how to use this API operation.
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) GetDomainNames ¶
func (c *APIGateway) GetDomainNames(input *GetDomainNamesInput) (*GetDomainNamesOutput, error)
GetDomainNames API operation for Amazon API Gateway.
Represents a collection of DomainName resources.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetDomainNames for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
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 ...request.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) (req *request.Request, output *GetDomainNamesOutput)
GetDomainNamesRequest generates a "aws/request.Request" representing the client's request for the GetDomainNames operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetDomainNames for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDomainNames method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDomainNamesRequest method. req, resp := client.GetDomainNamesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDomainNamesWithContext ¶
func (c *APIGateway) GetDomainNamesWithContext(ctx aws.Context, input *GetDomainNamesInput, opts ...request.Option) (*GetDomainNamesOutput, error)
GetDomainNamesWithContext is the same as GetDomainNames with the addition of the ability to pass a context and additional request options.
See GetDomainNames for details on how to use this API operation.
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) GetExport ¶
func (c *APIGateway) GetExport(input *GetExportInput) (*GetExportOutput, error)
GetExport API operation for Amazon API Gateway.
Exports a deployed version of a RestApi in a specified format.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetExport for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetExportRequest ¶
func (c *APIGateway) GetExportRequest(input *GetExportInput) (req *request.Request, output *GetExportOutput)
GetExportRequest generates a "aws/request.Request" representing the client's request for the GetExport operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetExport for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetExport method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetExportRequest method. req, resp := client.GetExportRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetExportWithContext ¶
func (c *APIGateway) GetExportWithContext(ctx aws.Context, input *GetExportInput, opts ...request.Option) (*GetExportOutput, error)
GetExportWithContext is the same as GetExport with the addition of the ability to pass a context and additional request options.
See GetExport for details on how to use this API operation.
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) GetIntegration ¶
func (c *APIGateway) GetIntegration(input *GetIntegrationInput) (*Integration, error)
GetIntegration API operation for Amazon API Gateway.
Represents a get integration.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetIntegration for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetIntegrationRequest ¶
func (c *APIGateway) GetIntegrationRequest(input *GetIntegrationInput) (req *request.Request, output *Integration)
GetIntegrationRequest generates a "aws/request.Request" representing the client's request for the GetIntegration operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetIntegration for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetIntegration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetIntegrationRequest method. req, resp := client.GetIntegrationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetIntegrationResponse ¶
func (c *APIGateway) GetIntegrationResponse(input *GetIntegrationResponseInput) (*IntegrationResponse, error)
GetIntegrationResponse API operation for Amazon API Gateway.
Represents a get integration response.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetIntegrationResponse for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetIntegrationResponseRequest ¶
func (c *APIGateway) GetIntegrationResponseRequest(input *GetIntegrationResponseInput) (req *request.Request, output *IntegrationResponse)
GetIntegrationResponseRequest generates a "aws/request.Request" representing the client's request for the GetIntegrationResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetIntegrationResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetIntegrationResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetIntegrationResponseRequest method. req, resp := client.GetIntegrationResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetIntegrationResponseWithContext ¶
func (c *APIGateway) GetIntegrationResponseWithContext(ctx aws.Context, input *GetIntegrationResponseInput, opts ...request.Option) (*IntegrationResponse, error)
GetIntegrationResponseWithContext is the same as GetIntegrationResponse with the addition of the ability to pass a context and additional request options.
See GetIntegrationResponse for details on how to use this API operation.
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) GetIntegrationWithContext ¶
func (c *APIGateway) GetIntegrationWithContext(ctx aws.Context, input *GetIntegrationInput, opts ...request.Option) (*Integration, error)
GetIntegrationWithContext is the same as GetIntegration with the addition of the ability to pass a context and additional request options.
See GetIntegration for details on how to use this API operation.
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) GetMethod ¶
func (c *APIGateway) GetMethod(input *GetMethodInput) (*Method, error)
GetMethod API operation for Amazon API Gateway.
Describe an existing Method resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetMethod for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetMethodRequest ¶
func (c *APIGateway) GetMethodRequest(input *GetMethodInput) (req *request.Request, output *Method)
GetMethodRequest generates a "aws/request.Request" representing the client's request for the GetMethod operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetMethod for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetMethodRequest method. req, resp := client.GetMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetMethodResponse ¶
func (c *APIGateway) GetMethodResponse(input *GetMethodResponseInput) (*MethodResponse, error)
GetMethodResponse API operation for Amazon API Gateway.
Describes a MethodResponse resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetMethodResponse for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetMethodResponseRequest ¶
func (c *APIGateway) GetMethodResponseRequest(input *GetMethodResponseInput) (req *request.Request, output *MethodResponse)
GetMethodResponseRequest generates a "aws/request.Request" representing the client's request for the GetMethodResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetMethodResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetMethodResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetMethodResponseRequest method. req, resp := client.GetMethodResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetMethodResponseWithContext ¶
func (c *APIGateway) GetMethodResponseWithContext(ctx aws.Context, input *GetMethodResponseInput, opts ...request.Option) (*MethodResponse, error)
GetMethodResponseWithContext is the same as GetMethodResponse with the addition of the ability to pass a context and additional request options.
See GetMethodResponse for details on how to use this API operation.
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) GetMethodWithContext ¶
func (c *APIGateway) GetMethodWithContext(ctx aws.Context, input *GetMethodInput, opts ...request.Option) (*Method, error)
GetMethodWithContext is the same as GetMethod with the addition of the ability to pass a context and additional request options.
See GetMethod for details on how to use this API operation.
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) GetModel ¶
func (c *APIGateway) GetModel(input *GetModelInput) (*Model, error)
GetModel API operation for Amazon API Gateway.
Describes an existing model defined for a RestApi resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetModel for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetModelRequest ¶
func (c *APIGateway) GetModelRequest(input *GetModelInput) (req *request.Request, output *Model)
GetModelRequest generates a "aws/request.Request" representing the client's request for the GetModel operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetModel for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetModel method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetModelRequest method. req, resp := client.GetModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetModelTemplate ¶
func (c *APIGateway) GetModelTemplate(input *GetModelTemplateInput) (*GetModelTemplateOutput, error)
GetModelTemplate 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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetModelTemplate for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetModelTemplateRequest ¶
func (c *APIGateway) GetModelTemplateRequest(input *GetModelTemplateInput) (req *request.Request, output *GetModelTemplateOutput)
GetModelTemplateRequest generates a "aws/request.Request" representing the client's request for the GetModelTemplate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetModelTemplate for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetModelTemplate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetModelTemplateRequest method. req, resp := client.GetModelTemplateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetModelTemplateWithContext ¶
func (c *APIGateway) GetModelTemplateWithContext(ctx aws.Context, input *GetModelTemplateInput, opts ...request.Option) (*GetModelTemplateOutput, error)
GetModelTemplateWithContext is the same as GetModelTemplate with the addition of the ability to pass a context and additional request options.
See GetModelTemplate for details on how to use this API operation.
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) GetModelWithContext ¶
func (c *APIGateway) GetModelWithContext(ctx aws.Context, input *GetModelInput, opts ...request.Option) (*Model, error)
GetModelWithContext is the same as GetModel with the addition of the ability to pass a context and additional request options.
See GetModel for details on how to use this API operation.
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) GetModels ¶
func (c *APIGateway) GetModels(input *GetModelsInput) (*GetModelsOutput, error)
GetModels API operation for Amazon API Gateway.
Describes existing Models defined for a RestApi resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetModels for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
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 ...request.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) (req *request.Request, output *GetModelsOutput)
GetModelsRequest generates a "aws/request.Request" representing the client's request for the GetModels operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetModels for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetModels method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetModelsRequest method. req, resp := client.GetModelsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetModelsWithContext ¶
func (c *APIGateway) GetModelsWithContext(ctx aws.Context, input *GetModelsInput, opts ...request.Option) (*GetModelsOutput, error)
GetModelsWithContext is the same as GetModels with the addition of the ability to pass a context and additional request options.
See GetModels for details on how to use this API operation.
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) GetRequestValidator ¶
func (c *APIGateway) GetRequestValidator(input *GetRequestValidatorInput) (*UpdateRequestValidatorOutput, error)
GetRequestValidator API operation for Amazon API Gateway.
Gets a RequestValidator of a given RestApi.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetRequestValidator for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetRequestValidatorRequest ¶
func (c *APIGateway) GetRequestValidatorRequest(input *GetRequestValidatorInput) (req *request.Request, output *UpdateRequestValidatorOutput)
GetRequestValidatorRequest generates a "aws/request.Request" representing the client's request for the GetRequestValidator operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetRequestValidator for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetRequestValidator method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetRequestValidatorRequest method. req, resp := client.GetRequestValidatorRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetRequestValidatorWithContext ¶
func (c *APIGateway) GetRequestValidatorWithContext(ctx aws.Context, input *GetRequestValidatorInput, opts ...request.Option) (*UpdateRequestValidatorOutput, error)
GetRequestValidatorWithContext is the same as GetRequestValidator with the addition of the ability to pass a context and additional request options.
See GetRequestValidator for details on how to use this API operation.
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) GetRequestValidators ¶
func (c *APIGateway) GetRequestValidators(input *GetRequestValidatorsInput) (*GetRequestValidatorsOutput, error)
GetRequestValidators API operation for Amazon API Gateway.
Gets the RequestValidators collection of a given RestApi.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetRequestValidators for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetRequestValidatorsRequest ¶
func (c *APIGateway) GetRequestValidatorsRequest(input *GetRequestValidatorsInput) (req *request.Request, output *GetRequestValidatorsOutput)
GetRequestValidatorsRequest generates a "aws/request.Request" representing the client's request for the GetRequestValidators operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetRequestValidators for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetRequestValidators method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetRequestValidatorsRequest method. req, resp := client.GetRequestValidatorsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetRequestValidatorsWithContext ¶
func (c *APIGateway) GetRequestValidatorsWithContext(ctx aws.Context, input *GetRequestValidatorsInput, opts ...request.Option) (*GetRequestValidatorsOutput, error)
GetRequestValidatorsWithContext is the same as GetRequestValidators with the addition of the ability to pass a context and additional request options.
See GetRequestValidators for details on how to use this API operation.
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) GetResource ¶
func (c *APIGateway) GetResource(input *GetResourceInput) (*Resource, error)
GetResource API operation for Amazon API Gateway.
Lists information about a resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetResource for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetResourceRequest ¶
func (c *APIGateway) GetResourceRequest(input *GetResourceInput) (req *request.Request, output *Resource)
GetResourceRequest generates a "aws/request.Request" representing the client's request for the GetResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetResourceRequest method. req, resp := client.GetResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetResourceWithContext ¶
func (c *APIGateway) GetResourceWithContext(ctx aws.Context, input *GetResourceInput, opts ...request.Option) (*Resource, error)
GetResourceWithContext is the same as GetResource with the addition of the ability to pass a context and additional request options.
See GetResource for details on how to use this API operation.
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) GetResources ¶
func (c *APIGateway) GetResources(input *GetResourcesInput) (*GetResourcesOutput, error)
GetResources API operation for Amazon API Gateway.
Lists information about a collection of Resource resources.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetResources for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
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 ...request.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) (req *request.Request, output *GetResourcesOutput)
GetResourcesRequest generates a "aws/request.Request" representing the client's request for the GetResources operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetResources for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetResources method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetResourcesRequest method. req, resp := client.GetResourcesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetResourcesWithContext ¶
func (c *APIGateway) GetResourcesWithContext(ctx aws.Context, input *GetResourcesInput, opts ...request.Option) (*GetResourcesOutput, error)
GetResourcesWithContext is the same as GetResources with the addition of the ability to pass a context and additional request options.
See GetResources for details on how to use this API operation.
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) GetRestApi ¶
func (c *APIGateway) GetRestApi(input *GetRestApiInput) (*RestApi, error)
GetRestApi API operation for Amazon API Gateway.
Lists the RestApi resource in the collection.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetRestApi for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetRestApiRequest ¶
func (c *APIGateway) GetRestApiRequest(input *GetRestApiInput) (req *request.Request, output *RestApi)
GetRestApiRequest generates a "aws/request.Request" representing the client's request for the GetRestApi operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetRestApi for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetRestApiRequest method. req, resp := client.GetRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetRestApiWithContext ¶
func (c *APIGateway) GetRestApiWithContext(ctx aws.Context, input *GetRestApiInput, opts ...request.Option) (*RestApi, error)
GetRestApiWithContext is the same as GetRestApi with the addition of the ability to pass a context and additional request options.
See GetRestApi for details on how to use this API operation.
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) GetRestApis ¶
func (c *APIGateway) GetRestApis(input *GetRestApisInput) (*GetRestApisOutput, error)
GetRestApis API operation for Amazon API Gateway.
Lists the RestApis resources for your collection.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetRestApis for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
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 ...request.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) (req *request.Request, output *GetRestApisOutput)
GetRestApisRequest generates a "aws/request.Request" representing the client's request for the GetRestApis operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetRestApis for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetRestApis method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetRestApisRequest method. req, resp := client.GetRestApisRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetRestApisWithContext ¶
func (c *APIGateway) GetRestApisWithContext(ctx aws.Context, input *GetRestApisInput, opts ...request.Option) (*GetRestApisOutput, error)
GetRestApisWithContext is the same as GetRestApis with the addition of the ability to pass a context and additional request options.
See GetRestApis for details on how to use this API operation.
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) GetSdk ¶
func (c *APIGateway) GetSdk(input *GetSdkInput) (*GetSdkOutput, error)
GetSdk API operation for Amazon API Gateway.
Generates a client SDK for a RestApi and Stage.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetSdk for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetSdkRequest ¶
func (c *APIGateway) GetSdkRequest(input *GetSdkInput) (req *request.Request, output *GetSdkOutput)
GetSdkRequest generates a "aws/request.Request" representing the client's request for the GetSdk operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetSdk for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSdk method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetSdkRequest method. req, resp := client.GetSdkRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetSdkType ¶
func (c *APIGateway) GetSdkType(input *GetSdkTypeInput) (*SdkType, error)
GetSdkType API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetSdkType for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetSdkTypeRequest ¶
func (c *APIGateway) GetSdkTypeRequest(input *GetSdkTypeInput) (req *request.Request, output *SdkType)
GetSdkTypeRequest generates a "aws/request.Request" representing the client's request for the GetSdkType operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetSdkType for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSdkType method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetSdkTypeRequest method. req, resp := client.GetSdkTypeRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetSdkTypeWithContext ¶
func (c *APIGateway) GetSdkTypeWithContext(ctx aws.Context, input *GetSdkTypeInput, opts ...request.Option) (*SdkType, error)
GetSdkTypeWithContext is the same as GetSdkType with the addition of the ability to pass a context and additional request options.
See GetSdkType for details on how to use this API operation.
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) GetSdkTypes ¶
func (c *APIGateway) GetSdkTypes(input *GetSdkTypesInput) (*GetSdkTypesOutput, error)
GetSdkTypes API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetSdkTypes for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetSdkTypesRequest ¶
func (c *APIGateway) GetSdkTypesRequest(input *GetSdkTypesInput) (req *request.Request, output *GetSdkTypesOutput)
GetSdkTypesRequest generates a "aws/request.Request" representing the client's request for the GetSdkTypes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetSdkTypes for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSdkTypes method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetSdkTypesRequest method. req, resp := client.GetSdkTypesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetSdkTypesWithContext ¶
func (c *APIGateway) GetSdkTypesWithContext(ctx aws.Context, input *GetSdkTypesInput, opts ...request.Option) (*GetSdkTypesOutput, error)
GetSdkTypesWithContext is the same as GetSdkTypes with the addition of the ability to pass a context and additional request options.
See GetSdkTypes for details on how to use this API operation.
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) GetSdkWithContext ¶
func (c *APIGateway) GetSdkWithContext(ctx aws.Context, input *GetSdkInput, opts ...request.Option) (*GetSdkOutput, error)
GetSdkWithContext is the same as GetSdk with the addition of the ability to pass a context and additional request options.
See GetSdk for details on how to use this API operation.
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) GetStage ¶
func (c *APIGateway) GetStage(input *GetStageInput) (*Stage, error)
GetStage API operation for Amazon API Gateway.
Gets information about a Stage resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetStage for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetStageRequest ¶
func (c *APIGateway) GetStageRequest(input *GetStageInput) (req *request.Request, output *Stage)
GetStageRequest generates a "aws/request.Request" representing the client's request for the GetStage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetStage for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetStage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetStageRequest method. req, resp := client.GetStageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetStageWithContext ¶
func (c *APIGateway) GetStageWithContext(ctx aws.Context, input *GetStageInput, opts ...request.Option) (*Stage, error)
GetStageWithContext is the same as GetStage with the addition of the ability to pass a context and additional request options.
See GetStage for details on how to use this API operation.
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) GetStages ¶
func (c *APIGateway) GetStages(input *GetStagesInput) (*GetStagesOutput, error)
GetStages API operation for Amazon API Gateway.
Gets information about one or more Stage resources.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetStages for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetStagesRequest ¶
func (c *APIGateway) GetStagesRequest(input *GetStagesInput) (req *request.Request, output *GetStagesOutput)
GetStagesRequest generates a "aws/request.Request" representing the client's request for the GetStages operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetStages for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetStages method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetStagesRequest method. req, resp := client.GetStagesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetStagesWithContext ¶
func (c *APIGateway) GetStagesWithContext(ctx aws.Context, input *GetStagesInput, opts ...request.Option) (*GetStagesOutput, error)
GetStagesWithContext is the same as GetStages with the addition of the ability to pass a context and additional request options.
See GetStages for details on how to use this API operation.
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) GetUsage ¶
func (c *APIGateway) GetUsage(input *GetUsageInput) (*Usage, error)
GetUsage API operation for Amazon API Gateway.
Gets the usage data of a usage plan in a specified time interval.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetUsage for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetUsagePages ¶
func (c *APIGateway) GetUsagePages(input *GetUsageInput, fn func(*Usage, 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 *Usage, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*APIGateway) GetUsagePagesWithContext ¶
func (c *APIGateway) GetUsagePagesWithContext(ctx aws.Context, input *GetUsageInput, fn func(*Usage, bool) bool, opts ...request.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) GetUsagePlan ¶
func (c *APIGateway) GetUsagePlan(input *GetUsagePlanInput) (*UsagePlan, error)
GetUsagePlan API operation for Amazon API Gateway.
Gets a usage plan of a given plan identifier.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetUsagePlan for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetUsagePlanKey ¶
func (c *APIGateway) GetUsagePlanKey(input *GetUsagePlanKeyInput) (*UsagePlanKey, error)
GetUsagePlanKey API operation for Amazon API Gateway.
Gets a usage plan key of a given key identifier.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetUsagePlanKey for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) GetUsagePlanKeyRequest ¶
func (c *APIGateway) GetUsagePlanKeyRequest(input *GetUsagePlanKeyInput) (req *request.Request, output *UsagePlanKey)
GetUsagePlanKeyRequest generates a "aws/request.Request" representing the client's request for the GetUsagePlanKey operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetUsagePlanKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsagePlanKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsagePlanKeyRequest method. req, resp := client.GetUsagePlanKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetUsagePlanKeyWithContext ¶
func (c *APIGateway) GetUsagePlanKeyWithContext(ctx aws.Context, input *GetUsagePlanKeyInput, opts ...request.Option) (*UsagePlanKey, error)
GetUsagePlanKeyWithContext is the same as GetUsagePlanKey with the addition of the ability to pass a context and additional request options.
See GetUsagePlanKey for details on how to use this API operation.
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) GetUsagePlanKeys ¶
func (c *APIGateway) GetUsagePlanKeys(input *GetUsagePlanKeysInput) (*GetUsagePlanKeysOutput, error)
GetUsagePlanKeys API operation for Amazon API Gateway.
Gets all the usage plan keys representing the API keys added to a specified usage plan.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetUsagePlanKeys for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
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 ...request.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) (req *request.Request, output *GetUsagePlanKeysOutput)
GetUsagePlanKeysRequest generates a "aws/request.Request" representing the client's request for the GetUsagePlanKeys operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetUsagePlanKeys for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsagePlanKeys method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsagePlanKeysRequest method. req, resp := client.GetUsagePlanKeysRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetUsagePlanKeysWithContext ¶
func (c *APIGateway) GetUsagePlanKeysWithContext(ctx aws.Context, input *GetUsagePlanKeysInput, opts ...request.Option) (*GetUsagePlanKeysOutput, error)
GetUsagePlanKeysWithContext is the same as GetUsagePlanKeys with the addition of the ability to pass a context and additional request options.
See GetUsagePlanKeys for details on how to use this API operation.
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) GetUsagePlanRequest ¶
func (c *APIGateway) GetUsagePlanRequest(input *GetUsagePlanInput) (req *request.Request, output *UsagePlan)
GetUsagePlanRequest generates a "aws/request.Request" representing the client's request for the GetUsagePlan operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetUsagePlan for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsagePlan method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsagePlanRequest method. req, resp := client.GetUsagePlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetUsagePlanWithContext ¶
func (c *APIGateway) GetUsagePlanWithContext(ctx aws.Context, input *GetUsagePlanInput, opts ...request.Option) (*UsagePlan, error)
GetUsagePlanWithContext is the same as GetUsagePlan with the addition of the ability to pass a context and additional request options.
See GetUsagePlan for details on how to use this API operation.
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) GetUsagePlans ¶
func (c *APIGateway) GetUsagePlans(input *GetUsagePlansInput) (*GetUsagePlansOutput, error)
GetUsagePlans API operation for Amazon API Gateway.
Gets all the usage plans of the caller's account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation GetUsagePlans for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeConflictException "ConflictException" * ErrCodeNotFoundException "NotFoundException"
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 ...request.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) (req *request.Request, output *GetUsagePlansOutput)
GetUsagePlansRequest generates a "aws/request.Request" representing the client's request for the GetUsagePlans operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetUsagePlans for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsagePlans method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsagePlansRequest method. req, resp := client.GetUsagePlansRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetUsagePlansWithContext ¶
func (c *APIGateway) GetUsagePlansWithContext(ctx aws.Context, input *GetUsagePlansInput, opts ...request.Option) (*GetUsagePlansOutput, error)
GetUsagePlansWithContext is the same as GetUsagePlans with the addition of the ability to pass a context and additional request options.
See GetUsagePlans for details on how to use this API operation.
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) GetUsageRequest ¶
func (c *APIGateway) GetUsageRequest(input *GetUsageInput) (req *request.Request, output *Usage)
GetUsageRequest generates a "aws/request.Request" representing the client's request for the GetUsage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetUsage for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsageRequest method. req, resp := client.GetUsageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetUsageWithContext ¶
func (c *APIGateway) GetUsageWithContext(ctx aws.Context, input *GetUsageInput, opts ...request.Option) (*Usage, error)
GetUsageWithContext is the same as GetUsage with the addition of the ability to pass a context and additional request options.
See GetUsage for details on how to use this API operation.
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) ImportApiKeys ¶
func (c *APIGateway) ImportApiKeys(input *ImportApiKeysInput) (*ImportApiKeysOutput, error)
ImportApiKeys API operation for Amazon API Gateway.
Import API keys from an external source, such as a CSV-formatted file.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation ImportApiKeys for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) ImportApiKeysRequest ¶
func (c *APIGateway) ImportApiKeysRequest(input *ImportApiKeysInput) (req *request.Request, output *ImportApiKeysOutput)
ImportApiKeysRequest generates a "aws/request.Request" representing the client's request for the ImportApiKeys operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See ImportApiKeys for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ImportApiKeys method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ImportApiKeysRequest method. req, resp := client.ImportApiKeysRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) ImportApiKeysWithContext ¶
func (c *APIGateway) ImportApiKeysWithContext(ctx aws.Context, input *ImportApiKeysInput, opts ...request.Option) (*ImportApiKeysOutput, error)
ImportApiKeysWithContext is the same as ImportApiKeys with the addition of the ability to pass a context and additional request options.
See ImportApiKeys for details on how to use this API operation.
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) ImportDocumentationParts ¶
func (c *APIGateway) ImportDocumentationParts(input *ImportDocumentationPartsInput) (*ImportDocumentationPartsOutput, error)
ImportDocumentationParts API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation ImportDocumentationParts for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) ImportDocumentationPartsRequest ¶
func (c *APIGateway) ImportDocumentationPartsRequest(input *ImportDocumentationPartsInput) (req *request.Request, output *ImportDocumentationPartsOutput)
ImportDocumentationPartsRequest generates a "aws/request.Request" representing the client's request for the ImportDocumentationParts operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See ImportDocumentationParts for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ImportDocumentationParts method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ImportDocumentationPartsRequest method. req, resp := client.ImportDocumentationPartsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) ImportDocumentationPartsWithContext ¶
func (c *APIGateway) ImportDocumentationPartsWithContext(ctx aws.Context, input *ImportDocumentationPartsInput, opts ...request.Option) (*ImportDocumentationPartsOutput, error)
ImportDocumentationPartsWithContext is the same as ImportDocumentationParts with the addition of the ability to pass a context and additional request options.
See ImportDocumentationParts for details on how to use this API operation.
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) ImportRestApi ¶
func (c *APIGateway) ImportRestApi(input *ImportRestApiInput) (*RestApi, error)
ImportRestApi 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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation ImportRestApi for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) ImportRestApiRequest ¶
func (c *APIGateway) ImportRestApiRequest(input *ImportRestApiInput) (req *request.Request, output *RestApi)
ImportRestApiRequest generates a "aws/request.Request" representing the client's request for the ImportRestApi operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See ImportRestApi for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ImportRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ImportRestApiRequest method. req, resp := client.ImportRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) ImportRestApiWithContext ¶
func (c *APIGateway) ImportRestApiWithContext(ctx aws.Context, input *ImportRestApiInput, opts ...request.Option) (*RestApi, error)
ImportRestApiWithContext is the same as ImportRestApi with the addition of the ability to pass a context and additional request options.
See ImportRestApi for details on how to use this API operation.
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) PutIntegration ¶
func (c *APIGateway) PutIntegration(input *PutIntegrationInput) (*Integration, error)
PutIntegration API operation for Amazon API Gateway.
Represents a put integration.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation PutIntegration for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) PutIntegrationRequest ¶
func (c *APIGateway) PutIntegrationRequest(input *PutIntegrationInput) (req *request.Request, output *Integration)
PutIntegrationRequest generates a "aws/request.Request" representing the client's request for the PutIntegration operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See PutIntegration for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutIntegration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutIntegrationRequest method. req, resp := client.PutIntegrationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutIntegrationResponse ¶
func (c *APIGateway) PutIntegrationResponse(input *PutIntegrationResponseInput) (*IntegrationResponse, error)
PutIntegrationResponse API operation for Amazon API Gateway.
Represents a put integration.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation PutIntegrationResponse for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) PutIntegrationResponseRequest ¶
func (c *APIGateway) PutIntegrationResponseRequest(input *PutIntegrationResponseInput) (req *request.Request, output *IntegrationResponse)
PutIntegrationResponseRequest generates a "aws/request.Request" representing the client's request for the PutIntegrationResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See PutIntegrationResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutIntegrationResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutIntegrationResponseRequest method. req, resp := client.PutIntegrationResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutIntegrationResponseWithContext ¶
func (c *APIGateway) PutIntegrationResponseWithContext(ctx aws.Context, input *PutIntegrationResponseInput, opts ...request.Option) (*IntegrationResponse, error)
PutIntegrationResponseWithContext is the same as PutIntegrationResponse with the addition of the ability to pass a context and additional request options.
See PutIntegrationResponse for details on how to use this API operation.
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) PutIntegrationWithContext ¶
func (c *APIGateway) PutIntegrationWithContext(ctx aws.Context, input *PutIntegrationInput, opts ...request.Option) (*Integration, error)
PutIntegrationWithContext is the same as PutIntegration with the addition of the ability to pass a context and additional request options.
See PutIntegration for details on how to use this API operation.
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) PutMethod ¶
func (c *APIGateway) PutMethod(input *PutMethodInput) (*Method, error)
PutMethod API operation for Amazon API Gateway.
Add a method to an existing Resource resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation PutMethod for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) PutMethodRequest ¶
func (c *APIGateway) PutMethodRequest(input *PutMethodInput) (req *request.Request, output *Method)
PutMethodRequest generates a "aws/request.Request" representing the client's request for the PutMethod operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See PutMethod for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutMethodRequest method. req, resp := client.PutMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutMethodResponse ¶
func (c *APIGateway) PutMethodResponse(input *PutMethodResponseInput) (*MethodResponse, error)
PutMethodResponse API operation for Amazon API Gateway.
Adds a MethodResponse to an existing Method resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation PutMethodResponse for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) PutMethodResponseRequest ¶
func (c *APIGateway) PutMethodResponseRequest(input *PutMethodResponseInput) (req *request.Request, output *MethodResponse)
PutMethodResponseRequest generates a "aws/request.Request" representing the client's request for the PutMethodResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See PutMethodResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutMethodResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutMethodResponseRequest method. req, resp := client.PutMethodResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutMethodResponseWithContext ¶
func (c *APIGateway) PutMethodResponseWithContext(ctx aws.Context, input *PutMethodResponseInput, opts ...request.Option) (*MethodResponse, error)
PutMethodResponseWithContext is the same as PutMethodResponse with the addition of the ability to pass a context and additional request options.
See PutMethodResponse for details on how to use this API operation.
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) PutMethodWithContext ¶
func (c *APIGateway) PutMethodWithContext(ctx aws.Context, input *PutMethodInput, opts ...request.Option) (*Method, error)
PutMethodWithContext is the same as PutMethod with the addition of the ability to pass a context and additional request options.
See PutMethod for details on how to use this API operation.
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) PutRestApi ¶
func (c *APIGateway) PutRestApi(input *PutRestApiInput) (*RestApi, error)
PutRestApi 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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation PutRestApi for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) PutRestApiRequest ¶
func (c *APIGateway) PutRestApiRequest(input *PutRestApiInput) (req *request.Request, output *RestApi)
PutRestApiRequest generates a "aws/request.Request" representing the client's request for the PutRestApi operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See PutRestApi for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutRestApiRequest method. req, resp := client.PutRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutRestApiWithContext ¶
func (c *APIGateway) PutRestApiWithContext(ctx aws.Context, input *PutRestApiInput, opts ...request.Option) (*RestApi, error)
PutRestApiWithContext is the same as PutRestApi with the addition of the ability to pass a context and additional request options.
See PutRestApi for details on how to use this API operation.
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) TestInvokeAuthorizer ¶
func (c *APIGateway) TestInvokeAuthorizer(input *TestInvokeAuthorizerInput) (*TestInvokeAuthorizerOutput, error)
TestInvokeAuthorizer 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)
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation TestInvokeAuthorizer for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) TestInvokeAuthorizerRequest ¶
func (c *APIGateway) TestInvokeAuthorizerRequest(input *TestInvokeAuthorizerInput) (req *request.Request, output *TestInvokeAuthorizerOutput)
TestInvokeAuthorizerRequest generates a "aws/request.Request" representing the client's request for the TestInvokeAuthorizer operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See TestInvokeAuthorizer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the TestInvokeAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the TestInvokeAuthorizerRequest method. req, resp := client.TestInvokeAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) TestInvokeAuthorizerWithContext ¶
func (c *APIGateway) TestInvokeAuthorizerWithContext(ctx aws.Context, input *TestInvokeAuthorizerInput, opts ...request.Option) (*TestInvokeAuthorizerOutput, error)
TestInvokeAuthorizerWithContext is the same as TestInvokeAuthorizer with the addition of the ability to pass a context and additional request options.
See TestInvokeAuthorizer for details on how to use this API operation.
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) TestInvokeMethod ¶
func (c *APIGateway) TestInvokeMethod(input *TestInvokeMethodInput) (*TestInvokeMethodOutput, error)
TestInvokeMethod API operation for Amazon API Gateway.
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation TestInvokeMethod for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) TestInvokeMethodRequest ¶
func (c *APIGateway) TestInvokeMethodRequest(input *TestInvokeMethodInput) (req *request.Request, output *TestInvokeMethodOutput)
TestInvokeMethodRequest generates a "aws/request.Request" representing the client's request for the TestInvokeMethod operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See TestInvokeMethod for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the TestInvokeMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the TestInvokeMethodRequest method. req, resp := client.TestInvokeMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) TestInvokeMethodWithContext ¶
func (c *APIGateway) TestInvokeMethodWithContext(ctx aws.Context, input *TestInvokeMethodInput, opts ...request.Option) (*TestInvokeMethodOutput, error)
TestInvokeMethodWithContext is the same as TestInvokeMethod with the addition of the ability to pass a context and additional request options.
See TestInvokeMethod for details on how to use this API operation.
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) UpdateAccount ¶
func (c *APIGateway) UpdateAccount(input *UpdateAccountInput) (*Account, error)
UpdateAccount API operation for Amazon API Gateway.
Changes information about the current Account resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateAccount for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateAccountRequest ¶
func (c *APIGateway) UpdateAccountRequest(input *UpdateAccountInput) (req *request.Request, output *Account)
UpdateAccountRequest generates a "aws/request.Request" representing the client's request for the UpdateAccount operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateAccount for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateAccount method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateAccountRequest method. req, resp := client.UpdateAccountRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateAccountWithContext ¶
func (c *APIGateway) UpdateAccountWithContext(ctx aws.Context, input *UpdateAccountInput, opts ...request.Option) (*Account, error)
UpdateAccountWithContext is the same as UpdateAccount with the addition of the ability to pass a context and additional request options.
See UpdateAccount for details on how to use this API operation.
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) UpdateApiKey ¶
func (c *APIGateway) UpdateApiKey(input *UpdateApiKeyInput) (*ApiKey, error)
UpdateApiKey API operation for Amazon API Gateway.
Changes information about an ApiKey resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateApiKey for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) UpdateApiKeyRequest ¶
func (c *APIGateway) UpdateApiKeyRequest(input *UpdateApiKeyInput) (req *request.Request, output *ApiKey)
UpdateApiKeyRequest generates a "aws/request.Request" representing the client's request for the UpdateApiKey operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateApiKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateApiKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateApiKeyRequest method. req, resp := client.UpdateApiKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateApiKeyWithContext ¶
func (c *APIGateway) UpdateApiKeyWithContext(ctx aws.Context, input *UpdateApiKeyInput, opts ...request.Option) (*ApiKey, error)
UpdateApiKeyWithContext is the same as UpdateApiKey with the addition of the ability to pass a context and additional request options.
See UpdateApiKey for details on how to use this API operation.
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) UpdateAuthorizer ¶
func (c *APIGateway) UpdateAuthorizer(input *UpdateAuthorizerInput) (*Authorizer, error)
UpdateAuthorizer 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)
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateAuthorizer for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateAuthorizerRequest ¶
func (c *APIGateway) UpdateAuthorizerRequest(input *UpdateAuthorizerInput) (req *request.Request, output *Authorizer)
UpdateAuthorizerRequest generates a "aws/request.Request" representing the client's request for the UpdateAuthorizer operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateAuthorizer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateAuthorizerRequest method. req, resp := client.UpdateAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateAuthorizerWithContext ¶
func (c *APIGateway) UpdateAuthorizerWithContext(ctx aws.Context, input *UpdateAuthorizerInput, opts ...request.Option) (*Authorizer, error)
UpdateAuthorizerWithContext is the same as UpdateAuthorizer with the addition of the ability to pass a context and additional request options.
See UpdateAuthorizer for details on how to use this API operation.
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) UpdateBasePathMapping ¶
func (c *APIGateway) UpdateBasePathMapping(input *UpdateBasePathMappingInput) (*BasePathMapping, error)
UpdateBasePathMapping API operation for Amazon API Gateway.
Changes information about the BasePathMapping resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateBasePathMapping for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateBasePathMappingRequest ¶
func (c *APIGateway) UpdateBasePathMappingRequest(input *UpdateBasePathMappingInput) (req *request.Request, output *BasePathMapping)
UpdateBasePathMappingRequest generates a "aws/request.Request" representing the client's request for the UpdateBasePathMapping operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateBasePathMapping for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateBasePathMapping method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateBasePathMappingRequest method. req, resp := client.UpdateBasePathMappingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateBasePathMappingWithContext ¶
func (c *APIGateway) UpdateBasePathMappingWithContext(ctx aws.Context, input *UpdateBasePathMappingInput, opts ...request.Option) (*BasePathMapping, error)
UpdateBasePathMappingWithContext is the same as UpdateBasePathMapping with the addition of the ability to pass a context and additional request options.
See UpdateBasePathMapping for details on how to use this API operation.
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) UpdateClientCertificate ¶
func (c *APIGateway) UpdateClientCertificate(input *UpdateClientCertificateInput) (*ClientCertificate, error)
UpdateClientCertificate API operation for Amazon API Gateway.
Changes information about an ClientCertificate resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateClientCertificate for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeNotFoundException "NotFoundException"
func (*APIGateway) UpdateClientCertificateRequest ¶
func (c *APIGateway) UpdateClientCertificateRequest(input *UpdateClientCertificateInput) (req *request.Request, output *ClientCertificate)
UpdateClientCertificateRequest generates a "aws/request.Request" representing the client's request for the UpdateClientCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateClientCertificate for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateClientCertificate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateClientCertificateRequest method. req, resp := client.UpdateClientCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateClientCertificateWithContext ¶
func (c *APIGateway) UpdateClientCertificateWithContext(ctx aws.Context, input *UpdateClientCertificateInput, opts ...request.Option) (*ClientCertificate, error)
UpdateClientCertificateWithContext is the same as UpdateClientCertificate with the addition of the ability to pass a context and additional request options.
See UpdateClientCertificate for details on how to use this API operation.
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) UpdateDeployment ¶
func (c *APIGateway) UpdateDeployment(input *UpdateDeploymentInput) (*Deployment, error)
UpdateDeployment API operation for Amazon API Gateway.
Changes information about a Deployment resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateDeployment for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeServiceUnavailableException "ServiceUnavailableException"
func (*APIGateway) UpdateDeploymentRequest ¶
func (c *APIGateway) UpdateDeploymentRequest(input *UpdateDeploymentInput) (req *request.Request, output *Deployment)
UpdateDeploymentRequest generates a "aws/request.Request" representing the client's request for the UpdateDeployment operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateDeployment for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateDeployment method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateDeploymentRequest method. req, resp := client.UpdateDeploymentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateDeploymentWithContext ¶
func (c *APIGateway) UpdateDeploymentWithContext(ctx aws.Context, input *UpdateDeploymentInput, opts ...request.Option) (*Deployment, error)
UpdateDeploymentWithContext is the same as UpdateDeployment with the addition of the ability to pass a context and additional request options.
See UpdateDeployment for details on how to use this API operation.
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) UpdateDocumentationPart ¶
func (c *APIGateway) UpdateDocumentationPart(input *UpdateDocumentationPartInput) (*DocumentationPart, error)
UpdateDocumentationPart API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateDocumentationPart for usage and error information.
Returned Error Codes:
* ErrCodeBadRequestException "BadRequestException" * ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateDocumentationPartRequest ¶
func (c *APIGateway) UpdateDocumentationPartRequest(input *UpdateDocumentationPartInput) (req *request.Request, output *DocumentationPart)
UpdateDocumentationPartRequest generates a "aws/request.Request" representing the client's request for the UpdateDocumentationPart operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateDocumentationPart for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateDocumentationPart method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateDocumentationPartRequest method. req, resp := client.UpdateDocumentationPartRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateDocumentationPartWithContext ¶
func (c *APIGateway) UpdateDocumentationPartWithContext(ctx aws.Context, input *UpdateDocumentationPartInput, opts ...request.Option) (*DocumentationPart, error)
UpdateDocumentationPartWithContext is the same as UpdateDocumentationPart with the addition of the ability to pass a context and additional request options.
See UpdateDocumentationPart for details on how to use this API operation.
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) UpdateDocumentationVersion ¶
func (c *APIGateway) UpdateDocumentationVersion(input *UpdateDocumentationVersionInput) (*DocumentationVersion, error)
UpdateDocumentationVersion API operation for Amazon API Gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateDocumentationVersion for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateDocumentationVersionRequest ¶
func (c *APIGateway) UpdateDocumentationVersionRequest(input *UpdateDocumentationVersionInput) (req *request.Request, output *DocumentationVersion)
UpdateDocumentationVersionRequest generates a "aws/request.Request" representing the client's request for the UpdateDocumentationVersion operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateDocumentationVersion for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateDocumentationVersion method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateDocumentationVersionRequest method. req, resp := client.UpdateDocumentationVersionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateDocumentationVersionWithContext ¶
func (c *APIGateway) UpdateDocumentationVersionWithContext(ctx aws.Context, input *UpdateDocumentationVersionInput, opts ...request.Option) (*DocumentationVersion, error)
UpdateDocumentationVersionWithContext is the same as UpdateDocumentationVersion with the addition of the ability to pass a context and additional request options.
See UpdateDocumentationVersion for details on how to use this API operation.
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) UpdateDomainName ¶
func (c *APIGateway) UpdateDomainName(input *UpdateDomainNameInput) (*DomainName, error)
UpdateDomainName API operation for Amazon API Gateway.
Changes information about the DomainName resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateDomainName for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateDomainNameRequest ¶
func (c *APIGateway) UpdateDomainNameRequest(input *UpdateDomainNameInput) (req *request.Request, output *DomainName)
UpdateDomainNameRequest generates a "aws/request.Request" representing the client's request for the UpdateDomainName operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateDomainName for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateDomainName method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateDomainNameRequest method. req, resp := client.UpdateDomainNameRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateDomainNameWithContext ¶
func (c *APIGateway) UpdateDomainNameWithContext(ctx aws.Context, input *UpdateDomainNameInput, opts ...request.Option) (*DomainName, error)
UpdateDomainNameWithContext is the same as UpdateDomainName with the addition of the ability to pass a context and additional request options.
See UpdateDomainName for details on how to use this API operation.
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) UpdateIntegration ¶
func (c *APIGateway) UpdateIntegration(input *UpdateIntegrationInput) (*Integration, error)
UpdateIntegration API operation for Amazon API Gateway.
Represents an update integration.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateIntegration for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) UpdateIntegrationRequest ¶
func (c *APIGateway) UpdateIntegrationRequest(input *UpdateIntegrationInput) (req *request.Request, output *Integration)
UpdateIntegrationRequest generates a "aws/request.Request" representing the client's request for the UpdateIntegration operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateIntegration for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateIntegration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateIntegrationRequest method. req, resp := client.UpdateIntegrationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateIntegrationResponse ¶
func (c *APIGateway) UpdateIntegrationResponse(input *UpdateIntegrationResponseInput) (*IntegrationResponse, error)
UpdateIntegrationResponse API operation for Amazon API Gateway.
Represents an update integration response.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateIntegrationResponse for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateIntegrationResponseRequest ¶
func (c *APIGateway) UpdateIntegrationResponseRequest(input *UpdateIntegrationResponseInput) (req *request.Request, output *IntegrationResponse)
UpdateIntegrationResponseRequest generates a "aws/request.Request" representing the client's request for the UpdateIntegrationResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateIntegrationResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateIntegrationResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateIntegrationResponseRequest method. req, resp := client.UpdateIntegrationResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateIntegrationResponseWithContext ¶
func (c *APIGateway) UpdateIntegrationResponseWithContext(ctx aws.Context, input *UpdateIntegrationResponseInput, opts ...request.Option) (*IntegrationResponse, error)
UpdateIntegrationResponseWithContext is the same as UpdateIntegrationResponse with the addition of the ability to pass a context and additional request options.
See UpdateIntegrationResponse for details on how to use this API operation.
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) UpdateIntegrationWithContext ¶
func (c *APIGateway) UpdateIntegrationWithContext(ctx aws.Context, input *UpdateIntegrationInput, opts ...request.Option) (*Integration, error)
UpdateIntegrationWithContext is the same as UpdateIntegration with the addition of the ability to pass a context and additional request options.
See UpdateIntegration for details on how to use this API operation.
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) UpdateMethod ¶
func (c *APIGateway) UpdateMethod(input *UpdateMethodInput) (*Method, error)
UpdateMethod API operation for Amazon API Gateway.
Updates an existing Method resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateMethod for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateMethodRequest ¶
func (c *APIGateway) UpdateMethodRequest(input *UpdateMethodInput) (req *request.Request, output *Method)
UpdateMethodRequest generates a "aws/request.Request" representing the client's request for the UpdateMethod operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateMethod for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateMethodRequest method. req, resp := client.UpdateMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateMethodResponse ¶
func (c *APIGateway) UpdateMethodResponse(input *UpdateMethodResponseInput) (*MethodResponse, error)
UpdateMethodResponse API operation for Amazon API Gateway.
Updates an existing MethodResponse resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateMethodResponse for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeLimitExceededException "LimitExceededException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateMethodResponseRequest ¶
func (c *APIGateway) UpdateMethodResponseRequest(input *UpdateMethodResponseInput) (req *request.Request, output *MethodResponse)
UpdateMethodResponseRequest generates a "aws/request.Request" representing the client's request for the UpdateMethodResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateMethodResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateMethodResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateMethodResponseRequest method. req, resp := client.UpdateMethodResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateMethodResponseWithContext ¶
func (c *APIGateway) UpdateMethodResponseWithContext(ctx aws.Context, input *UpdateMethodResponseInput, opts ...request.Option) (*MethodResponse, error)
UpdateMethodResponseWithContext is the same as UpdateMethodResponse with the addition of the ability to pass a context and additional request options.
See UpdateMethodResponse for details on how to use this API operation.
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) UpdateMethodWithContext ¶
func (c *APIGateway) UpdateMethodWithContext(ctx aws.Context, input *UpdateMethodInput, opts ...request.Option) (*Method, error)
UpdateMethodWithContext is the same as UpdateMethod with the addition of the ability to pass a context and additional request options.
See UpdateMethod for details on how to use this API operation.
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) UpdateModel ¶
func (c *APIGateway) UpdateModel(input *UpdateModelInput) (*Model, error)
UpdateModel API operation for Amazon API Gateway.
Changes information about a model.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateModel for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeConflictException "ConflictException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateModelRequest ¶
func (c *APIGateway) UpdateModelRequest(input *UpdateModelInput) (req *request.Request, output *Model)
UpdateModelRequest generates a "aws/request.Request" representing the client's request for the UpdateModel operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateModel for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateModel method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateModelRequest method. req, resp := client.UpdateModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateModelWithContext ¶
func (c *APIGateway) UpdateModelWithContext(ctx aws.Context, input *UpdateModelInput, opts ...request.Option) (*Model, error)
UpdateModelWithContext is the same as UpdateModel with the addition of the ability to pass a context and additional request options.
See UpdateModel for details on how to use this API operation.
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) UpdateRequestValidator ¶
func (c *APIGateway) UpdateRequestValidator(input *UpdateRequestValidatorInput) (*UpdateRequestValidatorOutput, error)
UpdateRequestValidator API operation for Amazon API Gateway.
Updates a RequestValidator of a given RestApi.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateRequestValidator for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateRequestValidatorRequest ¶
func (c *APIGateway) UpdateRequestValidatorRequest(input *UpdateRequestValidatorInput) (req *request.Request, output *UpdateRequestValidatorOutput)
UpdateRequestValidatorRequest generates a "aws/request.Request" representing the client's request for the UpdateRequestValidator operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateRequestValidator for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateRequestValidator method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateRequestValidatorRequest method. req, resp := client.UpdateRequestValidatorRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateRequestValidatorWithContext ¶
func (c *APIGateway) UpdateRequestValidatorWithContext(ctx aws.Context, input *UpdateRequestValidatorInput, opts ...request.Option) (*UpdateRequestValidatorOutput, error)
UpdateRequestValidatorWithContext is the same as UpdateRequestValidator with the addition of the ability to pass a context and additional request options.
See UpdateRequestValidator for details on how to use this API operation.
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) UpdateResource ¶
func (c *APIGateway) UpdateResource(input *UpdateResourceInput) (*Resource, error)
UpdateResource API operation for Amazon API Gateway.
Changes information about a Resource resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateResource for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateResourceRequest ¶
func (c *APIGateway) UpdateResourceRequest(input *UpdateResourceInput) (req *request.Request, output *Resource)
UpdateResourceRequest generates a "aws/request.Request" representing the client's request for the UpdateResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateResourceRequest method. req, resp := client.UpdateResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateResourceWithContext ¶
func (c *APIGateway) UpdateResourceWithContext(ctx aws.Context, input *UpdateResourceInput, opts ...request.Option) (*Resource, error)
UpdateResourceWithContext is the same as UpdateResource with the addition of the ability to pass a context and additional request options.
See UpdateResource for details on how to use this API operation.
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) UpdateRestApi ¶
func (c *APIGateway) UpdateRestApi(input *UpdateRestApiInput) (*RestApi, error)
UpdateRestApi API operation for Amazon API Gateway.
Changes information about the specified API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateRestApi for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateRestApiRequest ¶
func (c *APIGateway) UpdateRestApiRequest(input *UpdateRestApiInput) (req *request.Request, output *RestApi)
UpdateRestApiRequest generates a "aws/request.Request" representing the client's request for the UpdateRestApi operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateRestApi for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateRestApiRequest method. req, resp := client.UpdateRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateRestApiWithContext ¶
func (c *APIGateway) UpdateRestApiWithContext(ctx aws.Context, input *UpdateRestApiInput, opts ...request.Option) (*RestApi, error)
UpdateRestApiWithContext is the same as UpdateRestApi with the addition of the ability to pass a context and additional request options.
See UpdateRestApi for details on how to use this API operation.
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) UpdateStage ¶
func (c *APIGateway) UpdateStage(input *UpdateStageInput) (*Stage, error)
UpdateStage API operation for Amazon API Gateway.
Changes information about a Stage resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateStage for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeTooManyRequestsException "TooManyRequestsException"
func (*APIGateway) UpdateStageRequest ¶
func (c *APIGateway) UpdateStageRequest(input *UpdateStageInput) (req *request.Request, output *Stage)
UpdateStageRequest generates a "aws/request.Request" representing the client's request for the UpdateStage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateStage for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateStage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateStageRequest method. req, resp := client.UpdateStageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateStageWithContext ¶
func (c *APIGateway) UpdateStageWithContext(ctx aws.Context, input *UpdateStageInput, opts ...request.Option) (*Stage, error)
UpdateStageWithContext is the same as UpdateStage with the addition of the ability to pass a context and additional request options.
See UpdateStage for details on how to use this API operation.
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) UpdateUsage ¶
func (c *APIGateway) UpdateUsage(input *UpdateUsageInput) (*Usage, error)
UpdateUsage API operation for Amazon API Gateway.
Grants a temporary extension to the reamining quota of a usage plan associated with a specified API key.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateUsage for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeNotFoundException "NotFoundException"
func (*APIGateway) UpdateUsagePlan ¶
func (c *APIGateway) UpdateUsagePlan(input *UpdateUsagePlanInput) (*UsagePlan, error)
UpdateUsagePlan API operation for Amazon API Gateway.
Updates a usage plan of a given plan Id.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon API Gateway's API operation UpdateUsagePlan for usage and error information.
Returned Error Codes:
* ErrCodeUnauthorizedException "UnauthorizedException" * ErrCodeTooManyRequestsException "TooManyRequestsException" * ErrCodeBadRequestException "BadRequestException" * ErrCodeNotFoundException "NotFoundException" * ErrCodeConflictException "ConflictException"
func (*APIGateway) UpdateUsagePlanRequest ¶
func (c *APIGateway) UpdateUsagePlanRequest(input *UpdateUsagePlanInput) (req *request.Request, output *UsagePlan)
UpdateUsagePlanRequest generates a "aws/request.Request" representing the client's request for the UpdateUsagePlan operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateUsagePlan for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateUsagePlan method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateUsagePlanRequest method. req, resp := client.UpdateUsagePlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateUsagePlanWithContext ¶
func (c *APIGateway) UpdateUsagePlanWithContext(ctx aws.Context, input *UpdateUsagePlanInput, opts ...request.Option) (*UsagePlan, error)
UpdateUsagePlanWithContext is the same as UpdateUsagePlan with the addition of the ability to pass a context and additional request options.
See UpdateUsagePlan for details on how to use this API operation.
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) UpdateUsageRequest ¶
func (c *APIGateway) UpdateUsageRequest(input *UpdateUsageInput) (req *request.Request, output *Usage)
UpdateUsageRequest generates a "aws/request.Request" representing the client's request for the UpdateUsage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateUsage for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateUsage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateUsageRequest method. req, resp := client.UpdateUsageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateUsageWithContext ¶
func (c *APIGateway) UpdateUsageWithContext(ctx aws.Context, input *UpdateUsageInput, opts ...request.Option) (*Usage, error)
UpdateUsageWithContext is the same as UpdateUsage with the addition of the ability to pass a context and additional request options.
See UpdateUsage for details on how to use this API operation.
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.
type Account ¶
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)
type Account 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 }
func (Account) GoString ¶
func (s Account) GoString() string
GoString returns the string representation
func (*Account) SetApiKeyVersion ¶
func (s *Account) SetApiKeyVersion(v string) *Account
SetApiKeyVersion sets the ApiKeyVersion field's value.
func (*Account) SetCloudwatchRoleArn ¶
func (s *Account) SetCloudwatchRoleArn(v string) *Account
SetCloudwatchRoleArn sets the CloudwatchRoleArn field's value.
func (*Account) SetFeatures ¶
func (s *Account) SetFeatures(v []*string) *Account
SetFeatures sets the Features field's value.
func (*Account) SetThrottleSettings ¶
func (s *Account) SetThrottleSettings(v *ThrottleSettings) *Account
SetThrottleSettings sets the ThrottleSettings field's value.
func (Account) String ¶
func (s Account) String() string
String returns the string representation
type ApiKey ¶
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)
type ApiKey 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 }
func (ApiKey) GoString ¶
func (s ApiKey) GoString() string
GoString returns the string representation
func (*ApiKey) SetCreatedDate ¶
func (s *ApiKey) SetCreatedDate(v time.Time) *ApiKey
SetCreatedDate sets the CreatedDate field's value.
func (*ApiKey) SetCustomerId ¶
func (s *ApiKey) SetCustomerId(v string) *ApiKey
SetCustomerId sets the CustomerId field's value.
func (*ApiKey) SetDescription ¶
func (s *ApiKey) SetDescription(v string) *ApiKey
SetDescription sets the Description field's value.
func (*ApiKey) SetEnabled ¶
func (s *ApiKey) SetEnabled(v bool) *ApiKey
SetEnabled sets the Enabled field's value.
func (*ApiKey) SetId ¶
func (s *ApiKey) SetId(v string) *ApiKey
SetId sets the Id field's value.
func (*ApiKey) SetLastUpdatedDate ¶
func (s *ApiKey) SetLastUpdatedDate(v time.Time) *ApiKey
SetLastUpdatedDate sets the LastUpdatedDate field's value.
func (*ApiKey) SetName ¶
func (s *ApiKey) SetName(v string) *ApiKey
SetName sets the Name field's value.
func (*ApiKey) SetStageKeys ¶
func (s *ApiKey) SetStageKeys(v []*string) *ApiKey
SetStageKeys sets the StageKeys field's value.
func (*ApiKey) SetValue ¶
func (s *ApiKey) SetValue(v string) *ApiKey
SetValue sets the Value field's value.
func (ApiKey) String ¶
func (s ApiKey) String() string
String returns the string representation
type ApiStage ¶
API stage name of the associated API stage in a usage plan.
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 }
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 Authorizer ¶
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)
type Authorizer struct { // Optional customer-defined field, used in Swagger imports/exports. Has no // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the credentials required for the authorizer, if any. Two options // are available. 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 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"` // [Required] Specifies the authorizer's Uniform Resource Identifier (URI). // For TOKEN 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"` // [Required] The source of the identity in an incoming request. For a TOKEN // authorizer, this value is a mapping expression with the same syntax as integration // parameter mappings. The only valid source for tokens is 'header', so the // expression should match 'method.request.header.[headerName]'. The value of // the header '[headerName]' will be interpreted as the incoming token. For // COGNITO_USER_POOLS authorizers, this property is used. IdentitySource *string `locationName:"identitySource" type:"string"` // A validation expression for the incoming identity. For TOKEN authorizers, // this value should be a regular expression. The incoming token from the client // is matched against this expression, and will proceed if the token matches. // If the token doesn't match, the client receives a 401 Unauthorized response. IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` // [Required] The name of the authorizer. Name *string `locationName:"name" type:"string"` // A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this // is not defined. For authorizers of the COGNITO_USER_POOLS type, each element // corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. ProviderARNs []*string `locationName:"providerARNs" type:"list"` // [Required] The type of the authorizer. Currently, the valid type is TOKEN // for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool. Type *string `locationName:"type" type:"string" enum:"AuthorizerType"` // contains filtered or unexported fields }
func (Authorizer) GoString ¶
func (s Authorizer) GoString() string
GoString returns the string representation
func (*Authorizer) SetAuthType ¶
func (s *Authorizer) SetAuthType(v string) *Authorizer
SetAuthType sets the AuthType field's value.
func (*Authorizer) SetAuthorizerCredentials ¶
func (s *Authorizer) SetAuthorizerCredentials(v string) *Authorizer
SetAuthorizerCredentials sets the AuthorizerCredentials field's value.
func (*Authorizer) SetAuthorizerResultTtlInSeconds ¶
func (s *Authorizer) SetAuthorizerResultTtlInSeconds(v int64) *Authorizer
SetAuthorizerResultTtlInSeconds sets the AuthorizerResultTtlInSeconds field's value.
func (*Authorizer) SetAuthorizerUri ¶
func (s *Authorizer) SetAuthorizerUri(v string) *Authorizer
SetAuthorizerUri sets the AuthorizerUri field's value.
func (*Authorizer) SetId ¶
func (s *Authorizer) SetId(v string) *Authorizer
SetId sets the Id field's value.
func (*Authorizer) SetIdentitySource ¶
func (s *Authorizer) SetIdentitySource(v string) *Authorizer
SetIdentitySource sets the IdentitySource field's value.
func (*Authorizer) SetIdentityValidationExpression ¶
func (s *Authorizer) SetIdentityValidationExpression(v string) *Authorizer
SetIdentityValidationExpression sets the IdentityValidationExpression field's value.
func (*Authorizer) SetName ¶
func (s *Authorizer) SetName(v string) *Authorizer
SetName sets the Name field's value.
func (*Authorizer) SetProviderARNs ¶
func (s *Authorizer) SetProviderARNs(v []*string) *Authorizer
SetProviderARNs sets the ProviderARNs field's value.
func (*Authorizer) SetType ¶
func (s *Authorizer) SetType(v string) *Authorizer
SetType sets the Type field's value.
func (Authorizer) String ¶
func (s Authorizer) String() string
String returns the string representation
type BasePathMapping ¶
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)
type BasePathMapping 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 name of the API. RestApiId *string `locationName:"restApiId" type:"string"` // The name of the API's stage. Stage *string `locationName:"stage" type:"string"` // contains filtered or unexported fields }
func (BasePathMapping) GoString ¶
func (s BasePathMapping) GoString() string
GoString returns the string representation
func (*BasePathMapping) SetBasePath ¶
func (s *BasePathMapping) SetBasePath(v string) *BasePathMapping
SetBasePath sets the BasePath field's value.
func (*BasePathMapping) SetRestApiId ¶
func (s *BasePathMapping) SetRestApiId(v string) *BasePathMapping
SetRestApiId sets the RestApiId field's value.
func (*BasePathMapping) SetStage ¶
func (s *BasePathMapping) SetStage(v string) *BasePathMapping
SetStage sets the Stage field's value.
func (BasePathMapping) String ¶
func (s BasePathMapping) String() string
String returns the string representation
type ClientCertificate ¶
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used authenticate an API by the back-end server. To authenticate an API client (or user), use a custom Authorizer. Use Client-Side Certificate (http://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)
type ClientCertificate 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 }
func (ClientCertificate) GoString ¶
func (s ClientCertificate) GoString() string
GoString returns the string representation
func (*ClientCertificate) SetClientCertificateId ¶
func (s *ClientCertificate) SetClientCertificateId(v string) *ClientCertificate
SetClientCertificateId sets the ClientCertificateId field's value.
func (*ClientCertificate) SetCreatedDate ¶
func (s *ClientCertificate) SetCreatedDate(v time.Time) *ClientCertificate
SetCreatedDate sets the CreatedDate field's value.
func (*ClientCertificate) SetDescription ¶
func (s *ClientCertificate) SetDescription(v string) *ClientCertificate
SetDescription sets the Description field's value.
func (*ClientCertificate) SetExpirationDate ¶
func (s *ClientCertificate) SetExpirationDate(v time.Time) *ClientCertificate
SetExpirationDate sets the ExpirationDate field's value.
func (*ClientCertificate) SetPemEncodedCertificate ¶
func (s *ClientCertificate) SetPemEncodedCertificate(v string) *ClientCertificate
SetPemEncodedCertificate sets the PemEncodedCertificate field's value.
func (ClientCertificate) String ¶
func (s ClientCertificate) String() string
String returns the string representation
type CreateApiKeyInput ¶
Request to create an ApiKey resource.
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 }
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 CreateAuthorizerInput ¶
Request to add a new Authorizer to an existing RestApi resource.
type CreateAuthorizerInput struct { // Optional customer-defined field, used in Swagger imports/exports. Has no // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the credentials required for the authorizer, if any. AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"` // The TTL of cached authorizer results. AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` // [Required] Specifies the authorizer's Uniform Resource Identifier (URI). AuthorizerUri *string `locationName:"authorizerUri" type:"string"` // [Required] The source of the identity in an incoming request. // // IdentitySource is a required field IdentitySource *string `locationName:"identitySource" type:"string" required:"true"` // A validation expression for the incoming identity. 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 Cognito Your User Pool authorizer's provider ARNs. ProviderARNs []*string `locationName:"providerARNs" type:"list"` // The RestApi identifier under which the Authorizer will be created. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The type of the authorizer. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"AuthorizerType"` // contains filtered or unexported fields }
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 string) *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 CreateBasePathMappingInput ¶
Requests Amazon API Gateway to create a new BasePathMapping resource.
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 name of the API that you want to apply this mapping to. // // 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 }
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 CreateDeploymentInput ¶
Requests Amazon API Gateway to create a Deployment resource.
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 *string `locationName:"cacheClusterSize" type:"string" enum:"CacheClusterSize"` // The description for the Deployment resource to create. Description *string `locationName:"description" type:"string"` // The RestApi resource identifier for the Deployment resource to create. // // 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 }
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 string) *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 CreateDocumentationPartInput ¶
Creates a new documentation part of a given API.
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 identifier of an API of the to-be-created documentation part. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 CreateDocumentationVersionInput ¶
Creates a new documentation version of a given API.
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] Specifies the API identifier of the to-be-created documentation // version. // // 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 }
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 CreateDomainNameInput ¶
A request to create a new domain name.
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 }
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 CreateModelInput ¶
Request to add a new Model to an existing RestApi resource.
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. // // 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 }
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 CreateRequestValidatorInput ¶
Creates a RequestValidator of a given RestApi.
type CreateRequestValidatorInput struct { // The name of the to-be-created RequestValidator. Name *string `locationName:"name" type:"string"` // [Required] The identifier of the RestApi for which the RequestValidator is // created. // // 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 }
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 CreateResourceInput ¶
Requests Amazon API Gateway to create a Resource resource.
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 identifier of the RestApi for the resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 CreateRestApiInput ¶
The POST Request to add a new RestApi resource to your collection.
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 }
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 CreateStageInput ¶
Requests Amazon API Gateway to create a Stage resource.
type CreateStageInput struct { // Whether cache clustering is enabled for the stage. CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` // The stage's cache cluster size. CacheClusterSize *string `locationName:"cacheClusterSize" type:"string" enum:"CacheClusterSize"` // 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 identifier of the RestApi resource for the Stage resource to create. // // 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 }
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 string) *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 CreateUsagePlanInput ¶
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.
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 }
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 ¶
The POST request to create a usage plan key for adding an existing API key to a usage plan.
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 }
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 DeleteApiKeyInput ¶
A request to delete the ApiKey resource.
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 }
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) String ¶
func (s DeleteApiKeyOutput) String() string
String returns the string representation
type DeleteAuthorizerInput ¶
Request to delete an existing Authorizer resource.
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 RestApi identifier for the Authorizer resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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) String ¶
func (s DeleteAuthorizerOutput) String() string
String returns the string representation
type DeleteBasePathMappingInput ¶
A request to delete the BasePathMapping resource.
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 }
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) String ¶
func (s DeleteBasePathMappingOutput) String() string
String returns the string representation
type DeleteClientCertificateInput ¶
A request to delete the ClientCertificate resource.
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 }
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) String ¶
func (s DeleteClientCertificateOutput) String() string
String returns the string representation
type DeleteDeploymentInput ¶
Requests Amazon API Gateway to delete a Deployment resource.
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 identifier of the RestApi resource for the Deployment resource to delete. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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) String ¶
func (s DeleteDeploymentOutput) String() string
String returns the string representation
type DeleteDocumentationPartInput ¶
Deletes an existing documentation part of an API.
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] Specifies the identifier of an API of the to-be-deleted documentation // part. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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) String ¶
func (s DeleteDocumentationPartOutput) String() string
String returns the string representation
type DeleteDocumentationVersionInput ¶
Deletes an existing documentation version of an API.
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 identifier of an API of a to-be-deleted documentation snapshot. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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) String ¶
func (s DeleteDocumentationVersionOutput) String() string
String returns the string representation
type DeleteDomainNameInput ¶
A request to delete the DomainName resource.
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 }
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) String ¶
func (s DeleteDomainNameOutput) String() string
String returns the string representation
type DeleteIntegrationInput ¶
Represents a delete integration request.
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"` // Specifies a delete integration request's API identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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) String ¶
func (s DeleteIntegrationOutput) String() string
String returns the string representation
type DeleteIntegrationResponseInput ¶
Represents a delete integration response request.
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"` // Specifies a delete integration response request's API identifier. // // 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 }
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) String ¶
func (s DeleteIntegrationResponseOutput) String() string
String returns the string representation
type DeleteMethodInput ¶
Request to delete an existing Method resource.
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 RestApi identifier for the Method resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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) String ¶
func (s DeleteMethodOutput) String() string
String returns the string representation
type DeleteMethodResponseInput ¶
A request to delete an existing MethodResponse resource.
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 RestApi identifier for the MethodResponse resource. // // 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 }
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) String ¶
func (s DeleteMethodResponseOutput) String() string
String returns the string representation
type DeleteModelInput ¶
Request to delete an existing model in an existing RestApi resource.
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 RestApi under which the model will be deleted. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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) String ¶
func (s DeleteModelOutput) String() string
String returns the string representation
type DeleteRequestValidatorInput ¶
Deletes a specified RequestValidator of a given RestApi.
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"` // [Required] The identifier of the RestApi from which the given RequestValidator // is deleted. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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) String ¶
func (s DeleteRequestValidatorOutput) String() string
String returns the string representation
type DeleteResourceInput ¶
Request to delete a Resource.
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 RestApi identifier for the Resource resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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) String ¶
func (s DeleteResourceOutput) String() string
String returns the string representation
type DeleteRestApiInput ¶
Request to delete the specified API from your collection.
type DeleteRestApiInput struct { // The ID of the RestApi you want to delete. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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) String ¶
func (s DeleteRestApiOutput) String() string
String returns the string representation
type DeleteStageInput ¶
Requests Amazon API Gateway to delete a Stage resource.
type DeleteStageInput struct { // The identifier of the RestApi resource for the Stage resource to delete. // // 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 }
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) String ¶
func (s DeleteStageOutput) String() string
String returns the string representation
type DeleteUsagePlanInput ¶
The DELETE request to delete a uasge plan of a given plan Id.
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 }
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 ¶
The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
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 }
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) String ¶
func (s DeleteUsagePlanKeyOutput) String() string
String returns the string representation
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) String ¶
func (s DeleteUsagePlanOutput) String() string
String returns the string representation
type Deployment ¶
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/)
type Deployment 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 }
func (Deployment) GoString ¶
func (s Deployment) GoString() string
GoString returns the string representation
func (*Deployment) SetApiSummary ¶
func (s *Deployment) SetApiSummary(v map[string]map[string]*MethodSnapshot) *Deployment
SetApiSummary sets the ApiSummary field's value.
func (*Deployment) SetCreatedDate ¶
func (s *Deployment) SetCreatedDate(v time.Time) *Deployment
SetCreatedDate sets the CreatedDate field's value.
func (*Deployment) SetDescription ¶
func (s *Deployment) SetDescription(v string) *Deployment
SetDescription sets the Description field's value.
func (*Deployment) SetId ¶
func (s *Deployment) SetId(v string) *Deployment
SetId sets the Id field's value.
func (Deployment) String ¶
func (s Deployment) String() string
String returns the string representation
type DocumentationPart ¶
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
type DocumentationPart 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 }
func (DocumentationPart) GoString ¶
func (s DocumentationPart) GoString() string
GoString returns the string representation
func (*DocumentationPart) SetId ¶
func (s *DocumentationPart) SetId(v string) *DocumentationPart
SetId sets the Id field's value.
func (*DocumentationPart) SetLocation ¶
func (s *DocumentationPart) SetLocation(v *DocumentationPartLocation) *DocumentationPart
SetLocation sets the Location field's value.
func (*DocumentationPart) SetProperties ¶
func (s *DocumentationPart) SetProperties(v string) *DocumentationPart
SetProperties sets the Properties field's value.
func (DocumentationPart) String ¶
func (s DocumentationPart) String() string
String returns the string representation
type DocumentationPartLocation ¶
Specifies the target API entity to which the documentation applies.
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, AUTHROZER, METHOD, MODEL, REQUEST_BODY, or // RESOURCE type. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"DocumentationPartType"` // contains filtered or unexported fields }
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 string) *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 DocumentationVersion ¶
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
type DocumentationVersion 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 }
func (DocumentationVersion) GoString ¶
func (s DocumentationVersion) GoString() string
GoString returns the string representation
func (*DocumentationVersion) SetCreatedDate ¶
func (s *DocumentationVersion) SetCreatedDate(v time.Time) *DocumentationVersion
SetCreatedDate sets the CreatedDate field's value.
func (*DocumentationVersion) SetDescription ¶
func (s *DocumentationVersion) SetDescription(v string) *DocumentationVersion
SetDescription sets the Description field's value.
func (*DocumentationVersion) SetVersion ¶
func (s *DocumentationVersion) SetVersion(v string) *DocumentationVersion
SetVersion sets the Version field's value.
func (DocumentationVersion) String ¶
func (s DocumentationVersion) String() string
String returns the string representation
type DomainName ¶
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)
type DomainName 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 }
func (DomainName) GoString ¶
func (s DomainName) GoString() string
GoString returns the string representation
func (*DomainName) SetCertificateArn ¶
func (s *DomainName) SetCertificateArn(v string) *DomainName
SetCertificateArn sets the CertificateArn field's value.
func (*DomainName) SetCertificateName ¶
func (s *DomainName) SetCertificateName(v string) *DomainName
SetCertificateName sets the CertificateName field's value.
func (*DomainName) SetCertificateUploadDate ¶
func (s *DomainName) SetCertificateUploadDate(v time.Time) *DomainName
SetCertificateUploadDate sets the CertificateUploadDate field's value.
func (*DomainName) SetDistributionDomainName ¶
func (s *DomainName) SetDistributionDomainName(v string) *DomainName
SetDistributionDomainName sets the DistributionDomainName field's value.
func (*DomainName) SetDomainName ¶
func (s *DomainName) SetDomainName(v string) *DomainName
SetDomainName sets the DomainName field's value.
func (DomainName) String ¶
func (s DomainName) String() string
String returns the string representation
type FlushStageAuthorizersCacheInput ¶
Request to flush authorizer cache entries on a specified stage.
type FlushStageAuthorizersCacheInput struct { // The API identifier of the stage to flush. // // 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 }
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) String ¶
func (s FlushStageAuthorizersCacheOutput) String() string
String returns the string representation
type FlushStageCacheInput ¶
Requests Amazon API Gateway to flush a stage's cache.
type FlushStageCacheInput struct { // The API identifier of the stage to flush its cache. // // 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 }
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) String ¶
func (s FlushStageCacheOutput) String() string
String returns the string representation
type GenerateClientCertificateInput ¶
A request to generate a ClientCertificate resource.
type GenerateClientCertificateInput struct { // The description of the ClientCertificate. Description *string `locationName:"description" type:"string"` // contains filtered or unexported fields }
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 GetAccountInput ¶
Requests Amazon API Gateway to get information about the current Account resource.
type GetAccountInput struct {
// contains filtered or unexported fields
}
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 GetApiKeyInput ¶
A request to get information about the current ApiKey resource.
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 }
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 GetApiKeysInput ¶
A request to get information about the current ApiKeys resource.
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 ApiKeys to get information about. 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 }
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 ¶
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)
type GetApiKeysOutput struct { // The current page of any ApiKey resources in the collection of ApiKey resources. Items []*ApiKey `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 }
func (GetApiKeysOutput) GoString ¶
func (s GetApiKeysOutput) GoString() string
GoString returns the string representation
func (*GetApiKeysOutput) SetItems ¶
func (s *GetApiKeysOutput) SetItems(v []*ApiKey) *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 GetAuthorizerInput ¶
Request to describe an existing Authorizer resource.
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 RestApi identifier for the Authorizer resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 GetAuthorizersInput ¶
Request to describe an existing Authorizers resource.
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 RestApi identifier for the Authorizers resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 ¶
Represents a collection of Authorizer resources.
Enable custom authorization (http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html)
type GetAuthorizersOutput struct { // Gets the current list of Authorizer resources in the collection. Items []*Authorizer `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetAuthorizersOutput) GoString ¶
func (s GetAuthorizersOutput) GoString() string
GoString returns the string representation
func (*GetAuthorizersOutput) SetItems ¶
func (s *GetAuthorizersOutput) SetItems(v []*Authorizer) *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 GetBasePathMappingInput ¶
Request to describe a BasePathMapping resource.
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 }
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 GetBasePathMappingsInput ¶
A request to get information about a collection of BasePathMapping resources.
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 }
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 ¶
Represents a collection of BasePathMapping resources.
Use Custom Domain Names (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
type GetBasePathMappingsOutput struct { // The current page of any BasePathMapping resources in the collection of base // path mapping resources. Items []*BasePathMapping `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetBasePathMappingsOutput) GoString ¶
func (s GetBasePathMappingsOutput) GoString() string
GoString returns the string representation
func (*GetBasePathMappingsOutput) SetItems ¶
func (s *GetBasePathMappingsOutput) SetItems(v []*BasePathMapping) *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 GetClientCertificateInput ¶
A request to get information about the current ClientCertificate resource.
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 }
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 GetClientCertificatesInput ¶
A request to get information about a collection of ClientCertificate resources.
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 }
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 ¶
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)
type GetClientCertificatesOutput struct { // The current page of any ClientCertificate resources in the collection of // ClientCertificate resources. Items []*ClientCertificate `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetClientCertificatesOutput) GoString ¶
func (s GetClientCertificatesOutput) GoString() string
GoString returns the string representation
func (*GetClientCertificatesOutput) SetItems ¶
func (s *GetClientCertificatesOutput) SetItems(v []*ClientCertificate) *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 GetDeploymentInput ¶
Requests Amazon API Gateway to get information about a Deployment resource.
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 identifier of the RestApi resource for the Deployment resource to get // information about. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 GetDeploymentsInput ¶
Requests Amazon API Gateway to get information about a Deployments collection.
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 identifier of the RestApi resource for the collection of Deployment resources // to get information about. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 ¶
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/)
type GetDeploymentsOutput struct { // The current page of any Deployment resources in the collection of deployment // resources. Items []*Deployment `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetDeploymentsOutput) GoString ¶
func (s GetDeploymentsOutput) GoString() string
GoString returns the string representation
func (*GetDeploymentsOutput) SetItems ¶
func (s *GetDeploymentsOutput) SetItems(v []*Deployment) *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 GetDocumentationPartInput ¶
Gets a specified documentation part of a given API.
type GetDocumentationPartInput struct { // [Required] The identifier of the to-be-retrieved documentation part. // // DocumentationPartId is a required field DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"` // [Required] The identifier of an API of the to-be-retrieved documentation // part. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 GetDocumentationPartsInput ¶
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
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 identifier of the API of the to-be-retrieved documentation // parts. // // 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 *string `location:"querystring" locationName:"type" type:"string" enum:"DocumentationPartType"` // contains filtered or unexported fields }
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 string) *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 ¶
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
type GetDocumentationPartsOutput struct { // The current page of DocumentationPart resources in the DocumentationParts // collection. Items []*DocumentationPart `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetDocumentationPartsOutput) GoString ¶
func (s GetDocumentationPartsOutput) GoString() string
GoString returns the string representation
func (*GetDocumentationPartsOutput) SetItems ¶
func (s *GetDocumentationPartsOutput) SetItems(v []*DocumentationPart) *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 GetDocumentationVersionInput ¶
Gets a documentation snapshot of an API.
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 identifier of the API of the to-be-retrieved documentation // snapshot. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 GetDocumentationVersionsInput ¶
Gets the documentation versions of an API.
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 identifier of an API of the to-be-retrieved documentation // versions. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 ¶
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
type GetDocumentationVersionsOutput struct { // The current page of DocumentationVersion items from the DocumentationVersions // collection of an API. Items []*DocumentationVersion `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetDocumentationVersionsOutput) GoString ¶
func (s GetDocumentationVersionsOutput) GoString() string
GoString returns the string representation
func (*GetDocumentationVersionsOutput) SetItems ¶
func (s *GetDocumentationVersionsOutput) SetItems(v []*DocumentationVersion) *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 GetDomainNameInput ¶
Request to get the name of a DomainName resource.
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 }
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 GetDomainNamesInput ¶
Request to describe a collection of DomainName resources.
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 }
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 ¶
Represents a collection of DomainName resources.
Use Client-Side Certificate (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
type GetDomainNamesOutput struct { // The current page of any DomainName resources in the collection of DomainName // resources. Items []*DomainName `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetDomainNamesOutput) GoString ¶
func (s GetDomainNamesOutput) GoString() string
GoString returns the string representation
func (*GetDomainNamesOutput) SetItems ¶
func (s *GetDomainNamesOutput) SetItems(v []*DomainName) *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 GetExportInput ¶
Request a new export of a RestApi for a particular Stage.
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 identifier of the RestApi to be exported. // // 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 }
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 ¶
The binary blob response to GetExport, which contains the generated SDK.
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 }
func (GetExportOutput) GoString ¶
func (s GetExportOutput) GoString() string
GoString returns the string representation
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 GetIntegrationInput ¶
Represents a get integration request.
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"` // Specifies a get integration request's API identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 GetIntegrationResponseInput ¶
Represents a get integration response request.
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"` // Specifies a get integration response request's API identifier. // // 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 }
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 GetMethodInput ¶
Request to describe an existing Method resource.
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 RestApi identifier for the Method resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 GetMethodResponseInput ¶
Request to describe a MethodResponse resource.
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 RestApi identifier for the MethodResponse resource. // // 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 }
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 GetModelInput ¶
Request to list information about a model in an existing RestApi resource.
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 }
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 GetModelTemplateInput ¶
Request to generate a sample mapping template used to transform the payload.
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 ID of the RestApi 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 }
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 ¶
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)
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 }
func (GetModelTemplateOutput) GoString ¶
func (s GetModelTemplateOutput) GoString() string
GoString returns the string representation
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 GetModelsInput ¶
Request to list existing Models defined for a RestApi resource.
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 RestApi identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 ¶
Represents a collection of Model resources.
Method, MethodResponse, Models and Mappings (http://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html)
type GetModelsOutput struct { // Gets the current Model resource in the collection. Items []*Model `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetModelsOutput) GoString ¶
func (s GetModelsOutput) GoString() string
GoString returns the string representation
func (*GetModelsOutput) SetItems ¶
func (s *GetModelsOutput) SetItems(v []*Model) *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 GetRequestValidatorInput ¶
Gets a RequestValidator of a given RestApi.
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"` // [Required] The identifier of the RestApi to which the specified RequestValidator // belongs. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 GetRequestValidatorsInput ¶
Gets the RequestValidators collection of a given RestApi.
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"` // [Required] The identifier of a RestApi to which the RequestValidators collection // belongs. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 ¶
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)
type GetRequestValidatorsOutput struct { // The current page of RequestValidator resources in the RequestValidators collection. Items []*UpdateRequestValidatorOutput `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetRequestValidatorsOutput) GoString ¶
func (s GetRequestValidatorsOutput) GoString() string
GoString returns the string representation
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 GetResourceInput ¶
Request to list information about a resource.
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 RestApi identifier for the resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 GetResourcesInput ¶
Request to list information about a collection of resources.
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 RestApi identifier for the Resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 ¶
Represents a collection of Resource resources.
Create an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
type GetResourcesOutput struct { // Gets the current Resource resource in the collection. Items []*Resource `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetResourcesOutput) GoString ¶
func (s GetResourcesOutput) GoString() string
GoString returns the string representation
func (*GetResourcesOutput) SetItems ¶
func (s *GetResourcesOutput) SetItems(v []*Resource) *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 GetRestApiInput ¶
The GET request to list an existing RestApi defined for your collection.
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 }
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 GetRestApisInput ¶
The GET request to list existing RestApis defined for your collection.
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 }
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 ¶
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)
type GetRestApisOutput struct { // An array of links to the current page of RestApi resources. Items []*RestApi `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetRestApisOutput) GoString ¶
func (s GetRestApisOutput) GoString() string
GoString returns the string representation
func (*GetRestApisOutput) SetItems ¶
func (s *GetRestApisOutput) SetItems(v []*RestApi) *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 GetSdkInput ¶
Request a new generated client SDK for a RestApi and Stage.
type GetSdkInput struct { // A key-value map of query string parameters that specify properties of the // SDK, depending on the requested sdkType. For sdkType of objectivec, a parameter // named classPrefix is required. For sdkType of android, parameters named groupId, // artifactId, artifactVersion, and invokerPackage are required. Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // The identifier of the RestApi that the SDK will use. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The language for the generated SDK. Currently javascript, android, and objectivec // (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 }
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 ¶
The binary blob response to GetSdk, which contains the generated SDK.
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 }
func (GetSdkOutput) GoString ¶
func (s GetSdkOutput) GoString() string
GoString returns the string representation
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 GetSdkTypeInput ¶
Get an SdkType instance.
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 }
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 GetSdkTypesInput ¶
Get the SdkTypes collection.
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 }
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 ¶
The collection of SdkType instances.
type GetSdkTypesOutput struct { // The set of SdkType items that comprise this view of the SdkTypes collection. Items []*SdkType `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetSdkTypesOutput) GoString ¶
func (s GetSdkTypesOutput) GoString() string
GoString returns the string representation
func (*GetSdkTypesOutput) SetItems ¶
func (s *GetSdkTypesOutput) SetItems(v []*SdkType) *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 GetStageInput ¶
Requests Amazon API Gateway to get information about a Stage resource.
type GetStageInput struct { // The identifier of the RestApi resource for the Stage resource to get information // about. // // 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 }
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 GetStagesInput ¶
Requests Amazon API Gateway to get information about one or more Stage resources.
type GetStagesInput struct { // The stages' deployment identifiers. DeploymentId *string `location:"querystring" locationName:"deploymentId" type:"string"` // The stages' API identifiers. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 ¶
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)
type GetStagesOutput struct { // An individual Stage resource. Item []*Stage `locationName:"item" type:"list"` // contains filtered or unexported fields }
func (GetStagesOutput) GoString ¶
func (s GetStagesOutput) GoString() string
GoString returns the string representation
func (*GetStagesOutput) SetItem ¶
func (s *GetStagesOutput) SetItem(v []*Stage) *GetStagesOutput
SetItem sets the Item field's value.
func (GetStagesOutput) String ¶
func (s GetStagesOutput) String() string
String returns the string representation
type GetUsageInput ¶
The GET request to get the usage data of a usage plan in a specified time interval.
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 }
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 ¶
The GET request to get a usage plan of a given plan identifier.
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 }
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 ¶
The GET request to get a usage plan key of a given key identifier.
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 }
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 GetUsagePlanKeysInput ¶
The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
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 }
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 ¶
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)
type GetUsagePlanKeysOutput struct { // Gets the current item of the usage plan keys collection. Items []*UsagePlanKey `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetUsagePlanKeysOutput) GoString ¶
func (s GetUsagePlanKeysOutput) GoString() string
GoString returns the string representation
func (*GetUsagePlanKeysOutput) SetItems ¶
func (s *GetUsagePlanKeysOutput) SetItems(v []*UsagePlanKey) *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 GetUsagePlansInput ¶
The GET request to get all the usage plans of the caller's account.
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 }
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 ¶
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)
type GetUsagePlansOutput struct { // Gets the current item when enumerating the collection of UsagePlan. Items []*UsagePlan `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
func (GetUsagePlansOutput) GoString ¶
func (s GetUsagePlansOutput) GoString() string
GoString returns the string representation
func (*GetUsagePlansOutput) SetItems ¶
func (s *GetUsagePlansOutput) SetItems(v []*UsagePlan) *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 ImportApiKeysInput ¶
The POST request to import API keys from an external source, such as a CSV-formatted file.
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 *string `location:"querystring" locationName:"format" type:"string" required:"true" enum:"ApiKeysFormat"` // contains filtered or unexported fields }
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 string) *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 ¶
The identifier of an ApiKey used in a UsagePlan.
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 }
func (ImportApiKeysOutput) GoString ¶
func (s ImportApiKeysOutput) GoString() string
GoString returns the string representation
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 ImportDocumentationPartsInput ¶
Import documentation parts from an external (e.g., Swagger) definition file.
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 *string `location:"querystring" locationName:"mode" type:"string" enum:"PutMode"` // [Required] The identifier of an API of the to-be-imported documentation parts. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 string) *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 ¶
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
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 }
func (ImportDocumentationPartsOutput) GoString ¶
func (s ImportDocumentationPartsOutput) GoString() string
GoString returns the string representation
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 ImportRestApiInput ¶
A POST request to import an API to Amazon API Gateway using an input of an API definition file.
type ImportRestApiInput struct { // The POST request body containing external API definitions. Currently, only // Swagger definition JSON files are supported. // // 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. Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // contains filtered or unexported fields }
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 Integration ¶
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)
type Integration 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 *string `locationName:"contentHandling" type:"string" enum:"ContentHandlingStrategy"` // 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]*IntegrationResponse `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 *string `locationName:"type" type:"string" enum:"IntegrationType"` // 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 }
func (Integration) GoString ¶
func (s Integration) GoString() string
GoString returns the string representation
func (*Integration) SetCacheKeyParameters ¶
func (s *Integration) SetCacheKeyParameters(v []*string) *Integration
SetCacheKeyParameters sets the CacheKeyParameters field's value.
func (*Integration) SetCacheNamespace ¶
func (s *Integration) SetCacheNamespace(v string) *Integration
SetCacheNamespace sets the CacheNamespace field's value.
func (*Integration) SetContentHandling ¶
func (s *Integration) SetContentHandling(v string) *Integration
SetContentHandling sets the ContentHandling field's value.
func (*Integration) SetCredentials ¶
func (s *Integration) SetCredentials(v string) *Integration
SetCredentials sets the Credentials field's value.
func (*Integration) SetHttpMethod ¶
func (s *Integration) SetHttpMethod(v string) *Integration
SetHttpMethod sets the HttpMethod field's value.
func (*Integration) SetIntegrationResponses ¶
func (s *Integration) SetIntegrationResponses(v map[string]*IntegrationResponse) *Integration
SetIntegrationResponses sets the IntegrationResponses field's value.
func (*Integration) SetPassthroughBehavior ¶
func (s *Integration) SetPassthroughBehavior(v string) *Integration
SetPassthroughBehavior sets the PassthroughBehavior field's value.
func (*Integration) SetRequestParameters ¶
func (s *Integration) SetRequestParameters(v map[string]*string) *Integration
SetRequestParameters sets the RequestParameters field's value.
func (*Integration) SetRequestTemplates ¶
func (s *Integration) SetRequestTemplates(v map[string]*string) *Integration
SetRequestTemplates sets the RequestTemplates field's value.
func (*Integration) SetType ¶
func (s *Integration) SetType(v string) *Integration
SetType sets the Type field's value.
func (*Integration) SetUri ¶
func (s *Integration) SetUri(v string) *Integration
SetUri sets the Uri field's value.
func (Integration) String ¶
func (s Integration) String() string
String returns the string representation
type IntegrationResponse ¶
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)
type IntegrationResponse 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 *string `locationName:"contentHandling" type:"string" enum:"ContentHandlingStrategy"` // 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 }
func (IntegrationResponse) GoString ¶
func (s IntegrationResponse) GoString() string
GoString returns the string representation
func (*IntegrationResponse) SetContentHandling ¶
func (s *IntegrationResponse) SetContentHandling(v string) *IntegrationResponse
SetContentHandling sets the ContentHandling field's value.
func (*IntegrationResponse) SetResponseParameters ¶
func (s *IntegrationResponse) SetResponseParameters(v map[string]*string) *IntegrationResponse
SetResponseParameters sets the ResponseParameters field's value.
func (*IntegrationResponse) SetResponseTemplates ¶
func (s *IntegrationResponse) SetResponseTemplates(v map[string]*string) *IntegrationResponse
SetResponseTemplates sets the ResponseTemplates field's value.
func (*IntegrationResponse) SetSelectionPattern ¶
func (s *IntegrationResponse) SetSelectionPattern(v string) *IntegrationResponse
SetSelectionPattern sets the SelectionPattern field's value.
func (*IntegrationResponse) SetStatusCode ¶
func (s *IntegrationResponse) SetStatusCode(v string) *IntegrationResponse
SetStatusCode sets the StatusCode field's value.
func (IntegrationResponse) String ¶
func (s IntegrationResponse) String() string
String returns the string representation
type Method ¶
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)
type Method 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 *Integration `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]*MethodResponse `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 }
func (Method) GoString ¶
func (s Method) GoString() string
GoString returns the string representation
func (*Method) SetApiKeyRequired ¶
func (s *Method) SetApiKeyRequired(v bool) *Method
SetApiKeyRequired sets the ApiKeyRequired field's value.
func (*Method) SetAuthorizationType ¶
func (s *Method) SetAuthorizationType(v string) *Method
SetAuthorizationType sets the AuthorizationType field's value.
func (*Method) SetAuthorizerId ¶
func (s *Method) SetAuthorizerId(v string) *Method
SetAuthorizerId sets the AuthorizerId field's value.
func (*Method) SetHttpMethod ¶
func (s *Method) SetHttpMethod(v string) *Method
SetHttpMethod sets the HttpMethod field's value.
func (*Method) SetMethodIntegration ¶
func (s *Method) SetMethodIntegration(v *Integration) *Method
SetMethodIntegration sets the MethodIntegration field's value.
func (*Method) SetMethodResponses ¶
func (s *Method) SetMethodResponses(v map[string]*MethodResponse) *Method
SetMethodResponses sets the MethodResponses field's value.
func (*Method) SetOperationName ¶
func (s *Method) SetOperationName(v string) *Method
SetOperationName sets the OperationName field's value.
func (*Method) SetRequestModels ¶
func (s *Method) SetRequestModels(v map[string]*string) *Method
SetRequestModels sets the RequestModels field's value.
func (*Method) SetRequestParameters ¶
func (s *Method) SetRequestParameters(v map[string]*bool) *Method
SetRequestParameters sets the RequestParameters field's value.
func (*Method) SetRequestValidatorId ¶
func (s *Method) SetRequestValidatorId(v string) *Method
SetRequestValidatorId sets the RequestValidatorId field's value.
func (Method) String ¶
func (s Method) String() string
String returns the string representation
type MethodResponse ¶
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" }
type MethodResponse 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 }
func (MethodResponse) GoString ¶
func (s MethodResponse) GoString() string
GoString returns the string representation
func (*MethodResponse) SetResponseModels ¶
func (s *MethodResponse) SetResponseModels(v map[string]*string) *MethodResponse
SetResponseModels sets the ResponseModels field's value.
func (*MethodResponse) SetResponseParameters ¶
func (s *MethodResponse) SetResponseParameters(v map[string]*bool) *MethodResponse
SetResponseParameters sets the ResponseParameters field's value.
func (*MethodResponse) SetStatusCode ¶
func (s *MethodResponse) SetStatusCode(v string) *MethodResponse
SetStatusCode sets the StatusCode field's value.
func (MethodResponse) String ¶
func (s MethodResponse) String() string
String returns the string representation
type MethodSetting ¶
Specifies the method setting properties.
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 *string `locationName:"unauthorizedCacheControlHeaderStrategy" type:"string" enum:"UnauthorizedCacheControlHeaderStrategy"` // contains filtered or unexported fields }
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 string) *MethodSetting
SetUnauthorizedCacheControlHeaderStrategy sets the UnauthorizedCacheControlHeaderStrategy field's value.
func (MethodSetting) String ¶
func (s MethodSetting) String() string
String returns the string representation
type MethodSnapshot ¶
Represents a summary of a Method resource, given a particular date and time.
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 }
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 Model ¶
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)
type Model 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. 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 }
func (Model) GoString ¶
func (s Model) GoString() string
GoString returns the string representation
func (*Model) SetContentType ¶
func (s *Model) SetContentType(v string) *Model
SetContentType sets the ContentType field's value.
func (*Model) SetDescription ¶
func (s *Model) SetDescription(v string) *Model
SetDescription sets the Description field's value.
func (*Model) SetId ¶
func (s *Model) SetId(v string) *Model
SetId sets the Id field's value.
func (*Model) SetName ¶
func (s *Model) SetName(v string) *Model
SetName sets the Name field's value.
func (*Model) SetSchema ¶
func (s *Model) SetSchema(v string) *Model
SetSchema sets the Schema field's value.
func (Model) String ¶
func (s Model) String() string
String returns the string representation
type PatchOperation ¶
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.
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 *string `locationName:"op" type:"string" enum:"Op"` // 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 }
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 string) *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 PutIntegrationInput ¶
Represents a put integration request.
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 *string `locationName:"contentHandling" type:"string" enum:"ContentHandlingStrategy"` // 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"` // Specifies a put integration request's API identifier. // // 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 *string `locationName:"type" type:"string" required:"true" enum:"IntegrationType"` // Specifies a put integration input's Uniform Resource Identifier (URI). When // the integration type is HTTP or AWS, this field is required. For integration // with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' // format. Uri *string `locationName:"uri" type:"string"` // contains filtered or unexported fields }
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 string) *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 string) *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 PutIntegrationResponseInput ¶
Represents a put integration response request.
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 *string `locationName:"contentHandling" type:"string" enum:"ContentHandlingStrategy"` // 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"` // Specifies a put integration response request's API identifier. // // 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 }
func (PutIntegrationResponseInput) GoString ¶
func (s PutIntegrationResponseInput) GoString() string
GoString returns the string representation
func (*PutIntegrationResponseInput) SetContentHandling ¶
func (s *PutIntegrationResponseInput) SetContentHandling(v string) *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 PutMethodInput ¶
Request to add a method to an existing Resource resource.
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 RestApi identifier for the new Method resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 PutMethodResponseInput ¶
Request to add a MethodResponse to an existing Method resource.
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 RestApi identifier for the Method resource. // // 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 }
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 PutRestApiInput ¶
A PUT request to update an existing API, with external API definitions specified as the request body.
type PutRestApiInput struct { // The PUT request body containing external API definitions. Currently, only // Swagger definition JSON files are supported. // // 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 *string `location:"querystring" locationName:"mode" type:"string" enum:"PutMode"` // Custom headers supplied as part of the request. Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // The identifier of the RestApi to be updated. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 string) *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 QuotaSettings ¶
Quotas configured for a usage plan.
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 *string `locationName:"period" type:"string" enum:"QuotaPeriodType"` // contains filtered or unexported fields }
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 string) *QuotaSettings
SetPeriod sets the Period field's value.
func (QuotaSettings) String ¶
func (s QuotaSettings) String() string
String returns the string representation
type Resource ¶
Represents an API resource.
Create an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
type Resource 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]*Method `locationName:"resourceMethods" type:"map"` // contains filtered or unexported fields }
func (Resource) GoString ¶
func (s Resource) GoString() string
GoString returns the string representation
func (*Resource) SetId ¶
func (s *Resource) SetId(v string) *Resource
SetId sets the Id field's value.
func (*Resource) SetParentId ¶
func (s *Resource) SetParentId(v string) *Resource
SetParentId sets the ParentId field's value.
func (*Resource) SetPath ¶
func (s *Resource) SetPath(v string) *Resource
SetPath sets the Path field's value.
func (*Resource) SetPathPart ¶
func (s *Resource) SetPathPart(v string) *Resource
SetPathPart sets the PathPart field's value.
func (*Resource) SetResourceMethods ¶
func (s *Resource) SetResourceMethods(v map[string]*Method) *Resource
SetResourceMethods sets the ResourceMethods field's value.
func (Resource) String ¶
func (s Resource) String() string
String returns the string representation
type RestApi ¶
Represents a REST API.
Create an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
type RestApi 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 }
func (RestApi) GoString ¶
func (s RestApi) GoString() string
GoString returns the string representation
func (*RestApi) SetBinaryMediaTypes ¶
func (s *RestApi) SetBinaryMediaTypes(v []*string) *RestApi
SetBinaryMediaTypes sets the BinaryMediaTypes field's value.
func (*RestApi) SetCreatedDate ¶
func (s *RestApi) SetCreatedDate(v time.Time) *RestApi
SetCreatedDate sets the CreatedDate field's value.
func (*RestApi) SetDescription ¶
func (s *RestApi) SetDescription(v string) *RestApi
SetDescription sets the Description field's value.
func (*RestApi) SetId ¶
func (s *RestApi) SetId(v string) *RestApi
SetId sets the Id field's value.
func (*RestApi) SetName ¶
func (s *RestApi) SetName(v string) *RestApi
SetName sets the Name field's value.
func (*RestApi) SetVersion ¶
func (s *RestApi) SetVersion(v string) *RestApi
SetVersion sets the Version field's value.
func (*RestApi) SetWarnings ¶
func (s *RestApi) SetWarnings(v []*string) *RestApi
SetWarnings sets the Warnings field's value.
func (RestApi) String ¶
func (s RestApi) String() string
String returns the string representation
type SdkConfigurationProperty ¶
A configuration property of an SDK type.
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 }
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 SdkType ¶
A type of SDK that API Gateway can generate.
type SdkType 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 }
func (SdkType) GoString ¶
func (s SdkType) GoString() string
GoString returns the string representation
func (*SdkType) SetConfigurationProperties ¶
func (s *SdkType) SetConfigurationProperties(v []*SdkConfigurationProperty) *SdkType
SetConfigurationProperties sets the ConfigurationProperties field's value.
func (*SdkType) SetDescription ¶
func (s *SdkType) SetDescription(v string) *SdkType
SetDescription sets the Description field's value.
func (*SdkType) SetFriendlyName ¶
func (s *SdkType) SetFriendlyName(v string) *SdkType
SetFriendlyName sets the FriendlyName field's value.
func (*SdkType) SetId ¶
func (s *SdkType) SetId(v string) *SdkType
SetId sets the Id field's value.
func (SdkType) String ¶
func (s SdkType) String() string
String returns the string representation
type Stage ¶
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)
type Stage 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 *string `locationName:"cacheClusterSize" type:"string" enum:"CacheClusterSize"` // The status of the cache cluster for the stage, if enabled. CacheClusterStatus *string `locationName:"cacheClusterStatus" type:"string" enum:"CacheClusterStatus"` // 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 }
func (Stage) GoString ¶
func (s Stage) GoString() string
GoString returns the string representation
func (*Stage) SetCacheClusterEnabled ¶
func (s *Stage) SetCacheClusterEnabled(v bool) *Stage
SetCacheClusterEnabled sets the CacheClusterEnabled field's value.
func (*Stage) SetCacheClusterSize ¶
func (s *Stage) SetCacheClusterSize(v string) *Stage
SetCacheClusterSize sets the CacheClusterSize field's value.
func (*Stage) SetCacheClusterStatus ¶
func (s *Stage) SetCacheClusterStatus(v string) *Stage
SetCacheClusterStatus sets the CacheClusterStatus field's value.
func (*Stage) SetClientCertificateId ¶
func (s *Stage) SetClientCertificateId(v string) *Stage
SetClientCertificateId sets the ClientCertificateId field's value.
func (*Stage) SetCreatedDate ¶
func (s *Stage) SetCreatedDate(v time.Time) *Stage
SetCreatedDate sets the CreatedDate field's value.
func (*Stage) SetDeploymentId ¶
func (s *Stage) SetDeploymentId(v string) *Stage
SetDeploymentId sets the DeploymentId field's value.
func (*Stage) SetDescription ¶
func (s *Stage) SetDescription(v string) *Stage
SetDescription sets the Description field's value.
func (*Stage) SetDocumentationVersion ¶
func (s *Stage) SetDocumentationVersion(v string) *Stage
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*Stage) SetLastUpdatedDate ¶
func (s *Stage) SetLastUpdatedDate(v time.Time) *Stage
SetLastUpdatedDate sets the LastUpdatedDate field's value.
func (*Stage) SetMethodSettings ¶
func (s *Stage) SetMethodSettings(v map[string]*MethodSetting) *Stage
SetMethodSettings sets the MethodSettings field's value.
func (*Stage) SetStageName ¶
func (s *Stage) SetStageName(v string) *Stage
SetStageName sets the StageName field's value.
func (*Stage) SetVariables ¶
func (s *Stage) SetVariables(v map[string]*string) *Stage
SetVariables sets the Variables field's value.
func (Stage) String ¶
func (s Stage) String() string
String returns the string representation
type StageKey ¶
A reference to a unique stage identified in the format {restApiId}/{stage}.
type StageKey struct { // A list of Stage resources that are associated with the ApiKey resource. RestApiId *string `locationName:"restApiId" type:"string"` // The stage name in the RestApi that the stage key references. StageName *string `locationName:"stageName" type:"string"` // contains filtered or unexported fields }
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 ¶
Make a request to simulate the execution of an Authorizer.
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"` // Specifies a test invoke authorizer request's RestApi identifier. // // 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 }
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 ¶
Represents the response of the test invoke request for a custom Authorizer
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 }
func (TestInvokeAuthorizerOutput) GoString ¶
func (s TestInvokeAuthorizerOutput) GoString() string
GoString returns the string representation
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 TestInvokeMethodInput ¶
Make a request to simulate the execution of a Method.
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"` // Specifies a test invoke method request's API identifier. // // 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 }
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 ¶
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)
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 }
func (TestInvokeMethodOutput) GoString ¶
func (s TestInvokeMethodOutput) GoString() string
GoString returns the string representation
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 ThrottleSettings ¶
The API request rate limits.
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 }
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 UpdateAccountInput ¶
Requests Amazon API Gateway to change information about the current Account resource.
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 }
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 UpdateApiKeyInput ¶
A request to change information about an ApiKey resource.
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 }
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 UpdateAuthorizerInput ¶
Request to update an existing Authorizer resource.
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 RestApi identifier for the Authorizer resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 UpdateBasePathMappingInput ¶
A request to change information about the BasePathMapping resource.
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 }
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 UpdateClientCertificateInput ¶
A request to change information about an ClientCertificate resource.
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 }
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 UpdateDeploymentInput ¶
Requests Amazon API Gateway to change information about a Deployment resource.
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 replacement identifier of the RestApi resource for the Deployment resource // to change information about. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 UpdateDocumentationPartInput ¶
Updates an existing documentation part of a given API.
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 identifier of an API of the to-be-updated documentation part. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 UpdateDocumentationVersionInput ¶
Updates an existing documentation version of an API.
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 identifier of an API of the to-be-updated documentation version. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 UpdateDomainNameInput ¶
A request to change information about the DomainName resource.
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 }
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 UpdateIntegrationInput ¶
Represents an update integration request.
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"` // Represents an update integration request's API identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 UpdateIntegrationResponseInput ¶
Represents an update integration response request.
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"` // Specifies an update integration response request's API identifier. // // 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 }
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 UpdateMethodInput ¶
Request to update an existing Method resource.
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 RestApi identifier for the Method resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 UpdateMethodResponseInput ¶
A request to update an existing MethodResponse resource.
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 RestApi identifier for the MethodResponse resource. // // 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 }
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 UpdateModelInput ¶
Request to update an existing model in an existing RestApi resource.
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 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 }
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 UpdateRequestValidatorInput ¶
Updates a RequestValidator of a given RestApi.
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"` // [Required] The identifier of the RestApi for which the given RequestValidator // is updated. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 ¶
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)
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 }
func (UpdateRequestValidatorOutput) GoString ¶
func (s UpdateRequestValidatorOutput) GoString() string
GoString returns the string representation
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 UpdateResourceInput ¶
Request to change information about a Resource resource.
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 RestApi identifier for the Resource resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 UpdateRestApiInput ¶
Request to update an existing RestApi resource in your collection.
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 ID of the RestApi you want to update. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
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 UpdateStageInput ¶
Requests Amazon API Gateway to change information about a Stage resource.
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 identifier of the RestApi resource for the Stage resource to change information // about. // // 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 }
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 UpdateUsageInput ¶
The PATCH request to grant a temporary extension to the reamining quota of a usage plan associated with a specified API key.
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 }
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 UpdateUsagePlanInput ¶
The PATCH request to update a usage plan of a given plan Id.
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 }
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 Usage ¶
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)
type Usage 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 }
func (Usage) GoString ¶
func (s Usage) GoString() string
GoString returns the string representation
func (*Usage) SetEndDate ¶
func (s *Usage) SetEndDate(v string) *Usage
SetEndDate sets the EndDate field's value.
func (*Usage) SetItems ¶
func (s *Usage) SetItems(v map[string][][]*int64) *Usage
SetItems sets the Items field's value.
func (*Usage) SetPosition ¶
func (s *Usage) SetPosition(v string) *Usage
SetPosition sets the Position field's value.
func (*Usage) SetStartDate ¶
func (s *Usage) SetStartDate(v string) *Usage
SetStartDate sets the StartDate field's value.
func (*Usage) SetUsagePlanId ¶
func (s *Usage) SetUsagePlanId(v string) *Usage
SetUsagePlanId sets the UsagePlanId field's value.
func (Usage) String ¶
func (s Usage) String() string
String returns the string representation
type UsagePlan ¶
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)
type UsagePlan 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 }
func (UsagePlan) GoString ¶
func (s UsagePlan) GoString() string
GoString returns the string representation
func (*UsagePlan) SetApiStages ¶
func (s *UsagePlan) SetApiStages(v []*ApiStage) *UsagePlan
SetApiStages sets the ApiStages field's value.
func (*UsagePlan) SetDescription ¶
func (s *UsagePlan) SetDescription(v string) *UsagePlan
SetDescription sets the Description field's value.
func (*UsagePlan) SetId ¶
func (s *UsagePlan) SetId(v string) *UsagePlan
SetId sets the Id field's value.
func (*UsagePlan) SetName ¶
func (s *UsagePlan) SetName(v string) *UsagePlan
SetName sets the Name field's value.
func (*UsagePlan) SetProductCode ¶
func (s *UsagePlan) SetProductCode(v string) *UsagePlan
SetProductCode sets the ProductCode field's value.
func (*UsagePlan) SetQuota ¶
func (s *UsagePlan) SetQuota(v *QuotaSettings) *UsagePlan
SetQuota sets the Quota field's value.
func (*UsagePlan) SetThrottle ¶
func (s *UsagePlan) SetThrottle(v *ThrottleSettings) *UsagePlan
SetThrottle sets the Throttle field's value.
func (UsagePlan) String ¶
func (s UsagePlan) String() string
String returns the string representation
type UsagePlanKey ¶
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)
type UsagePlanKey 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 }
func (UsagePlanKey) GoString ¶
func (s UsagePlanKey) GoString() string
GoString returns the string representation
func (*UsagePlanKey) SetId ¶
func (s *UsagePlanKey) SetId(v string) *UsagePlanKey
SetId sets the Id field's value.
func (*UsagePlanKey) SetName ¶
func (s *UsagePlanKey) SetName(v string) *UsagePlanKey
SetName sets the Name field's value.
func (*UsagePlanKey) SetType ¶
func (s *UsagePlanKey) SetType(v string) *UsagePlanKey
SetType sets the Type field's value.
func (*UsagePlanKey) SetValue ¶
func (s *UsagePlanKey) SetValue(v string) *UsagePlanKey
SetValue sets the Value field's value.
func (UsagePlanKey) String ¶
func (s UsagePlanKey) String() string
String returns the string representation
Subdirectories
Name | Synopsis |
---|---|
.. | |
apigatewayiface | Package apigatewayiface provides an interface to enable mocking the Amazon API Gateway service client for testing your code. |