Documentation
¶
Overview ¶
Package apigateway provides the client and types for making API requests to Amazon API Gateway.
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
See apigateway package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/apigateway/
Using the Client ¶
To contact Amazon API Gateway with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon API Gateway client APIGateway for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/apigateway/#New
Index ¶
- Constants
- type APIGateway
- func (c *APIGateway) CreateApiKey(input *CreateApiKeyInput) (*ApiKey, error)
- func (c *APIGateway) CreateApiKeyRequest(input *CreateApiKeyInput) (req *request.Request, output *ApiKey)
- func (c *APIGateway) CreateApiKeyWithContext(ctx aws.Context, input *CreateApiKeyInput, opts ...request.Option) (*ApiKey, error)
- func (c *APIGateway) CreateAuthorizer(input *CreateAuthorizerInput) (*Authorizer, error)
- func (c *APIGateway) CreateAuthorizerRequest(input *CreateAuthorizerInput) (req *request.Request, output *Authorizer)
- func (c *APIGateway) CreateAuthorizerWithContext(ctx aws.Context, input *CreateAuthorizerInput, opts ...request.Option) (*Authorizer, error)
- func (c *APIGateway) CreateBasePathMapping(input *CreateBasePathMappingInput) (*BasePathMapping, error)
- func (c *APIGateway) CreateBasePathMappingRequest(input *CreateBasePathMappingInput) (req *request.Request, output *BasePathMapping)
- func (c *APIGateway) CreateBasePathMappingWithContext(ctx aws.Context, input *CreateBasePathMappingInput, opts ...request.Option) (*BasePathMapping, error)
- func (c *APIGateway) CreateDeployment(input *CreateDeploymentInput) (*Deployment, error)
- func (c *APIGateway) CreateDeploymentRequest(input *CreateDeploymentInput) (req *request.Request, output *Deployment)
- func (c *APIGateway) CreateDeploymentWithContext(ctx aws.Context, input *CreateDeploymentInput, opts ...request.Option) (*Deployment, error)
- func (c *APIGateway) CreateDocumentationPart(input *CreateDocumentationPartInput) (*DocumentationPart, error)
- func (c *APIGateway) CreateDocumentationPartRequest(input *CreateDocumentationPartInput) (req *request.Request, output *DocumentationPart)
- func (c *APIGateway) CreateDocumentationPartWithContext(ctx aws.Context, input *CreateDocumentationPartInput, opts ...request.Option) (*DocumentationPart, error)
- func (c *APIGateway) CreateDocumentationVersion(input *CreateDocumentationVersionInput) (*DocumentationVersion, error)
- func (c *APIGateway) CreateDocumentationVersionRequest(input *CreateDocumentationVersionInput) (req *request.Request, output *DocumentationVersion)
- func (c *APIGateway) CreateDocumentationVersionWithContext(ctx aws.Context, input *CreateDocumentationVersionInput, ...) (*DocumentationVersion, error)
- func (c *APIGateway) CreateDomainName(input *CreateDomainNameInput) (*DomainName, error)
- func (c *APIGateway) CreateDomainNameRequest(input *CreateDomainNameInput) (req *request.Request, output *DomainName)
- func (c *APIGateway) CreateDomainNameWithContext(ctx aws.Context, input *CreateDomainNameInput, opts ...request.Option) (*DomainName, error)
- func (c *APIGateway) CreateModel(input *CreateModelInput) (*Model, error)
- func (c *APIGateway) CreateModelRequest(input *CreateModelInput) (req *request.Request, output *Model)
- func (c *APIGateway) CreateModelWithContext(ctx aws.Context, input *CreateModelInput, opts ...request.Option) (*Model, error)
- func (c *APIGateway) CreateRequestValidator(input *CreateRequestValidatorInput) (*UpdateRequestValidatorOutput, error)
- func (c *APIGateway) CreateRequestValidatorRequest(input *CreateRequestValidatorInput) (req *request.Request, output *UpdateRequestValidatorOutput)
- func (c *APIGateway) CreateRequestValidatorWithContext(ctx aws.Context, input *CreateRequestValidatorInput, opts ...request.Option) (*UpdateRequestValidatorOutput, error)
- func (c *APIGateway) CreateResource(input *CreateResourceInput) (*Resource, error)
- func (c *APIGateway) CreateResourceRequest(input *CreateResourceInput) (req *request.Request, output *Resource)
- func (c *APIGateway) CreateResourceWithContext(ctx aws.Context, input *CreateResourceInput, opts ...request.Option) (*Resource, error)
- func (c *APIGateway) CreateRestApi(input *CreateRestApiInput) (*RestApi, error)
- func (c *APIGateway) CreateRestApiRequest(input *CreateRestApiInput) (req *request.Request, output *RestApi)
- func (c *APIGateway) CreateRestApiWithContext(ctx aws.Context, input *CreateRestApiInput, opts ...request.Option) (*RestApi, error)
- func (c *APIGateway) CreateStage(input *CreateStageInput) (*Stage, error)
- func (c *APIGateway) CreateStageRequest(input *CreateStageInput) (req *request.Request, output *Stage)
- func (c *APIGateway) CreateStageWithContext(ctx aws.Context, input *CreateStageInput, opts ...request.Option) (*Stage, error)
- func (c *APIGateway) CreateUsagePlan(input *CreateUsagePlanInput) (*UsagePlan, error)
- func (c *APIGateway) CreateUsagePlanKey(input *CreateUsagePlanKeyInput) (*UsagePlanKey, error)
- func (c *APIGateway) CreateUsagePlanKeyRequest(input *CreateUsagePlanKeyInput) (req *request.Request, output *UsagePlanKey)
- func (c *APIGateway) CreateUsagePlanKeyWithContext(ctx aws.Context, input *CreateUsagePlanKeyInput, opts ...request.Option) (*UsagePlanKey, error)
- func (c *APIGateway) CreateUsagePlanRequest(input *CreateUsagePlanInput) (req *request.Request, output *UsagePlan)
- func (c *APIGateway) CreateUsagePlanWithContext(ctx aws.Context, input *CreateUsagePlanInput, opts ...request.Option) (*UsagePlan, error)
- func (c *APIGateway) DeleteApiKey(input *DeleteApiKeyInput) (*DeleteApiKeyOutput, error)
- func (c *APIGateway) DeleteApiKeyRequest(input *DeleteApiKeyInput) (req *request.Request, output *DeleteApiKeyOutput)
- func (c *APIGateway) DeleteApiKeyWithContext(ctx aws.Context, input *DeleteApiKeyInput, opts ...request.Option) (*DeleteApiKeyOutput, error)
- func (c *APIGateway) DeleteAuthorizer(input *DeleteAuthorizerInput) (*DeleteAuthorizerOutput, error)
- func (c *APIGateway) DeleteAuthorizerRequest(input *DeleteAuthorizerInput) (req *request.Request, output *DeleteAuthorizerOutput)
- func (c *APIGateway) DeleteAuthorizerWithContext(ctx aws.Context, input *DeleteAuthorizerInput, opts ...request.Option) (*DeleteAuthorizerOutput, error)
- func (c *APIGateway) DeleteBasePathMapping(input *DeleteBasePathMappingInput) (*DeleteBasePathMappingOutput, error)
- func (c *APIGateway) DeleteBasePathMappingRequest(input *DeleteBasePathMappingInput) (req *request.Request, output *DeleteBasePathMappingOutput)
- func (c *APIGateway) DeleteBasePathMappingWithContext(ctx aws.Context, input *DeleteBasePathMappingInput, opts ...request.Option) (*DeleteBasePathMappingOutput, error)
- func (c *APIGateway) DeleteClientCertificate(input *DeleteClientCertificateInput) (*DeleteClientCertificateOutput, error)
- func (c *APIGateway) DeleteClientCertificateRequest(input *DeleteClientCertificateInput) (req *request.Request, output *DeleteClientCertificateOutput)
- func (c *APIGateway) DeleteClientCertificateWithContext(ctx aws.Context, input *DeleteClientCertificateInput, opts ...request.Option) (*DeleteClientCertificateOutput, error)
- func (c *APIGateway) DeleteDeployment(input *DeleteDeploymentInput) (*DeleteDeploymentOutput, error)
- func (c *APIGateway) DeleteDeploymentRequest(input *DeleteDeploymentInput) (req *request.Request, output *DeleteDeploymentOutput)
- func (c *APIGateway) DeleteDeploymentWithContext(ctx aws.Context, input *DeleteDeploymentInput, opts ...request.Option) (*DeleteDeploymentOutput, error)
- func (c *APIGateway) DeleteDocumentationPart(input *DeleteDocumentationPartInput) (*DeleteDocumentationPartOutput, error)
- func (c *APIGateway) DeleteDocumentationPartRequest(input *DeleteDocumentationPartInput) (req *request.Request, output *DeleteDocumentationPartOutput)
- func (c *APIGateway) DeleteDocumentationPartWithContext(ctx aws.Context, input *DeleteDocumentationPartInput, opts ...request.Option) (*DeleteDocumentationPartOutput, error)
- func (c *APIGateway) DeleteDocumentationVersion(input *DeleteDocumentationVersionInput) (*DeleteDocumentationVersionOutput, error)
- func (c *APIGateway) DeleteDocumentationVersionRequest(input *DeleteDocumentationVersionInput) (req *request.Request, output *DeleteDocumentationVersionOutput)
- func (c *APIGateway) DeleteDocumentationVersionWithContext(ctx aws.Context, input *DeleteDocumentationVersionInput, ...) (*DeleteDocumentationVersionOutput, error)
- func (c *APIGateway) DeleteDomainName(input *DeleteDomainNameInput) (*DeleteDomainNameOutput, error)
- func (c *APIGateway) DeleteDomainNameRequest(input *DeleteDomainNameInput) (req *request.Request, output *DeleteDomainNameOutput)
- func (c *APIGateway) DeleteDomainNameWithContext(ctx aws.Context, input *DeleteDomainNameInput, opts ...request.Option) (*DeleteDomainNameOutput, error)
- func (c *APIGateway) DeleteGatewayResponse(input *DeleteGatewayResponseInput) (*DeleteGatewayResponseOutput, error)
- func (c *APIGateway) DeleteGatewayResponseRequest(input *DeleteGatewayResponseInput) (req *request.Request, output *DeleteGatewayResponseOutput)
- func (c *APIGateway) DeleteGatewayResponseWithContext(ctx aws.Context, input *DeleteGatewayResponseInput, opts ...request.Option) (*DeleteGatewayResponseOutput, error)
- func (c *APIGateway) DeleteIntegration(input *DeleteIntegrationInput) (*DeleteIntegrationOutput, error)
- func (c *APIGateway) DeleteIntegrationRequest(input *DeleteIntegrationInput) (req *request.Request, output *DeleteIntegrationOutput)
- func (c *APIGateway) DeleteIntegrationResponse(input *DeleteIntegrationResponseInput) (*DeleteIntegrationResponseOutput, error)
- func (c *APIGateway) DeleteIntegrationResponseRequest(input *DeleteIntegrationResponseInput) (req *request.Request, output *DeleteIntegrationResponseOutput)
- func (c *APIGateway) DeleteIntegrationResponseWithContext(ctx aws.Context, input *DeleteIntegrationResponseInput, opts ...request.Option) (*DeleteIntegrationResponseOutput, error)
- func (c *APIGateway) DeleteIntegrationWithContext(ctx aws.Context, input *DeleteIntegrationInput, opts ...request.Option) (*DeleteIntegrationOutput, error)
- func (c *APIGateway) DeleteMethod(input *DeleteMethodInput) (*DeleteMethodOutput, error)
- func (c *APIGateway) DeleteMethodRequest(input *DeleteMethodInput) (req *request.Request, output *DeleteMethodOutput)
- func (c *APIGateway) DeleteMethodResponse(input *DeleteMethodResponseInput) (*DeleteMethodResponseOutput, error)
- func (c *APIGateway) DeleteMethodResponseRequest(input *DeleteMethodResponseInput) (req *request.Request, output *DeleteMethodResponseOutput)
- func (c *APIGateway) DeleteMethodResponseWithContext(ctx aws.Context, input *DeleteMethodResponseInput, opts ...request.Option) (*DeleteMethodResponseOutput, error)
- func (c *APIGateway) DeleteMethodWithContext(ctx aws.Context, input *DeleteMethodInput, opts ...request.Option) (*DeleteMethodOutput, error)
- func (c *APIGateway) DeleteModel(input *DeleteModelInput) (*DeleteModelOutput, error)
- func (c *APIGateway) DeleteModelRequest(input *DeleteModelInput) (req *request.Request, output *DeleteModelOutput)
- func (c *APIGateway) DeleteModelWithContext(ctx aws.Context, input *DeleteModelInput, opts ...request.Option) (*DeleteModelOutput, error)
- func (c *APIGateway) DeleteRequestValidator(input *DeleteRequestValidatorInput) (*DeleteRequestValidatorOutput, error)
- func (c *APIGateway) DeleteRequestValidatorRequest(input *DeleteRequestValidatorInput) (req *request.Request, output *DeleteRequestValidatorOutput)
- func (c *APIGateway) DeleteRequestValidatorWithContext(ctx aws.Context, input *DeleteRequestValidatorInput, opts ...request.Option) (*DeleteRequestValidatorOutput, error)
- func (c *APIGateway) DeleteResource(input *DeleteResourceInput) (*DeleteResourceOutput, error)
- func (c *APIGateway) DeleteResourceRequest(input *DeleteResourceInput) (req *request.Request, output *DeleteResourceOutput)
- func (c *APIGateway) DeleteResourceWithContext(ctx aws.Context, input *DeleteResourceInput, opts ...request.Option) (*DeleteResourceOutput, error)
- func (c *APIGateway) DeleteRestApi(input *DeleteRestApiInput) (*DeleteRestApiOutput, error)
- func (c *APIGateway) DeleteRestApiRequest(input *DeleteRestApiInput) (req *request.Request, output *DeleteRestApiOutput)
- func (c *APIGateway) DeleteRestApiWithContext(ctx aws.Context, input *DeleteRestApiInput, opts ...request.Option) (*DeleteRestApiOutput, error)
- func (c *APIGateway) DeleteStage(input *DeleteStageInput) (*DeleteStageOutput, error)
- func (c *APIGateway) DeleteStageRequest(input *DeleteStageInput) (req *request.Request, output *DeleteStageOutput)
- func (c *APIGateway) DeleteStageWithContext(ctx aws.Context, input *DeleteStageInput, opts ...request.Option) (*DeleteStageOutput, error)
- func (c *APIGateway) DeleteUsagePlan(input *DeleteUsagePlanInput) (*DeleteUsagePlanOutput, error)
- func (c *APIGateway) DeleteUsagePlanKey(input *DeleteUsagePlanKeyInput) (*DeleteUsagePlanKeyOutput, error)
- func (c *APIGateway) DeleteUsagePlanKeyRequest(input *DeleteUsagePlanKeyInput) (req *request.Request, output *DeleteUsagePlanKeyOutput)
- func (c *APIGateway) DeleteUsagePlanKeyWithContext(ctx aws.Context, input *DeleteUsagePlanKeyInput, opts ...request.Option) (*DeleteUsagePlanKeyOutput, error)
- func (c *APIGateway) DeleteUsagePlanRequest(input *DeleteUsagePlanInput) (req *request.Request, output *DeleteUsagePlanOutput)
- func (c *APIGateway) DeleteUsagePlanWithContext(ctx aws.Context, input *DeleteUsagePlanInput, opts ...request.Option) (*DeleteUsagePlanOutput, error)
- func (c *APIGateway) FlushStageAuthorizersCache(input *FlushStageAuthorizersCacheInput) (*FlushStageAuthorizersCacheOutput, error)
- func (c *APIGateway) FlushStageAuthorizersCacheRequest(input *FlushStageAuthorizersCacheInput) (req *request.Request, output *FlushStageAuthorizersCacheOutput)
- func (c *APIGateway) FlushStageAuthorizersCacheWithContext(ctx aws.Context, input *FlushStageAuthorizersCacheInput, ...) (*FlushStageAuthorizersCacheOutput, error)
- func (c *APIGateway) FlushStageCache(input *FlushStageCacheInput) (*FlushStageCacheOutput, error)
- func (c *APIGateway) FlushStageCacheRequest(input *FlushStageCacheInput) (req *request.Request, output *FlushStageCacheOutput)
- func (c *APIGateway) FlushStageCacheWithContext(ctx aws.Context, input *FlushStageCacheInput, opts ...request.Option) (*FlushStageCacheOutput, error)
- func (c *APIGateway) GenerateClientCertificate(input *GenerateClientCertificateInput) (*ClientCertificate, error)
- func (c *APIGateway) GenerateClientCertificateRequest(input *GenerateClientCertificateInput) (req *request.Request, output *ClientCertificate)
- func (c *APIGateway) GenerateClientCertificateWithContext(ctx aws.Context, input *GenerateClientCertificateInput, opts ...request.Option) (*ClientCertificate, error)
- func (c *APIGateway) GetAccount(input *GetAccountInput) (*Account, error)
- func (c *APIGateway) GetAccountRequest(input *GetAccountInput) (req *request.Request, output *Account)
- func (c *APIGateway) GetAccountWithContext(ctx aws.Context, input *GetAccountInput, opts ...request.Option) (*Account, error)
- func (c *APIGateway) GetApiKey(input *GetApiKeyInput) (*ApiKey, error)
- func (c *APIGateway) GetApiKeyRequest(input *GetApiKeyInput) (req *request.Request, output *ApiKey)
- func (c *APIGateway) GetApiKeyWithContext(ctx aws.Context, input *GetApiKeyInput, opts ...request.Option) (*ApiKey, error)
- func (c *APIGateway) GetApiKeys(input *GetApiKeysInput) (*GetApiKeysOutput, error)
- func (c *APIGateway) GetApiKeysPages(input *GetApiKeysInput, fn func(*GetApiKeysOutput, bool) bool) error
- func (c *APIGateway) GetApiKeysPagesWithContext(ctx aws.Context, input *GetApiKeysInput, fn func(*GetApiKeysOutput, bool) bool, ...) error
- func (c *APIGateway) GetApiKeysRequest(input *GetApiKeysInput) (req *request.Request, output *GetApiKeysOutput)
- func (c *APIGateway) GetApiKeysWithContext(ctx aws.Context, input *GetApiKeysInput, opts ...request.Option) (*GetApiKeysOutput, error)
- func (c *APIGateway) GetAuthorizer(input *GetAuthorizerInput) (*Authorizer, error)
- func (c *APIGateway) GetAuthorizerRequest(input *GetAuthorizerInput) (req *request.Request, output *Authorizer)
- func (c *APIGateway) GetAuthorizerWithContext(ctx aws.Context, input *GetAuthorizerInput, opts ...request.Option) (*Authorizer, error)
- func (c *APIGateway) GetAuthorizers(input *GetAuthorizersInput) (*GetAuthorizersOutput, error)
- func (c *APIGateway) GetAuthorizersRequest(input *GetAuthorizersInput) (req *request.Request, output *GetAuthorizersOutput)
- func (c *APIGateway) GetAuthorizersWithContext(ctx aws.Context, input *GetAuthorizersInput, opts ...request.Option) (*GetAuthorizersOutput, error)
- func (c *APIGateway) GetBasePathMapping(input *GetBasePathMappingInput) (*BasePathMapping, error)
- func (c *APIGateway) GetBasePathMappingRequest(input *GetBasePathMappingInput) (req *request.Request, output *BasePathMapping)
- func (c *APIGateway) GetBasePathMappingWithContext(ctx aws.Context, input *GetBasePathMappingInput, opts ...request.Option) (*BasePathMapping, error)
- func (c *APIGateway) GetBasePathMappings(input *GetBasePathMappingsInput) (*GetBasePathMappingsOutput, error)
- func (c *APIGateway) GetBasePathMappingsPages(input *GetBasePathMappingsInput, ...) error
- func (c *APIGateway) GetBasePathMappingsPagesWithContext(ctx aws.Context, input *GetBasePathMappingsInput, ...) error
- func (c *APIGateway) GetBasePathMappingsRequest(input *GetBasePathMappingsInput) (req *request.Request, output *GetBasePathMappingsOutput)
- func (c *APIGateway) GetBasePathMappingsWithContext(ctx aws.Context, input *GetBasePathMappingsInput, opts ...request.Option) (*GetBasePathMappingsOutput, error)
- func (c *APIGateway) GetClientCertificate(input *GetClientCertificateInput) (*ClientCertificate, error)
- func (c *APIGateway) GetClientCertificateRequest(input *GetClientCertificateInput) (req *request.Request, output *ClientCertificate)
- func (c *APIGateway) GetClientCertificateWithContext(ctx aws.Context, input *GetClientCertificateInput, opts ...request.Option) (*ClientCertificate, error)
- func (c *APIGateway) GetClientCertificates(input *GetClientCertificatesInput) (*GetClientCertificatesOutput, error)
- func (c *APIGateway) GetClientCertificatesPages(input *GetClientCertificatesInput, ...) error
- func (c *APIGateway) GetClientCertificatesPagesWithContext(ctx aws.Context, input *GetClientCertificatesInput, ...) error
- func (c *APIGateway) GetClientCertificatesRequest(input *GetClientCertificatesInput) (req *request.Request, output *GetClientCertificatesOutput)
- func (c *APIGateway) GetClientCertificatesWithContext(ctx aws.Context, input *GetClientCertificatesInput, opts ...request.Option) (*GetClientCertificatesOutput, error)
- func (c *APIGateway) GetDeployment(input *GetDeploymentInput) (*Deployment, error)
- func (c *APIGateway) GetDeploymentRequest(input *GetDeploymentInput) (req *request.Request, output *Deployment)
- func (c *APIGateway) GetDeploymentWithContext(ctx aws.Context, input *GetDeploymentInput, opts ...request.Option) (*Deployment, error)
- func (c *APIGateway) GetDeployments(input *GetDeploymentsInput) (*GetDeploymentsOutput, error)
- func (c *APIGateway) GetDeploymentsPages(input *GetDeploymentsInput, fn func(*GetDeploymentsOutput, bool) bool) error
- func (c *APIGateway) GetDeploymentsPagesWithContext(ctx aws.Context, input *GetDeploymentsInput, ...) error
- func (c *APIGateway) GetDeploymentsRequest(input *GetDeploymentsInput) (req *request.Request, output *GetDeploymentsOutput)
- func (c *APIGateway) GetDeploymentsWithContext(ctx aws.Context, input *GetDeploymentsInput, opts ...request.Option) (*GetDeploymentsOutput, error)
- func (c *APIGateway) GetDocumentationPart(input *GetDocumentationPartInput) (*DocumentationPart, error)
- func (c *APIGateway) GetDocumentationPartRequest(input *GetDocumentationPartInput) (req *request.Request, output *DocumentationPart)
- func (c *APIGateway) GetDocumentationPartWithContext(ctx aws.Context, input *GetDocumentationPartInput, opts ...request.Option) (*DocumentationPart, error)
- func (c *APIGateway) GetDocumentationParts(input *GetDocumentationPartsInput) (*GetDocumentationPartsOutput, error)
- func (c *APIGateway) GetDocumentationPartsRequest(input *GetDocumentationPartsInput) (req *request.Request, output *GetDocumentationPartsOutput)
- func (c *APIGateway) GetDocumentationPartsWithContext(ctx aws.Context, input *GetDocumentationPartsInput, opts ...request.Option) (*GetDocumentationPartsOutput, error)
- func (c *APIGateway) GetDocumentationVersion(input *GetDocumentationVersionInput) (*DocumentationVersion, error)
- func (c *APIGateway) GetDocumentationVersionRequest(input *GetDocumentationVersionInput) (req *request.Request, output *DocumentationVersion)
- func (c *APIGateway) GetDocumentationVersionWithContext(ctx aws.Context, input *GetDocumentationVersionInput, opts ...request.Option) (*DocumentationVersion, error)
- func (c *APIGateway) GetDocumentationVersions(input *GetDocumentationVersionsInput) (*GetDocumentationVersionsOutput, error)
- func (c *APIGateway) GetDocumentationVersionsRequest(input *GetDocumentationVersionsInput) (req *request.Request, output *GetDocumentationVersionsOutput)
- func (c *APIGateway) GetDocumentationVersionsWithContext(ctx aws.Context, input *GetDocumentationVersionsInput, opts ...request.Option) (*GetDocumentationVersionsOutput, error)
- func (c *APIGateway) GetDomainName(input *GetDomainNameInput) (*DomainName, error)
- func (c *APIGateway) GetDomainNameRequest(input *GetDomainNameInput) (req *request.Request, output *DomainName)
- func (c *APIGateway) GetDomainNameWithContext(ctx aws.Context, input *GetDomainNameInput, opts ...request.Option) (*DomainName, error)
- func (c *APIGateway) GetDomainNames(input *GetDomainNamesInput) (*GetDomainNamesOutput, error)
- func (c *APIGateway) GetDomainNamesPages(input *GetDomainNamesInput, fn func(*GetDomainNamesOutput, bool) bool) error
- func (c *APIGateway) GetDomainNamesPagesWithContext(ctx aws.Context, input *GetDomainNamesInput, ...) error
- func (c *APIGateway) GetDomainNamesRequest(input *GetDomainNamesInput) (req *request.Request, output *GetDomainNamesOutput)
- func (c *APIGateway) GetDomainNamesWithContext(ctx aws.Context, input *GetDomainNamesInput, opts ...request.Option) (*GetDomainNamesOutput, error)
- func (c *APIGateway) GetExport(input *GetExportInput) (*GetExportOutput, error)
- func (c *APIGateway) GetExportRequest(input *GetExportInput) (req *request.Request, output *GetExportOutput)
- func (c *APIGateway) GetExportWithContext(ctx aws.Context, input *GetExportInput, opts ...request.Option) (*GetExportOutput, error)
- func (c *APIGateway) GetGatewayResponse(input *GetGatewayResponseInput) (*UpdateGatewayResponseOutput, error)
- func (c *APIGateway) GetGatewayResponseRequest(input *GetGatewayResponseInput) (req *request.Request, output *UpdateGatewayResponseOutput)
- func (c *APIGateway) GetGatewayResponseWithContext(ctx aws.Context, input *GetGatewayResponseInput, opts ...request.Option) (*UpdateGatewayResponseOutput, error)
- func (c *APIGateway) GetGatewayResponses(input *GetGatewayResponsesInput) (*GetGatewayResponsesOutput, error)
- func (c *APIGateway) GetGatewayResponsesRequest(input *GetGatewayResponsesInput) (req *request.Request, output *GetGatewayResponsesOutput)
- func (c *APIGateway) GetGatewayResponsesWithContext(ctx aws.Context, input *GetGatewayResponsesInput, opts ...request.Option) (*GetGatewayResponsesOutput, error)
- func (c *APIGateway) GetIntegration(input *GetIntegrationInput) (*Integration, error)
- func (c *APIGateway) GetIntegrationRequest(input *GetIntegrationInput) (req *request.Request, output *Integration)
- func (c *APIGateway) GetIntegrationResponse(input *GetIntegrationResponseInput) (*IntegrationResponse, error)
- func (c *APIGateway) GetIntegrationResponseRequest(input *GetIntegrationResponseInput) (req *request.Request, output *IntegrationResponse)
- func (c *APIGateway) GetIntegrationResponseWithContext(ctx aws.Context, input *GetIntegrationResponseInput, opts ...request.Option) (*IntegrationResponse, error)
- func (c *APIGateway) GetIntegrationWithContext(ctx aws.Context, input *GetIntegrationInput, opts ...request.Option) (*Integration, error)
- func (c *APIGateway) GetMethod(input *GetMethodInput) (*Method, error)
- func (c *APIGateway) GetMethodRequest(input *GetMethodInput) (req *request.Request, output *Method)
- func (c *APIGateway) GetMethodResponse(input *GetMethodResponseInput) (*MethodResponse, error)
- func (c *APIGateway) GetMethodResponseRequest(input *GetMethodResponseInput) (req *request.Request, output *MethodResponse)
- func (c *APIGateway) GetMethodResponseWithContext(ctx aws.Context, input *GetMethodResponseInput, opts ...request.Option) (*MethodResponse, error)
- func (c *APIGateway) GetMethodWithContext(ctx aws.Context, input *GetMethodInput, opts ...request.Option) (*Method, error)
- func (c *APIGateway) GetModel(input *GetModelInput) (*Model, error)
- func (c *APIGateway) GetModelRequest(input *GetModelInput) (req *request.Request, output *Model)
- func (c *APIGateway) GetModelTemplate(input *GetModelTemplateInput) (*GetModelTemplateOutput, error)
- func (c *APIGateway) GetModelTemplateRequest(input *GetModelTemplateInput) (req *request.Request, output *GetModelTemplateOutput)
- func (c *APIGateway) GetModelTemplateWithContext(ctx aws.Context, input *GetModelTemplateInput, opts ...request.Option) (*GetModelTemplateOutput, error)
- func (c *APIGateway) GetModelWithContext(ctx aws.Context, input *GetModelInput, opts ...request.Option) (*Model, error)
- func (c *APIGateway) GetModels(input *GetModelsInput) (*GetModelsOutput, error)
- func (c *APIGateway) GetModelsPages(input *GetModelsInput, fn func(*GetModelsOutput, bool) bool) error
- func (c *APIGateway) GetModelsPagesWithContext(ctx aws.Context, input *GetModelsInput, fn func(*GetModelsOutput, bool) bool, ...) error
- func (c *APIGateway) GetModelsRequest(input *GetModelsInput) (req *request.Request, output *GetModelsOutput)
- func (c *APIGateway) GetModelsWithContext(ctx aws.Context, input *GetModelsInput, opts ...request.Option) (*GetModelsOutput, error)
- func (c *APIGateway) GetRequestValidator(input *GetRequestValidatorInput) (*UpdateRequestValidatorOutput, error)
- func (c *APIGateway) GetRequestValidatorRequest(input *GetRequestValidatorInput) (req *request.Request, output *UpdateRequestValidatorOutput)
- func (c *APIGateway) GetRequestValidatorWithContext(ctx aws.Context, input *GetRequestValidatorInput, opts ...request.Option) (*UpdateRequestValidatorOutput, error)
- func (c *APIGateway) GetRequestValidators(input *GetRequestValidatorsInput) (*GetRequestValidatorsOutput, error)
- func (c *APIGateway) GetRequestValidatorsRequest(input *GetRequestValidatorsInput) (req *request.Request, output *GetRequestValidatorsOutput)
- func (c *APIGateway) GetRequestValidatorsWithContext(ctx aws.Context, input *GetRequestValidatorsInput, opts ...request.Option) (*GetRequestValidatorsOutput, error)
- func (c *APIGateway) GetResource(input *GetResourceInput) (*Resource, error)
- func (c *APIGateway) GetResourceRequest(input *GetResourceInput) (req *request.Request, output *Resource)
- func (c *APIGateway) GetResourceWithContext(ctx aws.Context, input *GetResourceInput, opts ...request.Option) (*Resource, error)
- func (c *APIGateway) GetResources(input *GetResourcesInput) (*GetResourcesOutput, error)
- func (c *APIGateway) GetResourcesPages(input *GetResourcesInput, fn func(*GetResourcesOutput, bool) bool) error
- func (c *APIGateway) GetResourcesPagesWithContext(ctx aws.Context, input *GetResourcesInput, ...) error
- func (c *APIGateway) GetResourcesRequest(input *GetResourcesInput) (req *request.Request, output *GetResourcesOutput)
- func (c *APIGateway) GetResourcesWithContext(ctx aws.Context, input *GetResourcesInput, opts ...request.Option) (*GetResourcesOutput, error)
- func (c *APIGateway) GetRestApi(input *GetRestApiInput) (*RestApi, error)
- func (c *APIGateway) GetRestApiRequest(input *GetRestApiInput) (req *request.Request, output *RestApi)
- func (c *APIGateway) GetRestApiWithContext(ctx aws.Context, input *GetRestApiInput, opts ...request.Option) (*RestApi, error)
- func (c *APIGateway) GetRestApis(input *GetRestApisInput) (*GetRestApisOutput, error)
- func (c *APIGateway) GetRestApisPages(input *GetRestApisInput, fn func(*GetRestApisOutput, bool) bool) error
- func (c *APIGateway) GetRestApisPagesWithContext(ctx aws.Context, input *GetRestApisInput, ...) error
- func (c *APIGateway) GetRestApisRequest(input *GetRestApisInput) (req *request.Request, output *GetRestApisOutput)
- func (c *APIGateway) GetRestApisWithContext(ctx aws.Context, input *GetRestApisInput, opts ...request.Option) (*GetRestApisOutput, error)
- func (c *APIGateway) GetSdk(input *GetSdkInput) (*GetSdkOutput, error)
- func (c *APIGateway) GetSdkRequest(input *GetSdkInput) (req *request.Request, output *GetSdkOutput)
- func (c *APIGateway) GetSdkType(input *GetSdkTypeInput) (*SdkType, error)
- func (c *APIGateway) GetSdkTypeRequest(input *GetSdkTypeInput) (req *request.Request, output *SdkType)
- func (c *APIGateway) GetSdkTypeWithContext(ctx aws.Context, input *GetSdkTypeInput, opts ...request.Option) (*SdkType, error)
- func (c *APIGateway) GetSdkTypes(input *GetSdkTypesInput) (*GetSdkTypesOutput, error)
- func (c *APIGateway) GetSdkTypesRequest(input *GetSdkTypesInput) (req *request.Request, output *GetSdkTypesOutput)
- func (c *APIGateway) GetSdkTypesWithContext(ctx aws.Context, input *GetSdkTypesInput, opts ...request.Option) (*GetSdkTypesOutput, error)
- func (c *APIGateway) GetSdkWithContext(ctx aws.Context, input *GetSdkInput, opts ...request.Option) (*GetSdkOutput, error)
- func (c *APIGateway) GetStage(input *GetStageInput) (*Stage, error)
- func (c *APIGateway) GetStageRequest(input *GetStageInput) (req *request.Request, output *Stage)
- func (c *APIGateway) GetStageWithContext(ctx aws.Context, input *GetStageInput, opts ...request.Option) (*Stage, error)
- func (c *APIGateway) GetStages(input *GetStagesInput) (*GetStagesOutput, error)
- func (c *APIGateway) GetStagesRequest(input *GetStagesInput) (req *request.Request, output *GetStagesOutput)
- func (c *APIGateway) GetStagesWithContext(ctx aws.Context, input *GetStagesInput, opts ...request.Option) (*GetStagesOutput, error)
- func (c *APIGateway) GetUsage(input *GetUsageInput) (*Usage, error)
- func (c *APIGateway) GetUsagePages(input *GetUsageInput, fn func(*Usage, bool) bool) error
- func (c *APIGateway) GetUsagePagesWithContext(ctx aws.Context, input *GetUsageInput, fn func(*Usage, bool) bool, ...) error
- func (c *APIGateway) GetUsagePlan(input *GetUsagePlanInput) (*UsagePlan, error)
- func (c *APIGateway) GetUsagePlanKey(input *GetUsagePlanKeyInput) (*UsagePlanKey, error)
- func (c *APIGateway) GetUsagePlanKeyRequest(input *GetUsagePlanKeyInput) (req *request.Request, output *UsagePlanKey)
- func (c *APIGateway) GetUsagePlanKeyWithContext(ctx aws.Context, input *GetUsagePlanKeyInput, opts ...request.Option) (*UsagePlanKey, error)
- func (c *APIGateway) GetUsagePlanKeys(input *GetUsagePlanKeysInput) (*GetUsagePlanKeysOutput, error)
- func (c *APIGateway) GetUsagePlanKeysPages(input *GetUsagePlanKeysInput, fn func(*GetUsagePlanKeysOutput, bool) bool) error
- func (c *APIGateway) GetUsagePlanKeysPagesWithContext(ctx aws.Context, input *GetUsagePlanKeysInput, ...) error
- func (c *APIGateway) GetUsagePlanKeysRequest(input *GetUsagePlanKeysInput) (req *request.Request, output *GetUsagePlanKeysOutput)
- func (c *APIGateway) GetUsagePlanKeysWithContext(ctx aws.Context, input *GetUsagePlanKeysInput, opts ...request.Option) (*GetUsagePlanKeysOutput, error)
- func (c *APIGateway) GetUsagePlanRequest(input *GetUsagePlanInput) (req *request.Request, output *UsagePlan)
- func (c *APIGateway) GetUsagePlanWithContext(ctx aws.Context, input *GetUsagePlanInput, opts ...request.Option) (*UsagePlan, error)
- func (c *APIGateway) GetUsagePlans(input *GetUsagePlansInput) (*GetUsagePlansOutput, error)
- func (c *APIGateway) GetUsagePlansPages(input *GetUsagePlansInput, fn func(*GetUsagePlansOutput, bool) bool) error
- func (c *APIGateway) GetUsagePlansPagesWithContext(ctx aws.Context, input *GetUsagePlansInput, ...) error
- func (c *APIGateway) GetUsagePlansRequest(input *GetUsagePlansInput) (req *request.Request, output *GetUsagePlansOutput)
- func (c *APIGateway) GetUsagePlansWithContext(ctx aws.Context, input *GetUsagePlansInput, opts ...request.Option) (*GetUsagePlansOutput, error)
- func (c *APIGateway) GetUsageRequest(input *GetUsageInput) (req *request.Request, output *Usage)
- func (c *APIGateway) GetUsageWithContext(ctx aws.Context, input *GetUsageInput, opts ...request.Option) (*Usage, error)
- func (c *APIGateway) ImportApiKeys(input *ImportApiKeysInput) (*ImportApiKeysOutput, error)
- func (c *APIGateway) ImportApiKeysRequest(input *ImportApiKeysInput) (req *request.Request, output *ImportApiKeysOutput)
- func (c *APIGateway) ImportApiKeysWithContext(ctx aws.Context, input *ImportApiKeysInput, opts ...request.Option) (*ImportApiKeysOutput, error)
- func (c *APIGateway) ImportDocumentationParts(input *ImportDocumentationPartsInput) (*ImportDocumentationPartsOutput, error)
- func (c *APIGateway) ImportDocumentationPartsRequest(input *ImportDocumentationPartsInput) (req *request.Request, output *ImportDocumentationPartsOutput)
- func (c *APIGateway) ImportDocumentationPartsWithContext(ctx aws.Context, input *ImportDocumentationPartsInput, opts ...request.Option) (*ImportDocumentationPartsOutput, error)
- func (c *APIGateway) ImportRestApi(input *ImportRestApiInput) (*RestApi, error)
- func (c *APIGateway) ImportRestApiRequest(input *ImportRestApiInput) (req *request.Request, output *RestApi)
- func (c *APIGateway) ImportRestApiWithContext(ctx aws.Context, input *ImportRestApiInput, opts ...request.Option) (*RestApi, error)
- func (c *APIGateway) PutGatewayResponse(input *PutGatewayResponseInput) (*UpdateGatewayResponseOutput, error)
- func (c *APIGateway) PutGatewayResponseRequest(input *PutGatewayResponseInput) (req *request.Request, output *UpdateGatewayResponseOutput)
- func (c *APIGateway) PutGatewayResponseWithContext(ctx aws.Context, input *PutGatewayResponseInput, opts ...request.Option) (*UpdateGatewayResponseOutput, error)
- func (c *APIGateway) PutIntegration(input *PutIntegrationInput) (*Integration, error)
- func (c *APIGateway) PutIntegrationRequest(input *PutIntegrationInput) (req *request.Request, output *Integration)
- func (c *APIGateway) PutIntegrationResponse(input *PutIntegrationResponseInput) (*IntegrationResponse, error)
- func (c *APIGateway) PutIntegrationResponseRequest(input *PutIntegrationResponseInput) (req *request.Request, output *IntegrationResponse)
- func (c *APIGateway) PutIntegrationResponseWithContext(ctx aws.Context, input *PutIntegrationResponseInput, opts ...request.Option) (*IntegrationResponse, error)
- func (c *APIGateway) PutIntegrationWithContext(ctx aws.Context, input *PutIntegrationInput, opts ...request.Option) (*Integration, error)
- func (c *APIGateway) PutMethod(input *PutMethodInput) (*Method, error)
- func (c *APIGateway) PutMethodRequest(input *PutMethodInput) (req *request.Request, output *Method)
- func (c *APIGateway) PutMethodResponse(input *PutMethodResponseInput) (*MethodResponse, error)
- func (c *APIGateway) PutMethodResponseRequest(input *PutMethodResponseInput) (req *request.Request, output *MethodResponse)
- func (c *APIGateway) PutMethodResponseWithContext(ctx aws.Context, input *PutMethodResponseInput, opts ...request.Option) (*MethodResponse, error)
- func (c *APIGateway) PutMethodWithContext(ctx aws.Context, input *PutMethodInput, opts ...request.Option) (*Method, error)
- func (c *APIGateway) PutRestApi(input *PutRestApiInput) (*RestApi, error)
- func (c *APIGateway) PutRestApiRequest(input *PutRestApiInput) (req *request.Request, output *RestApi)
- func (c *APIGateway) PutRestApiWithContext(ctx aws.Context, input *PutRestApiInput, opts ...request.Option) (*RestApi, error)
- func (c *APIGateway) TestInvokeAuthorizer(input *TestInvokeAuthorizerInput) (*TestInvokeAuthorizerOutput, error)
- func (c *APIGateway) TestInvokeAuthorizerRequest(input *TestInvokeAuthorizerInput) (req *request.Request, output *TestInvokeAuthorizerOutput)
- func (c *APIGateway) TestInvokeAuthorizerWithContext(ctx aws.Context, input *TestInvokeAuthorizerInput, opts ...request.Option) (*TestInvokeAuthorizerOutput, error)
- func (c *APIGateway) TestInvokeMethod(input *TestInvokeMethodInput) (*TestInvokeMethodOutput, error)
- func (c *APIGateway) TestInvokeMethodRequest(input *TestInvokeMethodInput) (req *request.Request, output *TestInvokeMethodOutput)
- func (c *APIGateway) TestInvokeMethodWithContext(ctx aws.Context, input *TestInvokeMethodInput, opts ...request.Option) (*TestInvokeMethodOutput, error)
- func (c *APIGateway) UpdateAccount(input *UpdateAccountInput) (*Account, error)
- func (c *APIGateway) UpdateAccountRequest(input *UpdateAccountInput) (req *request.Request, output *Account)
- func (c *APIGateway) UpdateAccountWithContext(ctx aws.Context, input *UpdateAccountInput, opts ...request.Option) (*Account, error)
- func (c *APIGateway) UpdateApiKey(input *UpdateApiKeyInput) (*ApiKey, error)
- func (c *APIGateway) UpdateApiKeyRequest(input *UpdateApiKeyInput) (req *request.Request, output *ApiKey)
- func (c *APIGateway) UpdateApiKeyWithContext(ctx aws.Context, input *UpdateApiKeyInput, opts ...request.Option) (*ApiKey, error)
- func (c *APIGateway) UpdateAuthorizer(input *UpdateAuthorizerInput) (*Authorizer, error)
- func (c *APIGateway) UpdateAuthorizerRequest(input *UpdateAuthorizerInput) (req *request.Request, output *Authorizer)
- func (c *APIGateway) UpdateAuthorizerWithContext(ctx aws.Context, input *UpdateAuthorizerInput, opts ...request.Option) (*Authorizer, error)
- func (c *APIGateway) UpdateBasePathMapping(input *UpdateBasePathMappingInput) (*BasePathMapping, error)
- func (c *APIGateway) UpdateBasePathMappingRequest(input *UpdateBasePathMappingInput) (req *request.Request, output *BasePathMapping)
- func (c *APIGateway) UpdateBasePathMappingWithContext(ctx aws.Context, input *UpdateBasePathMappingInput, opts ...request.Option) (*BasePathMapping, error)
- func (c *APIGateway) UpdateClientCertificate(input *UpdateClientCertificateInput) (*ClientCertificate, error)
- func (c *APIGateway) UpdateClientCertificateRequest(input *UpdateClientCertificateInput) (req *request.Request, output *ClientCertificate)
- func (c *APIGateway) UpdateClientCertificateWithContext(ctx aws.Context, input *UpdateClientCertificateInput, opts ...request.Option) (*ClientCertificate, error)
- func (c *APIGateway) UpdateDeployment(input *UpdateDeploymentInput) (*Deployment, error)
- func (c *APIGateway) UpdateDeploymentRequest(input *UpdateDeploymentInput) (req *request.Request, output *Deployment)
- func (c *APIGateway) UpdateDeploymentWithContext(ctx aws.Context, input *UpdateDeploymentInput, opts ...request.Option) (*Deployment, error)
- func (c *APIGateway) UpdateDocumentationPart(input *UpdateDocumentationPartInput) (*DocumentationPart, error)
- func (c *APIGateway) UpdateDocumentationPartRequest(input *UpdateDocumentationPartInput) (req *request.Request, output *DocumentationPart)
- func (c *APIGateway) UpdateDocumentationPartWithContext(ctx aws.Context, input *UpdateDocumentationPartInput, opts ...request.Option) (*DocumentationPart, error)
- func (c *APIGateway) UpdateDocumentationVersion(input *UpdateDocumentationVersionInput) (*DocumentationVersion, error)
- func (c *APIGateway) UpdateDocumentationVersionRequest(input *UpdateDocumentationVersionInput) (req *request.Request, output *DocumentationVersion)
- func (c *APIGateway) UpdateDocumentationVersionWithContext(ctx aws.Context, input *UpdateDocumentationVersionInput, ...) (*DocumentationVersion, error)
- func (c *APIGateway) UpdateDomainName(input *UpdateDomainNameInput) (*DomainName, error)
- func (c *APIGateway) UpdateDomainNameRequest(input *UpdateDomainNameInput) (req *request.Request, output *DomainName)
- func (c *APIGateway) UpdateDomainNameWithContext(ctx aws.Context, input *UpdateDomainNameInput, opts ...request.Option) (*DomainName, error)
- func (c *APIGateway) UpdateGatewayResponse(input *UpdateGatewayResponseInput) (*UpdateGatewayResponseOutput, error)
- func (c *APIGateway) UpdateGatewayResponseRequest(input *UpdateGatewayResponseInput) (req *request.Request, output *UpdateGatewayResponseOutput)
- func (c *APIGateway) UpdateGatewayResponseWithContext(ctx aws.Context, input *UpdateGatewayResponseInput, opts ...request.Option) (*UpdateGatewayResponseOutput, error)
- func (c *APIGateway) UpdateIntegration(input *UpdateIntegrationInput) (*Integration, error)
- func (c *APIGateway) UpdateIntegrationRequest(input *UpdateIntegrationInput) (req *request.Request, output *Integration)
- func (c *APIGateway) UpdateIntegrationResponse(input *UpdateIntegrationResponseInput) (*IntegrationResponse, error)
- func (c *APIGateway) UpdateIntegrationResponseRequest(input *UpdateIntegrationResponseInput) (req *request.Request, output *IntegrationResponse)
- func (c *APIGateway) UpdateIntegrationResponseWithContext(ctx aws.Context, input *UpdateIntegrationResponseInput, opts ...request.Option) (*IntegrationResponse, error)
- func (c *APIGateway) UpdateIntegrationWithContext(ctx aws.Context, input *UpdateIntegrationInput, opts ...request.Option) (*Integration, error)
- func (c *APIGateway) UpdateMethod(input *UpdateMethodInput) (*Method, error)
- func (c *APIGateway) UpdateMethodRequest(input *UpdateMethodInput) (req *request.Request, output *Method)
- func (c *APIGateway) UpdateMethodResponse(input *UpdateMethodResponseInput) (*MethodResponse, error)
- func (c *APIGateway) UpdateMethodResponseRequest(input *UpdateMethodResponseInput) (req *request.Request, output *MethodResponse)
- func (c *APIGateway) UpdateMethodResponseWithContext(ctx aws.Context, input *UpdateMethodResponseInput, opts ...request.Option) (*MethodResponse, error)
- func (c *APIGateway) UpdateMethodWithContext(ctx aws.Context, input *UpdateMethodInput, opts ...request.Option) (*Method, error)
- func (c *APIGateway) UpdateModel(input *UpdateModelInput) (*Model, error)
- func (c *APIGateway) UpdateModelRequest(input *UpdateModelInput) (req *request.Request, output *Model)
- func (c *APIGateway) UpdateModelWithContext(ctx aws.Context, input *UpdateModelInput, opts ...request.Option) (*Model, error)
- func (c *APIGateway) UpdateRequestValidator(input *UpdateRequestValidatorInput) (*UpdateRequestValidatorOutput, error)
- func (c *APIGateway) UpdateRequestValidatorRequest(input *UpdateRequestValidatorInput) (req *request.Request, output *UpdateRequestValidatorOutput)
- func (c *APIGateway) UpdateRequestValidatorWithContext(ctx aws.Context, input *UpdateRequestValidatorInput, opts ...request.Option) (*UpdateRequestValidatorOutput, error)
- func (c *APIGateway) UpdateResource(input *UpdateResourceInput) (*Resource, error)
- func (c *APIGateway) UpdateResourceRequest(input *UpdateResourceInput) (req *request.Request, output *Resource)
- func (c *APIGateway) UpdateResourceWithContext(ctx aws.Context, input *UpdateResourceInput, opts ...request.Option) (*Resource, error)
- func (c *APIGateway) UpdateRestApi(input *UpdateRestApiInput) (*RestApi, error)
- func (c *APIGateway) UpdateRestApiRequest(input *UpdateRestApiInput) (req *request.Request, output *RestApi)
- func (c *APIGateway) UpdateRestApiWithContext(ctx aws.Context, input *UpdateRestApiInput, opts ...request.Option) (*RestApi, error)
- func (c *APIGateway) UpdateStage(input *UpdateStageInput) (*Stage, error)
- func (c *APIGateway) UpdateStageRequest(input *UpdateStageInput) (req *request.Request, output *Stage)
- func (c *APIGateway) UpdateStageWithContext(ctx aws.Context, input *UpdateStageInput, opts ...request.Option) (*Stage, error)
- func (c *APIGateway) UpdateUsage(input *UpdateUsageInput) (*Usage, error)
- func (c *APIGateway) UpdateUsagePlan(input *UpdateUsagePlanInput) (*UsagePlan, error)
- func (c *APIGateway) UpdateUsagePlanRequest(input *UpdateUsagePlanInput) (req *request.Request, output *UsagePlan)
- func (c *APIGateway) UpdateUsagePlanWithContext(ctx aws.Context, input *UpdateUsagePlanInput, opts ...request.Option) (*UsagePlan, error)
- func (c *APIGateway) UpdateUsageRequest(input *UpdateUsageInput) (req *request.Request, output *Usage)
- func (c *APIGateway) UpdateUsageWithContext(ctx aws.Context, input *UpdateUsageInput, opts ...request.Option) (*Usage, error)
- type AccessLogSettings
- type Account
- type ApiKey
- func (s ApiKey) GoString() string
- func (s *ApiKey) SetCreatedDate(v time.Time) *ApiKey
- func (s *ApiKey) SetCustomerId(v string) *ApiKey
- func (s *ApiKey) SetDescription(v string) *ApiKey
- func (s *ApiKey) SetEnabled(v bool) *ApiKey
- func (s *ApiKey) SetId(v string) *ApiKey
- func (s *ApiKey) SetLastUpdatedDate(v time.Time) *ApiKey
- func (s *ApiKey) SetName(v string) *ApiKey
- func (s *ApiKey) SetStageKeys(v []*string) *ApiKey
- func (s *ApiKey) SetValue(v string) *ApiKey
- func (s ApiKey) String() string
- type ApiStage
- type Authorizer
- func (s Authorizer) GoString() string
- func (s *Authorizer) SetAuthType(v string) *Authorizer
- func (s *Authorizer) SetAuthorizerCredentials(v string) *Authorizer
- func (s *Authorizer) SetAuthorizerResultTtlInSeconds(v int64) *Authorizer
- func (s *Authorizer) SetAuthorizerUri(v string) *Authorizer
- func (s *Authorizer) SetId(v string) *Authorizer
- func (s *Authorizer) SetIdentitySource(v string) *Authorizer
- func (s *Authorizer) SetIdentityValidationExpression(v string) *Authorizer
- func (s *Authorizer) SetName(v string) *Authorizer
- func (s *Authorizer) SetProviderARNs(v []*string) *Authorizer
- func (s *Authorizer) SetType(v string) *Authorizer
- func (s Authorizer) String() string
- type BasePathMapping
- type ClientCertificate
- func (s ClientCertificate) GoString() string
- func (s *ClientCertificate) SetClientCertificateId(v string) *ClientCertificate
- func (s *ClientCertificate) SetCreatedDate(v time.Time) *ClientCertificate
- func (s *ClientCertificate) SetDescription(v string) *ClientCertificate
- func (s *ClientCertificate) SetExpirationDate(v time.Time) *ClientCertificate
- func (s *ClientCertificate) SetPemEncodedCertificate(v string) *ClientCertificate
- func (s ClientCertificate) String() string
- type CreateApiKeyInput
- func (s CreateApiKeyInput) GoString() string
- func (s *CreateApiKeyInput) SetCustomerId(v string) *CreateApiKeyInput
- func (s *CreateApiKeyInput) SetDescription(v string) *CreateApiKeyInput
- func (s *CreateApiKeyInput) SetEnabled(v bool) *CreateApiKeyInput
- func (s *CreateApiKeyInput) SetGenerateDistinctId(v bool) *CreateApiKeyInput
- func (s *CreateApiKeyInput) SetName(v string) *CreateApiKeyInput
- func (s *CreateApiKeyInput) SetStageKeys(v []*StageKey) *CreateApiKeyInput
- func (s *CreateApiKeyInput) SetValue(v string) *CreateApiKeyInput
- func (s CreateApiKeyInput) String() string
- type CreateAuthorizerInput
- func (s CreateAuthorizerInput) GoString() string
- func (s *CreateAuthorizerInput) SetAuthType(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetAuthorizerCredentials(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetAuthorizerResultTtlInSeconds(v int64) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetAuthorizerUri(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetIdentitySource(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetIdentityValidationExpression(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetName(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetProviderARNs(v []*string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetRestApiId(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetType(v string) *CreateAuthorizerInput
- func (s CreateAuthorizerInput) String() string
- func (s *CreateAuthorizerInput) Validate() error
- type CreateBasePathMappingInput
- func (s CreateBasePathMappingInput) GoString() string
- func (s *CreateBasePathMappingInput) SetBasePath(v string) *CreateBasePathMappingInput
- func (s *CreateBasePathMappingInput) SetDomainName(v string) *CreateBasePathMappingInput
- func (s *CreateBasePathMappingInput) SetRestApiId(v string) *CreateBasePathMappingInput
- func (s *CreateBasePathMappingInput) SetStage(v string) *CreateBasePathMappingInput
- func (s CreateBasePathMappingInput) String() string
- func (s *CreateBasePathMappingInput) Validate() error
- type CreateDeploymentInput
- func (s CreateDeploymentInput) GoString() string
- func (s *CreateDeploymentInput) SetCacheClusterEnabled(v bool) *CreateDeploymentInput
- func (s *CreateDeploymentInput) SetCacheClusterSize(v string) *CreateDeploymentInput
- func (s *CreateDeploymentInput) SetDescription(v string) *CreateDeploymentInput
- func (s *CreateDeploymentInput) SetRestApiId(v string) *CreateDeploymentInput
- func (s *CreateDeploymentInput) SetStageDescription(v string) *CreateDeploymentInput
- func (s *CreateDeploymentInput) SetStageName(v string) *CreateDeploymentInput
- func (s *CreateDeploymentInput) SetVariables(v map[string]*string) *CreateDeploymentInput
- func (s CreateDeploymentInput) String() string
- func (s *CreateDeploymentInput) Validate() error
- type CreateDocumentationPartInput
- func (s CreateDocumentationPartInput) GoString() string
- func (s *CreateDocumentationPartInput) SetLocation(v *DocumentationPartLocation) *CreateDocumentationPartInput
- func (s *CreateDocumentationPartInput) SetProperties(v string) *CreateDocumentationPartInput
- func (s *CreateDocumentationPartInput) SetRestApiId(v string) *CreateDocumentationPartInput
- func (s CreateDocumentationPartInput) String() string
- func (s *CreateDocumentationPartInput) Validate() error
- type CreateDocumentationVersionInput
- func (s CreateDocumentationVersionInput) GoString() string
- func (s *CreateDocumentationVersionInput) SetDescription(v string) *CreateDocumentationVersionInput
- func (s *CreateDocumentationVersionInput) SetDocumentationVersion(v string) *CreateDocumentationVersionInput
- func (s *CreateDocumentationVersionInput) SetRestApiId(v string) *CreateDocumentationVersionInput
- func (s *CreateDocumentationVersionInput) SetStageName(v string) *CreateDocumentationVersionInput
- func (s CreateDocumentationVersionInput) String() string
- func (s *CreateDocumentationVersionInput) Validate() error
- type CreateDomainNameInput
- func (s CreateDomainNameInput) GoString() string
- func (s *CreateDomainNameInput) SetCertificateArn(v string) *CreateDomainNameInput
- func (s *CreateDomainNameInput) SetCertificateBody(v string) *CreateDomainNameInput
- func (s *CreateDomainNameInput) SetCertificateChain(v string) *CreateDomainNameInput
- func (s *CreateDomainNameInput) SetCertificateName(v string) *CreateDomainNameInput
- func (s *CreateDomainNameInput) SetCertificatePrivateKey(v string) *CreateDomainNameInput
- func (s *CreateDomainNameInput) SetDomainName(v string) *CreateDomainNameInput
- func (s *CreateDomainNameInput) SetEndpointConfiguration(v *EndpointConfiguration) *CreateDomainNameInput
- func (s *CreateDomainNameInput) SetRegionalCertificateArn(v string) *CreateDomainNameInput
- func (s *CreateDomainNameInput) SetRegionalCertificateName(v string) *CreateDomainNameInput
- func (s CreateDomainNameInput) String() string
- func (s *CreateDomainNameInput) Validate() error
- type CreateModelInput
- func (s CreateModelInput) GoString() string
- func (s *CreateModelInput) SetContentType(v string) *CreateModelInput
- func (s *CreateModelInput) SetDescription(v string) *CreateModelInput
- func (s *CreateModelInput) SetName(v string) *CreateModelInput
- func (s *CreateModelInput) SetRestApiId(v string) *CreateModelInput
- func (s *CreateModelInput) SetSchema(v string) *CreateModelInput
- func (s CreateModelInput) String() string
- func (s *CreateModelInput) Validate() error
- type CreateRequestValidatorInput
- func (s CreateRequestValidatorInput) GoString() string
- func (s *CreateRequestValidatorInput) SetName(v string) *CreateRequestValidatorInput
- func (s *CreateRequestValidatorInput) SetRestApiId(v string) *CreateRequestValidatorInput
- func (s *CreateRequestValidatorInput) SetValidateRequestBody(v bool) *CreateRequestValidatorInput
- func (s *CreateRequestValidatorInput) SetValidateRequestParameters(v bool) *CreateRequestValidatorInput
- func (s CreateRequestValidatorInput) String() string
- func (s *CreateRequestValidatorInput) Validate() error
- type CreateResourceInput
- func (s CreateResourceInput) GoString() string
- func (s *CreateResourceInput) SetParentId(v string) *CreateResourceInput
- func (s *CreateResourceInput) SetPathPart(v string) *CreateResourceInput
- func (s *CreateResourceInput) SetRestApiId(v string) *CreateResourceInput
- func (s CreateResourceInput) String() string
- func (s *CreateResourceInput) Validate() error
- type CreateRestApiInput
- func (s CreateRestApiInput) GoString() string
- func (s *CreateRestApiInput) SetBinaryMediaTypes(v []*string) *CreateRestApiInput
- func (s *CreateRestApiInput) SetCloneFrom(v string) *CreateRestApiInput
- func (s *CreateRestApiInput) SetDescription(v string) *CreateRestApiInput
- func (s *CreateRestApiInput) SetEndpointConfiguration(v *EndpointConfiguration) *CreateRestApiInput
- func (s *CreateRestApiInput) SetName(v string) *CreateRestApiInput
- func (s *CreateRestApiInput) SetVersion(v string) *CreateRestApiInput
- func (s CreateRestApiInput) String() string
- func (s *CreateRestApiInput) Validate() error
- type CreateStageInput
- func (s CreateStageInput) GoString() string
- func (s *CreateStageInput) SetCacheClusterEnabled(v bool) *CreateStageInput
- func (s *CreateStageInput) SetCacheClusterSize(v string) *CreateStageInput
- func (s *CreateStageInput) SetDeploymentId(v string) *CreateStageInput
- func (s *CreateStageInput) SetDescription(v string) *CreateStageInput
- func (s *CreateStageInput) SetDocumentationVersion(v string) *CreateStageInput
- func (s *CreateStageInput) SetRestApiId(v string) *CreateStageInput
- func (s *CreateStageInput) SetStageName(v string) *CreateStageInput
- func (s *CreateStageInput) SetVariables(v map[string]*string) *CreateStageInput
- func (s CreateStageInput) String() string
- func (s *CreateStageInput) Validate() error
- type CreateUsagePlanInput
- func (s CreateUsagePlanInput) GoString() string
- func (s *CreateUsagePlanInput) SetApiStages(v []*ApiStage) *CreateUsagePlanInput
- func (s *CreateUsagePlanInput) SetDescription(v string) *CreateUsagePlanInput
- func (s *CreateUsagePlanInput) SetName(v string) *CreateUsagePlanInput
- func (s *CreateUsagePlanInput) SetQuota(v *QuotaSettings) *CreateUsagePlanInput
- func (s *CreateUsagePlanInput) SetThrottle(v *ThrottleSettings) *CreateUsagePlanInput
- func (s CreateUsagePlanInput) String() string
- func (s *CreateUsagePlanInput) Validate() error
- type CreateUsagePlanKeyInput
- func (s CreateUsagePlanKeyInput) GoString() string
- func (s *CreateUsagePlanKeyInput) SetKeyId(v string) *CreateUsagePlanKeyInput
- func (s *CreateUsagePlanKeyInput) SetKeyType(v string) *CreateUsagePlanKeyInput
- func (s *CreateUsagePlanKeyInput) SetUsagePlanId(v string) *CreateUsagePlanKeyInput
- func (s CreateUsagePlanKeyInput) String() string
- func (s *CreateUsagePlanKeyInput) Validate() error
- type DeleteApiKeyInput
- type DeleteApiKeyOutput
- type DeleteAuthorizerInput
- func (s DeleteAuthorizerInput) GoString() string
- func (s *DeleteAuthorizerInput) SetAuthorizerId(v string) *DeleteAuthorizerInput
- func (s *DeleteAuthorizerInput) SetRestApiId(v string) *DeleteAuthorizerInput
- func (s DeleteAuthorizerInput) String() string
- func (s *DeleteAuthorizerInput) Validate() error
- type DeleteAuthorizerOutput
- type DeleteBasePathMappingInput
- func (s DeleteBasePathMappingInput) GoString() string
- func (s *DeleteBasePathMappingInput) SetBasePath(v string) *DeleteBasePathMappingInput
- func (s *DeleteBasePathMappingInput) SetDomainName(v string) *DeleteBasePathMappingInput
- func (s DeleteBasePathMappingInput) String() string
- func (s *DeleteBasePathMappingInput) Validate() error
- type DeleteBasePathMappingOutput
- type DeleteClientCertificateInput
- type DeleteClientCertificateOutput
- type DeleteDeploymentInput
- func (s DeleteDeploymentInput) GoString() string
- func (s *DeleteDeploymentInput) SetDeploymentId(v string) *DeleteDeploymentInput
- func (s *DeleteDeploymentInput) SetRestApiId(v string) *DeleteDeploymentInput
- func (s DeleteDeploymentInput) String() string
- func (s *DeleteDeploymentInput) Validate() error
- type DeleteDeploymentOutput
- type DeleteDocumentationPartInput
- func (s DeleteDocumentationPartInput) GoString() string
- func (s *DeleteDocumentationPartInput) SetDocumentationPartId(v string) *DeleteDocumentationPartInput
- func (s *DeleteDocumentationPartInput) SetRestApiId(v string) *DeleteDocumentationPartInput
- func (s DeleteDocumentationPartInput) String() string
- func (s *DeleteDocumentationPartInput) Validate() error
- type DeleteDocumentationPartOutput
- type DeleteDocumentationVersionInput
- func (s DeleteDocumentationVersionInput) GoString() string
- func (s *DeleteDocumentationVersionInput) SetDocumentationVersion(v string) *DeleteDocumentationVersionInput
- func (s *DeleteDocumentationVersionInput) SetRestApiId(v string) *DeleteDocumentationVersionInput
- func (s DeleteDocumentationVersionInput) String() string
- func (s *DeleteDocumentationVersionInput) Validate() error
- type DeleteDocumentationVersionOutput
- type DeleteDomainNameInput
- type DeleteDomainNameOutput
- type DeleteGatewayResponseInput
- func (s DeleteGatewayResponseInput) GoString() string
- func (s *DeleteGatewayResponseInput) SetResponseType(v string) *DeleteGatewayResponseInput
- func (s *DeleteGatewayResponseInput) SetRestApiId(v string) *DeleteGatewayResponseInput
- func (s DeleteGatewayResponseInput) String() string
- func (s *DeleteGatewayResponseInput) Validate() error
- type DeleteGatewayResponseOutput
- type DeleteIntegrationInput
- func (s DeleteIntegrationInput) GoString() string
- func (s *DeleteIntegrationInput) SetHttpMethod(v string) *DeleteIntegrationInput
- func (s *DeleteIntegrationInput) SetResourceId(v string) *DeleteIntegrationInput
- func (s *DeleteIntegrationInput) SetRestApiId(v string) *DeleteIntegrationInput
- func (s DeleteIntegrationInput) String() string
- func (s *DeleteIntegrationInput) Validate() error
- type DeleteIntegrationOutput
- type DeleteIntegrationResponseInput
- func (s DeleteIntegrationResponseInput) GoString() string
- func (s *DeleteIntegrationResponseInput) SetHttpMethod(v string) *DeleteIntegrationResponseInput
- func (s *DeleteIntegrationResponseInput) SetResourceId(v string) *DeleteIntegrationResponseInput
- func (s *DeleteIntegrationResponseInput) SetRestApiId(v string) *DeleteIntegrationResponseInput
- func (s *DeleteIntegrationResponseInput) SetStatusCode(v string) *DeleteIntegrationResponseInput
- func (s DeleteIntegrationResponseInput) String() string
- func (s *DeleteIntegrationResponseInput) Validate() error
- type DeleteIntegrationResponseOutput
- type DeleteMethodInput
- func (s DeleteMethodInput) GoString() string
- func (s *DeleteMethodInput) SetHttpMethod(v string) *DeleteMethodInput
- func (s *DeleteMethodInput) SetResourceId(v string) *DeleteMethodInput
- func (s *DeleteMethodInput) SetRestApiId(v string) *DeleteMethodInput
- func (s DeleteMethodInput) String() string
- func (s *DeleteMethodInput) Validate() error
- type DeleteMethodOutput
- type DeleteMethodResponseInput
- func (s DeleteMethodResponseInput) GoString() string
- func (s *DeleteMethodResponseInput) SetHttpMethod(v string) *DeleteMethodResponseInput
- func (s *DeleteMethodResponseInput) SetResourceId(v string) *DeleteMethodResponseInput
- func (s *DeleteMethodResponseInput) SetRestApiId(v string) *DeleteMethodResponseInput
- func (s *DeleteMethodResponseInput) SetStatusCode(v string) *DeleteMethodResponseInput
- func (s DeleteMethodResponseInput) String() string
- func (s *DeleteMethodResponseInput) Validate() error
- type DeleteMethodResponseOutput
- type DeleteModelInput
- type DeleteModelOutput
- type DeleteRequestValidatorInput
- func (s DeleteRequestValidatorInput) GoString() string
- func (s *DeleteRequestValidatorInput) SetRequestValidatorId(v string) *DeleteRequestValidatorInput
- func (s *DeleteRequestValidatorInput) SetRestApiId(v string) *DeleteRequestValidatorInput
- func (s DeleteRequestValidatorInput) String() string
- func (s *DeleteRequestValidatorInput) Validate() error
- type DeleteRequestValidatorOutput
- type DeleteResourceInput
- type DeleteResourceOutput
- type DeleteRestApiInput
- type DeleteRestApiOutput
- type DeleteStageInput
- type DeleteStageOutput
- type DeleteUsagePlanInput
- type DeleteUsagePlanKeyInput
- func (s DeleteUsagePlanKeyInput) GoString() string
- func (s *DeleteUsagePlanKeyInput) SetKeyId(v string) *DeleteUsagePlanKeyInput
- func (s *DeleteUsagePlanKeyInput) SetUsagePlanId(v string) *DeleteUsagePlanKeyInput
- func (s DeleteUsagePlanKeyInput) String() string
- func (s *DeleteUsagePlanKeyInput) Validate() error
- type DeleteUsagePlanKeyOutput
- type DeleteUsagePlanOutput
- type Deployment
- func (s Deployment) GoString() string
- func (s *Deployment) SetApiSummary(v map[string]map[string]*MethodSnapshot) *Deployment
- func (s *Deployment) SetCreatedDate(v time.Time) *Deployment
- func (s *Deployment) SetDescription(v string) *Deployment
- func (s *Deployment) SetId(v string) *Deployment
- func (s Deployment) String() string
- type DocumentationPart
- func (s DocumentationPart) GoString() string
- func (s *DocumentationPart) SetId(v string) *DocumentationPart
- func (s *DocumentationPart) SetLocation(v *DocumentationPartLocation) *DocumentationPart
- func (s *DocumentationPart) SetProperties(v string) *DocumentationPart
- func (s DocumentationPart) String() string
- type DocumentationPartLocation
- func (s DocumentationPartLocation) GoString() string
- func (s *DocumentationPartLocation) SetMethod(v string) *DocumentationPartLocation
- func (s *DocumentationPartLocation) SetName(v string) *DocumentationPartLocation
- func (s *DocumentationPartLocation) SetPath(v string) *DocumentationPartLocation
- func (s *DocumentationPartLocation) SetStatusCode(v string) *DocumentationPartLocation
- func (s *DocumentationPartLocation) SetType(v string) *DocumentationPartLocation
- func (s DocumentationPartLocation) String() string
- func (s *DocumentationPartLocation) Validate() error
- type DocumentationVersion
- func (s DocumentationVersion) GoString() string
- func (s *DocumentationVersion) SetCreatedDate(v time.Time) *DocumentationVersion
- func (s *DocumentationVersion) SetDescription(v string) *DocumentationVersion
- func (s *DocumentationVersion) SetVersion(v string) *DocumentationVersion
- func (s DocumentationVersion) String() string
- type DomainName
- func (s DomainName) GoString() string
- func (s *DomainName) SetCertificateArn(v string) *DomainName
- func (s *DomainName) SetCertificateName(v string) *DomainName
- func (s *DomainName) SetCertificateUploadDate(v time.Time) *DomainName
- func (s *DomainName) SetDistributionDomainName(v string) *DomainName
- func (s *DomainName) SetDistributionHostedZoneId(v string) *DomainName
- func (s *DomainName) SetDomainName(v string) *DomainName
- func (s *DomainName) SetEndpointConfiguration(v *EndpointConfiguration) *DomainName
- func (s *DomainName) SetRegionalCertificateArn(v string) *DomainName
- func (s *DomainName) SetRegionalCertificateName(v string) *DomainName
- func (s *DomainName) SetRegionalDomainName(v string) *DomainName
- func (s *DomainName) SetRegionalHostedZoneId(v string) *DomainName
- func (s DomainName) String() string
- type EndpointConfiguration
- type FlushStageAuthorizersCacheInput
- func (s FlushStageAuthorizersCacheInput) GoString() string
- func (s *FlushStageAuthorizersCacheInput) SetRestApiId(v string) *FlushStageAuthorizersCacheInput
- func (s *FlushStageAuthorizersCacheInput) SetStageName(v string) *FlushStageAuthorizersCacheInput
- func (s FlushStageAuthorizersCacheInput) String() string
- func (s *FlushStageAuthorizersCacheInput) Validate() error
- type FlushStageAuthorizersCacheOutput
- type FlushStageCacheInput
- type FlushStageCacheOutput
- type GenerateClientCertificateInput
- type GetAccountInput
- type GetApiKeyInput
- type GetApiKeysInput
- func (s GetApiKeysInput) GoString() string
- func (s *GetApiKeysInput) SetCustomerId(v string) *GetApiKeysInput
- func (s *GetApiKeysInput) SetIncludeValues(v bool) *GetApiKeysInput
- func (s *GetApiKeysInput) SetLimit(v int64) *GetApiKeysInput
- func (s *GetApiKeysInput) SetNameQuery(v string) *GetApiKeysInput
- func (s *GetApiKeysInput) SetPosition(v string) *GetApiKeysInput
- func (s GetApiKeysInput) String() string
- type GetApiKeysOutput
- type GetAuthorizerInput
- type GetAuthorizersInput
- func (s GetAuthorizersInput) GoString() string
- func (s *GetAuthorizersInput) SetLimit(v int64) *GetAuthorizersInput
- func (s *GetAuthorizersInput) SetPosition(v string) *GetAuthorizersInput
- func (s *GetAuthorizersInput) SetRestApiId(v string) *GetAuthorizersInput
- func (s GetAuthorizersInput) String() string
- func (s *GetAuthorizersInput) Validate() error
- type GetAuthorizersOutput
- type GetBasePathMappingInput
- func (s GetBasePathMappingInput) GoString() string
- func (s *GetBasePathMappingInput) SetBasePath(v string) *GetBasePathMappingInput
- func (s *GetBasePathMappingInput) SetDomainName(v string) *GetBasePathMappingInput
- func (s GetBasePathMappingInput) String() string
- func (s *GetBasePathMappingInput) Validate() error
- type GetBasePathMappingsInput
- func (s GetBasePathMappingsInput) GoString() string
- func (s *GetBasePathMappingsInput) SetDomainName(v string) *GetBasePathMappingsInput
- func (s *GetBasePathMappingsInput) SetLimit(v int64) *GetBasePathMappingsInput
- func (s *GetBasePathMappingsInput) SetPosition(v string) *GetBasePathMappingsInput
- func (s GetBasePathMappingsInput) String() string
- func (s *GetBasePathMappingsInput) Validate() error
- type GetBasePathMappingsOutput
- type GetClientCertificateInput
- type GetClientCertificatesInput
- type GetClientCertificatesOutput
- type GetDeploymentInput
- func (s GetDeploymentInput) GoString() string
- func (s *GetDeploymentInput) SetDeploymentId(v string) *GetDeploymentInput
- func (s *GetDeploymentInput) SetEmbed(v []*string) *GetDeploymentInput
- func (s *GetDeploymentInput) SetRestApiId(v string) *GetDeploymentInput
- func (s GetDeploymentInput) String() string
- func (s *GetDeploymentInput) Validate() error
- type GetDeploymentsInput
- func (s GetDeploymentsInput) GoString() string
- func (s *GetDeploymentsInput) SetLimit(v int64) *GetDeploymentsInput
- func (s *GetDeploymentsInput) SetPosition(v string) *GetDeploymentsInput
- func (s *GetDeploymentsInput) SetRestApiId(v string) *GetDeploymentsInput
- func (s GetDeploymentsInput) String() string
- func (s *GetDeploymentsInput) Validate() error
- type GetDeploymentsOutput
- type GetDocumentationPartInput
- func (s GetDocumentationPartInput) GoString() string
- func (s *GetDocumentationPartInput) SetDocumentationPartId(v string) *GetDocumentationPartInput
- func (s *GetDocumentationPartInput) SetRestApiId(v string) *GetDocumentationPartInput
- func (s GetDocumentationPartInput) String() string
- func (s *GetDocumentationPartInput) Validate() error
- type GetDocumentationPartsInput
- func (s GetDocumentationPartsInput) GoString() string
- func (s *GetDocumentationPartsInput) SetLimit(v int64) *GetDocumentationPartsInput
- func (s *GetDocumentationPartsInput) SetLocationStatus(v string) *GetDocumentationPartsInput
- func (s *GetDocumentationPartsInput) SetNameQuery(v string) *GetDocumentationPartsInput
- func (s *GetDocumentationPartsInput) SetPath(v string) *GetDocumentationPartsInput
- func (s *GetDocumentationPartsInput) SetPosition(v string) *GetDocumentationPartsInput
- func (s *GetDocumentationPartsInput) SetRestApiId(v string) *GetDocumentationPartsInput
- func (s *GetDocumentationPartsInput) SetType(v string) *GetDocumentationPartsInput
- func (s GetDocumentationPartsInput) String() string
- func (s *GetDocumentationPartsInput) Validate() error
- type GetDocumentationPartsOutput
- type GetDocumentationVersionInput
- func (s GetDocumentationVersionInput) GoString() string
- func (s *GetDocumentationVersionInput) SetDocumentationVersion(v string) *GetDocumentationVersionInput
- func (s *GetDocumentationVersionInput) SetRestApiId(v string) *GetDocumentationVersionInput
- func (s GetDocumentationVersionInput) String() string
- func (s *GetDocumentationVersionInput) Validate() error
- type GetDocumentationVersionsInput
- func (s GetDocumentationVersionsInput) GoString() string
- func (s *GetDocumentationVersionsInput) SetLimit(v int64) *GetDocumentationVersionsInput
- func (s *GetDocumentationVersionsInput) SetPosition(v string) *GetDocumentationVersionsInput
- func (s *GetDocumentationVersionsInput) SetRestApiId(v string) *GetDocumentationVersionsInput
- func (s GetDocumentationVersionsInput) String() string
- func (s *GetDocumentationVersionsInput) Validate() error
- type GetDocumentationVersionsOutput
- func (s GetDocumentationVersionsOutput) GoString() string
- func (s *GetDocumentationVersionsOutput) SetItems(v []*DocumentationVersion) *GetDocumentationVersionsOutput
- func (s *GetDocumentationVersionsOutput) SetPosition(v string) *GetDocumentationVersionsOutput
- func (s GetDocumentationVersionsOutput) String() string
- type GetDomainNameInput
- type GetDomainNamesInput
- type GetDomainNamesOutput
- type GetExportInput
- func (s GetExportInput) GoString() string
- func (s *GetExportInput) SetAccepts(v string) *GetExportInput
- func (s *GetExportInput) SetExportType(v string) *GetExportInput
- func (s *GetExportInput) SetParameters(v map[string]*string) *GetExportInput
- func (s *GetExportInput) SetRestApiId(v string) *GetExportInput
- func (s *GetExportInput) SetStageName(v string) *GetExportInput
- func (s GetExportInput) String() string
- func (s *GetExportInput) Validate() error
- type GetExportOutput
- type GetGatewayResponseInput
- func (s GetGatewayResponseInput) GoString() string
- func (s *GetGatewayResponseInput) SetResponseType(v string) *GetGatewayResponseInput
- func (s *GetGatewayResponseInput) SetRestApiId(v string) *GetGatewayResponseInput
- func (s GetGatewayResponseInput) String() string
- func (s *GetGatewayResponseInput) Validate() error
- type GetGatewayResponsesInput
- func (s GetGatewayResponsesInput) GoString() string
- func (s *GetGatewayResponsesInput) SetLimit(v int64) *GetGatewayResponsesInput
- func (s *GetGatewayResponsesInput) SetPosition(v string) *GetGatewayResponsesInput
- func (s *GetGatewayResponsesInput) SetRestApiId(v string) *GetGatewayResponsesInput
- func (s GetGatewayResponsesInput) String() string
- func (s *GetGatewayResponsesInput) Validate() error
- type GetGatewayResponsesOutput
- type GetIntegrationInput
- func (s GetIntegrationInput) GoString() string
- func (s *GetIntegrationInput) SetHttpMethod(v string) *GetIntegrationInput
- func (s *GetIntegrationInput) SetResourceId(v string) *GetIntegrationInput
- func (s *GetIntegrationInput) SetRestApiId(v string) *GetIntegrationInput
- func (s GetIntegrationInput) String() string
- func (s *GetIntegrationInput) Validate() error
- type GetIntegrationResponseInput
- func (s GetIntegrationResponseInput) GoString() string
- func (s *GetIntegrationResponseInput) SetHttpMethod(v string) *GetIntegrationResponseInput
- func (s *GetIntegrationResponseInput) SetResourceId(v string) *GetIntegrationResponseInput
- func (s *GetIntegrationResponseInput) SetRestApiId(v string) *GetIntegrationResponseInput
- func (s *GetIntegrationResponseInput) SetStatusCode(v string) *GetIntegrationResponseInput
- func (s GetIntegrationResponseInput) String() string
- func (s *GetIntegrationResponseInput) Validate() error
- type GetMethodInput
- func (s GetMethodInput) GoString() string
- func (s *GetMethodInput) SetHttpMethod(v string) *GetMethodInput
- func (s *GetMethodInput) SetResourceId(v string) *GetMethodInput
- func (s *GetMethodInput) SetRestApiId(v string) *GetMethodInput
- func (s GetMethodInput) String() string
- func (s *GetMethodInput) Validate() error
- type GetMethodResponseInput
- func (s GetMethodResponseInput) GoString() string
- func (s *GetMethodResponseInput) SetHttpMethod(v string) *GetMethodResponseInput
- func (s *GetMethodResponseInput) SetResourceId(v string) *GetMethodResponseInput
- func (s *GetMethodResponseInput) SetRestApiId(v string) *GetMethodResponseInput
- func (s *GetMethodResponseInput) SetStatusCode(v string) *GetMethodResponseInput
- func (s GetMethodResponseInput) String() string
- func (s *GetMethodResponseInput) Validate() error
- type GetModelInput
- func (s GetModelInput) GoString() string
- func (s *GetModelInput) SetFlatten(v bool) *GetModelInput
- func (s *GetModelInput) SetModelName(v string) *GetModelInput
- func (s *GetModelInput) SetRestApiId(v string) *GetModelInput
- func (s GetModelInput) String() string
- func (s *GetModelInput) Validate() error
- type GetModelTemplateInput
- func (s GetModelTemplateInput) GoString() string
- func (s *GetModelTemplateInput) SetModelName(v string) *GetModelTemplateInput
- func (s *GetModelTemplateInput) SetRestApiId(v string) *GetModelTemplateInput
- func (s GetModelTemplateInput) String() string
- func (s *GetModelTemplateInput) Validate() error
- type GetModelTemplateOutput
- type GetModelsInput
- func (s GetModelsInput) GoString() string
- func (s *GetModelsInput) SetLimit(v int64) *GetModelsInput
- func (s *GetModelsInput) SetPosition(v string) *GetModelsInput
- func (s *GetModelsInput) SetRestApiId(v string) *GetModelsInput
- func (s GetModelsInput) String() string
- func (s *GetModelsInput) Validate() error
- type GetModelsOutput
- type GetRequestValidatorInput
- func (s GetRequestValidatorInput) GoString() string
- func (s *GetRequestValidatorInput) SetRequestValidatorId(v string) *GetRequestValidatorInput
- func (s *GetRequestValidatorInput) SetRestApiId(v string) *GetRequestValidatorInput
- func (s GetRequestValidatorInput) String() string
- func (s *GetRequestValidatorInput) Validate() error
- type GetRequestValidatorsInput
- func (s GetRequestValidatorsInput) GoString() string
- func (s *GetRequestValidatorsInput) SetLimit(v int64) *GetRequestValidatorsInput
- func (s *GetRequestValidatorsInput) SetPosition(v string) *GetRequestValidatorsInput
- func (s *GetRequestValidatorsInput) SetRestApiId(v string) *GetRequestValidatorsInput
- func (s GetRequestValidatorsInput) String() string
- func (s *GetRequestValidatorsInput) Validate() error
- type GetRequestValidatorsOutput
- func (s GetRequestValidatorsOutput) GoString() string
- func (s *GetRequestValidatorsOutput) SetItems(v []*UpdateRequestValidatorOutput) *GetRequestValidatorsOutput
- func (s *GetRequestValidatorsOutput) SetPosition(v string) *GetRequestValidatorsOutput
- func (s GetRequestValidatorsOutput) String() string
- type GetResourceInput
- func (s GetResourceInput) GoString() string
- func (s *GetResourceInput) SetEmbed(v []*string) *GetResourceInput
- func (s *GetResourceInput) SetResourceId(v string) *GetResourceInput
- func (s *GetResourceInput) SetRestApiId(v string) *GetResourceInput
- func (s GetResourceInput) String() string
- func (s *GetResourceInput) Validate() error
- type GetResourcesInput
- func (s GetResourcesInput) GoString() string
- func (s *GetResourcesInput) SetEmbed(v []*string) *GetResourcesInput
- func (s *GetResourcesInput) SetLimit(v int64) *GetResourcesInput
- func (s *GetResourcesInput) SetPosition(v string) *GetResourcesInput
- func (s *GetResourcesInput) SetRestApiId(v string) *GetResourcesInput
- func (s GetResourcesInput) String() string
- func (s *GetResourcesInput) Validate() error
- type GetResourcesOutput
- type GetRestApiInput
- type GetRestApisInput
- type GetRestApisOutput
- type GetSdkInput
- func (s GetSdkInput) GoString() string
- func (s *GetSdkInput) SetParameters(v map[string]*string) *GetSdkInput
- func (s *GetSdkInput) SetRestApiId(v string) *GetSdkInput
- func (s *GetSdkInput) SetSdkType(v string) *GetSdkInput
- func (s *GetSdkInput) SetStageName(v string) *GetSdkInput
- func (s GetSdkInput) String() string
- func (s *GetSdkInput) Validate() error
- type GetSdkOutput
- type GetSdkTypeInput
- type GetSdkTypesInput
- type GetSdkTypesOutput
- type GetStageInput
- type GetStagesInput
- type GetStagesOutput
- type GetUsageInput
- func (s GetUsageInput) GoString() string
- func (s *GetUsageInput) SetEndDate(v string) *GetUsageInput
- func (s *GetUsageInput) SetKeyId(v string) *GetUsageInput
- func (s *GetUsageInput) SetLimit(v int64) *GetUsageInput
- func (s *GetUsageInput) SetPosition(v string) *GetUsageInput
- func (s *GetUsageInput) SetStartDate(v string) *GetUsageInput
- func (s *GetUsageInput) SetUsagePlanId(v string) *GetUsageInput
- func (s GetUsageInput) String() string
- func (s *GetUsageInput) Validate() error
- type GetUsagePlanInput
- type GetUsagePlanKeyInput
- type GetUsagePlanKeysInput
- func (s GetUsagePlanKeysInput) GoString() string
- func (s *GetUsagePlanKeysInput) SetLimit(v int64) *GetUsagePlanKeysInput
- func (s *GetUsagePlanKeysInput) SetNameQuery(v string) *GetUsagePlanKeysInput
- func (s *GetUsagePlanKeysInput) SetPosition(v string) *GetUsagePlanKeysInput
- func (s *GetUsagePlanKeysInput) SetUsagePlanId(v string) *GetUsagePlanKeysInput
- func (s GetUsagePlanKeysInput) String() string
- func (s *GetUsagePlanKeysInput) Validate() error
- type GetUsagePlanKeysOutput
- type GetUsagePlansInput
- type GetUsagePlansOutput
- type ImportApiKeysInput
- func (s ImportApiKeysInput) GoString() string
- func (s *ImportApiKeysInput) SetBody(v []byte) *ImportApiKeysInput
- func (s *ImportApiKeysInput) SetFailOnWarnings(v bool) *ImportApiKeysInput
- func (s *ImportApiKeysInput) SetFormat(v string) *ImportApiKeysInput
- func (s ImportApiKeysInput) String() string
- func (s *ImportApiKeysInput) Validate() error
- type ImportApiKeysOutput
- type ImportDocumentationPartsInput
- func (s ImportDocumentationPartsInput) GoString() string
- func (s *ImportDocumentationPartsInput) SetBody(v []byte) *ImportDocumentationPartsInput
- func (s *ImportDocumentationPartsInput) SetFailOnWarnings(v bool) *ImportDocumentationPartsInput
- func (s *ImportDocumentationPartsInput) SetMode(v string) *ImportDocumentationPartsInput
- func (s *ImportDocumentationPartsInput) SetRestApiId(v string) *ImportDocumentationPartsInput
- func (s ImportDocumentationPartsInput) String() string
- func (s *ImportDocumentationPartsInput) Validate() error
- type ImportDocumentationPartsOutput
- func (s ImportDocumentationPartsOutput) GoString() string
- func (s *ImportDocumentationPartsOutput) SetIds(v []*string) *ImportDocumentationPartsOutput
- func (s *ImportDocumentationPartsOutput) SetWarnings(v []*string) *ImportDocumentationPartsOutput
- func (s ImportDocumentationPartsOutput) String() string
- type ImportRestApiInput
- func (s ImportRestApiInput) GoString() string
- func (s *ImportRestApiInput) SetBody(v []byte) *ImportRestApiInput
- func (s *ImportRestApiInput) SetFailOnWarnings(v bool) *ImportRestApiInput
- func (s *ImportRestApiInput) SetParameters(v map[string]*string) *ImportRestApiInput
- func (s ImportRestApiInput) String() string
- func (s *ImportRestApiInput) Validate() error
- type Integration
- func (s Integration) GoString() string
- func (s *Integration) SetCacheKeyParameters(v []*string) *Integration
- func (s *Integration) SetCacheNamespace(v string) *Integration
- func (s *Integration) SetContentHandling(v string) *Integration
- func (s *Integration) SetCredentials(v string) *Integration
- func (s *Integration) SetHttpMethod(v string) *Integration
- func (s *Integration) SetIntegrationResponses(v map[string]*IntegrationResponse) *Integration
- func (s *Integration) SetPassthroughBehavior(v string) *Integration
- func (s *Integration) SetRequestParameters(v map[string]*string) *Integration
- func (s *Integration) SetRequestTemplates(v map[string]*string) *Integration
- func (s *Integration) SetTimeoutInMillis(v int64) *Integration
- func (s *Integration) SetType(v string) *Integration
- func (s *Integration) SetUri(v string) *Integration
- func (s Integration) String() string
- type IntegrationResponse
- func (s IntegrationResponse) GoString() string
- func (s *IntegrationResponse) SetContentHandling(v string) *IntegrationResponse
- func (s *IntegrationResponse) SetResponseParameters(v map[string]*string) *IntegrationResponse
- func (s *IntegrationResponse) SetResponseTemplates(v map[string]*string) *IntegrationResponse
- func (s *IntegrationResponse) SetSelectionPattern(v string) *IntegrationResponse
- func (s *IntegrationResponse) SetStatusCode(v string) *IntegrationResponse
- func (s IntegrationResponse) String() string
- type Method
- func (s Method) GoString() string
- func (s *Method) SetApiKeyRequired(v bool) *Method
- func (s *Method) SetAuthorizationType(v string) *Method
- func (s *Method) SetAuthorizerId(v string) *Method
- func (s *Method) SetHttpMethod(v string) *Method
- func (s *Method) SetMethodIntegration(v *Integration) *Method
- func (s *Method) SetMethodResponses(v map[string]*MethodResponse) *Method
- func (s *Method) SetOperationName(v string) *Method
- func (s *Method) SetRequestModels(v map[string]*string) *Method
- func (s *Method) SetRequestParameters(v map[string]*bool) *Method
- func (s *Method) SetRequestValidatorId(v string) *Method
- func (s Method) String() string
- type MethodResponse
- func (s MethodResponse) GoString() string
- func (s *MethodResponse) SetResponseModels(v map[string]*string) *MethodResponse
- func (s *MethodResponse) SetResponseParameters(v map[string]*bool) *MethodResponse
- func (s *MethodResponse) SetStatusCode(v string) *MethodResponse
- func (s MethodResponse) String() string
- type MethodSetting
- func (s MethodSetting) GoString() string
- func (s *MethodSetting) SetCacheDataEncrypted(v bool) *MethodSetting
- func (s *MethodSetting) SetCacheTtlInSeconds(v int64) *MethodSetting
- func (s *MethodSetting) SetCachingEnabled(v bool) *MethodSetting
- func (s *MethodSetting) SetDataTraceEnabled(v bool) *MethodSetting
- func (s *MethodSetting) SetLoggingLevel(v string) *MethodSetting
- func (s *MethodSetting) SetMetricsEnabled(v bool) *MethodSetting
- func (s *MethodSetting) SetRequireAuthorizationForCacheControl(v bool) *MethodSetting
- func (s *MethodSetting) SetThrottlingBurstLimit(v int64) *MethodSetting
- func (s *MethodSetting) SetThrottlingRateLimit(v float64) *MethodSetting
- func (s *MethodSetting) SetUnauthorizedCacheControlHeaderStrategy(v string) *MethodSetting
- func (s MethodSetting) String() string
- type MethodSnapshot
- type Model
- type PatchOperation
- func (s PatchOperation) GoString() string
- func (s *PatchOperation) SetFrom(v string) *PatchOperation
- func (s *PatchOperation) SetOp(v string) *PatchOperation
- func (s *PatchOperation) SetPath(v string) *PatchOperation
- func (s *PatchOperation) SetValue(v string) *PatchOperation
- func (s PatchOperation) String() string
- type PutGatewayResponseInput
- func (s PutGatewayResponseInput) GoString() string
- func (s *PutGatewayResponseInput) SetResponseParameters(v map[string]*string) *PutGatewayResponseInput
- func (s *PutGatewayResponseInput) SetResponseTemplates(v map[string]*string) *PutGatewayResponseInput
- func (s *PutGatewayResponseInput) SetResponseType(v string) *PutGatewayResponseInput
- func (s *PutGatewayResponseInput) SetRestApiId(v string) *PutGatewayResponseInput
- func (s *PutGatewayResponseInput) SetStatusCode(v string) *PutGatewayResponseInput
- func (s PutGatewayResponseInput) String() string
- func (s *PutGatewayResponseInput) Validate() error
- type PutIntegrationInput
- func (s PutIntegrationInput) GoString() string
- func (s *PutIntegrationInput) SetCacheKeyParameters(v []*string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetCacheNamespace(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetContentHandling(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetCredentials(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetHttpMethod(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetIntegrationHttpMethod(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetPassthroughBehavior(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetRequestParameters(v map[string]*string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetRequestTemplates(v map[string]*string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetResourceId(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetRestApiId(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetTimeoutInMillis(v int64) *PutIntegrationInput
- func (s *PutIntegrationInput) SetType(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetUri(v string) *PutIntegrationInput
- func (s PutIntegrationInput) String() string
- func (s *PutIntegrationInput) Validate() error
- type PutIntegrationResponseInput
- func (s PutIntegrationResponseInput) GoString() string
- func (s *PutIntegrationResponseInput) SetContentHandling(v string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetHttpMethod(v string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetResourceId(v string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetResponseParameters(v map[string]*string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetResponseTemplates(v map[string]*string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetRestApiId(v string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetSelectionPattern(v string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetStatusCode(v string) *PutIntegrationResponseInput
- func (s PutIntegrationResponseInput) String() string
- func (s *PutIntegrationResponseInput) Validate() error
- type PutMethodInput
- func (s PutMethodInput) GoString() string
- func (s *PutMethodInput) SetApiKeyRequired(v bool) *PutMethodInput
- func (s *PutMethodInput) SetAuthorizationType(v string) *PutMethodInput
- func (s *PutMethodInput) SetAuthorizerId(v string) *PutMethodInput
- func (s *PutMethodInput) SetHttpMethod(v string) *PutMethodInput
- func (s *PutMethodInput) SetOperationName(v string) *PutMethodInput
- func (s *PutMethodInput) SetRequestModels(v map[string]*string) *PutMethodInput
- func (s *PutMethodInput) SetRequestParameters(v map[string]*bool) *PutMethodInput
- func (s *PutMethodInput) SetRequestValidatorId(v string) *PutMethodInput
- func (s *PutMethodInput) SetResourceId(v string) *PutMethodInput
- func (s *PutMethodInput) SetRestApiId(v string) *PutMethodInput
- func (s PutMethodInput) String() string
- func (s *PutMethodInput) Validate() error
- type PutMethodResponseInput
- func (s PutMethodResponseInput) GoString() string
- func (s *PutMethodResponseInput) SetHttpMethod(v string) *PutMethodResponseInput
- func (s *PutMethodResponseInput) SetResourceId(v string) *PutMethodResponseInput
- func (s *PutMethodResponseInput) SetResponseModels(v map[string]*string) *PutMethodResponseInput
- func (s *PutMethodResponseInput) SetResponseParameters(v map[string]*bool) *PutMethodResponseInput
- func (s *PutMethodResponseInput) SetRestApiId(v string) *PutMethodResponseInput
- func (s *PutMethodResponseInput) SetStatusCode(v string) *PutMethodResponseInput
- func (s PutMethodResponseInput) String() string
- func (s *PutMethodResponseInput) Validate() error
- type PutRestApiInput
- func (s PutRestApiInput) GoString() string
- func (s *PutRestApiInput) SetBody(v []byte) *PutRestApiInput
- func (s *PutRestApiInput) SetFailOnWarnings(v bool) *PutRestApiInput
- func (s *PutRestApiInput) SetMode(v string) *PutRestApiInput
- func (s *PutRestApiInput) SetParameters(v map[string]*string) *PutRestApiInput
- func (s *PutRestApiInput) SetRestApiId(v string) *PutRestApiInput
- func (s PutRestApiInput) String() string
- func (s *PutRestApiInput) Validate() error
- type QuotaSettings
- type Resource
- func (s Resource) GoString() string
- func (s *Resource) SetId(v string) *Resource
- func (s *Resource) SetParentId(v string) *Resource
- func (s *Resource) SetPath(v string) *Resource
- func (s *Resource) SetPathPart(v string) *Resource
- func (s *Resource) SetResourceMethods(v map[string]*Method) *Resource
- func (s Resource) String() string
- type RestApi
- func (s RestApi) GoString() string
- func (s *RestApi) SetBinaryMediaTypes(v []*string) *RestApi
- func (s *RestApi) SetCreatedDate(v time.Time) *RestApi
- func (s *RestApi) SetDescription(v string) *RestApi
- func (s *RestApi) SetEndpointConfiguration(v *EndpointConfiguration) *RestApi
- func (s *RestApi) SetId(v string) *RestApi
- func (s *RestApi) SetName(v string) *RestApi
- func (s *RestApi) SetVersion(v string) *RestApi
- func (s *RestApi) SetWarnings(v []*string) *RestApi
- func (s RestApi) String() string
- type SdkConfigurationProperty
- func (s SdkConfigurationProperty) GoString() string
- func (s *SdkConfigurationProperty) SetDefaultValue(v string) *SdkConfigurationProperty
- func (s *SdkConfigurationProperty) SetDescription(v string) *SdkConfigurationProperty
- func (s *SdkConfigurationProperty) SetFriendlyName(v string) *SdkConfigurationProperty
- func (s *SdkConfigurationProperty) SetName(v string) *SdkConfigurationProperty
- func (s *SdkConfigurationProperty) SetRequired(v bool) *SdkConfigurationProperty
- func (s SdkConfigurationProperty) String() string
- type SdkType
- func (s SdkType) GoString() string
- func (s *SdkType) SetConfigurationProperties(v []*SdkConfigurationProperty) *SdkType
- func (s *SdkType) SetDescription(v string) *SdkType
- func (s *SdkType) SetFriendlyName(v string) *SdkType
- func (s *SdkType) SetId(v string) *SdkType
- func (s SdkType) String() string
- type Stage
- func (s Stage) GoString() string
- func (s *Stage) SetAccessLogSettings(v *AccessLogSettings) *Stage
- func (s *Stage) SetCacheClusterEnabled(v bool) *Stage
- func (s *Stage) SetCacheClusterSize(v string) *Stage
- func (s *Stage) SetCacheClusterStatus(v string) *Stage
- func (s *Stage) SetClientCertificateId(v string) *Stage
- func (s *Stage) SetCreatedDate(v time.Time) *Stage
- func (s *Stage) SetDeploymentId(v string) *Stage
- func (s *Stage) SetDescription(v string) *Stage
- func (s *Stage) SetDocumentationVersion(v string) *Stage
- func (s *Stage) SetLastUpdatedDate(v time.Time) *Stage
- func (s *Stage) SetMethodSettings(v map[string]*MethodSetting) *Stage
- func (s *Stage) SetStageName(v string) *Stage
- func (s *Stage) SetVariables(v map[string]*string) *Stage
- func (s Stage) String() string
- type StageKey
- type TestInvokeAuthorizerInput
- func (s TestInvokeAuthorizerInput) GoString() string
- func (s *TestInvokeAuthorizerInput) SetAdditionalContext(v map[string]*string) *TestInvokeAuthorizerInput
- func (s *TestInvokeAuthorizerInput) SetAuthorizerId(v string) *TestInvokeAuthorizerInput
- func (s *TestInvokeAuthorizerInput) SetBody(v string) *TestInvokeAuthorizerInput
- func (s *TestInvokeAuthorizerInput) SetHeaders(v map[string]*string) *TestInvokeAuthorizerInput
- func (s *TestInvokeAuthorizerInput) SetPathWithQueryString(v string) *TestInvokeAuthorizerInput
- func (s *TestInvokeAuthorizerInput) SetRestApiId(v string) *TestInvokeAuthorizerInput
- func (s *TestInvokeAuthorizerInput) SetStageVariables(v map[string]*string) *TestInvokeAuthorizerInput
- func (s TestInvokeAuthorizerInput) String() string
- func (s *TestInvokeAuthorizerInput) Validate() error
- type TestInvokeAuthorizerOutput
- func (s TestInvokeAuthorizerOutput) GoString() string
- func (s *TestInvokeAuthorizerOutput) SetAuthorization(v map[string][]*string) *TestInvokeAuthorizerOutput
- func (s *TestInvokeAuthorizerOutput) SetClaims(v map[string]*string) *TestInvokeAuthorizerOutput
- func (s *TestInvokeAuthorizerOutput) SetClientStatus(v int64) *TestInvokeAuthorizerOutput
- func (s *TestInvokeAuthorizerOutput) SetLatency(v int64) *TestInvokeAuthorizerOutput
- func (s *TestInvokeAuthorizerOutput) SetLog(v string) *TestInvokeAuthorizerOutput
- func (s *TestInvokeAuthorizerOutput) SetPolicy(v string) *TestInvokeAuthorizerOutput
- func (s *TestInvokeAuthorizerOutput) SetPrincipalId(v string) *TestInvokeAuthorizerOutput
- func (s TestInvokeAuthorizerOutput) String() string
- type TestInvokeMethodInput
- func (s TestInvokeMethodInput) GoString() string
- func (s *TestInvokeMethodInput) SetBody(v string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetClientCertificateId(v string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetHeaders(v map[string]*string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetHttpMethod(v string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetPathWithQueryString(v string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetResourceId(v string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetRestApiId(v string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetStageVariables(v map[string]*string) *TestInvokeMethodInput
- func (s TestInvokeMethodInput) String() string
- func (s *TestInvokeMethodInput) Validate() error
- type TestInvokeMethodOutput
- func (s TestInvokeMethodOutput) GoString() string
- func (s *TestInvokeMethodOutput) SetBody(v string) *TestInvokeMethodOutput
- func (s *TestInvokeMethodOutput) SetHeaders(v map[string]*string) *TestInvokeMethodOutput
- func (s *TestInvokeMethodOutput) SetLatency(v int64) *TestInvokeMethodOutput
- func (s *TestInvokeMethodOutput) SetLog(v string) *TestInvokeMethodOutput
- func (s *TestInvokeMethodOutput) SetStatus(v int64) *TestInvokeMethodOutput
- func (s TestInvokeMethodOutput) String() string
- type ThrottleSettings
- type UpdateAccountInput
- type UpdateApiKeyInput
- type UpdateAuthorizerInput
- func (s UpdateAuthorizerInput) GoString() string
- func (s *UpdateAuthorizerInput) SetAuthorizerId(v string) *UpdateAuthorizerInput
- func (s *UpdateAuthorizerInput) SetPatchOperations(v []*PatchOperation) *UpdateAuthorizerInput
- func (s *UpdateAuthorizerInput) SetRestApiId(v string) *UpdateAuthorizerInput
- func (s UpdateAuthorizerInput) String() string
- func (s *UpdateAuthorizerInput) Validate() error
- type UpdateBasePathMappingInput
- func (s UpdateBasePathMappingInput) GoString() string
- func (s *UpdateBasePathMappingInput) SetBasePath(v string) *UpdateBasePathMappingInput
- func (s *UpdateBasePathMappingInput) SetDomainName(v string) *UpdateBasePathMappingInput
- func (s *UpdateBasePathMappingInput) SetPatchOperations(v []*PatchOperation) *UpdateBasePathMappingInput
- func (s UpdateBasePathMappingInput) String() string
- func (s *UpdateBasePathMappingInput) Validate() error
- type UpdateClientCertificateInput
- func (s UpdateClientCertificateInput) GoString() string
- func (s *UpdateClientCertificateInput) SetClientCertificateId(v string) *UpdateClientCertificateInput
- func (s *UpdateClientCertificateInput) SetPatchOperations(v []*PatchOperation) *UpdateClientCertificateInput
- func (s UpdateClientCertificateInput) String() string
- func (s *UpdateClientCertificateInput) Validate() error
- type UpdateDeploymentInput
- func (s UpdateDeploymentInput) GoString() string
- func (s *UpdateDeploymentInput) SetDeploymentId(v string) *UpdateDeploymentInput
- func (s *UpdateDeploymentInput) SetPatchOperations(v []*PatchOperation) *UpdateDeploymentInput
- func (s *UpdateDeploymentInput) SetRestApiId(v string) *UpdateDeploymentInput
- func (s UpdateDeploymentInput) String() string
- func (s *UpdateDeploymentInput) Validate() error
- type UpdateDocumentationPartInput
- func (s UpdateDocumentationPartInput) GoString() string
- func (s *UpdateDocumentationPartInput) SetDocumentationPartId(v string) *UpdateDocumentationPartInput
- func (s *UpdateDocumentationPartInput) SetPatchOperations(v []*PatchOperation) *UpdateDocumentationPartInput
- func (s *UpdateDocumentationPartInput) SetRestApiId(v string) *UpdateDocumentationPartInput
- func (s UpdateDocumentationPartInput) String() string
- func (s *UpdateDocumentationPartInput) Validate() error
- type UpdateDocumentationVersionInput
- func (s UpdateDocumentationVersionInput) GoString() string
- func (s *UpdateDocumentationVersionInput) SetDocumentationVersion(v string) *UpdateDocumentationVersionInput
- func (s *UpdateDocumentationVersionInput) SetPatchOperations(v []*PatchOperation) *UpdateDocumentationVersionInput
- func (s *UpdateDocumentationVersionInput) SetRestApiId(v string) *UpdateDocumentationVersionInput
- func (s UpdateDocumentationVersionInput) String() string
- func (s *UpdateDocumentationVersionInput) Validate() error
- type UpdateDomainNameInput
- func (s UpdateDomainNameInput) GoString() string
- func (s *UpdateDomainNameInput) SetDomainName(v string) *UpdateDomainNameInput
- func (s *UpdateDomainNameInput) SetPatchOperations(v []*PatchOperation) *UpdateDomainNameInput
- func (s UpdateDomainNameInput) String() string
- func (s *UpdateDomainNameInput) Validate() error
- type UpdateGatewayResponseInput
- func (s UpdateGatewayResponseInput) GoString() string
- func (s *UpdateGatewayResponseInput) SetPatchOperations(v []*PatchOperation) *UpdateGatewayResponseInput
- func (s *UpdateGatewayResponseInput) SetResponseType(v string) *UpdateGatewayResponseInput
- func (s *UpdateGatewayResponseInput) SetRestApiId(v string) *UpdateGatewayResponseInput
- func (s UpdateGatewayResponseInput) String() string
- func (s *UpdateGatewayResponseInput) Validate() error
- type UpdateGatewayResponseOutput
- func (s UpdateGatewayResponseOutput) GoString() string
- func (s *UpdateGatewayResponseOutput) SetDefaultResponse(v bool) *UpdateGatewayResponseOutput
- func (s *UpdateGatewayResponseOutput) SetResponseParameters(v map[string]*string) *UpdateGatewayResponseOutput
- func (s *UpdateGatewayResponseOutput) SetResponseTemplates(v map[string]*string) *UpdateGatewayResponseOutput
- func (s *UpdateGatewayResponseOutput) SetResponseType(v string) *UpdateGatewayResponseOutput
- func (s *UpdateGatewayResponseOutput) SetStatusCode(v string) *UpdateGatewayResponseOutput
- func (s UpdateGatewayResponseOutput) String() string
- type UpdateIntegrationInput
- func (s UpdateIntegrationInput) GoString() string
- func (s *UpdateIntegrationInput) SetHttpMethod(v string) *UpdateIntegrationInput
- func (s *UpdateIntegrationInput) SetPatchOperations(v []*PatchOperation) *UpdateIntegrationInput
- func (s *UpdateIntegrationInput) SetResourceId(v string) *UpdateIntegrationInput
- func (s *UpdateIntegrationInput) SetRestApiId(v string) *UpdateIntegrationInput
- func (s UpdateIntegrationInput) String() string
- func (s *UpdateIntegrationInput) Validate() error
- type UpdateIntegrationResponseInput
- func (s UpdateIntegrationResponseInput) GoString() string
- func (s *UpdateIntegrationResponseInput) SetHttpMethod(v string) *UpdateIntegrationResponseInput
- func (s *UpdateIntegrationResponseInput) SetPatchOperations(v []*PatchOperation) *UpdateIntegrationResponseInput
- func (s *UpdateIntegrationResponseInput) SetResourceId(v string) *UpdateIntegrationResponseInput
- func (s *UpdateIntegrationResponseInput) SetRestApiId(v string) *UpdateIntegrationResponseInput
- func (s *UpdateIntegrationResponseInput) SetStatusCode(v string) *UpdateIntegrationResponseInput
- func (s UpdateIntegrationResponseInput) String() string
- func (s *UpdateIntegrationResponseInput) Validate() error
- type UpdateMethodInput
- func (s UpdateMethodInput) GoString() string
- func (s *UpdateMethodInput) SetHttpMethod(v string) *UpdateMethodInput
- func (s *UpdateMethodInput) SetPatchOperations(v []*PatchOperation) *UpdateMethodInput
- func (s *UpdateMethodInput) SetResourceId(v string) *UpdateMethodInput
- func (s *UpdateMethodInput) SetRestApiId(v string) *UpdateMethodInput
- func (s UpdateMethodInput) String() string
- func (s *UpdateMethodInput) Validate() error
- type UpdateMethodResponseInput
- func (s UpdateMethodResponseInput) GoString() string
- func (s *UpdateMethodResponseInput) SetHttpMethod(v string) *UpdateMethodResponseInput
- func (s *UpdateMethodResponseInput) SetPatchOperations(v []*PatchOperation) *UpdateMethodResponseInput
- func (s *UpdateMethodResponseInput) SetResourceId(v string) *UpdateMethodResponseInput
- func (s *UpdateMethodResponseInput) SetRestApiId(v string) *UpdateMethodResponseInput
- func (s *UpdateMethodResponseInput) SetStatusCode(v string) *UpdateMethodResponseInput
- func (s UpdateMethodResponseInput) String() string
- func (s *UpdateMethodResponseInput) Validate() error
- type UpdateModelInput
- func (s UpdateModelInput) GoString() string
- func (s *UpdateModelInput) SetModelName(v string) *UpdateModelInput
- func (s *UpdateModelInput) SetPatchOperations(v []*PatchOperation) *UpdateModelInput
- func (s *UpdateModelInput) SetRestApiId(v string) *UpdateModelInput
- func (s UpdateModelInput) String() string
- func (s *UpdateModelInput) Validate() error
- type UpdateRequestValidatorInput
- func (s UpdateRequestValidatorInput) GoString() string
- func (s *UpdateRequestValidatorInput) SetPatchOperations(v []*PatchOperation) *UpdateRequestValidatorInput
- func (s *UpdateRequestValidatorInput) SetRequestValidatorId(v string) *UpdateRequestValidatorInput
- func (s *UpdateRequestValidatorInput) SetRestApiId(v string) *UpdateRequestValidatorInput
- func (s UpdateRequestValidatorInput) String() string
- func (s *UpdateRequestValidatorInput) Validate() error
- type UpdateRequestValidatorOutput
- func (s UpdateRequestValidatorOutput) GoString() string
- func (s *UpdateRequestValidatorOutput) SetId(v string) *UpdateRequestValidatorOutput
- func (s *UpdateRequestValidatorOutput) SetName(v string) *UpdateRequestValidatorOutput
- func (s *UpdateRequestValidatorOutput) SetValidateRequestBody(v bool) *UpdateRequestValidatorOutput
- func (s *UpdateRequestValidatorOutput) SetValidateRequestParameters(v bool) *UpdateRequestValidatorOutput
- func (s UpdateRequestValidatorOutput) String() string
- type UpdateResourceInput
- func (s UpdateResourceInput) GoString() string
- func (s *UpdateResourceInput) SetPatchOperations(v []*PatchOperation) *UpdateResourceInput
- func (s *UpdateResourceInput) SetResourceId(v string) *UpdateResourceInput
- func (s *UpdateResourceInput) SetRestApiId(v string) *UpdateResourceInput
- func (s UpdateResourceInput) String() string
- func (s *UpdateResourceInput) Validate() error
- type UpdateRestApiInput
- type UpdateStageInput
- func (s UpdateStageInput) GoString() string
- func (s *UpdateStageInput) SetPatchOperations(v []*PatchOperation) *UpdateStageInput
- func (s *UpdateStageInput) SetRestApiId(v string) *UpdateStageInput
- func (s *UpdateStageInput) SetStageName(v string) *UpdateStageInput
- func (s UpdateStageInput) String() string
- func (s *UpdateStageInput) Validate() error
- type UpdateUsageInput
- func (s UpdateUsageInput) GoString() string
- func (s *UpdateUsageInput) SetKeyId(v string) *UpdateUsageInput
- func (s *UpdateUsageInput) SetPatchOperations(v []*PatchOperation) *UpdateUsageInput
- func (s *UpdateUsageInput) SetUsagePlanId(v string) *UpdateUsageInput
- func (s UpdateUsageInput) String() string
- func (s *UpdateUsageInput) Validate() error
- type UpdateUsagePlanInput
- func (s UpdateUsagePlanInput) GoString() string
- func (s *UpdateUsagePlanInput) SetPatchOperations(v []*PatchOperation) *UpdateUsagePlanInput
- func (s *UpdateUsagePlanInput) SetUsagePlanId(v string) *UpdateUsagePlanInput
- func (s UpdateUsagePlanInput) String() string
- func (s *UpdateUsagePlanInput) Validate() error
- type Usage
- func (s Usage) GoString() string
- func (s *Usage) SetEndDate(v string) *Usage
- func (s *Usage) SetItems(v map[string][][]*int64) *Usage
- func (s *Usage) SetPosition(v string) *Usage
- func (s *Usage) SetStartDate(v string) *Usage
- func (s *Usage) SetUsagePlanId(v string) *Usage
- func (s Usage) String() string
- type UsagePlan
- func (s UsagePlan) GoString() string
- func (s *UsagePlan) SetApiStages(v []*ApiStage) *UsagePlan
- func (s *UsagePlan) SetDescription(v string) *UsagePlan
- func (s *UsagePlan) SetId(v string) *UsagePlan
- func (s *UsagePlan) SetName(v string) *UsagePlan
- func (s *UsagePlan) SetProductCode(v string) *UsagePlan
- func (s *UsagePlan) SetQuota(v *QuotaSettings) *UsagePlan
- func (s *UsagePlan) SetThrottle(v *ThrottleSettings) *UsagePlan
- func (s UsagePlan) String() string
- type UsagePlanKey
Constants ¶
const ( // AuthorizerTypeToken is a AuthorizerType enum value AuthorizerTypeToken = "TOKEN" // AuthorizerTypeRequest is a AuthorizerType enum value AuthorizerTypeRequest = "REQUEST" // AuthorizerTypeCognitoUserPools is a AuthorizerType enum value AuthorizerTypeCognitoUserPools = "COGNITO_USER_POOLS" )
[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
const ( // 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 size 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" )
Returns the status of the CacheCluster.
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" )
const ( // EndpointTypeRegional is a EndpointType enum value EndpointTypeRegional = "REGIONAL" // EndpointTypeEdge is a EndpointType enum value EndpointTypeEdge = "EDGE" )
The endpoint type. The valid value is EDGE for edge-optimized API setup, most suitable for mobile applications, REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region
const ( // GatewayResponseTypeDefault4xx is a GatewayResponseType enum value GatewayResponseTypeDefault4xx = "DEFAULT_4XX" // GatewayResponseTypeDefault5xx is a GatewayResponseType enum value GatewayResponseTypeDefault5xx = "DEFAULT_5XX" // GatewayResponseTypeResourceNotFound is a GatewayResponseType enum value GatewayResponseTypeResourceNotFound = "RESOURCE_NOT_FOUND" GatewayResponseTypeUnauthorized = "UNAUTHORIZED" // GatewayResponseTypeInvalidApiKey is a GatewayResponseType enum value GatewayResponseTypeInvalidApiKey = "INVALID_API_KEY" // GatewayResponseTypeAccessDenied is a GatewayResponseType enum value GatewayResponseTypeAccessDenied = "ACCESS_DENIED" // GatewayResponseTypeAuthorizerFailure is a GatewayResponseType enum value GatewayResponseTypeAuthorizerFailure = "AUTHORIZER_FAILURE" // GatewayResponseTypeAuthorizerConfigurationError is a GatewayResponseType enum value GatewayResponseTypeAuthorizerConfigurationError = "AUTHORIZER_CONFIGURATION_ERROR" // GatewayResponseTypeInvalidSignature is a GatewayResponseType enum value GatewayResponseTypeInvalidSignature = "INVALID_SIGNATURE" // GatewayResponseTypeExpiredToken is a GatewayResponseType enum value GatewayResponseTypeExpiredToken = "EXPIRED_TOKEN" // GatewayResponseTypeMissingAuthenticationToken is a GatewayResponseType enum value GatewayResponseTypeMissingAuthenticationToken = "MISSING_AUTHENTICATION_TOKEN" // GatewayResponseTypeIntegrationFailure is a GatewayResponseType enum value GatewayResponseTypeIntegrationFailure = "INTEGRATION_FAILURE" // GatewayResponseTypeIntegrationTimeout is a GatewayResponseType enum value GatewayResponseTypeIntegrationTimeout = "INTEGRATION_TIMEOUT" // GatewayResponseTypeApiConfigurationError is a GatewayResponseType enum value GatewayResponseTypeApiConfigurationError = "API_CONFIGURATION_ERROR" // GatewayResponseTypeUnsupportedMediaType is a GatewayResponseType enum value GatewayResponseTypeUnsupportedMediaType = "UNSUPPORTED_MEDIA_TYPE" // GatewayResponseTypeBadRequestParameters is a GatewayResponseType enum value GatewayResponseTypeBadRequestParameters = "BAD_REQUEST_PARAMETERS" // GatewayResponseTypeBadRequestBody is a GatewayResponseType enum value GatewayResponseTypeBadRequestBody = "BAD_REQUEST_BODY" // GatewayResponseTypeRequestTooLarge is a GatewayResponseType enum value GatewayResponseTypeRequestTooLarge = "REQUEST_TOO_LARGE" // GatewayResponseTypeThrottled is a GatewayResponseType enum value GatewayResponseTypeThrottled = "THROTTLED" // GatewayResponseTypeQuotaExceeded is a GatewayResponseType enum value GatewayResponseTypeQuotaExceeded = "QUOTA_EXCEEDED" )
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" )
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 ( // LocationStatusTypeDocumented is a LocationStatusType enum value LocationStatusTypeDocumented = "DOCUMENTED" // LocationStatusTypeUndocumented is a LocationStatusType enum value LocationStatusTypeUndocumented = "UNDOCUMENTED" )
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 = "FAIL_WITH_403" UnauthorizedCacheControlHeaderStrategySucceedWithResponseHeader = "SUCCEED_WITH_RESPONSE_HEADER" UnauthorizedCacheControlHeaderStrategySucceedWithoutResponseHeader = "SUCCEED_WITHOUT_RESPONSE_HEADER" )
const ( // ErrCodeBadRequestException for service response error code // "BadRequestException". // // The submitted request is not valid, for example, the input is incomplete // or incorrect. See the accompanying error message for details. ErrCodeBadRequestException = "BadRequestException" // ErrCodeConflictException for service response error code // "ConflictException". // // The request configuration has conflicts. For details, see the accompanying // error message. ErrCodeConflictException = "ConflictException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // The request exceeded the rate limit. Retry after the specified time period. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeNotFoundException for service response error code // "NotFoundException". // // The requested resource is not found. Make sure that the request URI is correct. ErrCodeNotFoundException = "NotFoundException" // "ServiceUnavailableException". // // The requested service is not available. For details see the accompanying // error message. Retry after the specified time period. ErrCodeServiceUnavailableException = "ServiceUnavailableException" // ErrCodeTooManyRequestsException for service response error code // "TooManyRequestsException". // // The request has reached its throttling limit. Retry after the specified time // period. ErrCodeTooManyRequestsException = "TooManyRequestsException" // "UnauthorizedException". // // The request is denied because the caller has insufficient permissions. ErrCodeUnauthorizedException = "UnauthorizedException" )
const ( ServiceName = "apigateway" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
const (
// ApiKeysFormatCsv is a ApiKeysFormat enum value
ApiKeysFormatCsv = "csv"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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.
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateApiKey for more information on using the CreateApiKey API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.1.2
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) CreateAuthorizerRequest ¶ added in v1.1.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateAuthorizer for more information on using the CreateAuthorizer API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateBasePathMapping for more information on using the CreateBasePathMapping API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeServiceUnavailableException "ServiceUnavailableException" The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateDeployment for more information on using the CreateDeployment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.5.13
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) CreateDocumentationPartRequest ¶ added in v1.5.13
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateDocumentationPart for more information on using the CreateDocumentationPart API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.5.13
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) CreateDocumentationVersionRequest ¶ added in v1.5.13
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateDocumentationVersion for more information on using the CreateDocumentationVersion API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateDomainName for more information on using the CreateDomainName API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateModel for more information on using the CreateModel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.12
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) CreateRequestValidatorRequest ¶ added in v1.8.12
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateRequestValidator for more information on using the CreateRequestValidator API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.12
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateResource for more information on using the CreateResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateRestApi for more information on using the CreateRestApi API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateStage for more information on using the CreateStage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
func (*APIGateway) CreateUsagePlanKey ¶ added in v1.4.2
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) CreateUsagePlanKeyRequest ¶ added in v1.4.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateUsagePlanKey for more information on using the CreateUsagePlanKey API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateUsagePlan for more information on using the CreateUsagePlan API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteApiKey for more information on using the DeleteApiKey API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.1.2
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
func (*APIGateway) DeleteAuthorizerRequest ¶ added in v1.1.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteAuthorizer for more information on using the DeleteAuthorizer API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteBasePathMapping for more information on using the DeleteBasePathMapping API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteClientCertificate for more information on using the DeleteClientCertificate API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteDeployment for more information on using the DeleteDeployment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.5.13
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
func (*APIGateway) DeleteDocumentationPartRequest ¶ added in v1.5.13
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteDocumentationPart for more information on using the DeleteDocumentationPart API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.5.13
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) DeleteDocumentationVersionRequest ¶ added in v1.5.13
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteDocumentationVersion for more information on using the DeleteDocumentationVersion API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteDomainName for more information on using the DeleteDomainName API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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) DeleteGatewayResponse ¶ added in v1.10.10
func (c *APIGateway) DeleteGatewayResponse(input *DeleteGatewayResponseInput) (*DeleteGatewayResponseOutput, error)
DeleteGatewayResponse API operation for Amazon API Gateway.
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
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 DeleteGatewayResponse for usage and error information.
Returned Error Codes:
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
func (*APIGateway) DeleteGatewayResponseRequest ¶ added in v1.10.10
func (c *APIGateway) DeleteGatewayResponseRequest(input *DeleteGatewayResponseInput) (req *request.Request, output *DeleteGatewayResponseOutput)
DeleteGatewayResponseRequest generates a "aws/request.Request" representing the client's request for the DeleteGatewayResponse operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteGatewayResponse for more information on using the DeleteGatewayResponse API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteGatewayResponseRequest method. req, resp := client.DeleteGatewayResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteGatewayResponseWithContext ¶ added in v1.10.10
func (c *APIGateway) DeleteGatewayResponseWithContext(ctx aws.Context, input *DeleteGatewayResponseInput, opts ...request.Option) (*DeleteGatewayResponseOutput, error)
DeleteGatewayResponseWithContext is the same as DeleteGatewayResponse with the addition of the ability to pass a context and additional request options.
See DeleteGatewayResponse 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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteIntegration for more information on using the DeleteIntegration API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteIntegrationResponse for more information on using the DeleteIntegrationResponse API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteMethod for more information on using the DeleteMethod API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteMethodResponse for more information on using the DeleteMethodResponse API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteModel for more information on using the DeleteModel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.12
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
func (*APIGateway) DeleteRequestValidatorRequest ¶ added in v1.8.12
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteRequestValidator for more information on using the DeleteRequestValidator API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.12
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteResource for more information on using the DeleteResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteRestApi for more information on using the DeleteRestApi API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteStage for more information on using the DeleteStage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
func (*APIGateway) DeleteUsagePlanKey ¶ added in v1.4.2
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) DeleteUsagePlanKeyRequest ¶ added in v1.4.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteUsagePlanKey for more information on using the DeleteUsagePlanKey API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteUsagePlan for more information on using the DeleteUsagePlan API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.1.8
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) FlushStageAuthorizersCacheRequest ¶ added in v1.1.8
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See FlushStageAuthorizersCache for more information on using the FlushStageAuthorizersCache API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See FlushStageCache for more information on using the FlushStageCache API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GenerateClientCertificate for more information on using the GenerateClientCertificate API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetAccount for more information on using the GetAccount API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetApiKey for more information on using the GetApiKey API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 ¶ added in v1.8.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetApiKeys for more information on using the GetApiKeys API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.1.2
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetAuthorizerRequest ¶ added in v1.1.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetAuthorizer for more information on using the GetAuthorizer API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.1.2
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetAuthorizersRequest ¶ added in v1.1.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetAuthorizers for more information on using the GetAuthorizers API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetBasePathMapping for more information on using the GetBasePathMapping API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 ¶ added in v1.8.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetBasePathMappings for more information on using the GetBasePathMappings API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetClientCertificate for more information on using the GetClientCertificate API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 ¶ added in v1.8.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetClientCertificates for more information on using the GetClientCertificates API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeServiceUnavailableException "ServiceUnavailableException" The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetDeployment for more information on using the GetDeployment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeServiceUnavailableException "ServiceUnavailableException" The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
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 ¶ added in v1.8.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetDeployments for more information on using the GetDeployments API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.5.13
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetDocumentationPartRequest ¶ added in v1.5.13
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetDocumentationPart for more information on using the GetDocumentationPart API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.5.13
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetDocumentationPartsRequest ¶ added in v1.5.13
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetDocumentationParts for more information on using the GetDocumentationParts API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.5.13
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetDocumentationVersionRequest ¶ added in v1.5.13
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetDocumentationVersion for more information on using the GetDocumentationVersion API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.5.13
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetDocumentationVersionsRequest ¶ added in v1.5.13
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetDocumentationVersions for more information on using the GetDocumentationVersions API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeServiceUnavailableException "ServiceUnavailableException" The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetDomainName for more information on using the GetDomainName API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 ¶ added in v1.8.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetDomainNames for more information on using the GetDomainNames API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.1.2
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetExportRequest ¶ added in v1.1.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetExport for more information on using the GetExport API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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) GetGatewayResponse ¶ added in v1.10.10
func (c *APIGateway) GetGatewayResponse(input *GetGatewayResponseInput) (*UpdateGatewayResponseOutput, error)
GetGatewayResponse API operation for Amazon API Gateway.
Gets a GatewayResponse of a specified response type on the 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 GetGatewayResponse for usage and error information.
Returned Error Codes:
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetGatewayResponseRequest ¶ added in v1.10.10
func (c *APIGateway) GetGatewayResponseRequest(input *GetGatewayResponseInput) (req *request.Request, output *UpdateGatewayResponseOutput)
GetGatewayResponseRequest generates a "aws/request.Request" representing the client's request for the GetGatewayResponse operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetGatewayResponse for more information on using the GetGatewayResponse API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetGatewayResponseRequest method. req, resp := client.GetGatewayResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetGatewayResponseWithContext ¶ added in v1.10.10
func (c *APIGateway) GetGatewayResponseWithContext(ctx aws.Context, input *GetGatewayResponseInput, opts ...request.Option) (*UpdateGatewayResponseOutput, error)
GetGatewayResponseWithContext is the same as GetGatewayResponse with the addition of the ability to pass a context and additional request options.
See GetGatewayResponse 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) GetGatewayResponses ¶ added in v1.10.10
func (c *APIGateway) GetGatewayResponses(input *GetGatewayResponsesInput) (*GetGatewayResponsesOutput, error)
GetGatewayResponses API operation for Amazon API Gateway.
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the Amazon API Gateway-generated default GatewayResponses collection for the supported response types.
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 GetGatewayResponses for usage and error information.
Returned Error Codes:
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetGatewayResponsesRequest ¶ added in v1.10.10
func (c *APIGateway) GetGatewayResponsesRequest(input *GetGatewayResponsesInput) (req *request.Request, output *GetGatewayResponsesOutput)
GetGatewayResponsesRequest generates a "aws/request.Request" representing the client's request for the GetGatewayResponses operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetGatewayResponses for more information on using the GetGatewayResponses API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetGatewayResponsesRequest method. req, resp := client.GetGatewayResponsesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetGatewayResponsesWithContext ¶ added in v1.10.10
func (c *APIGateway) GetGatewayResponsesWithContext(ctx aws.Context, input *GetGatewayResponsesInput, opts ...request.Option) (*GetGatewayResponsesOutput, error)
GetGatewayResponsesWithContext is the same as GetGatewayResponses with the addition of the ability to pass a context and additional request options.
See GetGatewayResponses 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.
Get the integration settings.
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetIntegration for more information on using the GetIntegration API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetIntegrationResponse for more information on using the GetIntegrationResponse API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetMethod for more information on using the GetMethod API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetMethodResponse for more information on using the GetMethodResponse API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetModel for more information on using the GetModel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetModelTemplate for more information on using the GetModelTemplate API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.0
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 ¶ added in v1.8.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetModels for more information on using the GetModels API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.12
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetRequestValidatorRequest ¶ added in v1.8.12
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetRequestValidator for more information on using the GetRequestValidator API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.12
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 ¶ added in v1.8.12
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetRequestValidatorsRequest ¶ added in v1.8.12
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetRequestValidators for more information on using the GetRequestValidators API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.12
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetResource for more information on using the GetResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 ¶ added in v1.8.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetResources for more information on using the GetResources API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetRestApi for more information on using the GetRestApi API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 ¶ added in v1.8.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetRestApis for more information on using the GetRestApis API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetSdk for more information on using the GetSdk API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.6.8
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetSdkTypeRequest ¶ added in v1.6.8
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetSdkType for more information on using the GetSdkType API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.6.8
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" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetSdkTypesRequest ¶ added in v1.6.8
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetSdkTypes for more information on using the GetSdkTypes API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetStage for more information on using the GetStage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetStages for more information on using the GetStages API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetUsagePages ¶ added in v1.4.2
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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetUsagePlanKey ¶ added in v1.4.2
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetUsagePlanKeyRequest ¶ added in v1.4.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetUsagePlanKey for more information on using the GetUsagePlanKey API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) GetUsagePlanKeysPages ¶ added in v1.4.2
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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetUsagePlanKeys for more information on using the GetUsagePlanKeys API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetUsagePlan for more information on using the GetUsagePlan API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
func (*APIGateway) GetUsagePlansPages ¶ added in v1.4.2
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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetUsagePlans for more information on using the GetUsagePlans API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetUsage for more information on using the GetUsage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
func (*APIGateway) ImportApiKeysRequest ¶ added in v1.4.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ImportApiKeys for more information on using the ImportApiKeys API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.5.13
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) ImportDocumentationPartsRequest ¶ added in v1.5.13
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ImportDocumentationParts for more information on using the ImportDocumentationParts API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.1.16
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" The request is denied because the caller has insufficient permissions.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
func (*APIGateway) ImportRestApiRequest ¶ added in v1.1.16
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ImportRestApi for more information on using the ImportRestApi API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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) PutGatewayResponse ¶ added in v1.10.10
func (c *APIGateway) PutGatewayResponse(input *PutGatewayResponseInput) (*UpdateGatewayResponseOutput, error)
PutGatewayResponse API operation for Amazon API Gateway.
Creates a customization of a GatewayResponse of a specified response type and status code on the 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 PutGatewayResponse for usage and error information.
Returned Error Codes:
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) PutGatewayResponseRequest ¶ added in v1.10.10
func (c *APIGateway) PutGatewayResponseRequest(input *PutGatewayResponseInput) (req *request.Request, output *UpdateGatewayResponseOutput)
PutGatewayResponseRequest generates a "aws/request.Request" representing the client's request for the PutGatewayResponse operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutGatewayResponse for more information on using the PutGatewayResponse API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the PutGatewayResponseRequest method. req, resp := client.PutGatewayResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutGatewayResponseWithContext ¶ added in v1.10.10
func (c *APIGateway) PutGatewayResponseWithContext(ctx aws.Context, input *PutGatewayResponseInput, opts ...request.Option) (*UpdateGatewayResponseOutput, error)
PutGatewayResponseWithContext is the same as PutGatewayResponse with the addition of the ability to pass a context and additional request options.
See PutGatewayResponse 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.
Sets up a method's 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" The request is denied because the caller has insufficient permissions.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutIntegration for more information on using the PutIntegration API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutIntegrationResponse for more information on using the PutIntegrationResponse API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.0
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutMethod for more information on using the PutMethod API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutMethodResponse for more information on using the PutMethodResponse API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.0
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 ¶ added in v1.1.16
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" The request is denied because the caller has insufficient permissions.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
func (*APIGateway) PutRestApiRequest ¶ added in v1.1.16
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutRestApi for more information on using the PutRestApi API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.1.8
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) TestInvokeAuthorizerRequest ¶ added in v1.1.8
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TestInvokeAuthorizer for more information on using the TestInvokeAuthorizer API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TestInvokeMethod for more information on using the TestInvokeMethod API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateAccount for more information on using the UpdateAccount API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateApiKey for more information on using the UpdateApiKey API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.1.2
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) UpdateAuthorizerRequest ¶ added in v1.1.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateAuthorizer for more information on using the UpdateAuthorizer API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateBasePathMapping for more information on using the UpdateBasePathMapping API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateClientCertificate for more information on using the UpdateClientCertificate API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeServiceUnavailableException "ServiceUnavailableException" The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateDeployment for more information on using the UpdateDeployment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.5.13
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" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) UpdateDocumentationPartRequest ¶ added in v1.5.13
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateDocumentationPart for more information on using the UpdateDocumentationPart API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.5.13
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) UpdateDocumentationVersionRequest ¶ added in v1.5.13
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateDocumentationVersion for more information on using the UpdateDocumentationVersion API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateDomainName for more information on using the UpdateDomainName API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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) UpdateGatewayResponse ¶ added in v1.10.10
func (c *APIGateway) UpdateGatewayResponse(input *UpdateGatewayResponseInput) (*UpdateGatewayResponseOutput, error)
UpdateGatewayResponse API operation for Amazon API Gateway.
Updates a GatewayResponse of a specified response type on the 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 UpdateGatewayResponse for usage and error information.
Returned Error Codes:
ErrCodeUnauthorizedException "UnauthorizedException" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) UpdateGatewayResponseRequest ¶ added in v1.10.10
func (c *APIGateway) UpdateGatewayResponseRequest(input *UpdateGatewayResponseInput) (req *request.Request, output *UpdateGatewayResponseOutput)
UpdateGatewayResponseRequest generates a "aws/request.Request" representing the client's request for the UpdateGatewayResponse operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateGatewayResponse for more information on using the UpdateGatewayResponse API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateGatewayResponseRequest method. req, resp := client.UpdateGatewayResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateGatewayResponseWithContext ¶ added in v1.10.10
func (c *APIGateway) UpdateGatewayResponseWithContext(ctx aws.Context, input *UpdateGatewayResponseInput, opts ...request.Option) (*UpdateGatewayResponseOutput, error)
UpdateGatewayResponseWithContext is the same as UpdateGatewayResponse with the addition of the ability to pass a context and additional request options.
See UpdateGatewayResponse 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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateIntegration for more information on using the UpdateIntegration API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateIntegrationResponse for more information on using the UpdateIntegrationResponse API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateMethod for more information on using the UpdateMethod API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeLimitExceededException "LimitExceededException" The request exceeded the rate limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateMethodResponse for more information on using the UpdateMethodResponse API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateModel for more information on using the UpdateModel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.8.12
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
func (*APIGateway) UpdateRequestValidatorRequest ¶ added in v1.8.12
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateRequestValidator for more information on using the UpdateRequestValidator API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.12
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateResource for more information on using the UpdateResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateRestApi for more information on using the UpdateRestApi API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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" The request is denied because the caller has insufficient permissions.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateStage for more information on using the UpdateStage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
func (c *APIGateway) UpdateUsage(input *UpdateUsageInput) (*Usage, error)
UpdateUsage API operation for Amazon API Gateway.
Grants a temporary extension to the remaining 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" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
func (*APIGateway) UpdateUsagePlan ¶ added in v1.4.2
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" The request is denied because the caller has insufficient permissions.
ErrCodeTooManyRequestsException "TooManyRequestsException" The request has reached its throttling limit. Retry after the specified time period.
ErrCodeBadRequestException "BadRequestException" The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ErrCodeNotFoundException "NotFoundException" The requested resource is not found. Make sure that the request URI is correct.
ErrCodeConflictException "ConflictException" The request configuration has conflicts. For details, see the accompanying error message.
func (*APIGateway) UpdateUsagePlanRequest ¶ added in v1.4.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateUsagePlan for more information on using the UpdateUsagePlan API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 ¶ added in v1.4.2
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateUsage for more information on using the UpdateUsage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// 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 ¶ added in v1.8.0
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 AccessLogSettings ¶ added in v1.12.32
type AccessLogSettings struct { // The ARN of the CloudWatch Logs log group to receive access logs. DestinationArn *string `locationName:"destinationArn" type:"string"` // A single line format of the access logs of data, as specified by selected // $context variables (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). // The format must include at least $context.requestId. Format *string `locationName:"format" type:"string"` // contains filtered or unexported fields }
Access log settings, including the access log format and access log destination ARN.
func (AccessLogSettings) GoString ¶ added in v1.12.32
func (s AccessLogSettings) GoString() string
GoString returns the string representation
func (*AccessLogSettings) SetDestinationArn ¶ added in v1.12.32
func (s *AccessLogSettings) SetDestinationArn(v string) *AccessLogSettings
SetDestinationArn sets the DestinationArn field's value.
func (*AccessLogSettings) SetFormat ¶ added in v1.12.32
func (s *AccessLogSettings) SetFormat(v string) *AccessLogSettings
SetFormat sets the Format field's value.
func (AccessLogSettings) String ¶ added in v1.12.32
func (s AccessLogSettings) String() string
String returns the string representation
type Account ¶
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 }
Represents an AWS account that is associated with Amazon API Gateway.
To view the account info, call GET on this resource.
Error Codes ¶
The following exception may be thrown when the request fails.
UnauthorizedException NotFoundException TooManyRequestsException For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes (http://docs.aws.amazon.com/apigateway/api-reference/handling-errors/#api-error-codes)
Example: Get the information about an account.
Request ¶
GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html", "name": "account", "templated": true }, "self": { "href": "/account" }, "account:update": { "href": "/account" } }, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": { "rateLimit": 500, "burstLimit": 1000 } } In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.
API Gateway Limits (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-limits.html)Developer Guide (http://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html), AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html)
func (*Account) SetApiKeyVersion ¶ added in v1.5.0
SetApiKeyVersion sets the ApiKeyVersion field's value.
func (*Account) SetCloudwatchRoleArn ¶ added in v1.5.0
SetCloudwatchRoleArn sets the CloudwatchRoleArn field's value.
func (*Account) SetFeatures ¶ added in v1.5.0
SetFeatures sets the Features field's value.
func (*Account) SetThrottleSettings ¶ added in v1.5.0
func (s *Account) SetThrottleSettings(v *ThrottleSettings) *Account
SetThrottleSettings sets the ThrottleSettings field's value.
type ApiKey ¶
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 }
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
Use API Keys (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html)
func (*ApiKey) SetCreatedDate ¶ added in v1.5.0
SetCreatedDate sets the CreatedDate field's value.
func (*ApiKey) SetCustomerId ¶ added in v1.5.13
SetCustomerId sets the CustomerId field's value.
func (*ApiKey) SetDescription ¶ added in v1.5.0
SetDescription sets the Description field's value.
func (*ApiKey) SetEnabled ¶ added in v1.5.0
SetEnabled sets the Enabled field's value.
func (*ApiKey) SetLastUpdatedDate ¶ added in v1.5.0
SetLastUpdatedDate sets the LastUpdatedDate field's value.
func (*ApiKey) SetStageKeys ¶ added in v1.5.0
SetStageKeys sets the StageKeys field's value.
type ApiStage ¶ added in v1.4.2
type ApiStage struct { // API Id of the associated API stage in a usage plan. ApiId *string `locationName:"apiId" type:"string"` // API stage name of the associated API stage in a usage plan. Stage *string `locationName:"stage" type:"string"` // contains filtered or unexported fields }
API stage name of the associated API stage in a usage plan.
type Authorizer ¶ added in v1.1.2
type Authorizer struct { // Optional customer-defined field, used in Swagger imports and exports without // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the required credentials as an IAM role for Amazon API Gateway // to invoke the authorizer. To specify an IAM role for Amazon API Gateway to // assume, use the role's Amazon Resource Name (ARN). To use resource-based // permissions on the Lambda function, specify null. AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"` // The TTL in seconds of cached authorizer results. If it equals 0, authorization // caching is disabled. If it is greater than 0, API Gateway will cache authorizer // responses. If this field is not set, the default value is 300. The maximum // value is 3600, or 1 hour. AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or // REQUEST authorizers, this must be a well-formed Lambda function URI, for // example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, // where {region} is the same as the region hosting the Lambda function, path // indicates that the remaining substring in the URI should be treated as the // path to the resource, including the initial /. For Lambda functions, this // is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. AuthorizerUri *string `locationName:"authorizerUri" type:"string"` // The identifier for the authorizer resource. Id *string `locationName:"id" type:"string"` // The identity source for which authorization is requested. For a TOKEN authorizer, // this is required and specifies the request header mapping expression for // the custom header holding the authorization token submitted by the client. // For example, if the token header name is Auth, the header mapping expression // is method.request.header.Auth. // For the REQUEST authorizer, this is required when authorization caching is // enabled. The value is a comma-separated string of one or more mapping expressions // of the specified request parameters. For example, if an Auth header, a Name // query string parameter are defined as identity sources, this value is method.request.header.Auth, // method.request.querystring.Name. These parameters will be used to derive // the authorization caching key and to perform runtime validation of the REQUEST // authorizer by verifying all of the identity-related request parameters are // present, not null and non-empty. Only when this is true does the authorizer // invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized // response without calling the Lambda function. The valid value is a string // of comma-separated mapping expressions of the specified request parameters. // When the authorization caching is not enabled, this property is optional. // // For a COGNITO_USER_POOLS authorizer, this property is not used. IdentitySource *string `locationName:"identitySource" type:"string"` // A validation expression for the incoming identity token. For TOKEN authorizers, // this value is a regular expression. Amazon API Gateway will match the incoming // token from the client against the specified regular expression. It will invoke // the authorizer's Lambda function there is a match. Otherwise, it will return // a 401 Unauthorized response without calling the Lambda function. The validation // expression does not apply to the REQUEST authorizer. IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` // [Required] The name of the authorizer. Name *string `locationName:"name" type:"string"` // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. // Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. // For a TOKEN or REQUEST authorizer, this is not defined. ProviderARNs []*string `locationName:"providerARNs" type:"list"` // [Required] The authorizer type. Valid values are TOKEN for a Lambda function // using a single authorization token submitted in a custom header, REQUEST // for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS // for using an Amazon Cognito user pool. Type *string `locationName:"type" type:"string" enum:"AuthorizerType"` // contains filtered or unexported fields }
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
Enable custom authorization (http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html)
func (Authorizer) GoString ¶ added in v1.1.2
func (s Authorizer) GoString() string
GoString returns the string representation
func (*Authorizer) SetAuthType ¶ added in v1.5.0
func (s *Authorizer) SetAuthType(v string) *Authorizer
SetAuthType sets the AuthType field's value.
func (*Authorizer) SetAuthorizerCredentials ¶ added in v1.5.0
func (s *Authorizer) SetAuthorizerCredentials(v string) *Authorizer
SetAuthorizerCredentials sets the AuthorizerCredentials field's value.
func (*Authorizer) SetAuthorizerResultTtlInSeconds ¶ added in v1.5.0
func (s *Authorizer) SetAuthorizerResultTtlInSeconds(v int64) *Authorizer
SetAuthorizerResultTtlInSeconds sets the AuthorizerResultTtlInSeconds field's value.
func (*Authorizer) SetAuthorizerUri ¶ added in v1.5.0
func (s *Authorizer) SetAuthorizerUri(v string) *Authorizer
SetAuthorizerUri sets the AuthorizerUri field's value.
func (*Authorizer) SetId ¶ added in v1.5.0
func (s *Authorizer) SetId(v string) *Authorizer
SetId sets the Id field's value.
func (*Authorizer) SetIdentitySource ¶ added in v1.5.0
func (s *Authorizer) SetIdentitySource(v string) *Authorizer
SetIdentitySource sets the IdentitySource field's value.
func (*Authorizer) SetIdentityValidationExpression ¶ added in v1.5.0
func (s *Authorizer) SetIdentityValidationExpression(v string) *Authorizer
SetIdentityValidationExpression sets the IdentityValidationExpression field's value.
func (*Authorizer) SetName ¶ added in v1.5.0
func (s *Authorizer) SetName(v string) *Authorizer
SetName sets the Name field's value.
func (*Authorizer) SetProviderARNs ¶ added in v1.5.0
func (s *Authorizer) SetProviderARNs(v []*string) *Authorizer
SetProviderARNs sets the ProviderARNs field's value.
func (*Authorizer) SetType ¶ added in v1.5.0
func (s *Authorizer) SetType(v string) *Authorizer
SetType sets the Type field's value.
func (Authorizer) String ¶ added in v1.1.2
func (s Authorizer) String() string
String returns the string representation
type BasePathMapping ¶
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 string identifier of the associated RestApi. RestApiId *string `locationName:"restApiId" type:"string"` // The name of the associated stage. Stage *string `locationName:"stage" type:"string"` // contains filtered or unexported fields }
Represents the base path that callers of the API must provide as part of the URL after the domain name.
A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account. Use Custom Domain Names (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (BasePathMapping) GoString ¶
func (s BasePathMapping) GoString() string
GoString returns the string representation
func (*BasePathMapping) SetBasePath ¶ added in v1.5.0
func (s *BasePathMapping) SetBasePath(v string) *BasePathMapping
SetBasePath sets the BasePath field's value.
func (*BasePathMapping) SetRestApiId ¶ added in v1.5.0
func (s *BasePathMapping) SetRestApiId(v string) *BasePathMapping
SetRestApiId sets the RestApiId field's value.
func (*BasePathMapping) SetStage ¶ added in v1.5.0
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 ¶
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 }
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool. Use Client-Side Certificate (http://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)
func (ClientCertificate) GoString ¶
func (s ClientCertificate) GoString() string
GoString returns the string representation
func (*ClientCertificate) SetClientCertificateId ¶ added in v1.5.0
func (s *ClientCertificate) SetClientCertificateId(v string) *ClientCertificate
SetClientCertificateId sets the ClientCertificateId field's value.
func (*ClientCertificate) SetCreatedDate ¶ added in v1.5.0
func (s *ClientCertificate) SetCreatedDate(v time.Time) *ClientCertificate
SetCreatedDate sets the CreatedDate field's value.
func (*ClientCertificate) SetDescription ¶ added in v1.5.0
func (s *ClientCertificate) SetDescription(v string) *ClientCertificate
SetDescription sets the Description field's value.
func (*ClientCertificate) SetExpirationDate ¶ added in v1.5.0
func (s *ClientCertificate) SetExpirationDate(v time.Time) *ClientCertificate
SetExpirationDate sets the ExpirationDate field's value.
func (*ClientCertificate) SetPemEncodedCertificate ¶ added in v1.5.0
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 ¶
type CreateApiKeyInput struct { // An AWS Marketplace customer identifier , when integrating with the AWS SaaS // Marketplace. CustomerId *string `locationName:"customerId" type:"string"` // The description of the ApiKey. Description *string `locationName:"description" type:"string"` // Specifies whether the ApiKey can be used by callers. Enabled *bool `locationName:"enabled" type:"boolean"` // Specifies whether (true) or not (false) the key identifier is distinct from // the created API key value. GenerateDistinctId *bool `locationName:"generateDistinctId" type:"boolean"` // The name of the ApiKey. Name *string `locationName:"name" type:"string"` // DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. StageKeys []*StageKey `locationName:"stageKeys" type:"list"` // Specifies a value of the API key. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
Request to create an ApiKey resource.
func (CreateApiKeyInput) GoString ¶
func (s CreateApiKeyInput) GoString() string
GoString returns the string representation
func (*CreateApiKeyInput) SetCustomerId ¶ added in v1.5.13
func (s *CreateApiKeyInput) SetCustomerId(v string) *CreateApiKeyInput
SetCustomerId sets the CustomerId field's value.
func (*CreateApiKeyInput) SetDescription ¶ added in v1.5.0
func (s *CreateApiKeyInput) SetDescription(v string) *CreateApiKeyInput
SetDescription sets the Description field's value.
func (*CreateApiKeyInput) SetEnabled ¶ added in v1.5.0
func (s *CreateApiKeyInput) SetEnabled(v bool) *CreateApiKeyInput
SetEnabled sets the Enabled field's value.
func (*CreateApiKeyInput) SetGenerateDistinctId ¶ added in v1.5.0
func (s *CreateApiKeyInput) SetGenerateDistinctId(v bool) *CreateApiKeyInput
SetGenerateDistinctId sets the GenerateDistinctId field's value.
func (*CreateApiKeyInput) SetName ¶ added in v1.5.0
func (s *CreateApiKeyInput) SetName(v string) *CreateApiKeyInput
SetName sets the Name field's value.
func (*CreateApiKeyInput) SetStageKeys ¶ added in v1.5.0
func (s *CreateApiKeyInput) SetStageKeys(v []*StageKey) *CreateApiKeyInput
SetStageKeys sets the StageKeys field's value.
func (*CreateApiKeyInput) SetValue ¶ added in v1.5.0
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 ¶ added in v1.1.2
type CreateAuthorizerInput struct { // Optional customer-defined field, used in Swagger imports and exports without // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the required credentials as an IAM role for Amazon API Gateway // to invoke the authorizer. To specify an IAM role for Amazon API Gateway to // assume, use the role's Amazon Resource Name (ARN). To use resource-based // permissions on the Lambda function, specify null. AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"` // The TTL in seconds of cached authorizer results. If it equals 0, authorization // caching is disabled. If it is greater than 0, API Gateway will cache authorizer // responses. If this field is not set, the default value is 300. The maximum // value is 3600, or 1 hour. AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or // REQUEST authorizers, this must be a well-formed Lambda function URI, for // example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, // where {region} is the same as the region hosting the Lambda function, path // indicates that the remaining substring in the URI should be treated as the // path to the resource, including the initial /. For Lambda functions, this // is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. AuthorizerUri *string `locationName:"authorizerUri" type:"string"` // The identity source for which authorization is requested. For a TOKEN authorizer, // this is required and specifies the request header mapping expression for // the custom header holding the authorization token submitted by the client. // For example, if the token header name is Auth, the header mapping expression // is method.request.header.Auth. // For the REQUEST authorizer, this is required when authorization caching is // enabled. The value is a comma-separated string of one or more mapping expressions // of the specified request parameters. For example, if an Auth header, a Name // query string parameter are defined as identity sources, this value is method.request.header.Auth, // method.request.querystring.Name. These parameters will be used to derive // the authorization caching key and to perform runtime validation of the REQUEST // authorizer by verifying all of the identity-related request parameters are // present, not null and non-empty. Only when this is true does the authorizer // invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized // response without calling the Lambda function. The valid value is a string // of comma-separated mapping expressions of the specified request parameters. // When the authorization caching is not enabled, this property is optional. // // For a COGNITO_USER_POOLS authorizer, this property is not used. IdentitySource *string `locationName:"identitySource" type:"string"` // A validation expression for the incoming identity token. For TOKEN authorizers, // this value is a regular expression. Amazon API Gateway will match the incoming // token from the client against the specified regular expression. It will invoke // the authorizer's Lambda function there is a match. Otherwise, it will return // a 401 Unauthorized response without calling the Lambda function. The validation // expression does not apply to the REQUEST authorizer. IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` // [Required] The name of the authorizer. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. // Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. // For a TOKEN or REQUEST authorizer, this is not defined. ProviderARNs []*string `locationName:"providerARNs" type:"list"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The authorizer type. Valid values are TOKEN for a Lambda function // using a single authorization token submitted in a custom header, REQUEST // for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS // for using an Amazon Cognito user pool. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"AuthorizerType"` // contains filtered or unexported fields }
Request to add a new Authorizer to an existing RestApi resource.
func (CreateAuthorizerInput) GoString ¶ added in v1.1.2
func (s CreateAuthorizerInput) GoString() string
GoString returns the string representation
func (*CreateAuthorizerInput) SetAuthType ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetAuthType(v string) *CreateAuthorizerInput
SetAuthType sets the AuthType field's value.
func (*CreateAuthorizerInput) SetAuthorizerCredentials ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetAuthorizerCredentials(v string) *CreateAuthorizerInput
SetAuthorizerCredentials sets the AuthorizerCredentials field's value.
func (*CreateAuthorizerInput) SetAuthorizerResultTtlInSeconds ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetAuthorizerResultTtlInSeconds(v int64) *CreateAuthorizerInput
SetAuthorizerResultTtlInSeconds sets the AuthorizerResultTtlInSeconds field's value.
func (*CreateAuthorizerInput) SetAuthorizerUri ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetAuthorizerUri(v string) *CreateAuthorizerInput
SetAuthorizerUri sets the AuthorizerUri field's value.
func (*CreateAuthorizerInput) SetIdentitySource ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetIdentitySource(v string) *CreateAuthorizerInput
SetIdentitySource sets the IdentitySource field's value.
func (*CreateAuthorizerInput) SetIdentityValidationExpression ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetIdentityValidationExpression(v string) *CreateAuthorizerInput
SetIdentityValidationExpression sets the IdentityValidationExpression field's value.
func (*CreateAuthorizerInput) SetName ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetName(v string) *CreateAuthorizerInput
SetName sets the Name field's value.
func (*CreateAuthorizerInput) SetProviderARNs ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetProviderARNs(v []*string) *CreateAuthorizerInput
SetProviderARNs sets the ProviderARNs field's value.
func (*CreateAuthorizerInput) SetRestApiId ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetRestApiId(v string) *CreateAuthorizerInput
SetRestApiId sets the RestApiId field's value.
func (*CreateAuthorizerInput) SetType ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetType(v string) *CreateAuthorizerInput
SetType sets the Type field's value.
func (CreateAuthorizerInput) String ¶ added in v1.1.2
func (s CreateAuthorizerInput) String() string
String returns the string representation
func (*CreateAuthorizerInput) Validate ¶ added in v1.1.21
func (s *CreateAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateBasePathMappingInput ¶
type CreateBasePathMappingInput struct { // The base path name that callers of the API must provide as part of the URL // after the domain name. This value must be unique for all of the mappings // across a single API. Leave this blank if you do not want callers to specify // a base path name after the domain name. BasePath *string `locationName:"basePath" type:"string"` // The domain name of the BasePathMapping resource to create. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `locationName:"restApiId" type:"string" required:"true"` // The name of the API's stage that you want to use for this mapping. Leave // this blank if you do not want callers to explicitly specify the stage name // after any base path name. Stage *string `locationName:"stage" type:"string"` // contains filtered or unexported fields }
Requests Amazon API Gateway to create a new BasePathMapping resource.
func (CreateBasePathMappingInput) GoString ¶
func (s CreateBasePathMappingInput) GoString() string
GoString returns the string representation
func (*CreateBasePathMappingInput) SetBasePath ¶ added in v1.5.0
func (s *CreateBasePathMappingInput) SetBasePath(v string) *CreateBasePathMappingInput
SetBasePath sets the BasePath field's value.
func (*CreateBasePathMappingInput) SetDomainName ¶ added in v1.5.0
func (s *CreateBasePathMappingInput) SetDomainName(v string) *CreateBasePathMappingInput
SetDomainName sets the DomainName field's value.
func (*CreateBasePathMappingInput) SetRestApiId ¶ added in v1.5.0
func (s *CreateBasePathMappingInput) SetRestApiId(v string) *CreateBasePathMappingInput
SetRestApiId sets the RestApiId field's value.
func (*CreateBasePathMappingInput) SetStage ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *CreateBasePathMappingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDeploymentInput ¶
type CreateDeploymentInput struct { // Enables a cache cluster for the Stage resource specified in the input. CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` // Specifies the cache cluster size for the Stage resource specified in the // input, if a cache cluster is enabled. CacheClusterSize *string `locationName:"cacheClusterSize" type:"string" enum:"CacheClusterSize"` // The description for the Deployment resource to create. Description *string `locationName:"description" type:"string"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The description of the Stage resource for the Deployment resource to create. StageDescription *string `locationName:"stageDescription" type:"string"` // The name of the Stage resource for the Deployment resource to create. StageName *string `locationName:"stageName" type:"string"` // A map that defines the stage variables for the Stage resource that is associated // with the new deployment. Variable names can have alphanumeric and underscore // characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Variables map[string]*string `locationName:"variables" type:"map"` // contains filtered or unexported fields }
Requests Amazon API Gateway to create a Deployment resource.
func (CreateDeploymentInput) GoString ¶
func (s CreateDeploymentInput) GoString() string
GoString returns the string representation
func (*CreateDeploymentInput) SetCacheClusterEnabled ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetCacheClusterEnabled(v bool) *CreateDeploymentInput
SetCacheClusterEnabled sets the CacheClusterEnabled field's value.
func (*CreateDeploymentInput) SetCacheClusterSize ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetCacheClusterSize(v string) *CreateDeploymentInput
SetCacheClusterSize sets the CacheClusterSize field's value.
func (*CreateDeploymentInput) SetDescription ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetDescription(v string) *CreateDeploymentInput
SetDescription sets the Description field's value.
func (*CreateDeploymentInput) SetRestApiId ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetRestApiId(v string) *CreateDeploymentInput
SetRestApiId sets the RestApiId field's value.
func (*CreateDeploymentInput) SetStageDescription ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetStageDescription(v string) *CreateDeploymentInput
SetStageDescription sets the StageDescription field's value.
func (*CreateDeploymentInput) SetStageName ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetStageName(v string) *CreateDeploymentInput
SetStageName sets the StageName field's value.
func (*CreateDeploymentInput) SetVariables ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *CreateDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDocumentationPartInput ¶ added in v1.5.13
type CreateDocumentationPartInput struct { // [Required] The location of the targeted API entity of the to-be-created documentation // part. // // Location is a required field Location *DocumentationPartLocation `locationName:"location" type:"structure" required:"true"` // [Required] The new documentation content map of the targeted API entity. // Enclosed key-value pairs are API-specific, but only Swagger-compliant key-value // pairs can be exported and, hence, published. // // Properties is a required field Properties *string `locationName:"properties" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Creates a new documentation part of a given API.
func (CreateDocumentationPartInput) GoString ¶ added in v1.5.13
func (s CreateDocumentationPartInput) GoString() string
GoString returns the string representation
func (*CreateDocumentationPartInput) SetLocation ¶ added in v1.5.13
func (s *CreateDocumentationPartInput) SetLocation(v *DocumentationPartLocation) *CreateDocumentationPartInput
SetLocation sets the Location field's value.
func (*CreateDocumentationPartInput) SetProperties ¶ added in v1.5.13
func (s *CreateDocumentationPartInput) SetProperties(v string) *CreateDocumentationPartInput
SetProperties sets the Properties field's value.
func (*CreateDocumentationPartInput) SetRestApiId ¶ added in v1.5.13
func (s *CreateDocumentationPartInput) SetRestApiId(v string) *CreateDocumentationPartInput
SetRestApiId sets the RestApiId field's value.
func (CreateDocumentationPartInput) String ¶ added in v1.5.13
func (s CreateDocumentationPartInput) String() string
String returns the string representation
func (*CreateDocumentationPartInput) Validate ¶ added in v1.5.13
func (s *CreateDocumentationPartInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDocumentationVersionInput ¶ added in v1.5.13
type CreateDocumentationVersionInput struct { // A description about the new documentation snapshot. Description *string `locationName:"description" type:"string"` // [Required] The version identifier of the new snapshot. // // DocumentationVersion is a required field DocumentationVersion *string `locationName:"documentationVersion" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The stage name to be associated with the new documentation snapshot. StageName *string `locationName:"stageName" type:"string"` // contains filtered or unexported fields }
Creates a new documentation version of a given API.
func (CreateDocumentationVersionInput) GoString ¶ added in v1.5.13
func (s CreateDocumentationVersionInput) GoString() string
GoString returns the string representation
func (*CreateDocumentationVersionInput) SetDescription ¶ added in v1.5.13
func (s *CreateDocumentationVersionInput) SetDescription(v string) *CreateDocumentationVersionInput
SetDescription sets the Description field's value.
func (*CreateDocumentationVersionInput) SetDocumentationVersion ¶ added in v1.5.13
func (s *CreateDocumentationVersionInput) SetDocumentationVersion(v string) *CreateDocumentationVersionInput
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*CreateDocumentationVersionInput) SetRestApiId ¶ added in v1.5.13
func (s *CreateDocumentationVersionInput) SetRestApiId(v string) *CreateDocumentationVersionInput
SetRestApiId sets the RestApiId field's value.
func (*CreateDocumentationVersionInput) SetStageName ¶ added in v1.5.13
func (s *CreateDocumentationVersionInput) SetStageName(v string) *CreateDocumentationVersionInput
SetStageName sets the StageName field's value.
func (CreateDocumentationVersionInput) String ¶ added in v1.5.13
func (s CreateDocumentationVersionInput) String() string
String returns the string representation
func (*CreateDocumentationVersionInput) Validate ¶ added in v1.5.13
func (s *CreateDocumentationVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDomainNameInput ¶
type CreateDomainNameInput struct { // The reference to an AWS-managed certificate that will be used by edge-optimized // endpoint for this domain name. AWS Certificate Manager is the only supported // source. CertificateArn *string `locationName:"certificateArn" type:"string"` // [Deprecated] The body of the server certificate that will be used by edge-optimized // endpoint for this domain name 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, used by an edge-optimized endpoint // for this domain name. 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 that will be used by edge-optimized // endpoint for this domain name. CertificateName *string `locationName:"certificateName" type:"string"` // [Deprecated] Your edge-optimized endpoint's domain name 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"` // The endpoint configuration of this DomainName showing the endpoint types // of the domain name. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The reference to an AWS-managed certificate that will be used by regional // endpoint for this domain name. AWS Certificate Manager is the only supported // source. RegionalCertificateArn *string `locationName:"regionalCertificateArn" type:"string"` // The user-friendly name of the certificate that will be used by regional endpoint // for this domain name. RegionalCertificateName *string `locationName:"regionalCertificateName" type:"string"` // contains filtered or unexported fields }
A request to create a new domain name.
func (CreateDomainNameInput) GoString ¶
func (s CreateDomainNameInput) GoString() string
GoString returns the string representation
func (*CreateDomainNameInput) SetCertificateArn ¶ added in v1.7.7
func (s *CreateDomainNameInput) SetCertificateArn(v string) *CreateDomainNameInput
SetCertificateArn sets the CertificateArn field's value.
func (*CreateDomainNameInput) SetCertificateBody ¶ added in v1.5.0
func (s *CreateDomainNameInput) SetCertificateBody(v string) *CreateDomainNameInput
SetCertificateBody sets the CertificateBody field's value.
func (*CreateDomainNameInput) SetCertificateChain ¶ added in v1.5.0
func (s *CreateDomainNameInput) SetCertificateChain(v string) *CreateDomainNameInput
SetCertificateChain sets the CertificateChain field's value.
func (*CreateDomainNameInput) SetCertificateName ¶ added in v1.5.0
func (s *CreateDomainNameInput) SetCertificateName(v string) *CreateDomainNameInput
SetCertificateName sets the CertificateName field's value.
func (*CreateDomainNameInput) SetCertificatePrivateKey ¶ added in v1.5.0
func (s *CreateDomainNameInput) SetCertificatePrivateKey(v string) *CreateDomainNameInput
SetCertificatePrivateKey sets the CertificatePrivateKey field's value.
func (*CreateDomainNameInput) SetDomainName ¶ added in v1.5.0
func (s *CreateDomainNameInput) SetDomainName(v string) *CreateDomainNameInput
SetDomainName sets the DomainName field's value.
func (*CreateDomainNameInput) SetEndpointConfiguration ¶ added in v1.12.21
func (s *CreateDomainNameInput) SetEndpointConfiguration(v *EndpointConfiguration) *CreateDomainNameInput
SetEndpointConfiguration sets the EndpointConfiguration field's value.
func (*CreateDomainNameInput) SetRegionalCertificateArn ¶ added in v1.12.21
func (s *CreateDomainNameInput) SetRegionalCertificateArn(v string) *CreateDomainNameInput
SetRegionalCertificateArn sets the RegionalCertificateArn field's value.
func (*CreateDomainNameInput) SetRegionalCertificateName ¶ added in v1.12.21
func (s *CreateDomainNameInput) SetRegionalCertificateName(v string) *CreateDomainNameInput
SetRegionalCertificateName sets the RegionalCertificateName field's value.
func (CreateDomainNameInput) String ¶
func (s CreateDomainNameInput) String() string
String returns the string representation
func (*CreateDomainNameInput) Validate ¶ added in v1.1.21
func (s *CreateDomainNameInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateModelInput ¶
type CreateModelInput struct { // The content-type for the model. // // ContentType is a required field ContentType *string `locationName:"contentType" type:"string" required:"true"` // The description of the model. Description *string `locationName:"description" type:"string"` // The name of the model. Must be alphanumeric. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // The RestApi identifier under which the Model will be created. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The schema for the model. For application/json models, this should be JSON-schema // draft v4 (http://json-schema.org/documentation.html) model. Schema *string `locationName:"schema" type:"string"` // contains filtered or unexported fields }
Request to add a new Model to an existing RestApi resource.
func (CreateModelInput) GoString ¶
func (s CreateModelInput) GoString() string
GoString returns the string representation
func (*CreateModelInput) SetContentType ¶ added in v1.5.0
func (s *CreateModelInput) SetContentType(v string) *CreateModelInput
SetContentType sets the ContentType field's value.
func (*CreateModelInput) SetDescription ¶ added in v1.5.0
func (s *CreateModelInput) SetDescription(v string) *CreateModelInput
SetDescription sets the Description field's value.
func (*CreateModelInput) SetName ¶ added in v1.5.0
func (s *CreateModelInput) SetName(v string) *CreateModelInput
SetName sets the Name field's value.
func (*CreateModelInput) SetRestApiId ¶ added in v1.5.0
func (s *CreateModelInput) SetRestApiId(v string) *CreateModelInput
SetRestApiId sets the RestApiId field's value.
func (*CreateModelInput) SetSchema ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *CreateModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateRequestValidatorInput ¶ added in v1.8.12
type CreateRequestValidatorInput struct { // The name of the to-be-created RequestValidator. Name *string `locationName:"name" type:"string"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // A Boolean flag to indicate whether to validate request body according to // the configured model schema for the method (true) or not (false). ValidateRequestBody *bool `locationName:"validateRequestBody" type:"boolean"` // A Boolean flag to indicate whether to validate request parameters, true, // or not false. ValidateRequestParameters *bool `locationName:"validateRequestParameters" type:"boolean"` // contains filtered or unexported fields }
Creates a RequestValidator of a given RestApi.
func (CreateRequestValidatorInput) GoString ¶ added in v1.8.12
func (s CreateRequestValidatorInput) GoString() string
GoString returns the string representation
func (*CreateRequestValidatorInput) SetName ¶ added in v1.8.12
func (s *CreateRequestValidatorInput) SetName(v string) *CreateRequestValidatorInput
SetName sets the Name field's value.
func (*CreateRequestValidatorInput) SetRestApiId ¶ added in v1.8.12
func (s *CreateRequestValidatorInput) SetRestApiId(v string) *CreateRequestValidatorInput
SetRestApiId sets the RestApiId field's value.
func (*CreateRequestValidatorInput) SetValidateRequestBody ¶ added in v1.8.12
func (s *CreateRequestValidatorInput) SetValidateRequestBody(v bool) *CreateRequestValidatorInput
SetValidateRequestBody sets the ValidateRequestBody field's value.
func (*CreateRequestValidatorInput) SetValidateRequestParameters ¶ added in v1.8.12
func (s *CreateRequestValidatorInput) SetValidateRequestParameters(v bool) *CreateRequestValidatorInput
SetValidateRequestParameters sets the ValidateRequestParameters field's value.
func (CreateRequestValidatorInput) String ¶ added in v1.8.12
func (s CreateRequestValidatorInput) String() string
String returns the string representation
func (*CreateRequestValidatorInput) Validate ¶ added in v1.8.12
func (s *CreateRequestValidatorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateResourceInput ¶
type CreateResourceInput struct { // The parent resource's identifier. // // ParentId is a required field ParentId *string `location:"uri" locationName:"parent_id" type:"string" required:"true"` // The last path segment for this resource. // // PathPart is a required field PathPart *string `locationName:"pathPart" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to create a Resource resource.
func (CreateResourceInput) GoString ¶
func (s CreateResourceInput) GoString() string
GoString returns the string representation
func (*CreateResourceInput) SetParentId ¶ added in v1.5.0
func (s *CreateResourceInput) SetParentId(v string) *CreateResourceInput
SetParentId sets the ParentId field's value.
func (*CreateResourceInput) SetPathPart ¶ added in v1.5.0
func (s *CreateResourceInput) SetPathPart(v string) *CreateResourceInput
SetPathPart sets the PathPart field's value.
func (*CreateResourceInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *CreateResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateRestApiInput ¶
type CreateRestApiInput struct { // The list of binary media types supported by the RestApi. By default, the // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []*string `locationName:"binaryMediaTypes" type:"list"` // The ID of the RestApi that you want to clone from. CloneFrom *string `locationName:"cloneFrom" type:"string"` // The description of the RestApi. Description *string `locationName:"description" type:"string"` // The endpoint configuration of this RestApi showing the endpoint types of // the API. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The name of the RestApi. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // A version identifier for the API. Version *string `locationName:"version" type:"string"` // contains filtered or unexported fields }
The POST Request to add a new RestApi resource to your collection.
func (CreateRestApiInput) GoString ¶
func (s CreateRestApiInput) GoString() string
GoString returns the string representation
func (*CreateRestApiInput) SetBinaryMediaTypes ¶ added in v1.5.7
func (s *CreateRestApiInput) SetBinaryMediaTypes(v []*string) *CreateRestApiInput
SetBinaryMediaTypes sets the BinaryMediaTypes field's value.
func (*CreateRestApiInput) SetCloneFrom ¶ added in v1.5.0
func (s *CreateRestApiInput) SetCloneFrom(v string) *CreateRestApiInput
SetCloneFrom sets the CloneFrom field's value.
func (*CreateRestApiInput) SetDescription ¶ added in v1.5.0
func (s *CreateRestApiInput) SetDescription(v string) *CreateRestApiInput
SetDescription sets the Description field's value.
func (*CreateRestApiInput) SetEndpointConfiguration ¶ added in v1.12.21
func (s *CreateRestApiInput) SetEndpointConfiguration(v *EndpointConfiguration) *CreateRestApiInput
SetEndpointConfiguration sets the EndpointConfiguration field's value.
func (*CreateRestApiInput) SetName ¶ added in v1.5.0
func (s *CreateRestApiInput) SetName(v string) *CreateRestApiInput
SetName sets the Name field's value.
func (*CreateRestApiInput) SetVersion ¶ added in v1.5.13
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 ¶ added in v1.1.21
func (s *CreateRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateStageInput ¶
type CreateStageInput struct { // Whether cache clustering is enabled for the stage. CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` // The stage's cache cluster size. CacheClusterSize *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 string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name for the Stage resource. // // StageName is a required field StageName *string `locationName:"stageName" type:"string" required:"true"` // A map that defines the stage variables for the new Stage resource. Variable // names can have alphanumeric and underscore characters, and the values must // match [A-Za-z0-9-._~:/?#&=,]+. Variables map[string]*string `locationName:"variables" type:"map"` // contains filtered or unexported fields }
Requests Amazon API Gateway to create a Stage resource.
func (CreateStageInput) GoString ¶
func (s CreateStageInput) GoString() string
GoString returns the string representation
func (*CreateStageInput) SetCacheClusterEnabled ¶ added in v1.5.0
func (s *CreateStageInput) SetCacheClusterEnabled(v bool) *CreateStageInput
SetCacheClusterEnabled sets the CacheClusterEnabled field's value.
func (*CreateStageInput) SetCacheClusterSize ¶ added in v1.5.0
func (s *CreateStageInput) SetCacheClusterSize(v string) *CreateStageInput
SetCacheClusterSize sets the CacheClusterSize field's value.
func (*CreateStageInput) SetDeploymentId ¶ added in v1.5.0
func (s *CreateStageInput) SetDeploymentId(v string) *CreateStageInput
SetDeploymentId sets the DeploymentId field's value.
func (*CreateStageInput) SetDescription ¶ added in v1.5.0
func (s *CreateStageInput) SetDescription(v string) *CreateStageInput
SetDescription sets the Description field's value.
func (*CreateStageInput) SetDocumentationVersion ¶ added in v1.5.13
func (s *CreateStageInput) SetDocumentationVersion(v string) *CreateStageInput
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*CreateStageInput) SetRestApiId ¶ added in v1.5.0
func (s *CreateStageInput) SetRestApiId(v string) *CreateStageInput
SetRestApiId sets the RestApiId field's value.
func (*CreateStageInput) SetStageName ¶ added in v1.5.0
func (s *CreateStageInput) SetStageName(v string) *CreateStageInput
SetStageName sets the StageName field's value.
func (*CreateStageInput) SetVariables ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *CreateStageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUsagePlanInput ¶ added in v1.4.2
type CreateUsagePlanInput struct { // The associated API stages of the usage plan. ApiStages []*ApiStage `locationName:"apiStages" type:"list"` // The description of the usage plan. Description *string `locationName:"description" type:"string"` // The name of the usage plan. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // The quota of the usage plan. Quota *QuotaSettings `locationName:"quota" type:"structure"` // The throttling limits of the usage plan. Throttle *ThrottleSettings `locationName:"throttle" type:"structure"` // contains filtered or unexported fields }
The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.
func (CreateUsagePlanInput) GoString ¶ added in v1.4.2
func (s CreateUsagePlanInput) GoString() string
GoString returns the string representation
func (*CreateUsagePlanInput) SetApiStages ¶ added in v1.5.0
func (s *CreateUsagePlanInput) SetApiStages(v []*ApiStage) *CreateUsagePlanInput
SetApiStages sets the ApiStages field's value.
func (*CreateUsagePlanInput) SetDescription ¶ added in v1.5.0
func (s *CreateUsagePlanInput) SetDescription(v string) *CreateUsagePlanInput
SetDescription sets the Description field's value.
func (*CreateUsagePlanInput) SetName ¶ added in v1.5.0
func (s *CreateUsagePlanInput) SetName(v string) *CreateUsagePlanInput
SetName sets the Name field's value.
func (*CreateUsagePlanInput) SetQuota ¶ added in v1.5.0
func (s *CreateUsagePlanInput) SetQuota(v *QuotaSettings) *CreateUsagePlanInput
SetQuota sets the Quota field's value.
func (*CreateUsagePlanInput) SetThrottle ¶ added in v1.5.0
func (s *CreateUsagePlanInput) SetThrottle(v *ThrottleSettings) *CreateUsagePlanInput
SetThrottle sets the Throttle field's value.
func (CreateUsagePlanInput) String ¶ added in v1.4.2
func (s CreateUsagePlanInput) String() string
String returns the string representation
func (*CreateUsagePlanInput) Validate ¶ added in v1.4.2
func (s *CreateUsagePlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUsagePlanKeyInput ¶ added in v1.4.2
type CreateUsagePlanKeyInput struct { // The identifier of a UsagePlanKey resource for a plan customer. // // KeyId is a required field KeyId *string `locationName:"keyId" type:"string" required:"true"` // The type of a UsagePlanKey resource for a plan customer. // // KeyType is a required field KeyType *string `locationName:"keyType" type:"string" required:"true"` // The Id of the UsagePlan resource representing the usage plan containing the // to-be-created UsagePlanKey resource representing a plan customer. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The POST request to create a usage plan key for adding an existing API key to a usage plan.
func (CreateUsagePlanKeyInput) GoString ¶ added in v1.4.2
func (s CreateUsagePlanKeyInput) GoString() string
GoString returns the string representation
func (*CreateUsagePlanKeyInput) SetKeyId ¶ added in v1.5.0
func (s *CreateUsagePlanKeyInput) SetKeyId(v string) *CreateUsagePlanKeyInput
SetKeyId sets the KeyId field's value.
func (*CreateUsagePlanKeyInput) SetKeyType ¶ added in v1.5.0
func (s *CreateUsagePlanKeyInput) SetKeyType(v string) *CreateUsagePlanKeyInput
SetKeyType sets the KeyType field's value.
func (*CreateUsagePlanKeyInput) SetUsagePlanId ¶ added in v1.5.0
func (s *CreateUsagePlanKeyInput) SetUsagePlanId(v string) *CreateUsagePlanKeyInput
SetUsagePlanId sets the UsagePlanId field's value.
func (CreateUsagePlanKeyInput) String ¶ added in v1.4.2
func (s CreateUsagePlanKeyInput) String() string
String returns the string representation
func (*CreateUsagePlanKeyInput) Validate ¶ added in v1.4.2
func (s *CreateUsagePlanKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApiKeyInput ¶
type DeleteApiKeyInput struct { // The identifier of the ApiKey resource to be deleted. // // ApiKey is a required field ApiKey *string `location:"uri" locationName:"api_Key" type:"string" required:"true"` // contains filtered or unexported fields }
A request to delete the ApiKey resource.
func (DeleteApiKeyInput) GoString ¶
func (s DeleteApiKeyInput) GoString() string
GoString returns the string representation
func (*DeleteApiKeyInput) SetApiKey ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶ added in v1.1.2
type DeleteAuthorizerInput struct { // The identifier of the Authorizer resource. // // AuthorizerId is a required field AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete an existing Authorizer resource.
func (DeleteAuthorizerInput) GoString ¶ added in v1.1.2
func (s DeleteAuthorizerInput) GoString() string
GoString returns the string representation
func (*DeleteAuthorizerInput) SetAuthorizerId ¶ added in v1.5.0
func (s *DeleteAuthorizerInput) SetAuthorizerId(v string) *DeleteAuthorizerInput
SetAuthorizerId sets the AuthorizerId field's value.
func (*DeleteAuthorizerInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteAuthorizerInput) SetRestApiId(v string) *DeleteAuthorizerInput
SetRestApiId sets the RestApiId field's value.
func (DeleteAuthorizerInput) String ¶ added in v1.1.2
func (s DeleteAuthorizerInput) String() string
String returns the string representation
func (*DeleteAuthorizerInput) Validate ¶ added in v1.1.21
func (s *DeleteAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAuthorizerOutput ¶ added in v1.1.2
type DeleteAuthorizerOutput struct {
// contains filtered or unexported fields
}
func (DeleteAuthorizerOutput) GoString ¶ added in v1.1.2
func (s DeleteAuthorizerOutput) GoString() string
GoString returns the string representation
func (DeleteAuthorizerOutput) String ¶ added in v1.1.2
func (s DeleteAuthorizerOutput) String() string
String returns the string representation
type DeleteBasePathMappingInput ¶
type DeleteBasePathMappingInput struct { // The base path name of the BasePathMapping resource to delete. // // BasePath is a required field BasePath *string `location:"uri" locationName:"base_path" type:"string" required:"true"` // The domain name of the BasePathMapping resource to delete. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // contains filtered or unexported fields }
A request to delete the BasePathMapping resource.
func (DeleteBasePathMappingInput) GoString ¶
func (s DeleteBasePathMappingInput) GoString() string
GoString returns the string representation
func (*DeleteBasePathMappingInput) SetBasePath ¶ added in v1.5.0
func (s *DeleteBasePathMappingInput) SetBasePath(v string) *DeleteBasePathMappingInput
SetBasePath sets the BasePath field's value.
func (*DeleteBasePathMappingInput) SetDomainName ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶
type DeleteClientCertificateInput struct { // The identifier of the ClientCertificate resource to be deleted. // // ClientCertificateId is a required field ClientCertificateId *string `location:"uri" locationName:"clientcertificate_id" type:"string" required:"true"` // contains filtered or unexported fields }
A request to delete the ClientCertificate resource.
func (DeleteClientCertificateInput) GoString ¶
func (s DeleteClientCertificateInput) GoString() string
GoString returns the string representation
func (*DeleteClientCertificateInput) SetClientCertificateId ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶
type DeleteDeploymentInput struct { // The identifier of the Deployment resource to delete. // // DeploymentId is a required field DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to delete a Deployment resource.
func (DeleteDeploymentInput) GoString ¶
func (s DeleteDeploymentInput) GoString() string
GoString returns the string representation
func (*DeleteDeploymentInput) SetDeploymentId ¶ added in v1.5.0
func (s *DeleteDeploymentInput) SetDeploymentId(v string) *DeleteDeploymentInput
SetDeploymentId sets the DeploymentId field's value.
func (*DeleteDeploymentInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶ added in v1.5.13
type DeleteDocumentationPartInput struct { // [Required] The identifier of the to-be-deleted documentation part. // // DocumentationPartId is a required field DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Deletes an existing documentation part of an API.
func (DeleteDocumentationPartInput) GoString ¶ added in v1.5.13
func (s DeleteDocumentationPartInput) GoString() string
GoString returns the string representation
func (*DeleteDocumentationPartInput) SetDocumentationPartId ¶ added in v1.5.13
func (s *DeleteDocumentationPartInput) SetDocumentationPartId(v string) *DeleteDocumentationPartInput
SetDocumentationPartId sets the DocumentationPartId field's value.
func (*DeleteDocumentationPartInput) SetRestApiId ¶ added in v1.5.13
func (s *DeleteDocumentationPartInput) SetRestApiId(v string) *DeleteDocumentationPartInput
SetRestApiId sets the RestApiId field's value.
func (DeleteDocumentationPartInput) String ¶ added in v1.5.13
func (s DeleteDocumentationPartInput) String() string
String returns the string representation
func (*DeleteDocumentationPartInput) Validate ¶ added in v1.5.13
func (s *DeleteDocumentationPartInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDocumentationPartOutput ¶ added in v1.5.13
type DeleteDocumentationPartOutput struct {
// contains filtered or unexported fields
}
func (DeleteDocumentationPartOutput) GoString ¶ added in v1.5.13
func (s DeleteDocumentationPartOutput) GoString() string
GoString returns the string representation
func (DeleteDocumentationPartOutput) String ¶ added in v1.5.13
func (s DeleteDocumentationPartOutput) String() string
String returns the string representation
type DeleteDocumentationVersionInput ¶ added in v1.5.13
type DeleteDocumentationVersionInput struct { // [Required] The version identifier of a to-be-deleted documentation snapshot. // // DocumentationVersion is a required field DocumentationVersion *string `location:"uri" locationName:"doc_version" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Deletes an existing documentation version of an API.
func (DeleteDocumentationVersionInput) GoString ¶ added in v1.5.13
func (s DeleteDocumentationVersionInput) GoString() string
GoString returns the string representation
func (*DeleteDocumentationVersionInput) SetDocumentationVersion ¶ added in v1.5.13
func (s *DeleteDocumentationVersionInput) SetDocumentationVersion(v string) *DeleteDocumentationVersionInput
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*DeleteDocumentationVersionInput) SetRestApiId ¶ added in v1.5.13
func (s *DeleteDocumentationVersionInput) SetRestApiId(v string) *DeleteDocumentationVersionInput
SetRestApiId sets the RestApiId field's value.
func (DeleteDocumentationVersionInput) String ¶ added in v1.5.13
func (s DeleteDocumentationVersionInput) String() string
String returns the string representation
func (*DeleteDocumentationVersionInput) Validate ¶ added in v1.5.13
func (s *DeleteDocumentationVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDocumentationVersionOutput ¶ added in v1.5.13
type DeleteDocumentationVersionOutput struct {
// contains filtered or unexported fields
}
func (DeleteDocumentationVersionOutput) GoString ¶ added in v1.5.13
func (s DeleteDocumentationVersionOutput) GoString() string
GoString returns the string representation
func (DeleteDocumentationVersionOutput) String ¶ added in v1.5.13
func (s DeleteDocumentationVersionOutput) String() string
String returns the string representation
type DeleteDomainNameInput ¶
type DeleteDomainNameInput struct { // The name of the DomainName resource to be deleted. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // contains filtered or unexported fields }
A request to delete the DomainName resource.
func (DeleteDomainNameInput) GoString ¶
func (s DeleteDomainNameInput) GoString() string
GoString returns the string representation
func (*DeleteDomainNameInput) SetDomainName ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 DeleteGatewayResponseInput ¶ added in v1.10.10
type DeleteGatewayResponseInput struct { // The response type of the associated GatewayResponse. Valid values are ACCESS_DENIED // // API_CONFIGURATION_ERROR // AUTHORIZER_FAILURE // AUTHORIZER_CONFIGURATION_ERROR // BAD_REQUEST_PARAMETERS // BAD_REQUEST_BODY // DEFAULT_4XX // DEFAULT_5XX // EXPIRED_TOKEN // INVALID_SIGNATURE // INTEGRATION_FAILURE // INTEGRATION_TIMEOUT // INVALID_API_KEY // MISSING_AUTHENTICATION_TOKEN // QUOTA_EXCEEDED // REQUEST_TOO_LARGE // RESOURCE_NOT_FOUND // THROTTLED // UNAUTHORIZED // UNSUPPORTED_MEDIA_TYPES // // ResponseType is a required field ResponseType *string `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"GatewayResponseType"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
func (DeleteGatewayResponseInput) GoString ¶ added in v1.10.10
func (s DeleteGatewayResponseInput) GoString() string
GoString returns the string representation
func (*DeleteGatewayResponseInput) SetResponseType ¶ added in v1.10.10
func (s *DeleteGatewayResponseInput) SetResponseType(v string) *DeleteGatewayResponseInput
SetResponseType sets the ResponseType field's value.
func (*DeleteGatewayResponseInput) SetRestApiId ¶ added in v1.10.10
func (s *DeleteGatewayResponseInput) SetRestApiId(v string) *DeleteGatewayResponseInput
SetRestApiId sets the RestApiId field's value.
func (DeleteGatewayResponseInput) String ¶ added in v1.10.10
func (s DeleteGatewayResponseInput) String() string
String returns the string representation
func (*DeleteGatewayResponseInput) Validate ¶ added in v1.10.10
func (s *DeleteGatewayResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteGatewayResponseOutput ¶ added in v1.10.10
type DeleteGatewayResponseOutput struct {
// contains filtered or unexported fields
}
func (DeleteGatewayResponseOutput) GoString ¶ added in v1.10.10
func (s DeleteGatewayResponseOutput) GoString() string
GoString returns the string representation
func (DeleteGatewayResponseOutput) String ¶ added in v1.10.10
func (s DeleteGatewayResponseOutput) String() string
String returns the string representation
type DeleteIntegrationInput ¶
type DeleteIntegrationInput struct { // Specifies a delete integration request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a delete integration request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a delete integration request.
func (DeleteIntegrationInput) GoString ¶
func (s DeleteIntegrationInput) GoString() string
GoString returns the string representation
func (*DeleteIntegrationInput) SetHttpMethod ¶ added in v1.5.0
func (s *DeleteIntegrationInput) SetHttpMethod(v string) *DeleteIntegrationInput
SetHttpMethod sets the HttpMethod field's value.
func (*DeleteIntegrationInput) SetResourceId ¶ added in v1.5.0
func (s *DeleteIntegrationInput) SetResourceId(v string) *DeleteIntegrationInput
SetResourceId sets the ResourceId field's value.
func (*DeleteIntegrationInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶
type DeleteIntegrationResponseInput struct { // Specifies a delete integration response request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a delete integration response request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies a delete integration response request's status code. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a delete integration response request.
func (DeleteIntegrationResponseInput) GoString ¶
func (s DeleteIntegrationResponseInput) GoString() string
GoString returns the string representation
func (*DeleteIntegrationResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *DeleteIntegrationResponseInput) SetHttpMethod(v string) *DeleteIntegrationResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*DeleteIntegrationResponseInput) SetResourceId ¶ added in v1.5.0
func (s *DeleteIntegrationResponseInput) SetResourceId(v string) *DeleteIntegrationResponseInput
SetResourceId sets the ResourceId field's value.
func (*DeleteIntegrationResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteIntegrationResponseInput) SetRestApiId(v string) *DeleteIntegrationResponseInput
SetRestApiId sets the RestApiId field's value.
func (*DeleteIntegrationResponseInput) SetStatusCode ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶
type DeleteMethodInput struct { // The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete an existing Method resource.
func (DeleteMethodInput) GoString ¶
func (s DeleteMethodInput) GoString() string
GoString returns the string representation
func (*DeleteMethodInput) SetHttpMethod ¶ added in v1.5.0
func (s *DeleteMethodInput) SetHttpMethod(v string) *DeleteMethodInput
SetHttpMethod sets the HttpMethod field's value.
func (*DeleteMethodInput) SetResourceId ¶ added in v1.5.0
func (s *DeleteMethodInput) SetResourceId(v string) *DeleteMethodInput
SetResourceId sets the ResourceId field's value.
func (*DeleteMethodInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶
type DeleteMethodResponseInput struct { // The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the MethodResponse resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The status code identifier for the MethodResponse resource. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
A request to delete an existing MethodResponse resource.
func (DeleteMethodResponseInput) GoString ¶
func (s DeleteMethodResponseInput) GoString() string
GoString returns the string representation
func (*DeleteMethodResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *DeleteMethodResponseInput) SetHttpMethod(v string) *DeleteMethodResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*DeleteMethodResponseInput) SetResourceId ¶ added in v1.5.0
func (s *DeleteMethodResponseInput) SetResourceId(v string) *DeleteMethodResponseInput
SetResourceId sets the ResourceId field's value.
func (*DeleteMethodResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteMethodResponseInput) SetRestApiId(v string) *DeleteMethodResponseInput
SetRestApiId sets the RestApiId field's value.
func (*DeleteMethodResponseInput) SetStatusCode ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶
type DeleteModelInput struct { // The name of the model to delete. // // ModelName is a required field ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete an existing model in an existing RestApi resource.
func (DeleteModelInput) GoString ¶
func (s DeleteModelInput) GoString() string
GoString returns the string representation
func (*DeleteModelInput) SetModelName ¶ added in v1.5.0
func (s *DeleteModelInput) SetModelName(v string) *DeleteModelInput
SetModelName sets the ModelName field's value.
func (*DeleteModelInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶ added in v1.8.12
type DeleteRequestValidatorInput struct { // [Required] The identifier of the RequestValidator to be deleted. // // RequestValidatorId is a required field RequestValidatorId *string `location:"uri" locationName:"requestvalidator_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Deletes a specified RequestValidator of a given RestApi.
func (DeleteRequestValidatorInput) GoString ¶ added in v1.8.12
func (s DeleteRequestValidatorInput) GoString() string
GoString returns the string representation
func (*DeleteRequestValidatorInput) SetRequestValidatorId ¶ added in v1.8.12
func (s *DeleteRequestValidatorInput) SetRequestValidatorId(v string) *DeleteRequestValidatorInput
SetRequestValidatorId sets the RequestValidatorId field's value.
func (*DeleteRequestValidatorInput) SetRestApiId ¶ added in v1.8.12
func (s *DeleteRequestValidatorInput) SetRestApiId(v string) *DeleteRequestValidatorInput
SetRestApiId sets the RestApiId field's value.
func (DeleteRequestValidatorInput) String ¶ added in v1.8.12
func (s DeleteRequestValidatorInput) String() string
String returns the string representation
func (*DeleteRequestValidatorInput) Validate ¶ added in v1.8.12
func (s *DeleteRequestValidatorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteRequestValidatorOutput ¶ added in v1.8.12
type DeleteRequestValidatorOutput struct {
// contains filtered or unexported fields
}
func (DeleteRequestValidatorOutput) GoString ¶ added in v1.8.12
func (s DeleteRequestValidatorOutput) GoString() string
GoString returns the string representation
func (DeleteRequestValidatorOutput) String ¶ added in v1.8.12
func (s DeleteRequestValidatorOutput) String() string
String returns the string representation
type DeleteResourceInput ¶
type DeleteResourceInput struct { // The identifier of the Resource resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete a Resource.
func (DeleteResourceInput) GoString ¶
func (s DeleteResourceInput) GoString() string
GoString returns the string representation
func (*DeleteResourceInput) SetResourceId ¶ added in v1.5.0
func (s *DeleteResourceInput) SetResourceId(v string) *DeleteResourceInput
SetResourceId sets the ResourceId field's value.
func (*DeleteResourceInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶
type DeleteRestApiInput struct { // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete the specified API from your collection.
func (DeleteRestApiInput) GoString ¶
func (s DeleteRestApiInput) GoString() string
GoString returns the string representation
func (*DeleteRestApiInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶
type DeleteStageInput struct { // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the Stage resource to delete. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to delete a Stage resource.
func (DeleteStageInput) GoString ¶
func (s DeleteStageInput) GoString() string
GoString returns the string representation
func (*DeleteStageInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteStageInput) SetRestApiId(v string) *DeleteStageInput
SetRestApiId sets the RestApiId field's value.
func (*DeleteStageInput) SetStageName ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶ added in v1.4.2
type DeleteUsagePlanInput struct { // The Id of the to-be-deleted usage plan. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The DELETE request to delete a usage plan of a given plan Id.
func (DeleteUsagePlanInput) GoString ¶ added in v1.4.2
func (s DeleteUsagePlanInput) GoString() string
GoString returns the string representation
func (*DeleteUsagePlanInput) SetUsagePlanId ¶ added in v1.5.0
func (s *DeleteUsagePlanInput) SetUsagePlanId(v string) *DeleteUsagePlanInput
SetUsagePlanId sets the UsagePlanId field's value.
func (DeleteUsagePlanInput) String ¶ added in v1.4.2
func (s DeleteUsagePlanInput) String() string
String returns the string representation
func (*DeleteUsagePlanInput) Validate ¶ added in v1.4.2
func (s *DeleteUsagePlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUsagePlanKeyInput ¶ added in v1.4.2
type DeleteUsagePlanKeyInput struct { // The Id of the UsagePlanKey resource to be deleted. // // KeyId is a required field KeyId *string `location:"uri" locationName:"keyId" type:"string" required:"true"` // The Id of the UsagePlan resource representing the usage plan containing the // to-be-deleted UsagePlanKey resource representing a plan customer. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
func (DeleteUsagePlanKeyInput) GoString ¶ added in v1.4.2
func (s DeleteUsagePlanKeyInput) GoString() string
GoString returns the string representation
func (*DeleteUsagePlanKeyInput) SetKeyId ¶ added in v1.5.0
func (s *DeleteUsagePlanKeyInput) SetKeyId(v string) *DeleteUsagePlanKeyInput
SetKeyId sets the KeyId field's value.
func (*DeleteUsagePlanKeyInput) SetUsagePlanId ¶ added in v1.5.0
func (s *DeleteUsagePlanKeyInput) SetUsagePlanId(v string) *DeleteUsagePlanKeyInput
SetUsagePlanId sets the UsagePlanId field's value.
func (DeleteUsagePlanKeyInput) String ¶ added in v1.4.2
func (s DeleteUsagePlanKeyInput) String() string
String returns the string representation
func (*DeleteUsagePlanKeyInput) Validate ¶ added in v1.4.2
func (s *DeleteUsagePlanKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUsagePlanKeyOutput ¶ added in v1.4.2
type DeleteUsagePlanKeyOutput struct {
// contains filtered or unexported fields
}
func (DeleteUsagePlanKeyOutput) GoString ¶ added in v1.4.2
func (s DeleteUsagePlanKeyOutput) GoString() string
GoString returns the string representation
func (DeleteUsagePlanKeyOutput) String ¶ added in v1.4.2
func (s DeleteUsagePlanKeyOutput) String() string
String returns the string representation
type DeleteUsagePlanOutput ¶ added in v1.4.2
type DeleteUsagePlanOutput struct {
// contains filtered or unexported fields
}
func (DeleteUsagePlanOutput) GoString ¶ added in v1.4.2
func (s DeleteUsagePlanOutput) GoString() string
GoString returns the string representation
func (DeleteUsagePlanOutput) String ¶ added in v1.4.2
func (s DeleteUsagePlanOutput) String() string
String returns the string representation
type Deployment ¶
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 }
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
To create a deployment, call POST on the Deployments resource of a RestApi. To view, update, or delete a deployment, call GET, PATCH, or DELETE on the specified deployment resource (/restapis/{restapi_id}/deployments/{deployment_id}).
RestApi, Deployments, Stage, AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html), AWS SDKs (https://aws.amazon.com/tools/)
func (Deployment) GoString ¶
func (s Deployment) GoString() string
GoString returns the string representation
func (*Deployment) SetApiSummary ¶ added in v1.5.0
func (s *Deployment) SetApiSummary(v map[string]map[string]*MethodSnapshot) *Deployment
SetApiSummary sets the ApiSummary field's value.
func (*Deployment) SetCreatedDate ¶ added in v1.5.0
func (s *Deployment) SetCreatedDate(v time.Time) *Deployment
SetCreatedDate sets the CreatedDate field's value.
func (*Deployment) SetDescription ¶ added in v1.5.0
func (s *Deployment) SetDescription(v string) *Deployment
SetDescription sets the Description field's value.
func (*Deployment) SetId ¶ added in v1.5.0
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 ¶ added in v1.5.13
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 }
A documentation part for a targeted API entity.
A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.
The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.
Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationParts
func (DocumentationPart) GoString ¶ added in v1.5.13
func (s DocumentationPart) GoString() string
GoString returns the string representation
func (*DocumentationPart) SetId ¶ added in v1.5.13
func (s *DocumentationPart) SetId(v string) *DocumentationPart
SetId sets the Id field's value.
func (*DocumentationPart) SetLocation ¶ added in v1.5.13
func (s *DocumentationPart) SetLocation(v *DocumentationPartLocation) *DocumentationPart
SetLocation sets the Location field's value.
func (*DocumentationPart) SetProperties ¶ added in v1.5.13
func (s *DocumentationPart) SetProperties(v string) *DocumentationPart
SetProperties sets the Properties field's value.
func (DocumentationPart) String ¶ added in v1.5.13
func (s DocumentationPart) String() string
String returns the string representation
type DocumentationPartLocation ¶ added in v1.5.13
type DocumentationPartLocation struct { // The HTTP verb of a method. It is a valid field for the API entity types of // METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, // RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. // When an applicable child entity inherits the content of an entity of the // same type with more general specifications of the other location attributes, // the child entity's method attribute must match that of the parent entity // exactly. Method *string `locationName:"method" type:"string"` // The name of the targeted API entity. It is a valid and required field for // the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, // REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field // for any other entity type. Name *string `locationName:"name" type:"string"` // The URL path of the target. It is a valid field for the API entity types // of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, // RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for // the root resource. When an applicable child entity inherits the content of // another entity of the same type with more general specifications of the other // location attributes, the child entity's path attribute must match that of // the parent entity as a prefix. Path *string `locationName:"path" type:"string"` // The HTTP status code of a response. It is a valid field for the API entity // types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value // is * for any status code. When an applicable child entity inherits the content // of an entity of the same type with more general specifications of the other // location attributes, the child entity's statusCode attribute must match that // of the parent entity exactly. StatusCode *string `locationName:"statusCode" type:"string"` // The type of API entity to which the documentation content applies. It is // a valid and required field for API entity types of API, AUTHORIZER, MODEL, // RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, // RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not // apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, // or RESOURCE type. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"DocumentationPartType"` // contains filtered or unexported fields }
Specifies the target API entity to which the documentation applies.
func (DocumentationPartLocation) GoString ¶ added in v1.5.13
func (s DocumentationPartLocation) GoString() string
GoString returns the string representation
func (*DocumentationPartLocation) SetMethod ¶ added in v1.5.13
func (s *DocumentationPartLocation) SetMethod(v string) *DocumentationPartLocation
SetMethod sets the Method field's value.
func (*DocumentationPartLocation) SetName ¶ added in v1.5.13
func (s *DocumentationPartLocation) SetName(v string) *DocumentationPartLocation
SetName sets the Name field's value.
func (*DocumentationPartLocation) SetPath ¶ added in v1.5.13
func (s *DocumentationPartLocation) SetPath(v string) *DocumentationPartLocation
SetPath sets the Path field's value.
func (*DocumentationPartLocation) SetStatusCode ¶ added in v1.5.13
func (s *DocumentationPartLocation) SetStatusCode(v string) *DocumentationPartLocation
SetStatusCode sets the StatusCode field's value.
func (*DocumentationPartLocation) SetType ¶ added in v1.5.13
func (s *DocumentationPartLocation) SetType(v string) *DocumentationPartLocation
SetType sets the Type field's value.
func (DocumentationPartLocation) String ¶ added in v1.5.13
func (s DocumentationPartLocation) String() string
String returns the string representation
func (*DocumentationPartLocation) Validate ¶ added in v1.5.13
func (s *DocumentationPartLocation) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DocumentationVersion ¶ added in v1.5.13
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 }
A snapshot of the documentation of an API.
Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.
Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart, DocumentationVersions
func (DocumentationVersion) GoString ¶ added in v1.5.13
func (s DocumentationVersion) GoString() string
GoString returns the string representation
func (*DocumentationVersion) SetCreatedDate ¶ added in v1.5.13
func (s *DocumentationVersion) SetCreatedDate(v time.Time) *DocumentationVersion
SetCreatedDate sets the CreatedDate field's value.
func (*DocumentationVersion) SetDescription ¶ added in v1.5.13
func (s *DocumentationVersion) SetDescription(v string) *DocumentationVersion
SetDescription sets the Description field's value.
func (*DocumentationVersion) SetVersion ¶ added in v1.5.13
func (s *DocumentationVersion) SetVersion(v string) *DocumentationVersion
SetVersion sets the Version field's value.
func (DocumentationVersion) String ¶ added in v1.5.13
func (s DocumentationVersion) String() string
String returns the string representation
type DomainName ¶
type DomainName struct { // The reference to an AWS-managed certificate that will be used by edge-optimized // endpoint for this domain name. AWS Certificate Manager is the only supported // source. CertificateArn *string `locationName:"certificateArn" type:"string"` // The name of the certificate that will be used by edge-optimized endpoint // for this domain name. CertificateName *string `locationName:"certificateName" type:"string"` // The timestamp when the certificate that was used by edge-optimized endpoint // for this domain name was uploaded. CertificateUploadDate *time.Time `locationName:"certificateUploadDate" type:"timestamp" timestampFormat:"unix"` // The domain name of the Amazon CloudFront distribution associated with this // custom domain name for an edge-optimized endpoint. You set up this association // when adding a DNS record pointing the custom domain name to this distribution // name. For more information about CloudFront distributions, see the Amazon // CloudFront documentation (http://aws.amazon.com/documentation/cloudfront/). DistributionDomainName *string `locationName:"distributionDomainName" type:"string"` // The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized // endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more // information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) // and AWS Regions and Endpoints for API Gateway (http://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). DistributionHostedZoneId *string `locationName:"distributionHostedZoneId" type:"string"` // The name of the DomainName resource. DomainName *string `locationName:"domainName" type:"string"` // The endpoint configuration of this DomainName showing the endpoint types // of the domain name. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The reference to an AWS-managed certificate that will be used for validating // the regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string `locationName:"regionalCertificateArn" type:"string"` // The name of the certificate that will be used for validating the regional // domain name. RegionalCertificateName *string `locationName:"regionalCertificateName" type:"string"` // The domain name associated with the regional endpoint for this custom domain // name. You set up this association by adding a DNS record that points the // custom domain name to this regional domain name. The regional domain name // is returned by Amazon API Gateway when you create a regional endpoint. RegionalDomainName *string `locationName:"regionalDomainName" type:"string"` // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. // For more information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) // and AWS Regions and Endpoints for API Gateway (http://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). RegionalHostedZoneId *string `locationName:"regionalHostedZoneId" type:"string"` // contains filtered or unexported fields }
Represents a custom domain name as a user-friendly host name of an API (RestApi).
When you deploy an API, Amazon API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.
Set a Custom Host Name for an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (DomainName) GoString ¶
func (s DomainName) GoString() string
GoString returns the string representation
func (*DomainName) SetCertificateArn ¶ added in v1.7.7
func (s *DomainName) SetCertificateArn(v string) *DomainName
SetCertificateArn sets the CertificateArn field's value.
func (*DomainName) SetCertificateName ¶ added in v1.5.0
func (s *DomainName) SetCertificateName(v string) *DomainName
SetCertificateName sets the CertificateName field's value.
func (*DomainName) SetCertificateUploadDate ¶ added in v1.5.0
func (s *DomainName) SetCertificateUploadDate(v time.Time) *DomainName
SetCertificateUploadDate sets the CertificateUploadDate field's value.
func (*DomainName) SetDistributionDomainName ¶ added in v1.5.0
func (s *DomainName) SetDistributionDomainName(v string) *DomainName
SetDistributionDomainName sets the DistributionDomainName field's value.
func (*DomainName) SetDistributionHostedZoneId ¶ added in v1.12.30
func (s *DomainName) SetDistributionHostedZoneId(v string) *DomainName
SetDistributionHostedZoneId sets the DistributionHostedZoneId field's value.
func (*DomainName) SetDomainName ¶ added in v1.5.0
func (s *DomainName) SetDomainName(v string) *DomainName
SetDomainName sets the DomainName field's value.
func (*DomainName) SetEndpointConfiguration ¶ added in v1.12.21
func (s *DomainName) SetEndpointConfiguration(v *EndpointConfiguration) *DomainName
SetEndpointConfiguration sets the EndpointConfiguration field's value.
func (*DomainName) SetRegionalCertificateArn ¶ added in v1.12.21
func (s *DomainName) SetRegionalCertificateArn(v string) *DomainName
SetRegionalCertificateArn sets the RegionalCertificateArn field's value.
func (*DomainName) SetRegionalCertificateName ¶ added in v1.12.21
func (s *DomainName) SetRegionalCertificateName(v string) *DomainName
SetRegionalCertificateName sets the RegionalCertificateName field's value.
func (*DomainName) SetRegionalDomainName ¶ added in v1.12.21
func (s *DomainName) SetRegionalDomainName(v string) *DomainName
SetRegionalDomainName sets the RegionalDomainName field's value.
func (*DomainName) SetRegionalHostedZoneId ¶ added in v1.12.30
func (s *DomainName) SetRegionalHostedZoneId(v string) *DomainName
SetRegionalHostedZoneId sets the RegionalHostedZoneId field's value.
func (DomainName) String ¶
func (s DomainName) String() string
String returns the string representation
type EndpointConfiguration ¶ added in v1.12.21
type EndpointConfiguration struct { // A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). // For an edge-optimized API and its custom domain name, the endpoint type is // "EDGE". For a regional API and its custom domain name, the endpoint type // is REGIONAL. Types []*string `locationName:"types" type:"list"` // contains filtered or unexported fields }
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
func (EndpointConfiguration) GoString ¶ added in v1.12.21
func (s EndpointConfiguration) GoString() string
GoString returns the string representation
func (*EndpointConfiguration) SetTypes ¶ added in v1.12.21
func (s *EndpointConfiguration) SetTypes(v []*string) *EndpointConfiguration
SetTypes sets the Types field's value.
func (EndpointConfiguration) String ¶ added in v1.12.21
func (s EndpointConfiguration) String() string
String returns the string representation
type FlushStageAuthorizersCacheInput ¶ added in v1.1.8
type FlushStageAuthorizersCacheInput struct { // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the stage to flush. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Request to flush authorizer cache entries on a specified stage.
func (FlushStageAuthorizersCacheInput) GoString ¶ added in v1.1.8
func (s FlushStageAuthorizersCacheInput) GoString() string
GoString returns the string representation
func (*FlushStageAuthorizersCacheInput) SetRestApiId ¶ added in v1.5.0
func (s *FlushStageAuthorizersCacheInput) SetRestApiId(v string) *FlushStageAuthorizersCacheInput
SetRestApiId sets the RestApiId field's value.
func (*FlushStageAuthorizersCacheInput) SetStageName ¶ added in v1.5.0
func (s *FlushStageAuthorizersCacheInput) SetStageName(v string) *FlushStageAuthorizersCacheInput
SetStageName sets the StageName field's value.
func (FlushStageAuthorizersCacheInput) String ¶ added in v1.1.8
func (s FlushStageAuthorizersCacheInput) String() string
String returns the string representation
func (*FlushStageAuthorizersCacheInput) Validate ¶ added in v1.1.21
func (s *FlushStageAuthorizersCacheInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type FlushStageAuthorizersCacheOutput ¶ added in v1.1.8
type FlushStageAuthorizersCacheOutput struct {
// contains filtered or unexported fields
}
func (FlushStageAuthorizersCacheOutput) GoString ¶ added in v1.1.8
func (s FlushStageAuthorizersCacheOutput) GoString() string
GoString returns the string representation
func (FlushStageAuthorizersCacheOutput) String ¶ added in v1.1.8
func (s FlushStageAuthorizersCacheOutput) String() string
String returns the string representation
type FlushStageCacheInput ¶
type FlushStageCacheInput struct { // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the stage to flush its cache. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to flush a stage's cache.
func (FlushStageCacheInput) GoString ¶
func (s FlushStageCacheInput) GoString() string
GoString returns the string representation
func (*FlushStageCacheInput) SetRestApiId ¶ added in v1.5.0
func (s *FlushStageCacheInput) SetRestApiId(v string) *FlushStageCacheInput
SetRestApiId sets the RestApiId field's value.
func (*FlushStageCacheInput) SetStageName ¶ added in v1.5.0
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 ¶ added in v1.1.21
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 ¶
type GenerateClientCertificateInput struct { // The description of the ClientCertificate. Description *string `locationName:"description" type:"string"` // contains filtered or unexported fields }
A request to generate a ClientCertificate resource.
func (GenerateClientCertificateInput) GoString ¶
func (s GenerateClientCertificateInput) GoString() string
GoString returns the string representation
func (*GenerateClientCertificateInput) SetDescription ¶ added in v1.5.0
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 ¶
type GetAccountInput struct {
// contains filtered or unexported fields
}
Requests Amazon API Gateway to get information about the current Account resource.
func (GetAccountInput) GoString ¶
func (s GetAccountInput) GoString() string
GoString returns the string representation
func (GetAccountInput) String ¶
func (s GetAccountInput) String() string
String returns the string representation
type GetApiKeyInput ¶
type GetApiKeyInput struct { // The identifier of the ApiKey resource. // // ApiKey is a required field ApiKey *string `location:"uri" locationName:"api_Key" type:"string" required:"true"` // A boolean flag to specify whether (true) or not (false) the result contains // the key value. IncludeValue *bool `location:"querystring" locationName:"includeValue" type:"boolean"` // contains filtered or unexported fields }
A request to get information about the current ApiKey resource.
func (GetApiKeyInput) GoString ¶
func (s GetApiKeyInput) GoString() string
GoString returns the string representation
func (*GetApiKeyInput) SetApiKey ¶ added in v1.5.0
func (s *GetApiKeyInput) SetApiKey(v string) *GetApiKeyInput
SetApiKey sets the ApiKey field's value.
func (*GetApiKeyInput) SetIncludeValue ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetApiKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetApiKeysInput ¶
type GetApiKeysInput struct { // The identifier of a customer in AWS Marketplace or an external system, such // as a developer portal. CustomerId *string `location:"querystring" locationName:"customerId" type:"string"` // A boolean flag to specify whether (true) or not (false) the result contains // key values. IncludeValues *bool `location:"querystring" locationName:"includeValues" type:"boolean"` // The maximum number of returned results per page. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The name of queried API keys. NameQuery *string `location:"querystring" locationName:"name" type:"string"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
A request to get information about the current ApiKeys resource.
func (GetApiKeysInput) GoString ¶
func (s GetApiKeysInput) GoString() string
GoString returns the string representation
func (*GetApiKeysInput) SetCustomerId ¶ added in v1.5.7
func (s *GetApiKeysInput) SetCustomerId(v string) *GetApiKeysInput
SetCustomerId sets the CustomerId field's value.
func (*GetApiKeysInput) SetIncludeValues ¶ added in v1.5.0
func (s *GetApiKeysInput) SetIncludeValues(v bool) *GetApiKeysInput
SetIncludeValues sets the IncludeValues field's value.
func (*GetApiKeysInput) SetLimit ¶ added in v1.5.0
func (s *GetApiKeysInput) SetLimit(v int64) *GetApiKeysInput
SetLimit sets the Limit field's value.
func (*GetApiKeysInput) SetNameQuery ¶ added in v1.5.0
func (s *GetApiKeysInput) SetNameQuery(v string) *GetApiKeysInput
SetNameQuery sets the NameQuery field's value.
func (*GetApiKeysInput) SetPosition ¶ added in v1.5.0
func (s *GetApiKeysInput) SetPosition(v string) *GetApiKeysInput
SetPosition sets the Position field's value.
func (GetApiKeysInput) String ¶
func (s GetApiKeysInput) String() string
String returns the string representation
type GetApiKeysOutput ¶
type GetApiKeysOutput struct { // The current page of elements from this collection. Items []*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 }
Represents a collection of API keys as represented by an ApiKeys resource.
Use API Keys (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html)
func (GetApiKeysOutput) GoString ¶
func (s GetApiKeysOutput) GoString() string
GoString returns the string representation
func (*GetApiKeysOutput) SetItems ¶ added in v1.5.0
func (s *GetApiKeysOutput) SetItems(v []*ApiKey) *GetApiKeysOutput
SetItems sets the Items field's value.
func (*GetApiKeysOutput) SetPosition ¶ added in v1.5.0
func (s *GetApiKeysOutput) SetPosition(v string) *GetApiKeysOutput
SetPosition sets the Position field's value.
func (*GetApiKeysOutput) SetWarnings ¶ added in v1.5.0
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 ¶ added in v1.1.2
type GetAuthorizerInput struct { // The identifier of the Authorizer resource. // // AuthorizerId is a required field AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe an existing Authorizer resource.
func (GetAuthorizerInput) GoString ¶ added in v1.1.2
func (s GetAuthorizerInput) GoString() string
GoString returns the string representation
func (*GetAuthorizerInput) SetAuthorizerId ¶ added in v1.5.0
func (s *GetAuthorizerInput) SetAuthorizerId(v string) *GetAuthorizerInput
SetAuthorizerId sets the AuthorizerId field's value.
func (*GetAuthorizerInput) SetRestApiId ¶ added in v1.5.0
func (s *GetAuthorizerInput) SetRestApiId(v string) *GetAuthorizerInput
SetRestApiId sets the RestApiId field's value.
func (GetAuthorizerInput) String ¶ added in v1.1.2
func (s GetAuthorizerInput) String() string
String returns the string representation
func (*GetAuthorizerInput) Validate ¶ added in v1.1.21
func (s *GetAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAuthorizersInput ¶ added in v1.1.2
type GetAuthorizersInput struct { // The maximum number of returned results per page. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe an existing Authorizers resource.
func (GetAuthorizersInput) GoString ¶ added in v1.1.2
func (s GetAuthorizersInput) GoString() string
GoString returns the string representation
func (*GetAuthorizersInput) SetLimit ¶ added in v1.5.0
func (s *GetAuthorizersInput) SetLimit(v int64) *GetAuthorizersInput
SetLimit sets the Limit field's value.
func (*GetAuthorizersInput) SetPosition ¶ added in v1.5.0
func (s *GetAuthorizersInput) SetPosition(v string) *GetAuthorizersInput
SetPosition sets the Position field's value.
func (*GetAuthorizersInput) SetRestApiId ¶ added in v1.5.0
func (s *GetAuthorizersInput) SetRestApiId(v string) *GetAuthorizersInput
SetRestApiId sets the RestApiId field's value.
func (GetAuthorizersInput) String ¶ added in v1.1.2
func (s GetAuthorizersInput) String() string
String returns the string representation
func (*GetAuthorizersInput) Validate ¶ added in v1.1.21
func (s *GetAuthorizersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAuthorizersOutput ¶ added in v1.1.2
type GetAuthorizersOutput struct { // The current page of elements from this collection. Items []*Authorizer `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Represents a collection of Authorizer resources.
Enable custom authorization (http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html)
func (GetAuthorizersOutput) GoString ¶ added in v1.1.2
func (s GetAuthorizersOutput) GoString() string
GoString returns the string representation
func (*GetAuthorizersOutput) SetItems ¶ added in v1.5.0
func (s *GetAuthorizersOutput) SetItems(v []*Authorizer) *GetAuthorizersOutput
SetItems sets the Items field's value.
func (*GetAuthorizersOutput) SetPosition ¶ added in v1.5.0
func (s *GetAuthorizersOutput) SetPosition(v string) *GetAuthorizersOutput
SetPosition sets the Position field's value.
func (GetAuthorizersOutput) String ¶ added in v1.1.2
func (s GetAuthorizersOutput) String() string
String returns the string representation
type GetBasePathMappingInput ¶
type GetBasePathMappingInput struct { // The base path name that callers of the API must provide as part of the URL // after the domain name. This value must be unique for all of the mappings // across a single API. Leave this blank if you do not want callers to specify // any base path name after the domain name. // // BasePath is a required field BasePath *string `location:"uri" locationName:"base_path" type:"string" required:"true"` // The domain name of the BasePathMapping resource to be described. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe a BasePathMapping resource.
func (GetBasePathMappingInput) GoString ¶
func (s GetBasePathMappingInput) GoString() string
GoString returns the string representation
func (*GetBasePathMappingInput) SetBasePath ¶ added in v1.5.0
func (s *GetBasePathMappingInput) SetBasePath(v string) *GetBasePathMappingInput
SetBasePath sets the BasePath field's value.
func (*GetBasePathMappingInput) SetDomainName ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetBasePathMappingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetBasePathMappingsInput ¶
type GetBasePathMappingsInput struct { // The domain name of a BasePathMapping resource. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // The maximum number of returned results per page. The value is 25 by default // and could be between 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
A request to get information about a collection of BasePathMapping resources.
func (GetBasePathMappingsInput) GoString ¶
func (s GetBasePathMappingsInput) GoString() string
GoString returns the string representation
func (*GetBasePathMappingsInput) SetDomainName ¶ added in v1.5.0
func (s *GetBasePathMappingsInput) SetDomainName(v string) *GetBasePathMappingsInput
SetDomainName sets the DomainName field's value.
func (*GetBasePathMappingsInput) SetLimit ¶ added in v1.5.0
func (s *GetBasePathMappingsInput) SetLimit(v int64) *GetBasePathMappingsInput
SetLimit sets the Limit field's value.
func (*GetBasePathMappingsInput) SetPosition ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetBasePathMappingsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetBasePathMappingsOutput ¶
type GetBasePathMappingsOutput struct { // The current page of elements from this collection. Items []*BasePathMapping `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Represents a collection of BasePathMapping resources.
Use Custom Domain Names (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (GetBasePathMappingsOutput) GoString ¶
func (s GetBasePathMappingsOutput) GoString() string
GoString returns the string representation
func (*GetBasePathMappingsOutput) SetItems ¶ added in v1.5.0
func (s *GetBasePathMappingsOutput) SetItems(v []*BasePathMapping) *GetBasePathMappingsOutput
SetItems sets the Items field's value.
func (*GetBasePathMappingsOutput) SetPosition ¶ added in v1.5.0
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 ¶
type GetClientCertificateInput struct { // The identifier of the ClientCertificate resource to be described. // // ClientCertificateId is a required field ClientCertificateId *string `location:"uri" locationName:"clientcertificate_id" type:"string" required:"true"` // contains filtered or unexported fields }
A request to get information about the current ClientCertificate resource.
func (GetClientCertificateInput) GoString ¶
func (s GetClientCertificateInput) GoString() string
GoString returns the string representation
func (*GetClientCertificateInput) SetClientCertificateId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetClientCertificateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetClientCertificatesInput ¶
type GetClientCertificatesInput struct { // The maximum number of returned results per page. The value is 25 by default // and could be between 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
A request to get information about a collection of ClientCertificate resources.
func (GetClientCertificatesInput) GoString ¶
func (s GetClientCertificatesInput) GoString() string
GoString returns the string representation
func (*GetClientCertificatesInput) SetLimit ¶ added in v1.5.0
func (s *GetClientCertificatesInput) SetLimit(v int64) *GetClientCertificatesInput
SetLimit sets the Limit field's value.
func (*GetClientCertificatesInput) SetPosition ¶ added in v1.5.0
func (s *GetClientCertificatesInput) SetPosition(v string) *GetClientCertificatesInput
SetPosition sets the Position field's value.
func (GetClientCertificatesInput) String ¶
func (s GetClientCertificatesInput) String() string
String returns the string representation
type GetClientCertificatesOutput ¶
type GetClientCertificatesOutput struct { // The current page of elements from this collection. Items []*ClientCertificate `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Represents a collection of ClientCertificate resources.
Use Client-Side Certificate (http://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)
func (GetClientCertificatesOutput) GoString ¶
func (s GetClientCertificatesOutput) GoString() string
GoString returns the string representation
func (*GetClientCertificatesOutput) SetItems ¶ added in v1.5.0
func (s *GetClientCertificatesOutput) SetItems(v []*ClientCertificate) *GetClientCertificatesOutput
SetItems sets the Items field's value.
func (*GetClientCertificatesOutput) SetPosition ¶ added in v1.5.0
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 ¶
type GetDeploymentInput struct { // The identifier of the Deployment resource to get information about. // // DeploymentId is a required field DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` // A query parameter to retrieve the specified embedded resources of the returned // Deployment resource in the response. In a REST API call, this embed parameter // value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. // The SDK and other platform-dependent libraries might use a different format // for the list. Currently, this request supports only retrieval of the embedded // API summary this way. Hence, the parameter value must be a single-valued // list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary. Embed []*string `location:"querystring" locationName:"embed" type:"list"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to get information about a Deployment resource.
func (GetDeploymentInput) GoString ¶
func (s GetDeploymentInput) GoString() string
GoString returns the string representation
func (*GetDeploymentInput) SetDeploymentId ¶ added in v1.5.0
func (s *GetDeploymentInput) SetDeploymentId(v string) *GetDeploymentInput
SetDeploymentId sets the DeploymentId field's value.
func (*GetDeploymentInput) SetEmbed ¶ added in v1.8.15
func (s *GetDeploymentInput) SetEmbed(v []*string) *GetDeploymentInput
SetEmbed sets the Embed field's value.
func (*GetDeploymentInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDeploymentsInput ¶
type GetDeploymentsInput struct { // The maximum number of returned results per page. The value is 25 by default // and could be between 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to get information about a Deployments collection.
func (GetDeploymentsInput) GoString ¶
func (s GetDeploymentsInput) GoString() string
GoString returns the string representation
func (*GetDeploymentsInput) SetLimit ¶ added in v1.5.0
func (s *GetDeploymentsInput) SetLimit(v int64) *GetDeploymentsInput
SetLimit sets the Limit field's value.
func (*GetDeploymentsInput) SetPosition ¶ added in v1.5.0
func (s *GetDeploymentsInput) SetPosition(v string) *GetDeploymentsInput
SetPosition sets the Position field's value.
func (*GetDeploymentsInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetDeploymentsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDeploymentsOutput ¶
type GetDeploymentsOutput struct { // The current page of elements from this collection. Items []*Deployment `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.
To create a new deployment of a RestApi, make a POST request against this resource. To view, update, or delete an existing deployment, make a GET, PATCH, or DELETE request, respectively, on a specified Deployment resource.
Deploying an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html), AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html), AWS SDKs (https://aws.amazon.com/tools/)
func (GetDeploymentsOutput) GoString ¶
func (s GetDeploymentsOutput) GoString() string
GoString returns the string representation
func (*GetDeploymentsOutput) SetItems ¶ added in v1.5.0
func (s *GetDeploymentsOutput) SetItems(v []*Deployment) *GetDeploymentsOutput
SetItems sets the Items field's value.
func (*GetDeploymentsOutput) SetPosition ¶ added in v1.5.0
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 ¶ added in v1.5.13
type GetDocumentationPartInput struct { // [Required] The string identifier of the associated RestApi. // // DocumentationPartId is a required field DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets a specified documentation part of a given API.
func (GetDocumentationPartInput) GoString ¶ added in v1.5.13
func (s GetDocumentationPartInput) GoString() string
GoString returns the string representation
func (*GetDocumentationPartInput) SetDocumentationPartId ¶ added in v1.5.13
func (s *GetDocumentationPartInput) SetDocumentationPartId(v string) *GetDocumentationPartInput
SetDocumentationPartId sets the DocumentationPartId field's value.
func (*GetDocumentationPartInput) SetRestApiId ¶ added in v1.5.13
func (s *GetDocumentationPartInput) SetRestApiId(v string) *GetDocumentationPartInput
SetRestApiId sets the RestApiId field's value.
func (GetDocumentationPartInput) String ¶ added in v1.5.13
func (s GetDocumentationPartInput) String() string
String returns the string representation
func (*GetDocumentationPartInput) Validate ¶ added in v1.5.13
func (s *GetDocumentationPartInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDocumentationPartsInput ¶ added in v1.5.13
type GetDocumentationPartsInput struct { // The maximum number of returned results per page. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The status of the API documentation parts to retrieve. Valid values are DOCUMENTED // for retrieving DocumentationPart resources with content and UNDOCUMENTED // for DocumentationPart resources without content. LocationStatus *string `location:"querystring" locationName:"locationStatus" type:"string" enum:"LocationStatusType"` // The name of API entities of the to-be-retrieved documentation parts. NameQuery *string `location:"querystring" locationName:"name" type:"string"` // The path of API entities of the to-be-retrieved documentation parts. Path *string `location:"querystring" locationName:"path" type:"string"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The type of API entities of the to-be-retrieved documentation parts. Type *string `location:"querystring" locationName:"type" type:"string" enum:"DocumentationPartType"` // contains filtered or unexported fields }
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
func (GetDocumentationPartsInput) GoString ¶ added in v1.5.13
func (s GetDocumentationPartsInput) GoString() string
GoString returns the string representation
func (*GetDocumentationPartsInput) SetLimit ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) SetLimit(v int64) *GetDocumentationPartsInput
SetLimit sets the Limit field's value.
func (*GetDocumentationPartsInput) SetLocationStatus ¶ added in v1.12.30
func (s *GetDocumentationPartsInput) SetLocationStatus(v string) *GetDocumentationPartsInput
SetLocationStatus sets the LocationStatus field's value.
func (*GetDocumentationPartsInput) SetNameQuery ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) SetNameQuery(v string) *GetDocumentationPartsInput
SetNameQuery sets the NameQuery field's value.
func (*GetDocumentationPartsInput) SetPath ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) SetPath(v string) *GetDocumentationPartsInput
SetPath sets the Path field's value.
func (*GetDocumentationPartsInput) SetPosition ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) SetPosition(v string) *GetDocumentationPartsInput
SetPosition sets the Position field's value.
func (*GetDocumentationPartsInput) SetRestApiId ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) SetRestApiId(v string) *GetDocumentationPartsInput
SetRestApiId sets the RestApiId field's value.
func (*GetDocumentationPartsInput) SetType ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) SetType(v string) *GetDocumentationPartsInput
SetType sets the Type field's value.
func (GetDocumentationPartsInput) String ¶ added in v1.5.13
func (s GetDocumentationPartsInput) String() string
String returns the string representation
func (*GetDocumentationPartsInput) Validate ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDocumentationPartsOutput ¶ added in v1.5.13
type GetDocumentationPartsOutput struct { // The current page of elements from this collection. Items []*DocumentationPart `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
The collection of documentation parts of an API.
Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart
func (GetDocumentationPartsOutput) GoString ¶ added in v1.5.13
func (s GetDocumentationPartsOutput) GoString() string
GoString returns the string representation
func (*GetDocumentationPartsOutput) SetItems ¶ added in v1.5.13
func (s *GetDocumentationPartsOutput) SetItems(v []*DocumentationPart) *GetDocumentationPartsOutput
SetItems sets the Items field's value.
func (*GetDocumentationPartsOutput) SetPosition ¶ added in v1.5.13
func (s *GetDocumentationPartsOutput) SetPosition(v string) *GetDocumentationPartsOutput
SetPosition sets the Position field's value.
func (GetDocumentationPartsOutput) String ¶ added in v1.5.13
func (s GetDocumentationPartsOutput) String() string
String returns the string representation
type GetDocumentationVersionInput ¶ added in v1.5.13
type GetDocumentationVersionInput struct { // [Required] The version identifier of the to-be-retrieved documentation snapshot. // // DocumentationVersion is a required field DocumentationVersion *string `location:"uri" locationName:"doc_version" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets a documentation snapshot of an API.
func (GetDocumentationVersionInput) GoString ¶ added in v1.5.13
func (s GetDocumentationVersionInput) GoString() string
GoString returns the string representation
func (*GetDocumentationVersionInput) SetDocumentationVersion ¶ added in v1.5.13
func (s *GetDocumentationVersionInput) SetDocumentationVersion(v string) *GetDocumentationVersionInput
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*GetDocumentationVersionInput) SetRestApiId ¶ added in v1.5.13
func (s *GetDocumentationVersionInput) SetRestApiId(v string) *GetDocumentationVersionInput
SetRestApiId sets the RestApiId field's value.
func (GetDocumentationVersionInput) String ¶ added in v1.5.13
func (s GetDocumentationVersionInput) String() string
String returns the string representation
func (*GetDocumentationVersionInput) Validate ¶ added in v1.5.13
func (s *GetDocumentationVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDocumentationVersionsInput ¶ added in v1.5.13
type GetDocumentationVersionsInput struct { // The maximum number of returned results per page. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets the documentation versions of an API.
func (GetDocumentationVersionsInput) GoString ¶ added in v1.5.13
func (s GetDocumentationVersionsInput) GoString() string
GoString returns the string representation
func (*GetDocumentationVersionsInput) SetLimit ¶ added in v1.5.13
func (s *GetDocumentationVersionsInput) SetLimit(v int64) *GetDocumentationVersionsInput
SetLimit sets the Limit field's value.
func (*GetDocumentationVersionsInput) SetPosition ¶ added in v1.5.13
func (s *GetDocumentationVersionsInput) SetPosition(v string) *GetDocumentationVersionsInput
SetPosition sets the Position field's value.
func (*GetDocumentationVersionsInput) SetRestApiId ¶ added in v1.5.13
func (s *GetDocumentationVersionsInput) SetRestApiId(v string) *GetDocumentationVersionsInput
SetRestApiId sets the RestApiId field's value.
func (GetDocumentationVersionsInput) String ¶ added in v1.5.13
func (s GetDocumentationVersionsInput) String() string
String returns the string representation
func (*GetDocumentationVersionsInput) Validate ¶ added in v1.5.13
func (s *GetDocumentationVersionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDocumentationVersionsOutput ¶ added in v1.5.13
type GetDocumentationVersionsOutput struct { // The current page of elements from this collection. Items []*DocumentationVersion `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
The collection of documentation snapshots of an API.
Use the DocumentationVersions to manage documentation snapshots associated with various API stages.
Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart, DocumentationVersion
func (GetDocumentationVersionsOutput) GoString ¶ added in v1.5.13
func (s GetDocumentationVersionsOutput) GoString() string
GoString returns the string representation
func (*GetDocumentationVersionsOutput) SetItems ¶ added in v1.5.13
func (s *GetDocumentationVersionsOutput) SetItems(v []*DocumentationVersion) *GetDocumentationVersionsOutput
SetItems sets the Items field's value.
func (*GetDocumentationVersionsOutput) SetPosition ¶ added in v1.5.13
func (s *GetDocumentationVersionsOutput) SetPosition(v string) *GetDocumentationVersionsOutput
SetPosition sets the Position field's value.
func (GetDocumentationVersionsOutput) String ¶ added in v1.5.13
func (s GetDocumentationVersionsOutput) String() string
String returns the string representation
type GetDomainNameInput ¶
type GetDomainNameInput struct { // The name of the DomainName resource. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // contains filtered or unexported fields }
Request to get the name of a DomainName resource.
func (GetDomainNameInput) GoString ¶
func (s GetDomainNameInput) GoString() string
GoString returns the string representation
func (*GetDomainNameInput) SetDomainName ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetDomainNameInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDomainNamesInput ¶
type GetDomainNamesInput struct { // The maximum number of returned results per page. The value is 25 by default // and could be between 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
Request to describe a collection of DomainName resources.
func (GetDomainNamesInput) GoString ¶
func (s GetDomainNamesInput) GoString() string
GoString returns the string representation
func (*GetDomainNamesInput) SetLimit ¶ added in v1.5.0
func (s *GetDomainNamesInput) SetLimit(v int64) *GetDomainNamesInput
SetLimit sets the Limit field's value.
func (*GetDomainNamesInput) SetPosition ¶ added in v1.5.0
func (s *GetDomainNamesInput) SetPosition(v string) *GetDomainNamesInput
SetPosition sets the Position field's value.
func (GetDomainNamesInput) String ¶
func (s GetDomainNamesInput) String() string
String returns the string representation
type GetDomainNamesOutput ¶
type GetDomainNamesOutput struct { // The current page of elements from this collection. Items []*DomainName `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Represents a collection of DomainName resources.
Use Client-Side Certificate (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (GetDomainNamesOutput) GoString ¶
func (s GetDomainNamesOutput) GoString() string
GoString returns the string representation
func (*GetDomainNamesOutput) SetItems ¶ added in v1.5.0
func (s *GetDomainNamesOutput) SetItems(v []*DomainName) *GetDomainNamesOutput
SetItems sets the Items field's value.
func (*GetDomainNamesOutput) SetPosition ¶ added in v1.5.0
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 ¶ added in v1.1.2
type GetExportInput struct { // The content-type of the export, for example application/json. Currently application/json // and application/yaml are supported for exportType of swagger. This should // be specified in the Accept header for direct API requests. Accepts *string `location:"header" locationName:"Accept" type:"string"` // The type of export. Currently only 'swagger' is supported. // // ExportType is a required field ExportType *string `location:"uri" locationName:"export_type" type:"string" required:"true"` // A key-value map of query string parameters that specify properties of the // export, depending on the requested exportType. For exportTypeswagger, any // combination of the following parameters are supported: integrations will // export the API with x-amazon-apigateway-integration extensions. authorizers // will export the API with x-amazon-apigateway-authorizer extensions. postman // will export the API with Postman extensions, allowing for import to the Postman // tool Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the Stage that will be exported. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Request a new export of a RestApi for a particular Stage.
func (GetExportInput) GoString ¶ added in v1.1.2
func (s GetExportInput) GoString() string
GoString returns the string representation
func (*GetExportInput) SetAccepts ¶ added in v1.5.0
func (s *GetExportInput) SetAccepts(v string) *GetExportInput
SetAccepts sets the Accepts field's value.
func (*GetExportInput) SetExportType ¶ added in v1.5.0
func (s *GetExportInput) SetExportType(v string) *GetExportInput
SetExportType sets the ExportType field's value.
func (*GetExportInput) SetParameters ¶ added in v1.5.0
func (s *GetExportInput) SetParameters(v map[string]*string) *GetExportInput
SetParameters sets the Parameters field's value.
func (*GetExportInput) SetRestApiId ¶ added in v1.5.0
func (s *GetExportInput) SetRestApiId(v string) *GetExportInput
SetRestApiId sets the RestApiId field's value.
func (*GetExportInput) SetStageName ¶ added in v1.5.0
func (s *GetExportInput) SetStageName(v string) *GetExportInput
SetStageName sets the StageName field's value.
func (GetExportInput) String ¶ added in v1.1.2
func (s GetExportInput) String() string
String returns the string representation
func (*GetExportInput) Validate ¶ added in v1.1.21
func (s *GetExportInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetExportOutput ¶ added in v1.1.2
type GetExportOutput struct { // The binary blob response to GetExport, which contains the export. Body []byte `locationName:"body" type:"blob"` // The content-disposition header value in the HTTP response. ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"` // The content-type header value in the HTTP response. This will correspond // to a valid 'accept' type in the request. ContentType *string `location:"header" locationName:"Content-Type" type:"string"` // contains filtered or unexported fields }
The binary blob response to GetExport, which contains the generated SDK.
func (GetExportOutput) GoString ¶ added in v1.1.2
func (s GetExportOutput) GoString() string
GoString returns the string representation
func (*GetExportOutput) SetBody ¶ added in v1.5.0
func (s *GetExportOutput) SetBody(v []byte) *GetExportOutput
SetBody sets the Body field's value.
func (*GetExportOutput) SetContentDisposition ¶ added in v1.5.0
func (s *GetExportOutput) SetContentDisposition(v string) *GetExportOutput
SetContentDisposition sets the ContentDisposition field's value.
func (*GetExportOutput) SetContentType ¶ added in v1.5.0
func (s *GetExportOutput) SetContentType(v string) *GetExportOutput
SetContentType sets the ContentType field's value.
func (GetExportOutput) String ¶ added in v1.1.2
func (s GetExportOutput) String() string
String returns the string representation
type GetGatewayResponseInput ¶ added in v1.10.10
type GetGatewayResponseInput struct { // The response type of the associated GatewayResponse. Valid values are ACCESS_DENIED // // API_CONFIGURATION_ERROR // AUTHORIZER_FAILURE // AUTHORIZER_CONFIGURATION_ERROR // BAD_REQUEST_PARAMETERS // BAD_REQUEST_BODY // DEFAULT_4XX // DEFAULT_5XX // EXPIRED_TOKEN // INVALID_SIGNATURE // INTEGRATION_FAILURE // INTEGRATION_TIMEOUT // INVALID_API_KEY // MISSING_AUTHENTICATION_TOKEN // QUOTA_EXCEEDED // REQUEST_TOO_LARGE // RESOURCE_NOT_FOUND // THROTTLED // UNAUTHORIZED // UNSUPPORTED_MEDIA_TYPES // // ResponseType is a required field ResponseType *string `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"GatewayResponseType"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets a GatewayResponse of a specified response type on the given RestApi.
func (GetGatewayResponseInput) GoString ¶ added in v1.10.10
func (s GetGatewayResponseInput) GoString() string
GoString returns the string representation
func (*GetGatewayResponseInput) SetResponseType ¶ added in v1.10.10
func (s *GetGatewayResponseInput) SetResponseType(v string) *GetGatewayResponseInput
SetResponseType sets the ResponseType field's value.
func (*GetGatewayResponseInput) SetRestApiId ¶ added in v1.10.10
func (s *GetGatewayResponseInput) SetRestApiId(v string) *GetGatewayResponseInput
SetRestApiId sets the RestApiId field's value.
func (GetGatewayResponseInput) String ¶ added in v1.10.10
func (s GetGatewayResponseInput) String() string
String returns the string representation
func (*GetGatewayResponseInput) Validate ¶ added in v1.10.10
func (s *GetGatewayResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetGatewayResponsesInput ¶ added in v1.10.10
type GetGatewayResponsesInput struct { // The maximum number of returned results per page. The GatewayResponses collection // does not support pagination and the limit does not apply here. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. The GatewayResponse // collection does not support pagination and the position does not apply here. Position *string `location:"querystring" locationName:"position" type:"string"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the Amazon API Gateway-generated default GatewayResponses collection for the supported response types.
func (GetGatewayResponsesInput) GoString ¶ added in v1.10.10
func (s GetGatewayResponsesInput) GoString() string
GoString returns the string representation
func (*GetGatewayResponsesInput) SetLimit ¶ added in v1.10.10
func (s *GetGatewayResponsesInput) SetLimit(v int64) *GetGatewayResponsesInput
SetLimit sets the Limit field's value.
func (*GetGatewayResponsesInput) SetPosition ¶ added in v1.10.10
func (s *GetGatewayResponsesInput) SetPosition(v string) *GetGatewayResponsesInput
SetPosition sets the Position field's value.
func (*GetGatewayResponsesInput) SetRestApiId ¶ added in v1.10.10
func (s *GetGatewayResponsesInput) SetRestApiId(v string) *GetGatewayResponsesInput
SetRestApiId sets the RestApiId field's value.
func (GetGatewayResponsesInput) String ¶ added in v1.10.10
func (s GetGatewayResponsesInput) String() string
String returns the string representation
func (*GetGatewayResponsesInput) Validate ¶ added in v1.10.10
func (s *GetGatewayResponsesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetGatewayResponsesOutput ¶ added in v1.10.10
type GetGatewayResponsesOutput struct { // Returns the entire collection, because of no pagination support. Items []*UpdateGatewayResponseOutput `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.
For more information about valid gateway response types, see Gateway Response Types Supported by Amazon API Gateway (http://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html)Example: Get the collection of gateway responses of an API
Request ¶
This example request shows how to retrieve the GatewayResponses collection from an API.
GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515
Response ¶
The successful operation returns the 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "first": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "gatewayresponse:by-type": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "item": [ { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" }, { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" }, { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } ] }, "_embedded": { "item": [ { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "INTEGRATION_FAILURE", "statusCode": "504" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "RESOURCE_NOT_FOUND", "statusCode": "404" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "REQUEST_TOO_LARGE", "statusCode": "413" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "THROTTLED", "statusCode": "429" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "UNSUPPORTED_MEDIA_TYPE", "statusCode": "415" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "AUTHORIZER_CONFIGURATION_ERROR", "statusCode": "500" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "DEFAULT_5XX" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "DEFAULT_4XX" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "BAD_REQUEST_PARAMETERS", "statusCode": "400" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "BAD_REQUEST_BODY", "statusCode": "400" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "EXPIRED_TOKEN", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "ACCESS_DENIED", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "INVALID_API_KEY", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "UNAUTHORIZED", "statusCode": "401" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "API_CONFIGURATION_ERROR", "statusCode": "500" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "QUOTA_EXCEEDED", "statusCode": "429" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "INTEGRATION_TIMEOUT", "statusCode": "504" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "INVALID_SIGNATURE", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "AUTHORIZER_FAILURE", "statusCode": "500" } ] } }
Customize Gateway Responses (http://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html)
func (GetGatewayResponsesOutput) GoString ¶ added in v1.10.10
func (s GetGatewayResponsesOutput) GoString() string
GoString returns the string representation
func (*GetGatewayResponsesOutput) SetItems ¶ added in v1.10.10
func (s *GetGatewayResponsesOutput) SetItems(v []*UpdateGatewayResponseOutput) *GetGatewayResponsesOutput
SetItems sets the Items field's value.
func (*GetGatewayResponsesOutput) SetPosition ¶ added in v1.10.10
func (s *GetGatewayResponsesOutput) SetPosition(v string) *GetGatewayResponsesOutput
SetPosition sets the Position field's value.
func (GetGatewayResponsesOutput) String ¶ added in v1.10.10
func (s GetGatewayResponsesOutput) String() string
String returns the string representation
type GetIntegrationInput ¶
type GetIntegrationInput struct { // Specifies a get integration request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a get integration request's resource identifier // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a request to get the integration configuration.
func (GetIntegrationInput) GoString ¶
func (s GetIntegrationInput) GoString() string
GoString returns the string representation
func (*GetIntegrationInput) SetHttpMethod ¶ added in v1.5.0
func (s *GetIntegrationInput) SetHttpMethod(v string) *GetIntegrationInput
SetHttpMethod sets the HttpMethod field's value.
func (*GetIntegrationInput) SetResourceId ¶ added in v1.5.0
func (s *GetIntegrationInput) SetResourceId(v string) *GetIntegrationInput
SetResourceId sets the ResourceId field's value.
func (*GetIntegrationInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetIntegrationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetIntegrationResponseInput ¶
type GetIntegrationResponseInput struct { // Specifies a get integration response request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a get integration response request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies a get integration response request's status code. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a get integration response request.
func (GetIntegrationResponseInput) GoString ¶
func (s GetIntegrationResponseInput) GoString() string
GoString returns the string representation
func (*GetIntegrationResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *GetIntegrationResponseInput) SetHttpMethod(v string) *GetIntegrationResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*GetIntegrationResponseInput) SetResourceId ¶ added in v1.5.0
func (s *GetIntegrationResponseInput) SetResourceId(v string) *GetIntegrationResponseInput
SetResourceId sets the ResourceId field's value.
func (*GetIntegrationResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *GetIntegrationResponseInput) SetRestApiId(v string) *GetIntegrationResponseInput
SetRestApiId sets the RestApiId field's value.
func (*GetIntegrationResponseInput) SetStatusCode ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetIntegrationResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetMethodInput ¶
type GetMethodInput struct { // Specifies the method request's HTTP method type. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe an existing Method resource.
func (GetMethodInput) GoString ¶
func (s GetMethodInput) GoString() string
GoString returns the string representation
func (*GetMethodInput) SetHttpMethod ¶ added in v1.5.0
func (s *GetMethodInput) SetHttpMethod(v string) *GetMethodInput
SetHttpMethod sets the HttpMethod field's value.
func (*GetMethodInput) SetResourceId ¶ added in v1.5.0
func (s *GetMethodInput) SetResourceId(v string) *GetMethodInput
SetResourceId sets the ResourceId field's value.
func (*GetMethodInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetMethodResponseInput ¶
type GetMethodResponseInput struct { // The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the MethodResponse resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The status code for the MethodResponse resource. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe a MethodResponse resource.
func (GetMethodResponseInput) GoString ¶
func (s GetMethodResponseInput) GoString() string
GoString returns the string representation
func (*GetMethodResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *GetMethodResponseInput) SetHttpMethod(v string) *GetMethodResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*GetMethodResponseInput) SetResourceId ¶ added in v1.5.0
func (s *GetMethodResponseInput) SetResourceId(v string) *GetMethodResponseInput
SetResourceId sets the ResourceId field's value.
func (*GetMethodResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *GetMethodResponseInput) SetRestApiId(v string) *GetMethodResponseInput
SetRestApiId sets the RestApiId field's value.
func (*GetMethodResponseInput) SetStatusCode ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetMethodResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetModelInput ¶
type GetModelInput struct { // A query parameter of a Boolean value to resolve (true) all external model // references and returns a flattened model schema or not (false) The default // is false. Flatten *bool `location:"querystring" locationName:"flatten" type:"boolean"` // The name of the model as an identifier. // // ModelName is a required field ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // The RestApi identifier under which the Model exists. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to list information about a model in an existing RestApi resource.
func (GetModelInput) GoString ¶
func (s GetModelInput) GoString() string
GoString returns the string representation
func (*GetModelInput) SetFlatten ¶ added in v1.5.0
func (s *GetModelInput) SetFlatten(v bool) *GetModelInput
SetFlatten sets the Flatten field's value.
func (*GetModelInput) SetModelName ¶ added in v1.5.0
func (s *GetModelInput) SetModelName(v string) *GetModelInput
SetModelName sets the ModelName field's value.
func (*GetModelInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetModelTemplateInput ¶
type GetModelTemplateInput struct { // The name of the model for which to generate a template. // // ModelName is a required field ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to generate a sample mapping template used to transform the payload.
func (GetModelTemplateInput) GoString ¶
func (s GetModelTemplateInput) GoString() string
GoString returns the string representation
func (*GetModelTemplateInput) SetModelName ¶ added in v1.5.0
func (s *GetModelTemplateInput) SetModelName(v string) *GetModelTemplateInput
SetModelName sets the ModelName field's value.
func (*GetModelTemplateInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetModelTemplateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetModelTemplateOutput ¶
type GetModelTemplateOutput struct { // The Apache Velocity Template Language (VTL) (http://velocity.apache.org/engine/devel/vtl-reference-guide.html) // template content used for the template resource. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
Represents a mapping template used to transform a payload.
Mapping Templates (http://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html#models-mappings-mappings)
func (GetModelTemplateOutput) GoString ¶
func (s GetModelTemplateOutput) GoString() string
GoString returns the string representation
func (*GetModelTemplateOutput) SetValue ¶ added in v1.5.0
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 ¶
type GetModelsInput struct { // The maximum number of returned results per page. The value is 25 by default // and could be between 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to list existing Models defined for a RestApi resource.
func (GetModelsInput) GoString ¶
func (s GetModelsInput) GoString() string
GoString returns the string representation
func (*GetModelsInput) SetLimit ¶ added in v1.5.0
func (s *GetModelsInput) SetLimit(v int64) *GetModelsInput
SetLimit sets the Limit field's value.
func (*GetModelsInput) SetPosition ¶ added in v1.5.0
func (s *GetModelsInput) SetPosition(v string) *GetModelsInput
SetPosition sets the Position field's value.
func (*GetModelsInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetModelsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetModelsOutput ¶
type GetModelsOutput struct { // The current page of elements from this collection. Items []*Model `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Represents a collection of Model resources.
Method, MethodResponse, Models and Mappings (http://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html)
func (GetModelsOutput) GoString ¶
func (s GetModelsOutput) GoString() string
GoString returns the string representation
func (*GetModelsOutput) SetItems ¶ added in v1.5.0
func (s *GetModelsOutput) SetItems(v []*Model) *GetModelsOutput
SetItems sets the Items field's value.
func (*GetModelsOutput) SetPosition ¶ added in v1.5.0
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 ¶ added in v1.8.12
type GetRequestValidatorInput struct { // [Required] The identifier of the RequestValidator to be retrieved. // // RequestValidatorId is a required field RequestValidatorId *string `location:"uri" locationName:"requestvalidator_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets a RequestValidator of a given RestApi.
func (GetRequestValidatorInput) GoString ¶ added in v1.8.12
func (s GetRequestValidatorInput) GoString() string
GoString returns the string representation
func (*GetRequestValidatorInput) SetRequestValidatorId ¶ added in v1.8.12
func (s *GetRequestValidatorInput) SetRequestValidatorId(v string) *GetRequestValidatorInput
SetRequestValidatorId sets the RequestValidatorId field's value.
func (*GetRequestValidatorInput) SetRestApiId ¶ added in v1.8.12
func (s *GetRequestValidatorInput) SetRestApiId(v string) *GetRequestValidatorInput
SetRestApiId sets the RestApiId field's value.
func (GetRequestValidatorInput) String ¶ added in v1.8.12
func (s GetRequestValidatorInput) String() string
String returns the string representation
func (*GetRequestValidatorInput) Validate ¶ added in v1.8.12
func (s *GetRequestValidatorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRequestValidatorsInput ¶ added in v1.8.12
type GetRequestValidatorsInput struct { // The maximum number of returned results per page. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets the RequestValidators collection of a given RestApi.
func (GetRequestValidatorsInput) GoString ¶ added in v1.8.12
func (s GetRequestValidatorsInput) GoString() string
GoString returns the string representation
func (*GetRequestValidatorsInput) SetLimit ¶ added in v1.8.12
func (s *GetRequestValidatorsInput) SetLimit(v int64) *GetRequestValidatorsInput
SetLimit sets the Limit field's value.
func (*GetRequestValidatorsInput) SetPosition ¶ added in v1.8.12
func (s *GetRequestValidatorsInput) SetPosition(v string) *GetRequestValidatorsInput
SetPosition sets the Position field's value.
func (*GetRequestValidatorsInput) SetRestApiId ¶ added in v1.8.12
func (s *GetRequestValidatorsInput) SetRestApiId(v string) *GetRequestValidatorsInput
SetRestApiId sets the RestApiId field's value.
func (GetRequestValidatorsInput) String ¶ added in v1.8.12
func (s GetRequestValidatorsInput) String() string
String returns the string representation
func (*GetRequestValidatorsInput) Validate ¶ added in v1.8.12
func (s *GetRequestValidatorsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRequestValidatorsOutput ¶ added in v1.8.12
type GetRequestValidatorsOutput struct { // The current page of elements from this collection. Items []*UpdateRequestValidatorOutput `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
A collection of RequestValidator resources of a given RestApi.
In Swagger, the RequestValidators of an API is defined by the x-amazon-apigateway-request-validators (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.html) extension.
Enable Basic Request Validation in API Gateway (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html)
func (GetRequestValidatorsOutput) GoString ¶ added in v1.8.12
func (s GetRequestValidatorsOutput) GoString() string
GoString returns the string representation
func (*GetRequestValidatorsOutput) SetItems ¶ added in v1.8.12
func (s *GetRequestValidatorsOutput) SetItems(v []*UpdateRequestValidatorOutput) *GetRequestValidatorsOutput
SetItems sets the Items field's value.
func (*GetRequestValidatorsOutput) SetPosition ¶ added in v1.8.12
func (s *GetRequestValidatorsOutput) SetPosition(v string) *GetRequestValidatorsOutput
SetPosition sets the Position field's value.
func (GetRequestValidatorsOutput) String ¶ added in v1.8.12
func (s GetRequestValidatorsOutput) String() string
String returns the string representation
type GetResourceInput ¶
type GetResourceInput struct { // A query parameter to retrieve the specified resources embedded in the returned // Resource representation in the response. This embed parameter value is a // list of comma-separated strings. Currently, the request supports only retrieval // of the embedded Method resources this way. The query parameter value must // be a single-valued list and contain the "methods" string. For example, GET // /restapis/{restapi_id}/resources/{resource_id}?embed=methods. Embed []*string `location:"querystring" locationName:"embed" type:"list"` // The identifier for the Resource resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to list information about a resource.
func (GetResourceInput) GoString ¶
func (s GetResourceInput) GoString() string
GoString returns the string representation
func (*GetResourceInput) SetEmbed ¶ added in v1.8.15
func (s *GetResourceInput) SetEmbed(v []*string) *GetResourceInput
SetEmbed sets the Embed field's value.
func (*GetResourceInput) SetResourceId ¶ added in v1.5.0
func (s *GetResourceInput) SetResourceId(v string) *GetResourceInput
SetResourceId sets the ResourceId field's value.
func (*GetResourceInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetResourcesInput ¶
type GetResourcesInput struct { // A query parameter used to retrieve the specified resources embedded in the // returned Resources resource in the response. This embed parameter value is // a list of comma-separated strings. Currently, the request supports only retrieval // of the embedded Method resources this way. The query parameter value must // be a single-valued list and contain the "methods" string. For example, GET // /restapis/{restapi_id}/resources?embed=methods. Embed []*string `location:"querystring" locationName:"embed" type:"list"` // The maximum number of returned results per page. The value is 25 by default // and could be between 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to list information about a collection of resources.
func (GetResourcesInput) GoString ¶
func (s GetResourcesInput) GoString() string
GoString returns the string representation
func (*GetResourcesInput) SetEmbed ¶ added in v1.8.15
func (s *GetResourcesInput) SetEmbed(v []*string) *GetResourcesInput
SetEmbed sets the Embed field's value.
func (*GetResourcesInput) SetLimit ¶ added in v1.5.0
func (s *GetResourcesInput) SetLimit(v int64) *GetResourcesInput
SetLimit sets the Limit field's value.
func (*GetResourcesInput) SetPosition ¶ added in v1.5.0
func (s *GetResourcesInput) SetPosition(v string) *GetResourcesInput
SetPosition sets the Position field's value.
func (*GetResourcesInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetResourcesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetResourcesOutput ¶
type GetResourcesOutput struct { // The current page of elements from this collection. Items []*Resource `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Represents a collection of Resource resources.
Create an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (GetResourcesOutput) GoString ¶
func (s GetResourcesOutput) GoString() string
GoString returns the string representation
func (*GetResourcesOutput) SetItems ¶ added in v1.5.0
func (s *GetResourcesOutput) SetItems(v []*Resource) *GetResourcesOutput
SetItems sets the Items field's value.
func (*GetResourcesOutput) SetPosition ¶ added in v1.5.0
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 ¶
type GetRestApiInput struct { // The identifier of the RestApi resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
The GET request to list an existing RestApi defined for your collection.
func (GetRestApiInput) GoString ¶
func (s GetRestApiInput) GoString() string
GoString returns the string representation
func (*GetRestApiInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRestApisInput ¶
type GetRestApisInput struct { // The maximum number of returned results per page. The value is 25 by default // and could be between 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
The GET request to list existing RestApis defined for your collection.
func (GetRestApisInput) GoString ¶
func (s GetRestApisInput) GoString() string
GoString returns the string representation
func (*GetRestApisInput) SetLimit ¶ added in v1.5.0
func (s *GetRestApisInput) SetLimit(v int64) *GetRestApisInput
SetLimit sets the Limit field's value.
func (*GetRestApisInput) SetPosition ¶ added in v1.5.0
func (s *GetRestApisInput) SetPosition(v string) *GetRestApisInput
SetPosition sets the Position field's value.
func (GetRestApisInput) String ¶
func (s GetRestApisInput) String() string
String returns the string representation
type GetRestApisOutput ¶
type GetRestApisOutput struct { // The current page of elements from this collection. Items []*RestApi `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.
Create an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (GetRestApisOutput) GoString ¶
func (s GetRestApisOutput) GoString() string
GoString returns the string representation
func (*GetRestApisOutput) SetItems ¶ added in v1.5.0
func (s *GetRestApisOutput) SetItems(v []*RestApi) *GetRestApisOutput
SetItems sets the Items field's value.
func (*GetRestApisOutput) SetPosition ¶ added in v1.5.0
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 ¶
type GetSdkInput struct { // A string-to-string key-value map of query parameters sdkType-dependent properties // of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix // is required. For sdkType of android, parameters named groupId, artifactId, // artifactVersion, and invokerPackage are required. For sdkType of java, parameters // named serviceName and javaPackageName are required. Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The language for the generated SDK. Currently java, javascript, android, // objectivec (for iOS), swift (for iOS), and ruby are supported. // // SdkType is a required field SdkType *string `location:"uri" locationName:"sdk_type" type:"string" required:"true"` // The name of the Stage that the SDK will use. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Request a new generated client SDK for a RestApi and Stage.
func (GetSdkInput) GoString ¶
func (s GetSdkInput) GoString() string
GoString returns the string representation
func (*GetSdkInput) SetParameters ¶ added in v1.5.0
func (s *GetSdkInput) SetParameters(v map[string]*string) *GetSdkInput
SetParameters sets the Parameters field's value.
func (*GetSdkInput) SetRestApiId ¶ added in v1.5.0
func (s *GetSdkInput) SetRestApiId(v string) *GetSdkInput
SetRestApiId sets the RestApiId field's value.
func (*GetSdkInput) SetSdkType ¶ added in v1.5.0
func (s *GetSdkInput) SetSdkType(v string) *GetSdkInput
SetSdkType sets the SdkType field's value.
func (*GetSdkInput) SetStageName ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetSdkInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSdkOutput ¶
type GetSdkOutput struct { // The binary blob response to GetSdk, which contains the generated SDK. Body []byte `locationName:"body" type:"blob"` // The content-disposition header value in the HTTP response. ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"` // The content-type header value in the HTTP response. ContentType *string `location:"header" locationName:"Content-Type" type:"string"` // contains filtered or unexported fields }
The binary blob response to GetSdk, which contains the generated SDK.
func (GetSdkOutput) GoString ¶
func (s GetSdkOutput) GoString() string
GoString returns the string representation
func (*GetSdkOutput) SetBody ¶ added in v1.5.0
func (s *GetSdkOutput) SetBody(v []byte) *GetSdkOutput
SetBody sets the Body field's value.
func (*GetSdkOutput) SetContentDisposition ¶ added in v1.5.0
func (s *GetSdkOutput) SetContentDisposition(v string) *GetSdkOutput
SetContentDisposition sets the ContentDisposition field's value.
func (*GetSdkOutput) SetContentType ¶ added in v1.5.0
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 ¶ added in v1.6.8
type GetSdkTypeInput struct { // The identifier of the queried SdkType instance. // // Id is a required field Id *string `location:"uri" locationName:"sdktype_id" type:"string" required:"true"` // contains filtered or unexported fields }
Get an SdkType instance.
func (GetSdkTypeInput) GoString ¶ added in v1.6.8
func (s GetSdkTypeInput) GoString() string
GoString returns the string representation
func (*GetSdkTypeInput) SetId ¶ added in v1.6.8
func (s *GetSdkTypeInput) SetId(v string) *GetSdkTypeInput
SetId sets the Id field's value.
func (GetSdkTypeInput) String ¶ added in v1.6.8
func (s GetSdkTypeInput) String() string
String returns the string representation
func (*GetSdkTypeInput) Validate ¶ added in v1.6.8
func (s *GetSdkTypeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSdkTypesInput ¶ added in v1.6.8
type GetSdkTypesInput struct { // The maximum number of returned results per page. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
Get the SdkTypes collection.
func (GetSdkTypesInput) GoString ¶ added in v1.6.8
func (s GetSdkTypesInput) GoString() string
GoString returns the string representation
func (*GetSdkTypesInput) SetLimit ¶ added in v1.6.8
func (s *GetSdkTypesInput) SetLimit(v int64) *GetSdkTypesInput
SetLimit sets the Limit field's value.
func (*GetSdkTypesInput) SetPosition ¶ added in v1.6.8
func (s *GetSdkTypesInput) SetPosition(v string) *GetSdkTypesInput
SetPosition sets the Position field's value.
func (GetSdkTypesInput) String ¶ added in v1.6.8
func (s GetSdkTypesInput) String() string
String returns the string representation
type GetSdkTypesOutput ¶ added in v1.6.8
type GetSdkTypesOutput struct { // The current page of elements from this collection. Items []*SdkType `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
The collection of SdkType instances.
func (GetSdkTypesOutput) GoString ¶ added in v1.6.8
func (s GetSdkTypesOutput) GoString() string
GoString returns the string representation
func (*GetSdkTypesOutput) SetItems ¶ added in v1.6.8
func (s *GetSdkTypesOutput) SetItems(v []*SdkType) *GetSdkTypesOutput
SetItems sets the Items field's value.
func (*GetSdkTypesOutput) SetPosition ¶ added in v1.6.8
func (s *GetSdkTypesOutput) SetPosition(v string) *GetSdkTypesOutput
SetPosition sets the Position field's value.
func (GetSdkTypesOutput) String ¶ added in v1.6.8
func (s GetSdkTypesOutput) String() string
String returns the string representation
type GetStageInput ¶
type GetStageInput struct { // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the Stage resource to get information about. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to get information about a Stage resource.
func (GetStageInput) GoString ¶
func (s GetStageInput) GoString() string
GoString returns the string representation
func (*GetStageInput) SetRestApiId ¶ added in v1.5.0
func (s *GetStageInput) SetRestApiId(v string) *GetStageInput
SetRestApiId sets the RestApiId field's value.
func (*GetStageInput) SetStageName ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetStageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetStagesInput ¶
type GetStagesInput struct { // The stages' deployment identifiers. DeploymentId *string `location:"querystring" locationName:"deploymentId" type:"string"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to get information about one or more Stage resources.
func (GetStagesInput) GoString ¶
func (s GetStagesInput) GoString() string
GoString returns the string representation
func (*GetStagesInput) SetDeploymentId ¶ added in v1.5.0
func (s *GetStagesInput) SetDeploymentId(v string) *GetStagesInput
SetDeploymentId sets the DeploymentId field's value.
func (*GetStagesInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *GetStagesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetStagesOutput ¶
type GetStagesOutput struct { // The current page of elements from this collection. Item []*Stage `locationName:"item" type:"list"` // contains filtered or unexported fields }
A list of Stage resources that are associated with the ApiKey resource.
Deploying API in Stages (http://docs.aws.amazon.com/apigateway/latest/developerguide/stages.html)
func (GetStagesOutput) GoString ¶
func (s GetStagesOutput) GoString() string
GoString returns the string representation
func (*GetStagesOutput) SetItem ¶ added in v1.5.0
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 ¶ added in v1.4.2
type GetUsageInput struct { // The ending date (e.g., 2016-12-31) of the usage data. // // EndDate is a required field EndDate *string `location:"querystring" locationName:"endDate" type:"string" required:"true"` // The Id of the API key associated with the resultant usage data. KeyId *string `location:"querystring" locationName:"keyId" type:"string"` // The maximum number of returned results per page. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // The starting date (e.g., 2016-01-01) of the usage data. // // StartDate is a required field StartDate *string `location:"querystring" locationName:"startDate" type:"string" required:"true"` // The Id of the usage plan associated with the usage data. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The GET request to get the usage data of a usage plan in a specified time interval.
func (GetUsageInput) GoString ¶ added in v1.4.2
func (s GetUsageInput) GoString() string
GoString returns the string representation
func (*GetUsageInput) SetEndDate ¶ added in v1.5.0
func (s *GetUsageInput) SetEndDate(v string) *GetUsageInput
SetEndDate sets the EndDate field's value.
func (*GetUsageInput) SetKeyId ¶ added in v1.5.0
func (s *GetUsageInput) SetKeyId(v string) *GetUsageInput
SetKeyId sets the KeyId field's value.
func (*GetUsageInput) SetLimit ¶ added in v1.5.0
func (s *GetUsageInput) SetLimit(v int64) *GetUsageInput
SetLimit sets the Limit field's value.
func (*GetUsageInput) SetPosition ¶ added in v1.5.0
func (s *GetUsageInput) SetPosition(v string) *GetUsageInput
SetPosition sets the Position field's value.
func (*GetUsageInput) SetStartDate ¶ added in v1.5.0
func (s *GetUsageInput) SetStartDate(v string) *GetUsageInput
SetStartDate sets the StartDate field's value.
func (*GetUsageInput) SetUsagePlanId ¶ added in v1.5.0
func (s *GetUsageInput) SetUsagePlanId(v string) *GetUsageInput
SetUsagePlanId sets the UsagePlanId field's value.
func (GetUsageInput) String ¶ added in v1.4.2
func (s GetUsageInput) String() string
String returns the string representation
func (*GetUsageInput) Validate ¶ added in v1.4.2
func (s *GetUsageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUsagePlanInput ¶ added in v1.4.2
type GetUsagePlanInput struct { // The identifier of the UsagePlan resource to be retrieved. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The GET request to get a usage plan of a given plan identifier.
func (GetUsagePlanInput) GoString ¶ added in v1.4.2
func (s GetUsagePlanInput) GoString() string
GoString returns the string representation
func (*GetUsagePlanInput) SetUsagePlanId ¶ added in v1.5.0
func (s *GetUsagePlanInput) SetUsagePlanId(v string) *GetUsagePlanInput
SetUsagePlanId sets the UsagePlanId field's value.
func (GetUsagePlanInput) String ¶ added in v1.4.2
func (s GetUsagePlanInput) String() string
String returns the string representation
func (*GetUsagePlanInput) Validate ¶ added in v1.4.2
func (s *GetUsagePlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUsagePlanKeyInput ¶ added in v1.4.2
type GetUsagePlanKeyInput struct { // The key Id of the to-be-retrieved UsagePlanKey resource representing a plan // customer. // // KeyId is a required field KeyId *string `location:"uri" locationName:"keyId" type:"string" required:"true"` // The Id of the UsagePlan resource representing the usage plan containing the // to-be-retrieved UsagePlanKey resource representing a plan customer. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The GET request to get a usage plan key of a given key identifier.
func (GetUsagePlanKeyInput) GoString ¶ added in v1.4.2
func (s GetUsagePlanKeyInput) GoString() string
GoString returns the string representation
func (*GetUsagePlanKeyInput) SetKeyId ¶ added in v1.5.0
func (s *GetUsagePlanKeyInput) SetKeyId(v string) *GetUsagePlanKeyInput
SetKeyId sets the KeyId field's value.
func (*GetUsagePlanKeyInput) SetUsagePlanId ¶ added in v1.5.0
func (s *GetUsagePlanKeyInput) SetUsagePlanId(v string) *GetUsagePlanKeyInput
SetUsagePlanId sets the UsagePlanId field's value.
func (GetUsagePlanKeyInput) String ¶ added in v1.4.2
func (s GetUsagePlanKeyInput) String() string
String returns the string representation
func (*GetUsagePlanKeyInput) Validate ¶ added in v1.4.2
func (s *GetUsagePlanKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUsagePlanKeysInput ¶ added in v1.4.2
type GetUsagePlanKeysInput struct { // The maximum number of returned results per page. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // A query parameter specifying the name of the to-be-returned usage plan keys. NameQuery *string `location:"querystring" locationName:"name" type:"string"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // The Id of the UsagePlan resource representing the usage plan containing the // to-be-retrieved UsagePlanKey resource representing a plan customer. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
func (GetUsagePlanKeysInput) GoString ¶ added in v1.4.2
func (s GetUsagePlanKeysInput) GoString() string
GoString returns the string representation
func (*GetUsagePlanKeysInput) SetLimit ¶ added in v1.5.0
func (s *GetUsagePlanKeysInput) SetLimit(v int64) *GetUsagePlanKeysInput
SetLimit sets the Limit field's value.
func (*GetUsagePlanKeysInput) SetNameQuery ¶ added in v1.5.0
func (s *GetUsagePlanKeysInput) SetNameQuery(v string) *GetUsagePlanKeysInput
SetNameQuery sets the NameQuery field's value.
func (*GetUsagePlanKeysInput) SetPosition ¶ added in v1.5.0
func (s *GetUsagePlanKeysInput) SetPosition(v string) *GetUsagePlanKeysInput
SetPosition sets the Position field's value.
func (*GetUsagePlanKeysInput) SetUsagePlanId ¶ added in v1.5.0
func (s *GetUsagePlanKeysInput) SetUsagePlanId(v string) *GetUsagePlanKeysInput
SetUsagePlanId sets the UsagePlanId field's value.
func (GetUsagePlanKeysInput) String ¶ added in v1.4.2
func (s GetUsagePlanKeysInput) String() string
String returns the string representation
func (*GetUsagePlanKeysInput) Validate ¶ added in v1.4.2
func (s *GetUsagePlanKeysInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUsagePlanKeysOutput ¶ added in v1.4.2
type GetUsagePlanKeysOutput struct { // The current page of elements from this collection. Items []*UsagePlanKey `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
Create and Use Usage Plans (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (GetUsagePlanKeysOutput) GoString ¶ added in v1.4.2
func (s GetUsagePlanKeysOutput) GoString() string
GoString returns the string representation
func (*GetUsagePlanKeysOutput) SetItems ¶ added in v1.5.0
func (s *GetUsagePlanKeysOutput) SetItems(v []*UsagePlanKey) *GetUsagePlanKeysOutput
SetItems sets the Items field's value.
func (*GetUsagePlanKeysOutput) SetPosition ¶ added in v1.5.0
func (s *GetUsagePlanKeysOutput) SetPosition(v string) *GetUsagePlanKeysOutput
SetPosition sets the Position field's value.
func (GetUsagePlanKeysOutput) String ¶ added in v1.4.2
func (s GetUsagePlanKeysOutput) String() string
String returns the string representation
type GetUsagePlansInput ¶ added in v1.4.2
type GetUsagePlansInput struct { // The identifier of the API key associated with the usage plans. KeyId *string `location:"querystring" locationName:"keyId" type:"string"` // The maximum number of returned results per page. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
The GET request to get all the usage plans of the caller's account.
func (GetUsagePlansInput) GoString ¶ added in v1.4.2
func (s GetUsagePlansInput) GoString() string
GoString returns the string representation
func (*GetUsagePlansInput) SetKeyId ¶ added in v1.5.0
func (s *GetUsagePlansInput) SetKeyId(v string) *GetUsagePlansInput
SetKeyId sets the KeyId field's value.
func (*GetUsagePlansInput) SetLimit ¶ added in v1.5.0
func (s *GetUsagePlansInput) SetLimit(v int64) *GetUsagePlansInput
SetLimit sets the Limit field's value.
func (*GetUsagePlansInput) SetPosition ¶ added in v1.5.0
func (s *GetUsagePlansInput) SetPosition(v string) *GetUsagePlansInput
SetPosition sets the Position field's value.
func (GetUsagePlansInput) String ¶ added in v1.4.2
func (s GetUsagePlansInput) String() string
String returns the string representation
type GetUsagePlansOutput ¶ added in v1.4.2
type GetUsagePlansOutput struct { // The current page of elements from this collection. Items []*UsagePlan `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Represents a collection of usage plans for an AWS account.
Create and Use Usage Plans (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (GetUsagePlansOutput) GoString ¶ added in v1.4.2
func (s GetUsagePlansOutput) GoString() string
GoString returns the string representation
func (*GetUsagePlansOutput) SetItems ¶ added in v1.5.0
func (s *GetUsagePlansOutput) SetItems(v []*UsagePlan) *GetUsagePlansOutput
SetItems sets the Items field's value.
func (*GetUsagePlansOutput) SetPosition ¶ added in v1.5.0
func (s *GetUsagePlansOutput) SetPosition(v string) *GetUsagePlansOutput
SetPosition sets the Position field's value.
func (GetUsagePlansOutput) String ¶ added in v1.4.2
func (s GetUsagePlansOutput) String() string
String returns the string representation
type ImportApiKeysInput ¶ added in v1.4.2
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 }
The POST request to import API keys from an external source, such as a CSV-formatted file.
func (ImportApiKeysInput) GoString ¶ added in v1.4.2
func (s ImportApiKeysInput) GoString() string
GoString returns the string representation
func (*ImportApiKeysInput) SetBody ¶ added in v1.5.0
func (s *ImportApiKeysInput) SetBody(v []byte) *ImportApiKeysInput
SetBody sets the Body field's value.
func (*ImportApiKeysInput) SetFailOnWarnings ¶ added in v1.5.0
func (s *ImportApiKeysInput) SetFailOnWarnings(v bool) *ImportApiKeysInput
SetFailOnWarnings sets the FailOnWarnings field's value.
func (*ImportApiKeysInput) SetFormat ¶ added in v1.5.0
func (s *ImportApiKeysInput) SetFormat(v string) *ImportApiKeysInput
SetFormat sets the Format field's value.
func (ImportApiKeysInput) String ¶ added in v1.4.2
func (s ImportApiKeysInput) String() string
String returns the string representation
func (*ImportApiKeysInput) Validate ¶ added in v1.4.2
func (s *ImportApiKeysInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportApiKeysOutput ¶ added in v1.4.2
type ImportApiKeysOutput struct { // A list of all the ApiKey identifiers. Ids []*string `locationName:"ids" type:"list"` // A list of warning messages. Warnings []*string `locationName:"warnings" type:"list"` // contains filtered or unexported fields }
The identifier of an ApiKey used in a UsagePlan.
func (ImportApiKeysOutput) GoString ¶ added in v1.4.2
func (s ImportApiKeysOutput) GoString() string
GoString returns the string representation
func (*ImportApiKeysOutput) SetIds ¶ added in v1.5.0
func (s *ImportApiKeysOutput) SetIds(v []*string) *ImportApiKeysOutput
SetIds sets the Ids field's value.
func (*ImportApiKeysOutput) SetWarnings ¶ added in v1.5.0
func (s *ImportApiKeysOutput) SetWarnings(v []*string) *ImportApiKeysOutput
SetWarnings sets the Warnings field's value.
func (ImportApiKeysOutput) String ¶ added in v1.4.2
func (s ImportApiKeysOutput) String() string
String returns the string representation
type ImportDocumentationPartsInput ¶ added in v1.5.13
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 string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Import documentation parts from an external (e.g., Swagger) definition file.
func (ImportDocumentationPartsInput) GoString ¶ added in v1.5.13
func (s ImportDocumentationPartsInput) GoString() string
GoString returns the string representation
func (*ImportDocumentationPartsInput) SetBody ¶ added in v1.5.13
func (s *ImportDocumentationPartsInput) SetBody(v []byte) *ImportDocumentationPartsInput
SetBody sets the Body field's value.
func (*ImportDocumentationPartsInput) SetFailOnWarnings ¶ added in v1.5.13
func (s *ImportDocumentationPartsInput) SetFailOnWarnings(v bool) *ImportDocumentationPartsInput
SetFailOnWarnings sets the FailOnWarnings field's value.
func (*ImportDocumentationPartsInput) SetMode ¶ added in v1.5.13
func (s *ImportDocumentationPartsInput) SetMode(v string) *ImportDocumentationPartsInput
SetMode sets the Mode field's value.
func (*ImportDocumentationPartsInput) SetRestApiId ¶ added in v1.5.13
func (s *ImportDocumentationPartsInput) SetRestApiId(v string) *ImportDocumentationPartsInput
SetRestApiId sets the RestApiId field's value.
func (ImportDocumentationPartsInput) String ¶ added in v1.5.13
func (s ImportDocumentationPartsInput) String() string
String returns the string representation
func (*ImportDocumentationPartsInput) Validate ¶ added in v1.5.13
func (s *ImportDocumentationPartsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportDocumentationPartsOutput ¶ added in v1.5.13
type ImportDocumentationPartsOutput struct { // A list of the returned documentation part identifiers. Ids []*string `locationName:"ids" type:"list"` // A list of warning messages reported during import of documentation parts. Warnings []*string `locationName:"warnings" type:"list"` // contains filtered or unexported fields }
A collection of the imported DocumentationPart identifiers.
This is used to return the result when documentation parts in an external (e.g., Swagger) file are imported into Amazon API Gateway Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), documentationpart:import (http://docs.aws.amazon.com/apigateway/api-reference/link-relation/documentationpart-import/), DocumentationPart
func (ImportDocumentationPartsOutput) GoString ¶ added in v1.5.13
func (s ImportDocumentationPartsOutput) GoString() string
GoString returns the string representation
func (*ImportDocumentationPartsOutput) SetIds ¶ added in v1.5.13
func (s *ImportDocumentationPartsOutput) SetIds(v []*string) *ImportDocumentationPartsOutput
SetIds sets the Ids field's value.
func (*ImportDocumentationPartsOutput) SetWarnings ¶ added in v1.5.13
func (s *ImportDocumentationPartsOutput) SetWarnings(v []*string) *ImportDocumentationPartsOutput
SetWarnings sets the Warnings field's value.
func (ImportDocumentationPartsOutput) String ¶ added in v1.5.13
func (s ImportDocumentationPartsOutput) String() string
String returns the string representation
type ImportRestApiInput ¶ added in v1.1.16
type ImportRestApiInput struct { // The POST request body containing external API definitions. Currently, only // Swagger definition JSON files are supported. The maximum size of the API // definition file is 2MB. // // Body is a required field Body []byte `locationName:"body" type:"blob" required:"true"` // A query parameter to indicate whether to rollback the API creation (true) // or not (false) when a warning is encountered. The default value is false. FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` // A key-value map of context-specific query string parameters specifying the // behavior of different API importing operations. The following shows operation-specific // parameters and their supported values. // // To exclude DocumentationParts from the import, set parameters as ignore=documentation. // // To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE // orendpointConfigurationTypes=REGIONAL. The default endpoint type is EDGE. // // To handle imported basePath, set parameters as basePath=ignore, basePath=prepend // or basePath=split. // // For example, the AWS CLI command to exclude documentation from the imported // API is: // // aws apigateway import-rest-api --parameters ignore=documentation --body // 'file:///path/to/imported-api-body.json // The AWS CLI command to set the regional endpoint on the imported API is: // // aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL // --body 'file:///path/to/imported-api-body.json Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // contains filtered or unexported fields }
A POST request to import an API to Amazon API Gateway using an input of an API definition file.
func (ImportRestApiInput) GoString ¶ added in v1.1.16
func (s ImportRestApiInput) GoString() string
GoString returns the string representation
func (*ImportRestApiInput) SetBody ¶ added in v1.5.0
func (s *ImportRestApiInput) SetBody(v []byte) *ImportRestApiInput
SetBody sets the Body field's value.
func (*ImportRestApiInput) SetFailOnWarnings ¶ added in v1.5.0
func (s *ImportRestApiInput) SetFailOnWarnings(v bool) *ImportRestApiInput
SetFailOnWarnings sets the FailOnWarnings field's value.
func (*ImportRestApiInput) SetParameters ¶ added in v1.5.0
func (s *ImportRestApiInput) SetParameters(v map[string]*string) *ImportRestApiInput
SetParameters sets the Parameters field's value.
func (ImportRestApiInput) String ¶ added in v1.1.16
func (s ImportRestApiInput) String() string
String returns the string representation
func (*ImportRestApiInput) Validate ¶ added in v1.1.21
func (s *ImportRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Integration ¶
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"` // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 // milliseconds or 29 seconds. TimeoutInMillis *int64 `locationName:"timeoutInMillis" type:"integer"` // 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 }
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
In the API Gateway console, the built-in Lambda integration is an AWS integration.
Creating an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (Integration) GoString ¶
func (s Integration) GoString() string
GoString returns the string representation
func (*Integration) SetCacheKeyParameters ¶ added in v1.5.0
func (s *Integration) SetCacheKeyParameters(v []*string) *Integration
SetCacheKeyParameters sets the CacheKeyParameters field's value.
func (*Integration) SetCacheNamespace ¶ added in v1.5.0
func (s *Integration) SetCacheNamespace(v string) *Integration
SetCacheNamespace sets the CacheNamespace field's value.
func (*Integration) SetContentHandling ¶ added in v1.5.7
func (s *Integration) SetContentHandling(v string) *Integration
SetContentHandling sets the ContentHandling field's value.
func (*Integration) SetCredentials ¶ added in v1.5.0
func (s *Integration) SetCredentials(v string) *Integration
SetCredentials sets the Credentials field's value.
func (*Integration) SetHttpMethod ¶ added in v1.5.0
func (s *Integration) SetHttpMethod(v string) *Integration
SetHttpMethod sets the HttpMethod field's value.
func (*Integration) SetIntegrationResponses ¶ added in v1.5.0
func (s *Integration) SetIntegrationResponses(v map[string]*IntegrationResponse) *Integration
SetIntegrationResponses sets the IntegrationResponses field's value.
func (*Integration) SetPassthroughBehavior ¶ added in v1.5.0
func (s *Integration) SetPassthroughBehavior(v string) *Integration
SetPassthroughBehavior sets the PassthroughBehavior field's value.
func (*Integration) SetRequestParameters ¶ added in v1.5.0
func (s *Integration) SetRequestParameters(v map[string]*string) *Integration
SetRequestParameters sets the RequestParameters field's value.
func (*Integration) SetRequestTemplates ¶ added in v1.5.0
func (s *Integration) SetRequestTemplates(v map[string]*string) *Integration
SetRequestTemplates sets the RequestTemplates field's value.
func (*Integration) SetTimeoutInMillis ¶ added in v1.12.32
func (s *Integration) SetTimeoutInMillis(v int64) *Integration
SetTimeoutInMillis sets the TimeoutInMillis field's value.
func (*Integration) SetType ¶ added in v1.5.0
func (s *Integration) SetType(v string) *Integration
SetType sets the Type field's value.
func (*Integration) SetUri ¶ added in v1.5.0
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 ¶
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 }
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
Creating an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (IntegrationResponse) GoString ¶
func (s IntegrationResponse) GoString() string
GoString returns the string representation
func (*IntegrationResponse) SetContentHandling ¶ added in v1.5.7
func (s *IntegrationResponse) SetContentHandling(v string) *IntegrationResponse
SetContentHandling sets the ContentHandling field's value.
func (*IntegrationResponse) SetResponseParameters ¶ added in v1.5.0
func (s *IntegrationResponse) SetResponseParameters(v map[string]*string) *IntegrationResponse
SetResponseParameters sets the ResponseParameters field's value.
func (*IntegrationResponse) SetResponseTemplates ¶ added in v1.5.0
func (s *IntegrationResponse) SetResponseTemplates(v map[string]*string) *IntegrationResponse
SetResponseTemplates sets the ResponseTemplates field's value.
func (*IntegrationResponse) SetSelectionPattern ¶ added in v1.5.0
func (s *IntegrationResponse) SetSelectionPattern(v string) *IntegrationResponse
SetSelectionPattern sets the SelectionPattern field's value.
func (*IntegrationResponse) SetStatusCode ¶ added in v1.5.0
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 ¶
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 }
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
Example: Retrive the GET method on a specified resource
Request ¶
The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri).
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": true, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E\")" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }
In the example above, the response template for the 200 OK response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E and the output is decoded using the $util.urlDecode() (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#util-templat-reference) helper function.
MethodResponse, Integration, IntegrationResponse, Resource, Set up an API's method (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html)
func (*Method) SetApiKeyRequired ¶ added in v1.5.0
SetApiKeyRequired sets the ApiKeyRequired field's value.
func (*Method) SetAuthorizationType ¶ added in v1.5.0
SetAuthorizationType sets the AuthorizationType field's value.
func (*Method) SetAuthorizerId ¶ added in v1.5.0
SetAuthorizerId sets the AuthorizerId field's value.
func (*Method) SetHttpMethod ¶ added in v1.5.0
SetHttpMethod sets the HttpMethod field's value.
func (*Method) SetMethodIntegration ¶ added in v1.5.0
func (s *Method) SetMethodIntegration(v *Integration) *Method
SetMethodIntegration sets the MethodIntegration field's value.
func (*Method) SetMethodResponses ¶ added in v1.5.0
func (s *Method) SetMethodResponses(v map[string]*MethodResponse) *Method
SetMethodResponses sets the MethodResponses field's value.
func (*Method) SetOperationName ¶ added in v1.6.8
SetOperationName sets the OperationName field's value.
func (*Method) SetRequestModels ¶ added in v1.5.0
SetRequestModels sets the RequestModels field's value.
func (*Method) SetRequestParameters ¶ added in v1.5.0
SetRequestParameters sets the RequestParameters field's value.
func (*Method) SetRequestValidatorId ¶ added in v1.8.12
SetRequestValidatorId sets the RequestValidatorId field's value.
type MethodResponse ¶
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 }
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
Example: A MethodResponse instance of an API
Request ¶
The example request retrieves a MethodResponse of the 200 status code.
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" }
func (MethodResponse) GoString ¶
func (s MethodResponse) GoString() string
GoString returns the string representation
func (*MethodResponse) SetResponseModels ¶ added in v1.5.0
func (s *MethodResponse) SetResponseModels(v map[string]*string) *MethodResponse
SetResponseModels sets the ResponseModels field's value.
func (*MethodResponse) SetResponseParameters ¶ added in v1.5.0
func (s *MethodResponse) SetResponseParameters(v map[string]*bool) *MethodResponse
SetResponseParameters sets the ResponseParameters field's value.
func (*MethodResponse) SetStatusCode ¶ added in v1.5.0
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 ¶
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"` // 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 }
Specifies the method setting properties.
func (MethodSetting) GoString ¶
func (s MethodSetting) GoString() string
GoString returns the string representation
func (*MethodSetting) SetCacheDataEncrypted ¶ added in v1.5.0
func (s *MethodSetting) SetCacheDataEncrypted(v bool) *MethodSetting
SetCacheDataEncrypted sets the CacheDataEncrypted field's value.
func (*MethodSetting) SetCacheTtlInSeconds ¶ added in v1.5.0
func (s *MethodSetting) SetCacheTtlInSeconds(v int64) *MethodSetting
SetCacheTtlInSeconds sets the CacheTtlInSeconds field's value.
func (*MethodSetting) SetCachingEnabled ¶ added in v1.5.0
func (s *MethodSetting) SetCachingEnabled(v bool) *MethodSetting
SetCachingEnabled sets the CachingEnabled field's value.
func (*MethodSetting) SetDataTraceEnabled ¶ added in v1.5.0
func (s *MethodSetting) SetDataTraceEnabled(v bool) *MethodSetting
SetDataTraceEnabled sets the DataTraceEnabled field's value.
func (*MethodSetting) SetLoggingLevel ¶ added in v1.5.0
func (s *MethodSetting) SetLoggingLevel(v string) *MethodSetting
SetLoggingLevel sets the LoggingLevel field's value.
func (*MethodSetting) SetMetricsEnabled ¶ added in v1.5.0
func (s *MethodSetting) SetMetricsEnabled(v bool) *MethodSetting
SetMetricsEnabled sets the MetricsEnabled field's value.
func (*MethodSetting) SetRequireAuthorizationForCacheControl ¶ added in v1.5.0
func (s *MethodSetting) SetRequireAuthorizationForCacheControl(v bool) *MethodSetting
SetRequireAuthorizationForCacheControl sets the RequireAuthorizationForCacheControl field's value.
func (*MethodSetting) SetThrottlingBurstLimit ¶ added in v1.5.0
func (s *MethodSetting) SetThrottlingBurstLimit(v int64) *MethodSetting
SetThrottlingBurstLimit sets the ThrottlingBurstLimit field's value.
func (*MethodSetting) SetThrottlingRateLimit ¶ added in v1.5.0
func (s *MethodSetting) SetThrottlingRateLimit(v float64) *MethodSetting
SetThrottlingRateLimit sets the ThrottlingRateLimit field's value.
func (*MethodSetting) SetUnauthorizedCacheControlHeaderStrategy ¶ added in v1.5.0
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 ¶
type MethodSnapshot struct { // Specifies whether the method requires a valid ApiKey. ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"` // The method's authorization type. Valid values are NONE for open access, AWS_IAM // for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS // for using a Cognito user pool. AuthorizationType *string `locationName:"authorizationType" type:"string"` // contains filtered or unexported fields }
Represents a summary of a Method resource, given a particular date and time.
func (MethodSnapshot) GoString ¶
func (s MethodSnapshot) GoString() string
GoString returns the string representation
func (*MethodSnapshot) SetApiKeyRequired ¶ added in v1.5.0
func (s *MethodSnapshot) SetApiKeyRequired(v bool) *MethodSnapshot
SetApiKeyRequired sets the ApiKeyRequired field's value.
func (*MethodSnapshot) SetAuthorizationType ¶ added in v1.5.0
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 ¶
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. Must be an alphanumeric string. Name *string `locationName:"name" type:"string"` // The schema for the model. For application/json models, this should be JSON-schema // draft v4 (http://json-schema.org/documentation.html) model. Do not include // "\*/" characters in the description of any properties because such "\*/" // characters may be interpreted as the closing marker for comments in some // languages, such as Java or JavaScript, causing the installation of your API's // SDK generated by API Gateway to fail. Schema *string `locationName:"schema" type:"string"` // contains filtered or unexported fields }
Represents the data structure of a method's request or response payload.
A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.
A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.
Method, MethodResponse, Models and Mappings (http://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html)
func (*Model) SetContentType ¶ added in v1.5.0
SetContentType sets the ContentType field's value.
func (*Model) SetDescription ¶ added in v1.5.0
SetDescription sets the Description field's value.
type PatchOperation ¶
type PatchOperation struct { // Not supported. From *string `locationName:"from" type:"string"` // An update operation to be performed with this PATCH request. The valid value // can be "add", "remove", or "replace". Not all valid operations are supported // for a given resource. Support of the operations depends on specific operational // contexts. Attempts to apply an unsupported operation on a resource will return // an error message. Op *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 }
A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.
func (PatchOperation) GoString ¶
func (s PatchOperation) GoString() string
GoString returns the string representation
func (*PatchOperation) SetFrom ¶ added in v1.5.0
func (s *PatchOperation) SetFrom(v string) *PatchOperation
SetFrom sets the From field's value.
func (*PatchOperation) SetOp ¶ added in v1.5.0
func (s *PatchOperation) SetOp(v string) *PatchOperation
SetOp sets the Op field's value.
func (*PatchOperation) SetPath ¶ added in v1.5.0
func (s *PatchOperation) SetPath(v string) *PatchOperation
SetPath sets the Path field's value.
func (*PatchOperation) SetValue ¶ added in v1.5.0
func (s *PatchOperation) SetValue(v string) *PatchOperation
SetValue sets the Value field's value.
func (PatchOperation) String ¶
func (s PatchOperation) String() string
String returns the string representation
type PutGatewayResponseInput ¶ added in v1.10.10
type PutGatewayResponseInput struct { // Response parameters (paths, query strings and headers) of the GatewayResponse // as a string-to-string map of key-value pairs. ResponseParameters map[string]*string `locationName:"responseParameters" type:"map"` // Response templates of the GatewayResponse as a string-to-string map of key-value // pairs. ResponseTemplates map[string]*string `locationName:"responseTemplates" type:"map"` // The response type of the associated GatewayResponse. Valid values are ACCESS_DENIED // // API_CONFIGURATION_ERROR // AUTHORIZER_FAILURE // AUTHORIZER_CONFIGURATION_ERROR // BAD_REQUEST_PARAMETERS // BAD_REQUEST_BODY // DEFAULT_4XX // DEFAULT_5XX // EXPIRED_TOKEN // INVALID_SIGNATURE // INTEGRATION_FAILURE // INTEGRATION_TIMEOUT // INVALID_API_KEY // MISSING_AUTHENTICATION_TOKEN // QUOTA_EXCEEDED // REQUEST_TOO_LARGE // RESOURCE_NOT_FOUND // THROTTLED // UNAUTHORIZED // UNSUPPORTED_MEDIA_TYPES // // ResponseType is a required field ResponseType *string `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"GatewayResponseType"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The HTTP status code of the GatewayResponse StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
func (PutGatewayResponseInput) GoString ¶ added in v1.10.10
func (s PutGatewayResponseInput) GoString() string
GoString returns the string representation
func (*PutGatewayResponseInput) SetResponseParameters ¶ added in v1.10.10
func (s *PutGatewayResponseInput) SetResponseParameters(v map[string]*string) *PutGatewayResponseInput
SetResponseParameters sets the ResponseParameters field's value.
func (*PutGatewayResponseInput) SetResponseTemplates ¶ added in v1.10.10
func (s *PutGatewayResponseInput) SetResponseTemplates(v map[string]*string) *PutGatewayResponseInput
SetResponseTemplates sets the ResponseTemplates field's value.
func (*PutGatewayResponseInput) SetResponseType ¶ added in v1.10.10
func (s *PutGatewayResponseInput) SetResponseType(v string) *PutGatewayResponseInput
SetResponseType sets the ResponseType field's value.
func (*PutGatewayResponseInput) SetRestApiId ¶ added in v1.10.10
func (s *PutGatewayResponseInput) SetRestApiId(v string) *PutGatewayResponseInput
SetRestApiId sets the RestApiId field's value.
func (*PutGatewayResponseInput) SetStatusCode ¶ added in v1.10.10
func (s *PutGatewayResponseInput) SetStatusCode(v string) *PutGatewayResponseInput
SetStatusCode sets the StatusCode field's value.
func (PutGatewayResponseInput) String ¶ added in v1.10.10
func (s PutGatewayResponseInput) String() string
String returns the string representation
func (*PutGatewayResponseInput) Validate ¶ added in v1.10.10
func (s *PutGatewayResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutIntegrationInput ¶
type PutIntegrationInput struct { // Specifies a put integration input's cache key parameters. CacheKeyParameters []*string `locationName:"cacheKeyParameters" type:"list"` // Specifies a put integration input's cache namespace. CacheNamespace *string `locationName:"cacheNamespace" type:"string"` // Specifies how to handle request payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: // // * CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded // string to the corresponding binary blob. // // * CONVERT_TO_TEXT: Converts a request payload from a binary blob to a // Base64-encoded string. // // If this property is not defined, the request payload will be passed through // from the method request to integration request without modification, provided // that the passthroughBehaviors is configured to support payload pass-through. ContentHandling *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"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 // milliseconds or 29 seconds. TimeoutInMillis *int64 `locationName:"timeoutInMillis" type:"integer"` // Specifies a put integration input's type. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" 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 }
Sets up a method's integration.
func (PutIntegrationInput) GoString ¶
func (s PutIntegrationInput) GoString() string
GoString returns the string representation
func (*PutIntegrationInput) SetCacheKeyParameters ¶ added in v1.5.0
func (s *PutIntegrationInput) SetCacheKeyParameters(v []*string) *PutIntegrationInput
SetCacheKeyParameters sets the CacheKeyParameters field's value.
func (*PutIntegrationInput) SetCacheNamespace ¶ added in v1.5.0
func (s *PutIntegrationInput) SetCacheNamespace(v string) *PutIntegrationInput
SetCacheNamespace sets the CacheNamespace field's value.
func (*PutIntegrationInput) SetContentHandling ¶ added in v1.5.7
func (s *PutIntegrationInput) SetContentHandling(v string) *PutIntegrationInput
SetContentHandling sets the ContentHandling field's value.
func (*PutIntegrationInput) SetCredentials ¶ added in v1.5.0
func (s *PutIntegrationInput) SetCredentials(v string) *PutIntegrationInput
SetCredentials sets the Credentials field's value.
func (*PutIntegrationInput) SetHttpMethod ¶ added in v1.5.0
func (s *PutIntegrationInput) SetHttpMethod(v string) *PutIntegrationInput
SetHttpMethod sets the HttpMethod field's value.
func (*PutIntegrationInput) SetIntegrationHttpMethod ¶ added in v1.5.0
func (s *PutIntegrationInput) SetIntegrationHttpMethod(v string) *PutIntegrationInput
SetIntegrationHttpMethod sets the IntegrationHttpMethod field's value.
func (*PutIntegrationInput) SetPassthroughBehavior ¶ added in v1.5.0
func (s *PutIntegrationInput) SetPassthroughBehavior(v string) *PutIntegrationInput
SetPassthroughBehavior sets the PassthroughBehavior field's value.
func (*PutIntegrationInput) SetRequestParameters ¶ added in v1.5.0
func (s *PutIntegrationInput) SetRequestParameters(v map[string]*string) *PutIntegrationInput
SetRequestParameters sets the RequestParameters field's value.
func (*PutIntegrationInput) SetRequestTemplates ¶ added in v1.5.0
func (s *PutIntegrationInput) SetRequestTemplates(v map[string]*string) *PutIntegrationInput
SetRequestTemplates sets the RequestTemplates field's value.
func (*PutIntegrationInput) SetResourceId ¶ added in v1.5.0
func (s *PutIntegrationInput) SetResourceId(v string) *PutIntegrationInput
SetResourceId sets the ResourceId field's value.
func (*PutIntegrationInput) SetRestApiId ¶ added in v1.5.0
func (s *PutIntegrationInput) SetRestApiId(v string) *PutIntegrationInput
SetRestApiId sets the RestApiId field's value.
func (*PutIntegrationInput) SetTimeoutInMillis ¶ added in v1.12.32
func (s *PutIntegrationInput) SetTimeoutInMillis(v int64) *PutIntegrationInput
SetTimeoutInMillis sets the TimeoutInMillis field's value.
func (*PutIntegrationInput) SetType ¶ added in v1.5.0
func (s *PutIntegrationInput) SetType(v string) *PutIntegrationInput
SetType sets the Type field's value.
func (*PutIntegrationInput) SetUri ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *PutIntegrationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutIntegrationResponseInput ¶
type PutIntegrationResponseInput struct { // Specifies how to handle response payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: // // * CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded // string to the corresponding binary blob. // // * CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. // // If this property is not defined, the response payload will be passed through // from the integration response to the method response without modification. ContentHandling *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"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies the selection pattern of a put integration response. SelectionPattern *string `locationName:"selectionPattern" type:"string"` // Specifies the status code that is used to map the integration response to // an existing MethodResponse. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a put integration response request.
func (PutIntegrationResponseInput) GoString ¶
func (s PutIntegrationResponseInput) GoString() string
GoString returns the string representation
func (*PutIntegrationResponseInput) SetContentHandling ¶ added in v1.5.7
func (s *PutIntegrationResponseInput) SetContentHandling(v string) *PutIntegrationResponseInput
SetContentHandling sets the ContentHandling field's value.
func (*PutIntegrationResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetHttpMethod(v string) *PutIntegrationResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*PutIntegrationResponseInput) SetResourceId ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetResourceId(v string) *PutIntegrationResponseInput
SetResourceId sets the ResourceId field's value.
func (*PutIntegrationResponseInput) SetResponseParameters ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetResponseParameters(v map[string]*string) *PutIntegrationResponseInput
SetResponseParameters sets the ResponseParameters field's value.
func (*PutIntegrationResponseInput) SetResponseTemplates ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetResponseTemplates(v map[string]*string) *PutIntegrationResponseInput
SetResponseTemplates sets the ResponseTemplates field's value.
func (*PutIntegrationResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetRestApiId(v string) *PutIntegrationResponseInput
SetRestApiId sets the RestApiId field's value.
func (*PutIntegrationResponseInput) SetSelectionPattern ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetSelectionPattern(v string) *PutIntegrationResponseInput
SetSelectionPattern sets the SelectionPattern field's value.
func (*PutIntegrationResponseInput) SetStatusCode ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *PutIntegrationResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutMethodInput ¶
type PutMethodInput struct { // Specifies whether the method required a valid ApiKey. ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"` // The method's authorization type. Valid values are NONE for open access, AWS_IAM // for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS // for using a Cognito user pool. // // AuthorizationType is a required field AuthorizationType *string `locationName:"authorizationType" type:"string" required:"true"` // Specifies the identifier of an Authorizer to use on this Method, if the type // is CUSTOM. AuthorizerId *string `locationName:"authorizerId" type:"string"` // Specifies the method request's HTTP method type. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // A human-friendly operation identifier for the method. For example, you can // assign the operationName of ListPets for the GET /pets method in PetStore // (http://petstore-demo-endpoint.execute-api.com/petstore/pets) example. OperationName *string `locationName:"operationName" type:"string"` // Specifies the Model resources used for the request's content type. Request // models are represented as a key/value map, with a content type as the key // and a Model name as the value. RequestModels map[string]*string `locationName:"requestModels" type:"map"` // A key-value map defining required or optional method request parameters that // can be accepted by Amazon API Gateway. A key defines a method request parameter // name matching the pattern of method.request.{location}.{name}, where location // is querystring, path, or header and name is a valid and unique parameter // name. The value associated with the key is a Boolean flag indicating whether // the parameter is required (true) or optional (false). The method request // parameter names defined here are available in Integration to be mapped to // integration request parameters or body-mapping templates. RequestParameters map[string]*bool `locationName:"requestParameters" type:"map"` // The identifier of a RequestValidator for validating the method request. RequestValidatorId *string `locationName:"requestValidatorId" type:"string"` // The Resource identifier for the new Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to add a method to an existing Resource resource.
func (PutMethodInput) GoString ¶
func (s PutMethodInput) GoString() string
GoString returns the string representation
func (*PutMethodInput) SetApiKeyRequired ¶ added in v1.5.0
func (s *PutMethodInput) SetApiKeyRequired(v bool) *PutMethodInput
SetApiKeyRequired sets the ApiKeyRequired field's value.
func (*PutMethodInput) SetAuthorizationType ¶ added in v1.5.0
func (s *PutMethodInput) SetAuthorizationType(v string) *PutMethodInput
SetAuthorizationType sets the AuthorizationType field's value.
func (*PutMethodInput) SetAuthorizerId ¶ added in v1.5.0
func (s *PutMethodInput) SetAuthorizerId(v string) *PutMethodInput
SetAuthorizerId sets the AuthorizerId field's value.
func (*PutMethodInput) SetHttpMethod ¶ added in v1.5.0
func (s *PutMethodInput) SetHttpMethod(v string) *PutMethodInput
SetHttpMethod sets the HttpMethod field's value.
func (*PutMethodInput) SetOperationName ¶ added in v1.6.8
func (s *PutMethodInput) SetOperationName(v string) *PutMethodInput
SetOperationName sets the OperationName field's value.
func (*PutMethodInput) SetRequestModels ¶ added in v1.5.0
func (s *PutMethodInput) SetRequestModels(v map[string]*string) *PutMethodInput
SetRequestModels sets the RequestModels field's value.
func (*PutMethodInput) SetRequestParameters ¶ added in v1.5.0
func (s *PutMethodInput) SetRequestParameters(v map[string]*bool) *PutMethodInput
SetRequestParameters sets the RequestParameters field's value.
func (*PutMethodInput) SetRequestValidatorId ¶ added in v1.8.12
func (s *PutMethodInput) SetRequestValidatorId(v string) *PutMethodInput
SetRequestValidatorId sets the RequestValidatorId field's value.
func (*PutMethodInput) SetResourceId ¶ added in v1.5.0
func (s *PutMethodInput) SetResourceId(v string) *PutMethodInput
SetResourceId sets the ResourceId field's value.
func (*PutMethodInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *PutMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutMethodResponseInput ¶
type PutMethodResponseInput struct { // The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies the Model resources used for the response's content type. Response // models are represented as a key/value map, with a content type as the key // and a Model name as the value. ResponseModels map[string]*string `locationName:"responseModels" type:"map"` // A key-value map specifying required or optional response parameters that // Amazon API Gateway can send back to the caller. A key defines a method response // header name and the associated value is a Boolean flag indicating whether // the method response parameter is required or not. The method response header // names must match the pattern of method.response.header.{name}, where name // is a valid and unique header name. The response parameter names defined here // are available in the integration response to be mapped from an integration // response header expressed in integration.response.header.{name}, a static // value enclosed within a pair of single quotes (e.g., 'application/json'), // or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, // where JSON-expression is a valid JSON expression without the $ prefix.) ResponseParameters map[string]*bool `locationName:"responseParameters" type:"map"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The method response's status code. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
Request to add a MethodResponse to an existing Method resource.
func (PutMethodResponseInput) GoString ¶
func (s PutMethodResponseInput) GoString() string
GoString returns the string representation
func (*PutMethodResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *PutMethodResponseInput) SetHttpMethod(v string) *PutMethodResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*PutMethodResponseInput) SetResourceId ¶ added in v1.5.0
func (s *PutMethodResponseInput) SetResourceId(v string) *PutMethodResponseInput
SetResourceId sets the ResourceId field's value.
func (*PutMethodResponseInput) SetResponseModels ¶ added in v1.5.0
func (s *PutMethodResponseInput) SetResponseModels(v map[string]*string) *PutMethodResponseInput
SetResponseModels sets the ResponseModels field's value.
func (*PutMethodResponseInput) SetResponseParameters ¶ added in v1.5.0
func (s *PutMethodResponseInput) SetResponseParameters(v map[string]*bool) *PutMethodResponseInput
SetResponseParameters sets the ResponseParameters field's value.
func (*PutMethodResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *PutMethodResponseInput) SetRestApiId(v string) *PutMethodResponseInput
SetRestApiId sets the RestApiId field's value.
func (*PutMethodResponseInput) SetStatusCode ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *PutMethodResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutRestApiInput ¶ added in v1.1.16
type PutRestApiInput struct { // The PUT request body containing external API definitions. Currently, only // Swagger definition JSON files are supported. The maximum size of the API // definition file is 2MB. // // Body is a required field Body []byte `locationName:"body" type:"blob" required:"true"` // A query parameter to indicate whether to rollback the API update (true) or // not (false) when a warning is encountered. The default value is false. FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` // The mode query parameter to specify the update mode. Valid values are "merge" // and "overwrite". By default, the update mode is "merge". Mode *string `location:"querystring" locationName:"mode" type:"string" enum:"PutMode"` // Custom header parameters as part of the request. For example, to exclude // DocumentationParts from an imported API, set ignore=documentation as a parameters // value, as in the AWS CLI command of aws apigateway import-rest-api --parameters // ignore=documentation --body 'file:///path/to/imported-api-body.json. Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
A PUT request to update an existing API, with external API definitions specified as the request body.
func (PutRestApiInput) GoString ¶ added in v1.1.16
func (s PutRestApiInput) GoString() string
GoString returns the string representation
func (*PutRestApiInput) SetBody ¶ added in v1.5.0
func (s *PutRestApiInput) SetBody(v []byte) *PutRestApiInput
SetBody sets the Body field's value.
func (*PutRestApiInput) SetFailOnWarnings ¶ added in v1.5.0
func (s *PutRestApiInput) SetFailOnWarnings(v bool) *PutRestApiInput
SetFailOnWarnings sets the FailOnWarnings field's value.
func (*PutRestApiInput) SetMode ¶ added in v1.5.0
func (s *PutRestApiInput) SetMode(v string) *PutRestApiInput
SetMode sets the Mode field's value.
func (*PutRestApiInput) SetParameters ¶ added in v1.5.0
func (s *PutRestApiInput) SetParameters(v map[string]*string) *PutRestApiInput
SetParameters sets the Parameters field's value.
func (*PutRestApiInput) SetRestApiId ¶ added in v1.5.0
func (s *PutRestApiInput) SetRestApiId(v string) *PutRestApiInput
SetRestApiId sets the RestApiId field's value.
func (PutRestApiInput) String ¶ added in v1.1.16
func (s PutRestApiInput) String() string
String returns the string representation
func (*PutRestApiInput) Validate ¶ added in v1.1.21
func (s *PutRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type QuotaSettings ¶ added in v1.4.2
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 }
Quotas configured for a usage plan.
func (QuotaSettings) GoString ¶ added in v1.4.2
func (s QuotaSettings) GoString() string
GoString returns the string representation
func (*QuotaSettings) SetLimit ¶ added in v1.5.0
func (s *QuotaSettings) SetLimit(v int64) *QuotaSettings
SetLimit sets the Limit field's value.
func (*QuotaSettings) SetOffset ¶ added in v1.5.0
func (s *QuotaSettings) SetOffset(v int64) *QuotaSettings
SetOffset sets the Offset field's value.
func (*QuotaSettings) SetPeriod ¶ added in v1.5.0
func (s *QuotaSettings) SetPeriod(v string) *QuotaSettings
SetPeriod sets the Period field's value.
func (QuotaSettings) String ¶ added in v1.4.2
func (s QuotaSettings) String() string
String returns the string representation
type Resource ¶
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 }
Represents an API resource.
Create an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (*Resource) SetParentId ¶ added in v1.5.0
SetParentId sets the ParentId field's value.
func (*Resource) SetPathPart ¶ added in v1.5.0
SetPathPart sets the PathPart field's value.
func (*Resource) SetResourceMethods ¶ added in v1.5.0
SetResourceMethods sets the ResourceMethods field's value.
type RestApi ¶
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 endpoint configuration of this RestApi showing the endpoint types of // the API. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The API's identifier. This identifier is unique across all of your APIs in // Amazon API Gateway. Id *string `locationName:"id" type:"string"` // The API's name. Name *string `locationName:"name" type:"string"` // A version identifier for the API. Version *string `locationName:"version" type:"string"` // The warning messages reported when failonwarnings is turned on during API // import. Warnings []*string `locationName:"warnings" type:"list"` // contains filtered or unexported fields }
Represents a REST API.
Create an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (*RestApi) SetBinaryMediaTypes ¶ added in v1.5.7
SetBinaryMediaTypes sets the BinaryMediaTypes field's value.
func (*RestApi) SetCreatedDate ¶ added in v1.5.0
SetCreatedDate sets the CreatedDate field's value.
func (*RestApi) SetDescription ¶ added in v1.5.0
SetDescription sets the Description field's value.
func (*RestApi) SetEndpointConfiguration ¶ added in v1.12.21
func (s *RestApi) SetEndpointConfiguration(v *EndpointConfiguration) *RestApi
SetEndpointConfiguration sets the EndpointConfiguration field's value.
func (*RestApi) SetVersion ¶ added in v1.5.13
SetVersion sets the Version field's value.
func (*RestApi) SetWarnings ¶ added in v1.5.0
SetWarnings sets the Warnings field's value.
type SdkConfigurationProperty ¶ added in v1.6.8
type SdkConfigurationProperty struct { // The default value of an SdkType configuration property. DefaultValue *string `locationName:"defaultValue" type:"string"` // The description of an SdkType configuration property. Description *string `locationName:"description" type:"string"` // The user-friendly name of an SdkType configuration property. FriendlyName *string `locationName:"friendlyName" type:"string"` // The name of a an SdkType configuration property. Name *string `locationName:"name" type:"string"` // A boolean flag of an SdkType configuration property to indicate if the associated // SDK configuration property is required (true) or not (false). Required *bool `locationName:"required" type:"boolean"` // contains filtered or unexported fields }
A configuration property of an SDK type.
func (SdkConfigurationProperty) GoString ¶ added in v1.6.8
func (s SdkConfigurationProperty) GoString() string
GoString returns the string representation
func (*SdkConfigurationProperty) SetDefaultValue ¶ added in v1.6.8
func (s *SdkConfigurationProperty) SetDefaultValue(v string) *SdkConfigurationProperty
SetDefaultValue sets the DefaultValue field's value.
func (*SdkConfigurationProperty) SetDescription ¶ added in v1.6.8
func (s *SdkConfigurationProperty) SetDescription(v string) *SdkConfigurationProperty
SetDescription sets the Description field's value.
func (*SdkConfigurationProperty) SetFriendlyName ¶ added in v1.6.8
func (s *SdkConfigurationProperty) SetFriendlyName(v string) *SdkConfigurationProperty
SetFriendlyName sets the FriendlyName field's value.
func (*SdkConfigurationProperty) SetName ¶ added in v1.6.8
func (s *SdkConfigurationProperty) SetName(v string) *SdkConfigurationProperty
SetName sets the Name field's value.
func (*SdkConfigurationProperty) SetRequired ¶ added in v1.6.8
func (s *SdkConfigurationProperty) SetRequired(v bool) *SdkConfigurationProperty
SetRequired sets the Required field's value.
func (SdkConfigurationProperty) String ¶ added in v1.6.8
func (s SdkConfigurationProperty) String() string
String returns the string representation
type SdkType ¶ added in v1.6.8
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 }
A type of SDK that API Gateway can generate.
func (*SdkType) SetConfigurationProperties ¶ added in v1.6.8
func (s *SdkType) SetConfigurationProperties(v []*SdkConfigurationProperty) *SdkType
SetConfigurationProperties sets the ConfigurationProperties field's value.
func (*SdkType) SetDescription ¶ added in v1.6.8
SetDescription sets the Description field's value.
func (*SdkType) SetFriendlyName ¶ added in v1.6.8
SetFriendlyName sets the FriendlyName field's value.
type Stage ¶
type Stage struct { // The access log settings in this stage. AccessLogSettings *AccessLogSettings `locationName:"accessLogSettings" type:"structure"` // 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 }
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Deploy an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html)
func (*Stage) SetAccessLogSettings ¶ added in v1.12.32
func (s *Stage) SetAccessLogSettings(v *AccessLogSettings) *Stage
SetAccessLogSettings sets the AccessLogSettings field's value.
func (*Stage) SetCacheClusterEnabled ¶ added in v1.5.0
SetCacheClusterEnabled sets the CacheClusterEnabled field's value.
func (*Stage) SetCacheClusterSize ¶ added in v1.5.0
SetCacheClusterSize sets the CacheClusterSize field's value.
func (*Stage) SetCacheClusterStatus ¶ added in v1.5.0
SetCacheClusterStatus sets the CacheClusterStatus field's value.
func (*Stage) SetClientCertificateId ¶ added in v1.5.0
SetClientCertificateId sets the ClientCertificateId field's value.
func (*Stage) SetCreatedDate ¶ added in v1.5.0
SetCreatedDate sets the CreatedDate field's value.
func (*Stage) SetDeploymentId ¶ added in v1.5.0
SetDeploymentId sets the DeploymentId field's value.
func (*Stage) SetDescription ¶ added in v1.5.0
SetDescription sets the Description field's value.
func (*Stage) SetDocumentationVersion ¶ added in v1.5.13
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*Stage) SetLastUpdatedDate ¶ added in v1.5.0
SetLastUpdatedDate sets the LastUpdatedDate field's value.
func (*Stage) SetMethodSettings ¶ added in v1.5.0
func (s *Stage) SetMethodSettings(v map[string]*MethodSetting) *Stage
SetMethodSettings sets the MethodSettings field's value.
func (*Stage) SetStageName ¶ added in v1.5.0
SetStageName sets the StageName field's value.
func (*Stage) SetVariables ¶ added in v1.5.0
SetVariables sets the Variables field's value.
type StageKey ¶
type StageKey struct { // The string identifier of the associated RestApi. RestApiId *string `locationName:"restApiId" type:"string"` // The stage name associated with the stage key. StageName *string `locationName:"stageName" type:"string"` // contains filtered or unexported fields }
A reference to a unique stage identified in the format {restApiId}/{stage}.
func (*StageKey) SetRestApiId ¶ added in v1.5.0
SetRestApiId sets the RestApiId field's value.
func (*StageKey) SetStageName ¶ added in v1.5.0
SetStageName sets the StageName field's value.
type TestInvokeAuthorizerInput ¶ added in v1.1.8
type TestInvokeAuthorizerInput struct { // [Optional] A key-value map of additional context variables. AdditionalContext map[string]*string `locationName:"additionalContext" type:"map"` // Specifies a test invoke authorizer request's Authorizer ID. // // AuthorizerId is a required field AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // [Optional] The simulated request body of an incoming invocation request. Body *string `locationName:"body" type:"string"` // [Required] A key-value map of headers to simulate an incoming invocation // request. This is where the incoming authorization token, or identity source, // should be specified. Headers map[string]*string `locationName:"headers" type:"map"` // [Optional] The URI path, including query string, of the simulated invocation // request. Use this to specify path parameters and query string parameters. PathWithQueryString *string `locationName:"pathWithQueryString" type:"string"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // A key-value map of stage variables to simulate an invocation on a deployed // Stage. StageVariables map[string]*string `locationName:"stageVariables" type:"map"` // contains filtered or unexported fields }
Make a request to simulate the execution of an Authorizer.
func (TestInvokeAuthorizerInput) GoString ¶ added in v1.1.8
func (s TestInvokeAuthorizerInput) GoString() string
GoString returns the string representation
func (*TestInvokeAuthorizerInput) SetAdditionalContext ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetAdditionalContext(v map[string]*string) *TestInvokeAuthorizerInput
SetAdditionalContext sets the AdditionalContext field's value.
func (*TestInvokeAuthorizerInput) SetAuthorizerId ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetAuthorizerId(v string) *TestInvokeAuthorizerInput
SetAuthorizerId sets the AuthorizerId field's value.
func (*TestInvokeAuthorizerInput) SetBody ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetBody(v string) *TestInvokeAuthorizerInput
SetBody sets the Body field's value.
func (*TestInvokeAuthorizerInput) SetHeaders ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetHeaders(v map[string]*string) *TestInvokeAuthorizerInput
SetHeaders sets the Headers field's value.
func (*TestInvokeAuthorizerInput) SetPathWithQueryString ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetPathWithQueryString(v string) *TestInvokeAuthorizerInput
SetPathWithQueryString sets the PathWithQueryString field's value.
func (*TestInvokeAuthorizerInput) SetRestApiId ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetRestApiId(v string) *TestInvokeAuthorizerInput
SetRestApiId sets the RestApiId field's value.
func (*TestInvokeAuthorizerInput) SetStageVariables ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetStageVariables(v map[string]*string) *TestInvokeAuthorizerInput
SetStageVariables sets the StageVariables field's value.
func (TestInvokeAuthorizerInput) String ¶ added in v1.1.8
func (s TestInvokeAuthorizerInput) String() string
String returns the string representation
func (*TestInvokeAuthorizerInput) Validate ¶ added in v1.1.21
func (s *TestInvokeAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TestInvokeAuthorizerOutput ¶ added in v1.1.8
type TestInvokeAuthorizerOutput struct { Authorization map[string][]*string `locationName:"authorization" type:"map"` // The open identity claims (http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims), // with any supported custom attributes, returned from the Cognito Your User // Pool configured for the API. Claims map[string]*string `locationName:"claims" type:"map"` // The HTTP status code that the client would have received. Value is 0 if the // authorizer succeeded. ClientStatus *int64 `locationName:"clientStatus" type:"integer"` // The execution latency of the test authorizer request. Latency *int64 `locationName:"latency" type:"long"` // The Amazon API Gateway execution log for the test authorizer request. Log *string `locationName:"log" type:"string"` // The JSON policy document returned by the Authorizer Policy *string `locationName:"policy" type:"string"` // The principal identity returned by the Authorizer PrincipalId *string `locationName:"principalId" type:"string"` // contains filtered or unexported fields }
Represents the response of the test invoke request for a custom Authorizer
func (TestInvokeAuthorizerOutput) GoString ¶ added in v1.1.8
func (s TestInvokeAuthorizerOutput) GoString() string
GoString returns the string representation
func (*TestInvokeAuthorizerOutput) SetAuthorization ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetAuthorization(v map[string][]*string) *TestInvokeAuthorizerOutput
SetAuthorization sets the Authorization field's value.
func (*TestInvokeAuthorizerOutput) SetClaims ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetClaims(v map[string]*string) *TestInvokeAuthorizerOutput
SetClaims sets the Claims field's value.
func (*TestInvokeAuthorizerOutput) SetClientStatus ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetClientStatus(v int64) *TestInvokeAuthorizerOutput
SetClientStatus sets the ClientStatus field's value.
func (*TestInvokeAuthorizerOutput) SetLatency ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetLatency(v int64) *TestInvokeAuthorizerOutput
SetLatency sets the Latency field's value.
func (*TestInvokeAuthorizerOutput) SetLog ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetLog(v string) *TestInvokeAuthorizerOutput
SetLog sets the Log field's value.
func (*TestInvokeAuthorizerOutput) SetPolicy ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetPolicy(v string) *TestInvokeAuthorizerOutput
SetPolicy sets the Policy field's value.
func (*TestInvokeAuthorizerOutput) SetPrincipalId ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetPrincipalId(v string) *TestInvokeAuthorizerOutput
SetPrincipalId sets the PrincipalId field's value.
func (TestInvokeAuthorizerOutput) String ¶ added in v1.1.8
func (s TestInvokeAuthorizerOutput) String() string
String returns the string representation
type TestInvokeMethodInput ¶
type TestInvokeMethodInput struct { // The simulated request body of an incoming invocation request. Body *string `locationName:"body" type:"string"` // A ClientCertificate identifier to use in the test invocation. API Gateway // will use the certificate when making the HTTPS request to the defined back-end // endpoint. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // A key-value map of headers to simulate an incoming invocation request. Headers map[string]*string `locationName:"headers" type:"map"` // Specifies a test invoke method request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The URI path, including query string, of the simulated invocation request. // Use this to specify path parameters and query string parameters. PathWithQueryString *string `locationName:"pathWithQueryString" type:"string"` // Specifies a test invoke method request's resource ID. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // A key-value map of stage variables to simulate an invocation on a deployed // Stage. StageVariables map[string]*string `locationName:"stageVariables" type:"map"` // contains filtered or unexported fields }
Make a request to simulate the execution of a Method.
func (TestInvokeMethodInput) GoString ¶
func (s TestInvokeMethodInput) GoString() string
GoString returns the string representation
func (*TestInvokeMethodInput) SetBody ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetBody(v string) *TestInvokeMethodInput
SetBody sets the Body field's value.
func (*TestInvokeMethodInput) SetClientCertificateId ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetClientCertificateId(v string) *TestInvokeMethodInput
SetClientCertificateId sets the ClientCertificateId field's value.
func (*TestInvokeMethodInput) SetHeaders ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetHeaders(v map[string]*string) *TestInvokeMethodInput
SetHeaders sets the Headers field's value.
func (*TestInvokeMethodInput) SetHttpMethod ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetHttpMethod(v string) *TestInvokeMethodInput
SetHttpMethod sets the HttpMethod field's value.
func (*TestInvokeMethodInput) SetPathWithQueryString ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetPathWithQueryString(v string) *TestInvokeMethodInput
SetPathWithQueryString sets the PathWithQueryString field's value.
func (*TestInvokeMethodInput) SetResourceId ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetResourceId(v string) *TestInvokeMethodInput
SetResourceId sets the ResourceId field's value.
func (*TestInvokeMethodInput) SetRestApiId ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetRestApiId(v string) *TestInvokeMethodInput
SetRestApiId sets the RestApiId field's value.
func (*TestInvokeMethodInput) SetStageVariables ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *TestInvokeMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TestInvokeMethodOutput ¶
type TestInvokeMethodOutput struct { // The body of the HTTP response. Body *string `locationName:"body" type:"string"` // The headers of the HTTP response. Headers map[string]*string `locationName:"headers" type:"map"` // The execution latency of the test invoke request. Latency *int64 `locationName:"latency" type:"long"` // The Amazon API Gateway execution log for the test invoke request. Log *string `locationName:"log" type:"string"` // The HTTP status code. Status *int64 `locationName:"status" type:"integer"` // contains filtered or unexported fields }
Represents the response of the test invoke request in the HTTP method.
Test API using the API Gateway console (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-test-method.html#how-to-test-method-console)
func (TestInvokeMethodOutput) GoString ¶
func (s TestInvokeMethodOutput) GoString() string
GoString returns the string representation
func (*TestInvokeMethodOutput) SetBody ¶ added in v1.5.0
func (s *TestInvokeMethodOutput) SetBody(v string) *TestInvokeMethodOutput
SetBody sets the Body field's value.
func (*TestInvokeMethodOutput) SetHeaders ¶ added in v1.5.0
func (s *TestInvokeMethodOutput) SetHeaders(v map[string]*string) *TestInvokeMethodOutput
SetHeaders sets the Headers field's value.
func (*TestInvokeMethodOutput) SetLatency ¶ added in v1.5.0
func (s *TestInvokeMethodOutput) SetLatency(v int64) *TestInvokeMethodOutput
SetLatency sets the Latency field's value.
func (*TestInvokeMethodOutput) SetLog ¶ added in v1.5.0
func (s *TestInvokeMethodOutput) SetLog(v string) *TestInvokeMethodOutput
SetLog sets the Log field's value.
func (*TestInvokeMethodOutput) SetStatus ¶ added in v1.5.0
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 ¶
type ThrottleSettings struct { // The API request burst limit, the maximum rate limit over a time ranging from // one to a few seconds, depending upon whether the underlying token bucket // is at its full capacity. BurstLimit *int64 `locationName:"burstLimit" type:"integer"` // The API request steady-state rate limit. RateLimit *float64 `locationName:"rateLimit" type:"double"` // contains filtered or unexported fields }
The API request rate limits.
func (ThrottleSettings) GoString ¶
func (s ThrottleSettings) GoString() string
GoString returns the string representation
func (*ThrottleSettings) SetBurstLimit ¶ added in v1.5.0
func (s *ThrottleSettings) SetBurstLimit(v int64) *ThrottleSettings
SetBurstLimit sets the BurstLimit field's value.
func (*ThrottleSettings) SetRateLimit ¶ added in v1.5.0
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 ¶
type UpdateAccountInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // contains filtered or unexported fields }
Requests Amazon API Gateway to change information about the current Account resource.
func (UpdateAccountInput) GoString ¶
func (s UpdateAccountInput) GoString() string
GoString returns the string representation
func (*UpdateAccountInput) SetPatchOperations ¶ added in v1.5.0
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 ¶
type UpdateApiKeyInput struct { // The identifier of the ApiKey resource to be updated. // // ApiKey is a required field ApiKey *string `location:"uri" locationName:"api_Key" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // contains filtered or unexported fields }
A request to change information about an ApiKey resource.
func (UpdateApiKeyInput) GoString ¶
func (s UpdateApiKeyInput) GoString() string
GoString returns the string representation
func (*UpdateApiKeyInput) SetApiKey ¶ added in v1.5.0
func (s *UpdateApiKeyInput) SetApiKey(v string) *UpdateApiKeyInput
SetApiKey sets the ApiKey field's value.
func (*UpdateApiKeyInput) SetPatchOperations ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateApiKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateAuthorizerInput ¶ added in v1.1.2
type UpdateAuthorizerInput struct { // The identifier of the Authorizer resource. // // AuthorizerId is a required field AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to update an existing Authorizer resource.
func (UpdateAuthorizerInput) GoString ¶ added in v1.1.2
func (s UpdateAuthorizerInput) GoString() string
GoString returns the string representation
func (*UpdateAuthorizerInput) SetAuthorizerId ¶ added in v1.5.0
func (s *UpdateAuthorizerInput) SetAuthorizerId(v string) *UpdateAuthorizerInput
SetAuthorizerId sets the AuthorizerId field's value.
func (*UpdateAuthorizerInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateAuthorizerInput) SetPatchOperations(v []*PatchOperation) *UpdateAuthorizerInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateAuthorizerInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateAuthorizerInput) SetRestApiId(v string) *UpdateAuthorizerInput
SetRestApiId sets the RestApiId field's value.
func (UpdateAuthorizerInput) String ¶ added in v1.1.2
func (s UpdateAuthorizerInput) String() string
String returns the string representation
func (*UpdateAuthorizerInput) Validate ¶ added in v1.1.21
func (s *UpdateAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateBasePathMappingInput ¶
type UpdateBasePathMappingInput struct { // The base path of the BasePathMapping resource to change. // // BasePath is a required field BasePath *string `location:"uri" locationName:"base_path" type:"string" required:"true"` // The domain name of the BasePathMapping resource to change. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // contains filtered or unexported fields }
A request to change information about the BasePathMapping resource.
func (UpdateBasePathMappingInput) GoString ¶
func (s UpdateBasePathMappingInput) GoString() string
GoString returns the string representation
func (*UpdateBasePathMappingInput) SetBasePath ¶ added in v1.5.0
func (s *UpdateBasePathMappingInput) SetBasePath(v string) *UpdateBasePathMappingInput
SetBasePath sets the BasePath field's value.
func (*UpdateBasePathMappingInput) SetDomainName ¶ added in v1.5.0
func (s *UpdateBasePathMappingInput) SetDomainName(v string) *UpdateBasePathMappingInput
SetDomainName sets the DomainName field's value.
func (*UpdateBasePathMappingInput) SetPatchOperations ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateBasePathMappingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateClientCertificateInput ¶
type UpdateClientCertificateInput struct { // The identifier of the ClientCertificate resource to be updated. // // ClientCertificateId is a required field ClientCertificateId *string `location:"uri" locationName:"clientcertificate_id" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // contains filtered or unexported fields }
A request to change information about an ClientCertificate resource.
func (UpdateClientCertificateInput) GoString ¶
func (s UpdateClientCertificateInput) GoString() string
GoString returns the string representation
func (*UpdateClientCertificateInput) SetClientCertificateId ¶ added in v1.5.0
func (s *UpdateClientCertificateInput) SetClientCertificateId(v string) *UpdateClientCertificateInput
SetClientCertificateId sets the ClientCertificateId field's value.
func (*UpdateClientCertificateInput) SetPatchOperations ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateClientCertificateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDeploymentInput ¶
type UpdateDeploymentInput struct { // The replacement identifier for the Deployment resource to change information // about. // // DeploymentId is a required field DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to change information about a Deployment resource.
func (UpdateDeploymentInput) GoString ¶
func (s UpdateDeploymentInput) GoString() string
GoString returns the string representation
func (*UpdateDeploymentInput) SetDeploymentId ¶ added in v1.5.0
func (s *UpdateDeploymentInput) SetDeploymentId(v string) *UpdateDeploymentInput
SetDeploymentId sets the DeploymentId field's value.
func (*UpdateDeploymentInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateDeploymentInput) SetPatchOperations(v []*PatchOperation) *UpdateDeploymentInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateDeploymentInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDocumentationPartInput ¶ added in v1.5.13
type UpdateDocumentationPartInput struct { // [Required] The identifier of the to-be-updated documentation part. // // DocumentationPartId is a required field DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Updates an existing documentation part of a given API.
func (UpdateDocumentationPartInput) GoString ¶ added in v1.5.13
func (s UpdateDocumentationPartInput) GoString() string
GoString returns the string representation
func (*UpdateDocumentationPartInput) SetDocumentationPartId ¶ added in v1.5.13
func (s *UpdateDocumentationPartInput) SetDocumentationPartId(v string) *UpdateDocumentationPartInput
SetDocumentationPartId sets the DocumentationPartId field's value.
func (*UpdateDocumentationPartInput) SetPatchOperations ¶ added in v1.5.13
func (s *UpdateDocumentationPartInput) SetPatchOperations(v []*PatchOperation) *UpdateDocumentationPartInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateDocumentationPartInput) SetRestApiId ¶ added in v1.5.13
func (s *UpdateDocumentationPartInput) SetRestApiId(v string) *UpdateDocumentationPartInput
SetRestApiId sets the RestApiId field's value.
func (UpdateDocumentationPartInput) String ¶ added in v1.5.13
func (s UpdateDocumentationPartInput) String() string
String returns the string representation
func (*UpdateDocumentationPartInput) Validate ¶ added in v1.5.13
func (s *UpdateDocumentationPartInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDocumentationVersionInput ¶ added in v1.5.13
type UpdateDocumentationVersionInput struct { // [Required] The version identifier of the to-be-updated documentation version. // // DocumentationVersion is a required field DocumentationVersion *string `location:"uri" locationName:"doc_version" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The string identifier of the associated RestApi.. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Updates an existing documentation version of an API.
func (UpdateDocumentationVersionInput) GoString ¶ added in v1.5.13
func (s UpdateDocumentationVersionInput) GoString() string
GoString returns the string representation
func (*UpdateDocumentationVersionInput) SetDocumentationVersion ¶ added in v1.5.13
func (s *UpdateDocumentationVersionInput) SetDocumentationVersion(v string) *UpdateDocumentationVersionInput
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*UpdateDocumentationVersionInput) SetPatchOperations ¶ added in v1.5.13
func (s *UpdateDocumentationVersionInput) SetPatchOperations(v []*PatchOperation) *UpdateDocumentationVersionInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateDocumentationVersionInput) SetRestApiId ¶ added in v1.5.13
func (s *UpdateDocumentationVersionInput) SetRestApiId(v string) *UpdateDocumentationVersionInput
SetRestApiId sets the RestApiId field's value.
func (UpdateDocumentationVersionInput) String ¶ added in v1.5.13
func (s UpdateDocumentationVersionInput) String() string
String returns the string representation
func (*UpdateDocumentationVersionInput) Validate ¶ added in v1.5.13
func (s *UpdateDocumentationVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDomainNameInput ¶
type UpdateDomainNameInput struct { // The name of the DomainName resource to be changed. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // contains filtered or unexported fields }
A request to change information about the DomainName resource.
func (UpdateDomainNameInput) GoString ¶
func (s UpdateDomainNameInput) GoString() string
GoString returns the string representation
func (*UpdateDomainNameInput) SetDomainName ¶ added in v1.5.0
func (s *UpdateDomainNameInput) SetDomainName(v string) *UpdateDomainNameInput
SetDomainName sets the DomainName field's value.
func (*UpdateDomainNameInput) SetPatchOperations ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateDomainNameInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateGatewayResponseInput ¶ added in v1.10.10
type UpdateGatewayResponseInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The response type of the associated GatewayResponse. Valid values are ACCESS_DENIED // // API_CONFIGURATION_ERROR // AUTHORIZER_FAILURE // AUTHORIZER_CONFIGURATION_ERROR // BAD_REQUEST_PARAMETERS // BAD_REQUEST_BODY // DEFAULT_4XX // DEFAULT_5XX // EXPIRED_TOKEN // INVALID_SIGNATURE // INTEGRATION_FAILURE // INTEGRATION_TIMEOUT // INVALID_API_KEY // MISSING_AUTHENTICATION_TOKEN // QUOTA_EXCEEDED // REQUEST_TOO_LARGE // RESOURCE_NOT_FOUND // THROTTLED // UNAUTHORIZED // UNSUPPORTED_MEDIA_TYPES // // ResponseType is a required field ResponseType *string `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"GatewayResponseType"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Updates a GatewayResponse of a specified response type on the given RestApi.
func (UpdateGatewayResponseInput) GoString ¶ added in v1.10.10
func (s UpdateGatewayResponseInput) GoString() string
GoString returns the string representation
func (*UpdateGatewayResponseInput) SetPatchOperations ¶ added in v1.10.10
func (s *UpdateGatewayResponseInput) SetPatchOperations(v []*PatchOperation) *UpdateGatewayResponseInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateGatewayResponseInput) SetResponseType ¶ added in v1.10.10
func (s *UpdateGatewayResponseInput) SetResponseType(v string) *UpdateGatewayResponseInput
SetResponseType sets the ResponseType field's value.
func (*UpdateGatewayResponseInput) SetRestApiId ¶ added in v1.10.10
func (s *UpdateGatewayResponseInput) SetRestApiId(v string) *UpdateGatewayResponseInput
SetRestApiId sets the RestApiId field's value.
func (UpdateGatewayResponseInput) String ¶ added in v1.10.10
func (s UpdateGatewayResponseInput) String() string
String returns the string representation
func (*UpdateGatewayResponseInput) Validate ¶ added in v1.10.10
func (s *UpdateGatewayResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateGatewayResponseOutput ¶ added in v1.10.10
type UpdateGatewayResponseOutput struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway // response (true) or not (false). A default gateway response is one generated // by Amazon API Gateway without any customization by an API developer. DefaultResponse *bool `locationName:"defaultResponse" type:"boolean"` // Response parameters (paths, query strings and headers) of the GatewayResponse // as a string-to-string map of key-value pairs. ResponseParameters map[string]*string `locationName:"responseParameters" type:"map"` // Response templates of the GatewayResponse as a string-to-string map of key-value // pairs. ResponseTemplates map[string]*string `locationName:"responseTemplates" type:"map"` // The response type of the associated GatewayResponse. Valid values are ACCESS_DENIED // // API_CONFIGURATION_ERROR // AUTHORIZER_FAILURE // AUTHORIZER_CONFIGURATION_ERROR // BAD_REQUEST_PARAMETERS // BAD_REQUEST_BODY // DEFAULT_4XX // DEFAULT_5XX // EXPIRED_TOKEN // INVALID_SIGNATURE // INTEGRATION_FAILURE // INTEGRATION_TIMEOUT // INVALID_API_KEY // MISSING_AUTHENTICATION_TOKEN // QUOTA_EXCEEDED // REQUEST_TOO_LARGE // RESOURCE_NOT_FOUND // THROTTLED // UNAUTHORIZED // UNSUPPORTED_MEDIA_TYPES ResponseType *string `locationName:"responseType" type:"string" enum:"GatewayResponseType"` // The HTTP status code for this GatewayResponse. StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
For more information about valid gateway response types, see Gateway Response Types Supported by Amazon API Gateway (http://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html)Example: Get a Gateway Response of a given response type
Request ¶
This example shows how to get a gateway response of the MISSING_AUTHNETICATION_TOKEN type.
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45
The response type is specified as a URL path.
Response ¶
The successful operation returns the 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{\n \"message\": $context.error.messageString,\n \"type\": \"$context.error.responseType\",\n \"stage\": \"$context.stage\",\n \"resourcePath\": \"$context.resourcePath\",\n \"stageVariables.a\": \"$stageVariables.a\",\n \"statusCode\": \"'404'\"\n}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404" }
Customize Gateway Responses (http://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html)
func (UpdateGatewayResponseOutput) GoString ¶ added in v1.10.10
func (s UpdateGatewayResponseOutput) GoString() string
GoString returns the string representation
func (*UpdateGatewayResponseOutput) SetDefaultResponse ¶ added in v1.10.10
func (s *UpdateGatewayResponseOutput) SetDefaultResponse(v bool) *UpdateGatewayResponseOutput
SetDefaultResponse sets the DefaultResponse field's value.
func (*UpdateGatewayResponseOutput) SetResponseParameters ¶ added in v1.10.10
func (s *UpdateGatewayResponseOutput) SetResponseParameters(v map[string]*string) *UpdateGatewayResponseOutput
SetResponseParameters sets the ResponseParameters field's value.
func (*UpdateGatewayResponseOutput) SetResponseTemplates ¶ added in v1.10.10
func (s *UpdateGatewayResponseOutput) SetResponseTemplates(v map[string]*string) *UpdateGatewayResponseOutput
SetResponseTemplates sets the ResponseTemplates field's value.
func (*UpdateGatewayResponseOutput) SetResponseType ¶ added in v1.10.10
func (s *UpdateGatewayResponseOutput) SetResponseType(v string) *UpdateGatewayResponseOutput
SetResponseType sets the ResponseType field's value.
func (*UpdateGatewayResponseOutput) SetStatusCode ¶ added in v1.10.10
func (s *UpdateGatewayResponseOutput) SetStatusCode(v string) *UpdateGatewayResponseOutput
SetStatusCode sets the StatusCode field's value.
func (UpdateGatewayResponseOutput) String ¶ added in v1.10.10
func (s UpdateGatewayResponseOutput) String() string
String returns the string representation
type UpdateIntegrationInput ¶
type UpdateIntegrationInput struct { // Represents an update integration request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // Represents an update integration request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Represents an update integration request.
func (UpdateIntegrationInput) GoString ¶
func (s UpdateIntegrationInput) GoString() string
GoString returns the string representation
func (*UpdateIntegrationInput) SetHttpMethod ¶ added in v1.5.0
func (s *UpdateIntegrationInput) SetHttpMethod(v string) *UpdateIntegrationInput
SetHttpMethod sets the HttpMethod field's value.
func (*UpdateIntegrationInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateIntegrationInput) SetPatchOperations(v []*PatchOperation) *UpdateIntegrationInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateIntegrationInput) SetResourceId ¶ added in v1.5.0
func (s *UpdateIntegrationInput) SetResourceId(v string) *UpdateIntegrationInput
SetResourceId sets the ResourceId field's value.
func (*UpdateIntegrationInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateIntegrationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateIntegrationResponseInput ¶
type UpdateIntegrationResponseInput struct { // Specifies an update integration response request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // Specifies an update integration response request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies an update integration response request's status code. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
Represents an update integration response request.
func (UpdateIntegrationResponseInput) GoString ¶
func (s UpdateIntegrationResponseInput) GoString() string
GoString returns the string representation
func (*UpdateIntegrationResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *UpdateIntegrationResponseInput) SetHttpMethod(v string) *UpdateIntegrationResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*UpdateIntegrationResponseInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateIntegrationResponseInput) SetPatchOperations(v []*PatchOperation) *UpdateIntegrationResponseInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateIntegrationResponseInput) SetResourceId ¶ added in v1.5.0
func (s *UpdateIntegrationResponseInput) SetResourceId(v string) *UpdateIntegrationResponseInput
SetResourceId sets the ResourceId field's value.
func (*UpdateIntegrationResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateIntegrationResponseInput) SetRestApiId(v string) *UpdateIntegrationResponseInput
SetRestApiId sets the RestApiId field's value.
func (*UpdateIntegrationResponseInput) SetStatusCode ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateIntegrationResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateMethodInput ¶
type UpdateMethodInput struct { // The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The Resource identifier for the Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to update an existing Method resource.
func (UpdateMethodInput) GoString ¶
func (s UpdateMethodInput) GoString() string
GoString returns the string representation
func (*UpdateMethodInput) SetHttpMethod ¶ added in v1.5.0
func (s *UpdateMethodInput) SetHttpMethod(v string) *UpdateMethodInput
SetHttpMethod sets the HttpMethod field's value.
func (*UpdateMethodInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateMethodInput) SetPatchOperations(v []*PatchOperation) *UpdateMethodInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateMethodInput) SetResourceId ¶ added in v1.5.0
func (s *UpdateMethodInput) SetResourceId(v string) *UpdateMethodInput
SetResourceId sets the ResourceId field's value.
func (*UpdateMethodInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateMethodResponseInput ¶
type UpdateMethodResponseInput struct { // The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The Resource identifier for the MethodResponse resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The status code for the MethodResponse resource. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
A request to update an existing MethodResponse resource.
func (UpdateMethodResponseInput) GoString ¶
func (s UpdateMethodResponseInput) GoString() string
GoString returns the string representation
func (*UpdateMethodResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *UpdateMethodResponseInput) SetHttpMethod(v string) *UpdateMethodResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*UpdateMethodResponseInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateMethodResponseInput) SetPatchOperations(v []*PatchOperation) *UpdateMethodResponseInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateMethodResponseInput) SetResourceId ¶ added in v1.5.0
func (s *UpdateMethodResponseInput) SetResourceId(v string) *UpdateMethodResponseInput
SetResourceId sets the ResourceId field's value.
func (*UpdateMethodResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateMethodResponseInput) SetRestApiId(v string) *UpdateMethodResponseInput
SetRestApiId sets the RestApiId field's value.
func (*UpdateMethodResponseInput) SetStatusCode ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateMethodResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateModelInput ¶
type UpdateModelInput struct { // The name of the model to update. // // ModelName is a required field ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to update an existing model in an existing RestApi resource.
func (UpdateModelInput) GoString ¶
func (s UpdateModelInput) GoString() string
GoString returns the string representation
func (*UpdateModelInput) SetModelName ¶ added in v1.5.0
func (s *UpdateModelInput) SetModelName(v string) *UpdateModelInput
SetModelName sets the ModelName field's value.
func (*UpdateModelInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateModelInput) SetPatchOperations(v []*PatchOperation) *UpdateModelInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateModelInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateRequestValidatorInput ¶ added in v1.8.12
type UpdateRequestValidatorInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The identifier of RequestValidator to be updated. // // RequestValidatorId is a required field RequestValidatorId *string `location:"uri" locationName:"requestvalidator_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Updates a RequestValidator of a given RestApi.
func (UpdateRequestValidatorInput) GoString ¶ added in v1.8.12
func (s UpdateRequestValidatorInput) GoString() string
GoString returns the string representation
func (*UpdateRequestValidatorInput) SetPatchOperations ¶ added in v1.8.12
func (s *UpdateRequestValidatorInput) SetPatchOperations(v []*PatchOperation) *UpdateRequestValidatorInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateRequestValidatorInput) SetRequestValidatorId ¶ added in v1.8.12
func (s *UpdateRequestValidatorInput) SetRequestValidatorId(v string) *UpdateRequestValidatorInput
SetRequestValidatorId sets the RequestValidatorId field's value.
func (*UpdateRequestValidatorInput) SetRestApiId ¶ added in v1.8.12
func (s *UpdateRequestValidatorInput) SetRestApiId(v string) *UpdateRequestValidatorInput
SetRestApiId sets the RestApiId field's value.
func (UpdateRequestValidatorInput) String ¶ added in v1.8.12
func (s UpdateRequestValidatorInput) String() string
String returns the string representation
func (*UpdateRequestValidatorInput) Validate ¶ added in v1.8.12
func (s *UpdateRequestValidatorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateRequestValidatorOutput ¶ added in v1.8.12
type UpdateRequestValidatorOutput struct { // The identifier of this RequestValidator. Id *string `locationName:"id" type:"string"` // The name of this RequestValidator Name *string `locationName:"name" type:"string"` // A Boolean flag to indicate whether to validate a request body according to // the configured Model schema. ValidateRequestBody *bool `locationName:"validateRequestBody" type:"boolean"` // A Boolean flag to indicate whether to validate request parameters (true) // or not (false). ValidateRequestParameters *bool `locationName:"validateRequestParameters" type:"boolean"` // contains filtered or unexported fields }
A set of validation rules for incoming Method requests.
In Swagger, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html) object. It the referenced using the x-amazon-apigateway-request-validator (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator) property.
Enable Basic Request Validation in API Gateway (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html)
func (UpdateRequestValidatorOutput) GoString ¶ added in v1.8.12
func (s UpdateRequestValidatorOutput) GoString() string
GoString returns the string representation
func (*UpdateRequestValidatorOutput) SetId ¶ added in v1.8.12
func (s *UpdateRequestValidatorOutput) SetId(v string) *UpdateRequestValidatorOutput
SetId sets the Id field's value.
func (*UpdateRequestValidatorOutput) SetName ¶ added in v1.8.12
func (s *UpdateRequestValidatorOutput) SetName(v string) *UpdateRequestValidatorOutput
SetName sets the Name field's value.
func (*UpdateRequestValidatorOutput) SetValidateRequestBody ¶ added in v1.8.12
func (s *UpdateRequestValidatorOutput) SetValidateRequestBody(v bool) *UpdateRequestValidatorOutput
SetValidateRequestBody sets the ValidateRequestBody field's value.
func (*UpdateRequestValidatorOutput) SetValidateRequestParameters ¶ added in v1.8.12
func (s *UpdateRequestValidatorOutput) SetValidateRequestParameters(v bool) *UpdateRequestValidatorOutput
SetValidateRequestParameters sets the ValidateRequestParameters field's value.
func (UpdateRequestValidatorOutput) String ¶ added in v1.8.12
func (s UpdateRequestValidatorOutput) String() string
String returns the string representation
type UpdateResourceInput ¶
type UpdateResourceInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The identifier of the Resource resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to change information about a Resource resource.
func (UpdateResourceInput) GoString ¶
func (s UpdateResourceInput) GoString() string
GoString returns the string representation
func (*UpdateResourceInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateResourceInput) SetPatchOperations(v []*PatchOperation) *UpdateResourceInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateResourceInput) SetResourceId ¶ added in v1.5.0
func (s *UpdateResourceInput) SetResourceId(v string) *UpdateResourceInput
SetResourceId sets the ResourceId field's value.
func (*UpdateResourceInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateRestApiInput ¶
type UpdateRestApiInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to update an existing RestApi resource in your collection.
func (UpdateRestApiInput) GoString ¶
func (s UpdateRestApiInput) GoString() string
GoString returns the string representation
func (*UpdateRestApiInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateRestApiInput) SetPatchOperations(v []*PatchOperation) *UpdateRestApiInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateRestApiInput) SetRestApiId ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateStageInput ¶
type UpdateStageInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the Stage resource to change information about. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to change information about a Stage resource.
func (UpdateStageInput) GoString ¶
func (s UpdateStageInput) GoString() string
GoString returns the string representation
func (*UpdateStageInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateStageInput) SetPatchOperations(v []*PatchOperation) *UpdateStageInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateStageInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateStageInput) SetRestApiId(v string) *UpdateStageInput
SetRestApiId sets the RestApiId field's value.
func (*UpdateStageInput) SetStageName ¶ added in v1.5.0
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 ¶ added in v1.1.21
func (s *UpdateStageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUsageInput ¶ added in v1.4.2
type UpdateUsageInput struct { // The identifier of the API key associated with the usage plan in which a temporary // extension is granted to the remaining quota. // // KeyId is a required field KeyId *string `location:"uri" locationName:"keyId" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The Id of the usage plan associated with the usage data. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.
func (UpdateUsageInput) GoString ¶ added in v1.4.2
func (s UpdateUsageInput) GoString() string
GoString returns the string representation
func (*UpdateUsageInput) SetKeyId ¶ added in v1.5.0
func (s *UpdateUsageInput) SetKeyId(v string) *UpdateUsageInput
SetKeyId sets the KeyId field's value.
func (*UpdateUsageInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateUsageInput) SetPatchOperations(v []*PatchOperation) *UpdateUsageInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateUsageInput) SetUsagePlanId ¶ added in v1.5.0
func (s *UpdateUsageInput) SetUsagePlanId(v string) *UpdateUsageInput
SetUsagePlanId sets the UsagePlanId field's value.
func (UpdateUsageInput) String ¶ added in v1.4.2
func (s UpdateUsageInput) String() string
String returns the string representation
func (*UpdateUsageInput) Validate ¶ added in v1.4.2
func (s *UpdateUsageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUsagePlanInput ¶ added in v1.4.2
type UpdateUsagePlanInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The Id of the to-be-updated usage plan. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The PATCH request to update a usage plan of a given plan Id.
func (UpdateUsagePlanInput) GoString ¶ added in v1.4.2
func (s UpdateUsagePlanInput) GoString() string
GoString returns the string representation
func (*UpdateUsagePlanInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateUsagePlanInput) SetPatchOperations(v []*PatchOperation) *UpdateUsagePlanInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateUsagePlanInput) SetUsagePlanId ¶ added in v1.5.0
func (s *UpdateUsagePlanInput) SetUsagePlanId(v string) *UpdateUsagePlanInput
SetUsagePlanId sets the UsagePlanId field's value.
func (UpdateUsagePlanInput) String ¶ added in v1.4.2
func (s UpdateUsagePlanInput) String() string
String returns the string representation
func (*UpdateUsagePlanInput) Validate ¶ added in v1.4.2
func (s *UpdateUsagePlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Usage ¶ added in v1.4.2
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 }
Represents the usage data of a usage plan.
Create and Use Usage Plans (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html), Manage Usage in a Usage Plan (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-usage-plans-with-console.html#api-gateway-usage-plan-manage-usage)
func (*Usage) SetEndDate ¶ added in v1.5.0
SetEndDate sets the EndDate field's value.
func (*Usage) SetPosition ¶ added in v1.5.0
SetPosition sets the Position field's value.
func (*Usage) SetStartDate ¶ added in v1.5.0
SetStartDate sets the StartDate field's value.
func (*Usage) SetUsagePlanId ¶ added in v1.5.0
SetUsagePlanId sets the UsagePlanId field's value.
type UsagePlan ¶ added in v1.4.2
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 }
Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.
In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.
Create and Use Usage Plans (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (*UsagePlan) SetApiStages ¶ added in v1.5.0
SetApiStages sets the ApiStages field's value.
func (*UsagePlan) SetDescription ¶ added in v1.5.0
SetDescription sets the Description field's value.
func (*UsagePlan) SetProductCode ¶ added in v1.5.13
SetProductCode sets the ProductCode field's value.
func (*UsagePlan) SetQuota ¶ added in v1.5.0
func (s *UsagePlan) SetQuota(v *QuotaSettings) *UsagePlan
SetQuota sets the Quota field's value.
func (*UsagePlan) SetThrottle ¶ added in v1.5.0
func (s *UsagePlan) SetThrottle(v *ThrottleSettings) *UsagePlan
SetThrottle sets the Throttle field's value.
type UsagePlanKey ¶ added in v1.4.2
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 }
Represents a usage plan key to identify a plan customer.
To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.
" Create and Use Usage Plans (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (UsagePlanKey) GoString ¶ added in v1.4.2
func (s UsagePlanKey) GoString() string
GoString returns the string representation
func (*UsagePlanKey) SetId ¶ added in v1.5.0
func (s *UsagePlanKey) SetId(v string) *UsagePlanKey
SetId sets the Id field's value.
func (*UsagePlanKey) SetName ¶ added in v1.5.0
func (s *UsagePlanKey) SetName(v string) *UsagePlanKey
SetName sets the Name field's value.
func (*UsagePlanKey) SetType ¶ added in v1.5.0
func (s *UsagePlanKey) SetType(v string) *UsagePlanKey
SetType sets the Type field's value.
func (*UsagePlanKey) SetValue ¶ added in v1.5.0
func (s *UsagePlanKey) SetValue(v string) *UsagePlanKey
SetValue sets the Value field's value.
func (UsagePlanKey) String ¶ added in v1.4.2
func (s UsagePlanKey) String() string
String returns the string representation
Directories
¶
Path | Synopsis |
---|---|
Package apigatewayiface provides an interface to enable mocking the Amazon API Gateway service client for testing your code.
|
Package apigatewayiface provides an interface to enable mocking the Amazon API Gateway service client for testing your code. |