Documentation ¶
Overview ¶
Package apigateway provides a client for Amazon API Gateway.
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) CreateAuthorizer(input *CreateAuthorizerInput) (*Authorizer, error)
- func (c *APIGateway) CreateAuthorizerRequest(input *CreateAuthorizerInput) (req *request.Request, output *Authorizer)
- func (c *APIGateway) CreateBasePathMapping(input *CreateBasePathMappingInput) (*BasePathMapping, error)
- func (c *APIGateway) CreateBasePathMappingRequest(input *CreateBasePathMappingInput) (req *request.Request, output *BasePathMapping)
- func (c *APIGateway) CreateDeployment(input *CreateDeploymentInput) (*Deployment, error)
- func (c *APIGateway) CreateDeploymentRequest(input *CreateDeploymentInput) (req *request.Request, output *Deployment)
- func (c *APIGateway) CreateDomainName(input *CreateDomainNameInput) (*DomainName, error)
- func (c *APIGateway) CreateDomainNameRequest(input *CreateDomainNameInput) (req *request.Request, output *DomainName)
- func (c *APIGateway) CreateModel(input *CreateModelInput) (*Model, error)
- func (c *APIGateway) CreateModelRequest(input *CreateModelInput) (req *request.Request, output *Model)
- func (c *APIGateway) CreateResource(input *CreateResourceInput) (*Resource, error)
- func (c *APIGateway) CreateResourceRequest(input *CreateResourceInput) (req *request.Request, output *Resource)
- func (c *APIGateway) CreateRestApi(input *CreateRestApiInput) (*RestApi, error)
- func (c *APIGateway) CreateRestApiRequest(input *CreateRestApiInput) (req *request.Request, output *RestApi)
- func (c *APIGateway) CreateStage(input *CreateStageInput) (*Stage, error)
- func (c *APIGateway) CreateStageRequest(input *CreateStageInput) (req *request.Request, output *Stage)
- 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) CreateUsagePlanRequest(input *CreateUsagePlanInput) (req *request.Request, output *UsagePlan)
- func (c *APIGateway) DeleteApiKey(input *DeleteApiKeyInput) (*DeleteApiKeyOutput, error)
- func (c *APIGateway) DeleteApiKeyRequest(input *DeleteApiKeyInput) (req *request.Request, output *DeleteApiKeyOutput)
- func (c *APIGateway) DeleteAuthorizer(input *DeleteAuthorizerInput) (*DeleteAuthorizerOutput, error)
- func (c *APIGateway) DeleteAuthorizerRequest(input *DeleteAuthorizerInput) (req *request.Request, output *DeleteAuthorizerOutput)
- func (c *APIGateway) DeleteBasePathMapping(input *DeleteBasePathMappingInput) (*DeleteBasePathMappingOutput, error)
- func (c *APIGateway) DeleteBasePathMappingRequest(input *DeleteBasePathMappingInput) (req *request.Request, output *DeleteBasePathMappingOutput)
- func (c *APIGateway) DeleteClientCertificate(input *DeleteClientCertificateInput) (*DeleteClientCertificateOutput, error)
- func (c *APIGateway) DeleteClientCertificateRequest(input *DeleteClientCertificateInput) (req *request.Request, output *DeleteClientCertificateOutput)
- func (c *APIGateway) DeleteDeployment(input *DeleteDeploymentInput) (*DeleteDeploymentOutput, error)
- func (c *APIGateway) DeleteDeploymentRequest(input *DeleteDeploymentInput) (req *request.Request, output *DeleteDeploymentOutput)
- func (c *APIGateway) DeleteDomainName(input *DeleteDomainNameInput) (*DeleteDomainNameOutput, error)
- func (c *APIGateway) DeleteDomainNameRequest(input *DeleteDomainNameInput) (req *request.Request, output *DeleteDomainNameOutput)
- 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) 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) DeleteModel(input *DeleteModelInput) (*DeleteModelOutput, error)
- func (c *APIGateway) DeleteModelRequest(input *DeleteModelInput) (req *request.Request, output *DeleteModelOutput)
- func (c *APIGateway) DeleteResource(input *DeleteResourceInput) (*DeleteResourceOutput, error)
- func (c *APIGateway) DeleteResourceRequest(input *DeleteResourceInput) (req *request.Request, output *DeleteResourceOutput)
- func (c *APIGateway) DeleteRestApi(input *DeleteRestApiInput) (*DeleteRestApiOutput, error)
- func (c *APIGateway) DeleteRestApiRequest(input *DeleteRestApiInput) (req *request.Request, output *DeleteRestApiOutput)
- func (c *APIGateway) DeleteStage(input *DeleteStageInput) (*DeleteStageOutput, error)
- func (c *APIGateway) DeleteStageRequest(input *DeleteStageInput) (req *request.Request, output *DeleteStageOutput)
- 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) DeleteUsagePlanRequest(input *DeleteUsagePlanInput) (req *request.Request, output *DeleteUsagePlanOutput)
- func (c *APIGateway) FlushStageAuthorizersCache(input *FlushStageAuthorizersCacheInput) (*FlushStageAuthorizersCacheOutput, error)
- func (c *APIGateway) FlushStageAuthorizersCacheRequest(input *FlushStageAuthorizersCacheInput) (req *request.Request, output *FlushStageAuthorizersCacheOutput)
- func (c *APIGateway) FlushStageCache(input *FlushStageCacheInput) (*FlushStageCacheOutput, error)
- func (c *APIGateway) FlushStageCacheRequest(input *FlushStageCacheInput) (req *request.Request, output *FlushStageCacheOutput)
- func (c *APIGateway) GenerateClientCertificate(input *GenerateClientCertificateInput) (*ClientCertificate, error)
- func (c *APIGateway) GenerateClientCertificateRequest(input *GenerateClientCertificateInput) (req *request.Request, output *ClientCertificate)
- func (c *APIGateway) GetAccount(input *GetAccountInput) (*Account, error)
- func (c *APIGateway) GetAccountRequest(input *GetAccountInput) (req *request.Request, output *Account)
- func (c *APIGateway) GetApiKey(input *GetApiKeyInput) (*ApiKey, error)
- func (c *APIGateway) GetApiKeyRequest(input *GetApiKeyInput) (req *request.Request, output *ApiKey)
- func (c *APIGateway) GetApiKeys(input *GetApiKeysInput) (*GetApiKeysOutput, error)
- func (c *APIGateway) GetApiKeysPages(input *GetApiKeysInput, ...) error
- func (c *APIGateway) GetApiKeysRequest(input *GetApiKeysInput) (req *request.Request, output *GetApiKeysOutput)
- func (c *APIGateway) GetAuthorizer(input *GetAuthorizerInput) (*Authorizer, error)
- func (c *APIGateway) GetAuthorizerRequest(input *GetAuthorizerInput) (req *request.Request, output *Authorizer)
- func (c *APIGateway) GetAuthorizers(input *GetAuthorizersInput) (*GetAuthorizersOutput, error)
- func (c *APIGateway) GetAuthorizersRequest(input *GetAuthorizersInput) (req *request.Request, output *GetAuthorizersOutput)
- func (c *APIGateway) GetBasePathMapping(input *GetBasePathMappingInput) (*BasePathMapping, error)
- func (c *APIGateway) GetBasePathMappingRequest(input *GetBasePathMappingInput) (req *request.Request, output *BasePathMapping)
- func (c *APIGateway) GetBasePathMappings(input *GetBasePathMappingsInput) (*GetBasePathMappingsOutput, error)
- func (c *APIGateway) GetBasePathMappingsPages(input *GetBasePathMappingsInput, ...) error
- func (c *APIGateway) GetBasePathMappingsRequest(input *GetBasePathMappingsInput) (req *request.Request, output *GetBasePathMappingsOutput)
- func (c *APIGateway) GetClientCertificate(input *GetClientCertificateInput) (*ClientCertificate, error)
- func (c *APIGateway) GetClientCertificateRequest(input *GetClientCertificateInput) (req *request.Request, output *ClientCertificate)
- func (c *APIGateway) GetClientCertificates(input *GetClientCertificatesInput) (*GetClientCertificatesOutput, error)
- func (c *APIGateway) GetClientCertificatesPages(input *GetClientCertificatesInput, ...) error
- func (c *APIGateway) GetClientCertificatesRequest(input *GetClientCertificatesInput) (req *request.Request, output *GetClientCertificatesOutput)
- func (c *APIGateway) GetDeployment(input *GetDeploymentInput) (*Deployment, error)
- func (c *APIGateway) GetDeploymentRequest(input *GetDeploymentInput) (req *request.Request, output *Deployment)
- func (c *APIGateway) GetDeployments(input *GetDeploymentsInput) (*GetDeploymentsOutput, error)
- func (c *APIGateway) GetDeploymentsPages(input *GetDeploymentsInput, ...) error
- func (c *APIGateway) GetDeploymentsRequest(input *GetDeploymentsInput) (req *request.Request, output *GetDeploymentsOutput)
- func (c *APIGateway) GetDomainName(input *GetDomainNameInput) (*DomainName, error)
- func (c *APIGateway) GetDomainNameRequest(input *GetDomainNameInput) (req *request.Request, output *DomainName)
- func (c *APIGateway) GetDomainNames(input *GetDomainNamesInput) (*GetDomainNamesOutput, error)
- func (c *APIGateway) GetDomainNamesPages(input *GetDomainNamesInput, ...) error
- func (c *APIGateway) GetDomainNamesRequest(input *GetDomainNamesInput) (req *request.Request, output *GetDomainNamesOutput)
- func (c *APIGateway) GetExport(input *GetExportInput) (*GetExportOutput, error)
- func (c *APIGateway) GetExportRequest(input *GetExportInput) (req *request.Request, output *GetExportOutput)
- 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) 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) 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) GetModels(input *GetModelsInput) (*GetModelsOutput, error)
- func (c *APIGateway) GetModelsPages(input *GetModelsInput, ...) error
- func (c *APIGateway) GetModelsRequest(input *GetModelsInput) (req *request.Request, output *GetModelsOutput)
- func (c *APIGateway) GetResource(input *GetResourceInput) (*Resource, error)
- func (c *APIGateway) GetResourceRequest(input *GetResourceInput) (req *request.Request, output *Resource)
- func (c *APIGateway) GetResources(input *GetResourcesInput) (*GetResourcesOutput, error)
- func (c *APIGateway) GetResourcesPages(input *GetResourcesInput, ...) error
- func (c *APIGateway) GetResourcesRequest(input *GetResourcesInput) (req *request.Request, output *GetResourcesOutput)
- func (c *APIGateway) GetRestApi(input *GetRestApiInput) (*RestApi, error)
- func (c *APIGateway) GetRestApiRequest(input *GetRestApiInput) (req *request.Request, output *RestApi)
- func (c *APIGateway) GetRestApis(input *GetRestApisInput) (*GetRestApisOutput, error)
- func (c *APIGateway) GetRestApisPages(input *GetRestApisInput, ...) error
- func (c *APIGateway) GetRestApisRequest(input *GetRestApisInput) (req *request.Request, output *GetRestApisOutput)
- func (c *APIGateway) GetSdk(input *GetSdkInput) (*GetSdkOutput, error)
- func (c *APIGateway) GetSdkRequest(input *GetSdkInput) (req *request.Request, output *GetSdkOutput)
- func (c *APIGateway) GetStage(input *GetStageInput) (*Stage, error)
- func (c *APIGateway) GetStageRequest(input *GetStageInput) (req *request.Request, output *Stage)
- func (c *APIGateway) GetStages(input *GetStagesInput) (*GetStagesOutput, error)
- func (c *APIGateway) GetStagesRequest(input *GetStagesInput) (req *request.Request, output *GetStagesOutput)
- func (c *APIGateway) GetUsage(input *GetUsageInput) (*Usage, error)
- func (c *APIGateway) GetUsagePages(input *GetUsageInput, fn func(p *Usage, lastPage bool) (shouldContinue 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) GetUsagePlanKeys(input *GetUsagePlanKeysInput) (*GetUsagePlanKeysOutput, error)
- func (c *APIGateway) GetUsagePlanKeysPages(input *GetUsagePlanKeysInput, ...) error
- func (c *APIGateway) GetUsagePlanKeysRequest(input *GetUsagePlanKeysInput) (req *request.Request, output *GetUsagePlanKeysOutput)
- func (c *APIGateway) GetUsagePlanRequest(input *GetUsagePlanInput) (req *request.Request, output *UsagePlan)
- func (c *APIGateway) GetUsagePlans(input *GetUsagePlansInput) (*GetUsagePlansOutput, error)
- func (c *APIGateway) GetUsagePlansPages(input *GetUsagePlansInput, ...) error
- func (c *APIGateway) GetUsagePlansRequest(input *GetUsagePlansInput) (req *request.Request, output *GetUsagePlansOutput)
- func (c *APIGateway) GetUsageRequest(input *GetUsageInput) (req *request.Request, output *Usage)
- func (c *APIGateway) ImportApiKeys(input *ImportApiKeysInput) (*ImportApiKeysOutput, error)
- func (c *APIGateway) ImportApiKeysRequest(input *ImportApiKeysInput) (req *request.Request, output *ImportApiKeysOutput)
- func (c *APIGateway) ImportRestApi(input *ImportRestApiInput) (*RestApi, error)
- func (c *APIGateway) ImportRestApiRequest(input *ImportRestApiInput) (req *request.Request, output *RestApi)
- 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) 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) PutRestApi(input *PutRestApiInput) (*RestApi, error)
- func (c *APIGateway) PutRestApiRequest(input *PutRestApiInput) (req *request.Request, output *RestApi)
- func (c *APIGateway) TestInvokeAuthorizer(input *TestInvokeAuthorizerInput) (*TestInvokeAuthorizerOutput, error)
- func (c *APIGateway) TestInvokeAuthorizerRequest(input *TestInvokeAuthorizerInput) (req *request.Request, output *TestInvokeAuthorizerOutput)
- func (c *APIGateway) TestInvokeMethod(input *TestInvokeMethodInput) (*TestInvokeMethodOutput, error)
- func (c *APIGateway) TestInvokeMethodRequest(input *TestInvokeMethodInput) (req *request.Request, output *TestInvokeMethodOutput)
- func (c *APIGateway) UpdateAccount(input *UpdateAccountInput) (*Account, error)
- func (c *APIGateway) UpdateAccountRequest(input *UpdateAccountInput) (req *request.Request, output *Account)
- func (c *APIGateway) UpdateApiKey(input *UpdateApiKeyInput) (*ApiKey, error)
- func (c *APIGateway) UpdateApiKeyRequest(input *UpdateApiKeyInput) (req *request.Request, output *ApiKey)
- func (c *APIGateway) UpdateAuthorizer(input *UpdateAuthorizerInput) (*Authorizer, error)
- func (c *APIGateway) UpdateAuthorizerRequest(input *UpdateAuthorizerInput) (req *request.Request, output *Authorizer)
- func (c *APIGateway) UpdateBasePathMapping(input *UpdateBasePathMappingInput) (*BasePathMapping, error)
- func (c *APIGateway) UpdateBasePathMappingRequest(input *UpdateBasePathMappingInput) (req *request.Request, output *BasePathMapping)
- func (c *APIGateway) UpdateClientCertificate(input *UpdateClientCertificateInput) (*ClientCertificate, error)
- func (c *APIGateway) UpdateClientCertificateRequest(input *UpdateClientCertificateInput) (req *request.Request, output *ClientCertificate)
- func (c *APIGateway) UpdateDeployment(input *UpdateDeploymentInput) (*Deployment, error)
- func (c *APIGateway) UpdateDeploymentRequest(input *UpdateDeploymentInput) (req *request.Request, output *Deployment)
- func (c *APIGateway) UpdateDomainName(input *UpdateDomainNameInput) (*DomainName, error)
- func (c *APIGateway) UpdateDomainNameRequest(input *UpdateDomainNameInput) (req *request.Request, output *DomainName)
- 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) 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) UpdateModel(input *UpdateModelInput) (*Model, error)
- func (c *APIGateway) UpdateModelRequest(input *UpdateModelInput) (req *request.Request, output *Model)
- func (c *APIGateway) UpdateResource(input *UpdateResourceInput) (*Resource, error)
- func (c *APIGateway) UpdateResourceRequest(input *UpdateResourceInput) (req *request.Request, output *Resource)
- func (c *APIGateway) UpdateRestApi(input *UpdateRestApiInput) (*RestApi, error)
- func (c *APIGateway) UpdateRestApiRequest(input *UpdateRestApiInput) (req *request.Request, output *RestApi)
- func (c *APIGateway) UpdateStage(input *UpdateStageInput) (*Stage, error)
- func (c *APIGateway) UpdateStageRequest(input *UpdateStageInput) (req *request.Request, output *Stage)
- 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) UpdateUsageRequest(input *UpdateUsageInput) (req *request.Request, output *Usage)
- type Account
- type ApiKey
- type ApiStage
- type Authorizer
- type BasePathMapping
- type ClientCertificate
- type CreateApiKeyInput
- type CreateAuthorizerInput
- type CreateBasePathMappingInput
- type CreateDeploymentInput
- type CreateDomainNameInput
- type CreateModelInput
- type CreateResourceInput
- type CreateRestApiInput
- type CreateStageInput
- type CreateUsagePlanInput
- type CreateUsagePlanKeyInput
- type DeleteApiKeyInput
- type DeleteApiKeyOutput
- type DeleteAuthorizerInput
- type DeleteAuthorizerOutput
- type DeleteBasePathMappingInput
- type DeleteBasePathMappingOutput
- type DeleteClientCertificateInput
- type DeleteClientCertificateOutput
- type DeleteDeploymentInput
- type DeleteDeploymentOutput
- type DeleteDomainNameInput
- type DeleteDomainNameOutput
- type DeleteIntegrationInput
- type DeleteIntegrationOutput
- type DeleteIntegrationResponseInput
- type DeleteIntegrationResponseOutput
- type DeleteMethodInput
- type DeleteMethodOutput
- type DeleteMethodResponseInput
- type DeleteMethodResponseOutput
- type DeleteModelInput
- type DeleteModelOutput
- type DeleteResourceInput
- type DeleteResourceOutput
- type DeleteRestApiInput
- type DeleteRestApiOutput
- type DeleteStageInput
- type DeleteStageOutput
- type DeleteUsagePlanInput
- type DeleteUsagePlanKeyInput
- type DeleteUsagePlanKeyOutput
- type DeleteUsagePlanOutput
- type Deployment
- type DomainName
- type FlushStageAuthorizersCacheInput
- type FlushStageAuthorizersCacheOutput
- type FlushStageCacheInput
- type FlushStageCacheOutput
- type GenerateClientCertificateInput
- type GetAccountInput
- type GetApiKeyInput
- type GetApiKeysInput
- type GetApiKeysOutput
- type GetAuthorizerInput
- type GetAuthorizersInput
- type GetAuthorizersOutput
- type GetBasePathMappingInput
- type GetBasePathMappingsInput
- type GetBasePathMappingsOutput
- type GetClientCertificateInput
- type GetClientCertificatesInput
- type GetClientCertificatesOutput
- type GetDeploymentInput
- type GetDeploymentsInput
- type GetDeploymentsOutput
- type GetDomainNameInput
- type GetDomainNamesInput
- type GetDomainNamesOutput
- type GetExportInput
- type GetExportOutput
- type GetIntegrationInput
- type GetIntegrationResponseInput
- type GetMethodInput
- type GetMethodResponseInput
- type GetModelInput
- type GetModelTemplateInput
- type GetModelTemplateOutput
- type GetModelsInput
- type GetModelsOutput
- type GetResourceInput
- type GetResourcesInput
- type GetResourcesOutput
- type GetRestApiInput
- type GetRestApisInput
- type GetRestApisOutput
- type GetSdkInput
- type GetSdkOutput
- type GetStageInput
- type GetStagesInput
- type GetStagesOutput
- type GetUsageInput
- type GetUsagePlanInput
- type GetUsagePlanKeyInput
- type GetUsagePlanKeysInput
- type GetUsagePlanKeysOutput
- type GetUsagePlansInput
- type GetUsagePlansOutput
- type ImportApiKeysInput
- type ImportApiKeysOutput
- type ImportRestApiInput
- type Integration
- type IntegrationResponse
- type Method
- type MethodResponse
- type MethodSetting
- type MethodSnapshot
- type Model
- type PatchOperation
- type PutIntegrationInput
- type PutIntegrationResponseInput
- type PutMethodInput
- type PutMethodResponseInput
- type PutRestApiInput
- type QuotaSettings
- type Resource
- type RestApi
- type Stage
- type StageKey
- type TestInvokeAuthorizerInput
- type TestInvokeAuthorizerOutput
- type TestInvokeMethodInput
- type TestInvokeMethodOutput
- type ThrottleSettings
- type UpdateAccountInput
- type UpdateApiKeyInput
- type UpdateAuthorizerInput
- type UpdateBasePathMappingInput
- type UpdateClientCertificateInput
- type UpdateDeploymentInput
- type UpdateDomainNameInput
- type UpdateIntegrationInput
- type UpdateIntegrationResponseInput
- type UpdateMethodInput
- type UpdateMethodResponseInput
- type UpdateModelInput
- type UpdateResourceInput
- type UpdateRestApiInput
- type UpdateStageInput
- type UpdateUsageInput
- type UpdateUsagePlanInput
- type Usage
- type UsagePlan
- type UsagePlanKey
Examples ¶
- APIGateway.CreateApiKey
- APIGateway.CreateAuthorizer
- APIGateway.CreateBasePathMapping
- APIGateway.CreateDeployment
- APIGateway.CreateDomainName
- APIGateway.CreateModel
- APIGateway.CreateResource
- APIGateway.CreateRestApi
- APIGateway.CreateStage
- APIGateway.CreateUsagePlan
- APIGateway.CreateUsagePlanKey
- APIGateway.DeleteApiKey
- APIGateway.DeleteAuthorizer
- APIGateway.DeleteBasePathMapping
- APIGateway.DeleteClientCertificate
- APIGateway.DeleteDeployment
- APIGateway.DeleteDomainName
- APIGateway.DeleteIntegration
- APIGateway.DeleteIntegrationResponse
- APIGateway.DeleteMethod
- APIGateway.DeleteMethodResponse
- APIGateway.DeleteModel
- APIGateway.DeleteResource
- APIGateway.DeleteRestApi
- APIGateway.DeleteStage
- APIGateway.DeleteUsagePlan
- APIGateway.DeleteUsagePlanKey
- APIGateway.FlushStageAuthorizersCache
- APIGateway.FlushStageCache
- APIGateway.GenerateClientCertificate
- APIGateway.GetAccount
- APIGateway.GetApiKey
- APIGateway.GetApiKeys
- APIGateway.GetAuthorizer
- APIGateway.GetAuthorizers
- APIGateway.GetBasePathMapping
- APIGateway.GetBasePathMappings
- APIGateway.GetClientCertificate
- APIGateway.GetClientCertificates
- APIGateway.GetDeployment
- APIGateway.GetDeployments
- APIGateway.GetDomainName
- APIGateway.GetDomainNames
- APIGateway.GetExport
- APIGateway.GetIntegration
- APIGateway.GetIntegrationResponse
- APIGateway.GetMethod
- APIGateway.GetMethodResponse
- APIGateway.GetModel
- APIGateway.GetModelTemplate
- APIGateway.GetModels
- APIGateway.GetResource
- APIGateway.GetResources
- APIGateway.GetRestApi
- APIGateway.GetRestApis
- APIGateway.GetSdk
- APIGateway.GetStage
- APIGateway.GetStages
- APIGateway.GetUsage
- APIGateway.GetUsagePlan
- APIGateway.GetUsagePlanKey
- APIGateway.GetUsagePlanKeys
- APIGateway.GetUsagePlans
- APIGateway.ImportApiKeys
- APIGateway.ImportRestApi
- APIGateway.PutIntegration
- APIGateway.PutIntegrationResponse
- APIGateway.PutMethod
- APIGateway.PutMethodResponse
- APIGateway.PutRestApi
- APIGateway.TestInvokeAuthorizer
- APIGateway.TestInvokeMethod
- APIGateway.UpdateAccount
- APIGateway.UpdateApiKey
- APIGateway.UpdateAuthorizer
- APIGateway.UpdateBasePathMapping
- APIGateway.UpdateClientCertificate
- APIGateway.UpdateDeployment
- APIGateway.UpdateDomainName
- APIGateway.UpdateIntegration
- APIGateway.UpdateIntegrationResponse
- APIGateway.UpdateMethod
- APIGateway.UpdateMethodResponse
- APIGateway.UpdateModel
- APIGateway.UpdateResource
- APIGateway.UpdateRestApi
- APIGateway.UpdateStage
- APIGateway.UpdateUsage
- APIGateway.UpdateUsagePlan
Constants ¶
const ( // @enum AuthorizerType AuthorizerTypeToken = "TOKEN" // @enum AuthorizerType AuthorizerTypeCognitoUserPools = "COGNITO_USER_POOLS" )
The authorizer type. the only current value is TOKEN.
const ( // @enum CacheClusterSize CacheClusterSize05 = "0.5" // @enum CacheClusterSize CacheClusterSize16 = "1.6" // @enum CacheClusterSize CacheClusterSize61 = "6.1" // @enum CacheClusterSize CacheClusterSize135 = "13.5" // @enum CacheClusterSize CacheClusterSize284 = "28.4" // @enum CacheClusterSize CacheClusterSize582 = "58.2" // @enum CacheClusterSize CacheClusterSize118 = "118" // @enum CacheClusterSize CacheClusterSize237 = "237" )
Returns the size of the CacheCluster.
const ( // @enum CacheClusterStatus CacheClusterStatusCreateInProgress = "CREATE_IN_PROGRESS" // @enum CacheClusterStatus CacheClusterStatusAvailable = "AVAILABLE" // @enum CacheClusterStatus CacheClusterStatusDeleteInProgress = "DELETE_IN_PROGRESS" // @enum CacheClusterStatus CacheClusterStatusNotAvailable = "NOT_AVAILABLE" // @enum CacheClusterStatus CacheClusterStatusFlushInProgress = "FLUSH_IN_PROGRESS" )
Returns the status of the CacheCluster.
const ( // @enum IntegrationType IntegrationTypeHttp = "HTTP" // @enum IntegrationType IntegrationTypeAws = "AWS" // @enum IntegrationType IntegrationTypeMock = "MOCK" )
The integration type. The valid value is HTTP, AWS, or MOCK.
const ( // @enum PutMode PutModeMerge = "merge" // @enum PutMode PutModeOverwrite = "overwrite" )
const ( // @enum QuotaPeriodType QuotaPeriodTypeDay = "DAY" // @enum QuotaPeriodType QuotaPeriodTypeWeek = "WEEK" // @enum QuotaPeriodType QuotaPeriodTypeMonth = "MONTH" )
const (UnauthorizedCacheControlHeaderStrategyFailWith403 = "FAIL_WITH_403" UnauthorizedCacheControlHeaderStrategySucceedWithResponseHeader = "SUCCEED_WITH_RESPONSE_HEADER" UnauthorizedCacheControlHeaderStrategySucceedWithoutResponseHeader = "SUCCEED_WITHOUT_RESPONSE_HEADER" )
const ( // @enum op OpAdd = "add" // @enum op OpRemove = "remove" // @enum op OpReplace = "replace" // @enum op OpMove = "move" // @enum op OpCopy = "copy" // @enum op OpTest = "test" )
const (
// @enum ApiKeysFormat
ApiKeysFormatCsv = "csv"
)
const ServiceName = "apigateway"
A ServiceName is the name of the service the client will make API calls to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIGateway ¶
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. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client'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)
Create an ApiKey resource.
AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html)
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.CreateApiKeyInput{ Description: aws.String("String"), Enabled: aws.Bool(true), GenerateDistinctId: aws.Bool(true), Name: aws.String("String"), StageKeys: []*apigateway.StageKey{ { // Required RestApiId: aws.String("String"), StageName: aws.String("String"), }, // More values... }, Value: aws.String("String"), } resp, err := svc.CreateApiKey(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) CreateApiKeyRequest ¶
func (c *APIGateway) CreateApiKeyRequest(input *CreateApiKeyInput) (req *request.Request, output *ApiKey)
CreateApiKeyRequest generates a "aws/request.Request" representing the client's request for the CreateApiKey operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateApiKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateApiKeyRequest method. req, resp := client.CreateApiKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateAuthorizer ¶ added in v1.1.2
func (c *APIGateway) CreateAuthorizer(input *CreateAuthorizerInput) (*Authorizer, error)
Adds a new Authorizer resource to an existing RestApi resource.
AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html)
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.CreateAuthorizerInput{ IdentitySource: aws.String("String"), // Required Name: aws.String("String"), // Required RestApiId: aws.String("String"), // Required Type: aws.String("AuthorizerType"), // Required AuthType: aws.String("String"), AuthorizerCredentials: aws.String("String"), AuthorizerResultTtlInSeconds: aws.Int64(1), AuthorizerUri: aws.String("String"), IdentityValidationExpression: aws.String("String"), ProviderARNs: []*string{ aws.String("ProviderARN"), // Required // More values... }, } resp, err := svc.CreateAuthorizer(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateAuthorizerRequest method. req, resp := client.CreateAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateBasePathMapping ¶
func (c *APIGateway) CreateBasePathMapping(input *CreateBasePathMappingInput) (*BasePathMapping, error)
Creates a new BasePathMapping resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.CreateBasePathMappingInput{ DomainName: aws.String("String"), // Required RestApiId: aws.String("String"), // Required BasePath: aws.String("String"), Stage: aws.String("String"), } resp, err := svc.CreateBasePathMapping(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) CreateBasePathMappingRequest ¶
func (c *APIGateway) CreateBasePathMappingRequest(input *CreateBasePathMappingInput) (req *request.Request, output *BasePathMapping)
CreateBasePathMappingRequest generates a "aws/request.Request" representing the client's request for the CreateBasePathMapping operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateBasePathMapping method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateBasePathMappingRequest method. req, resp := client.CreateBasePathMappingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateDeployment ¶
func (c *APIGateway) CreateDeployment(input *CreateDeploymentInput) (*Deployment, error)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.CreateDeploymentInput{ RestApiId: aws.String("String"), // Required StageName: aws.String("String"), // Required CacheClusterEnabled: aws.Bool(true), CacheClusterSize: aws.String("CacheClusterSize"), Description: aws.String("String"), StageDescription: aws.String("String"), Variables: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, } resp, err := svc.CreateDeployment(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) CreateDeploymentRequest ¶
func (c *APIGateway) CreateDeploymentRequest(input *CreateDeploymentInput) (req *request.Request, output *Deployment)
CreateDeploymentRequest generates a "aws/request.Request" representing the client's request for the CreateDeployment operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDeployment method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateDeploymentRequest method. req, resp := client.CreateDeploymentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateDomainName ¶
func (c *APIGateway) CreateDomainName(input *CreateDomainNameInput) (*DomainName, error)
Creates a new domain name.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.CreateDomainNameInput{ CertificateBody: aws.String("String"), // Required CertificateChain: aws.String("String"), // Required CertificateName: aws.String("String"), // Required CertificatePrivateKey: aws.String("String"), // Required DomainName: aws.String("String"), // Required } resp, err := svc.CreateDomainName(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) CreateDomainNameRequest ¶
func (c *APIGateway) CreateDomainNameRequest(input *CreateDomainNameInput) (req *request.Request, output *DomainName)
CreateDomainNameRequest generates a "aws/request.Request" representing the client's request for the CreateDomainName operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDomainName method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateDomainNameRequest method. req, resp := client.CreateDomainNameRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateModel ¶
func (c *APIGateway) CreateModel(input *CreateModelInput) (*Model, error)
Adds a new Model resource to an existing RestApi resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.CreateModelInput{ ContentType: aws.String("String"), // Required Name: aws.String("String"), // Required RestApiId: aws.String("String"), // Required Description: aws.String("String"), Schema: aws.String("String"), } resp, err := svc.CreateModel(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) CreateModelRequest ¶
func (c *APIGateway) CreateModelRequest(input *CreateModelInput) (req *request.Request, output *Model)
CreateModelRequest generates a "aws/request.Request" representing the client's request for the CreateModel operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateModel method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateModelRequest method. req, resp := client.CreateModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateResource ¶
func (c *APIGateway) CreateResource(input *CreateResourceInput) (*Resource, error)
Creates a Resource resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.CreateResourceInput{ ParentId: aws.String("String"), // Required PathPart: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.CreateResource(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) CreateResourceRequest ¶
func (c *APIGateway) CreateResourceRequest(input *CreateResourceInput) (req *request.Request, output *Resource)
CreateResourceRequest generates a "aws/request.Request" representing the client's request for the CreateResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateResourceRequest method. req, resp := client.CreateResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateRestApi ¶
func (c *APIGateway) CreateRestApi(input *CreateRestApiInput) (*RestApi, error)
Creates a new RestApi resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.CreateRestApiInput{ Name: aws.String("String"), // Required CloneFrom: aws.String("String"), Description: aws.String("String"), } resp, err := svc.CreateRestApi(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) CreateRestApiRequest ¶
func (c *APIGateway) CreateRestApiRequest(input *CreateRestApiInput) (req *request.Request, output *RestApi)
CreateRestApiRequest generates a "aws/request.Request" representing the client's request for the CreateRestApi operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateRestApiRequest method. req, resp := client.CreateRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateStage ¶
func (c *APIGateway) CreateStage(input *CreateStageInput) (*Stage, error)
Creates a new Stage resource that references a pre-existing Deployment for the API.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.CreateStageInput{ DeploymentId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required StageName: aws.String("String"), // Required CacheClusterEnabled: aws.Bool(true), CacheClusterSize: aws.String("CacheClusterSize"), Description: aws.String("String"), Variables: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, } resp, err := svc.CreateStage(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) CreateStageRequest ¶
func (c *APIGateway) CreateStageRequest(input *CreateStageInput) (req *request.Request, output *Stage)
CreateStageRequest generates a "aws/request.Request" representing the client's request for the CreateStage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateStage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateStageRequest method. req, resp := client.CreateStageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateUsagePlan ¶ added in v1.4.2
func (c *APIGateway) CreateUsagePlan(input *CreateUsagePlanInput) (*UsagePlan, error)
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.CreateUsagePlanInput{ Name: aws.String("String"), // Required ApiStages: []*apigateway.ApiStage{ { // Required ApiId: aws.String("String"), Stage: aws.String("String"), }, // More values... }, Description: aws.String("String"), Quota: &apigateway.QuotaSettings{ Limit: aws.Int64(1), Offset: aws.Int64(1), Period: aws.String("QuotaPeriodType"), }, Throttle: &apigateway.ThrottleSettings{ BurstLimit: aws.Int64(1), RateLimit: aws.Float64(1.0), }, } resp, err := svc.CreateUsagePlan(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) CreateUsagePlanKey ¶ added in v1.4.2
func (c *APIGateway) CreateUsagePlanKey(input *CreateUsagePlanKeyInput) (*UsagePlanKey, error)
Creates a usage plan key for adding an existing API key to a usage plan.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.CreateUsagePlanKeyInput{ KeyId: aws.String("String"), // Required KeyType: aws.String("String"), // Required UsagePlanId: aws.String("String"), // Required } resp, err := svc.CreateUsagePlanKey(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateUsagePlanKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateUsagePlanKeyRequest method. req, resp := client.CreateUsagePlanKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) 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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateUsagePlan method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateUsagePlanRequest method. req, resp := client.CreateUsagePlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteApiKey ¶
func (c *APIGateway) DeleteApiKey(input *DeleteApiKeyInput) (*DeleteApiKeyOutput, error)
Deletes the ApiKey resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteApiKeyInput{ ApiKey: aws.String("String"), // Required } resp, err := svc.DeleteApiKey(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteApiKeyRequest ¶
func (c *APIGateway) DeleteApiKeyRequest(input *DeleteApiKeyInput) (req *request.Request, output *DeleteApiKeyOutput)
DeleteApiKeyRequest generates a "aws/request.Request" representing the client's request for the DeleteApiKey operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteApiKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteApiKeyRequest method. req, resp := client.DeleteApiKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteAuthorizer ¶ added in v1.1.2
func (c *APIGateway) DeleteAuthorizer(input *DeleteAuthorizerInput) (*DeleteAuthorizerOutput, error)
Deletes an existing Authorizer resource.
AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html)
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteAuthorizerInput{ AuthorizerId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.DeleteAuthorizer(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteAuthorizerRequest method. req, resp := client.DeleteAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteBasePathMapping ¶
func (c *APIGateway) DeleteBasePathMapping(input *DeleteBasePathMappingInput) (*DeleteBasePathMappingOutput, error)
Deletes the BasePathMapping resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteBasePathMappingInput{ BasePath: aws.String("String"), // Required DomainName: aws.String("String"), // Required } resp, err := svc.DeleteBasePathMapping(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteBasePathMappingRequest ¶
func (c *APIGateway) DeleteBasePathMappingRequest(input *DeleteBasePathMappingInput) (req *request.Request, output *DeleteBasePathMappingOutput)
DeleteBasePathMappingRequest generates a "aws/request.Request" representing the client's request for the DeleteBasePathMapping operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteBasePathMapping method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteBasePathMappingRequest method. req, resp := client.DeleteBasePathMappingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteClientCertificate ¶
func (c *APIGateway) DeleteClientCertificate(input *DeleteClientCertificateInput) (*DeleteClientCertificateOutput, error)
Deletes the ClientCertificate resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteClientCertificateInput{ ClientCertificateId: aws.String("String"), // Required } resp, err := svc.DeleteClientCertificate(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteClientCertificateRequest ¶
func (c *APIGateway) DeleteClientCertificateRequest(input *DeleteClientCertificateInput) (req *request.Request, output *DeleteClientCertificateOutput)
DeleteClientCertificateRequest generates a "aws/request.Request" representing the client's request for the DeleteClientCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteClientCertificate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteClientCertificateRequest method. req, resp := client.DeleteClientCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteDeployment ¶
func (c *APIGateway) DeleteDeployment(input *DeleteDeploymentInput) (*DeleteDeploymentOutput, error)
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteDeploymentInput{ DeploymentId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.DeleteDeployment(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteDeploymentRequest ¶
func (c *APIGateway) DeleteDeploymentRequest(input *DeleteDeploymentInput) (req *request.Request, output *DeleteDeploymentOutput)
DeleteDeploymentRequest generates a "aws/request.Request" representing the client's request for the DeleteDeployment operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDeployment method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteDeploymentRequest method. req, resp := client.DeleteDeploymentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteDomainName ¶
func (c *APIGateway) DeleteDomainName(input *DeleteDomainNameInput) (*DeleteDomainNameOutput, error)
Deletes the DomainName resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteDomainNameInput{ DomainName: aws.String("String"), // Required } resp, err := svc.DeleteDomainName(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteDomainNameRequest ¶
func (c *APIGateway) DeleteDomainNameRequest(input *DeleteDomainNameInput) (req *request.Request, output *DeleteDomainNameOutput)
DeleteDomainNameRequest generates a "aws/request.Request" representing the client's request for the DeleteDomainName operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDomainName method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteDomainNameRequest method. req, resp := client.DeleteDomainNameRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteIntegration ¶
func (c *APIGateway) DeleteIntegration(input *DeleteIntegrationInput) (*DeleteIntegrationOutput, error)
Represents a delete integration.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteIntegrationInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.DeleteIntegration(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteIntegrationRequest ¶
func (c *APIGateway) DeleteIntegrationRequest(input *DeleteIntegrationInput) (req *request.Request, output *DeleteIntegrationOutput)
DeleteIntegrationRequest generates a "aws/request.Request" representing the client's request for the DeleteIntegration operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteIntegration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteIntegrationRequest method. req, resp := client.DeleteIntegrationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteIntegrationResponse ¶
func (c *APIGateway) DeleteIntegrationResponse(input *DeleteIntegrationResponseInput) (*DeleteIntegrationResponseOutput, error)
Represents a delete integration response.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteIntegrationResponseInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required StatusCode: aws.String("StatusCode"), // Required } resp, err := svc.DeleteIntegrationResponse(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteIntegrationResponseRequest ¶
func (c *APIGateway) DeleteIntegrationResponseRequest(input *DeleteIntegrationResponseInput) (req *request.Request, output *DeleteIntegrationResponseOutput)
DeleteIntegrationResponseRequest generates a "aws/request.Request" representing the client's request for the DeleteIntegrationResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteIntegrationResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteIntegrationResponseRequest method. req, resp := client.DeleteIntegrationResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteMethod ¶
func (c *APIGateway) DeleteMethod(input *DeleteMethodInput) (*DeleteMethodOutput, error)
Deletes an existing Method resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteMethodInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.DeleteMethod(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteMethodRequest ¶
func (c *APIGateway) DeleteMethodRequest(input *DeleteMethodInput) (req *request.Request, output *DeleteMethodOutput)
DeleteMethodRequest generates a "aws/request.Request" representing the client's request for the DeleteMethod operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteMethodRequest method. req, resp := client.DeleteMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteMethodResponse ¶
func (c *APIGateway) DeleteMethodResponse(input *DeleteMethodResponseInput) (*DeleteMethodResponseOutput, error)
Deletes an existing MethodResponse resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteMethodResponseInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required StatusCode: aws.String("StatusCode"), // Required } resp, err := svc.DeleteMethodResponse(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteMethodResponseRequest ¶
func (c *APIGateway) DeleteMethodResponseRequest(input *DeleteMethodResponseInput) (req *request.Request, output *DeleteMethodResponseOutput)
DeleteMethodResponseRequest generates a "aws/request.Request" representing the client's request for the DeleteMethodResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteMethodResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteMethodResponseRequest method. req, resp := client.DeleteMethodResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteModel ¶
func (c *APIGateway) DeleteModel(input *DeleteModelInput) (*DeleteModelOutput, error)
Deletes a model.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteModelInput{ ModelName: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.DeleteModel(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteModelRequest ¶
func (c *APIGateway) DeleteModelRequest(input *DeleteModelInput) (req *request.Request, output *DeleteModelOutput)
DeleteModelRequest generates a "aws/request.Request" representing the client's request for the DeleteModel operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteModel method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteModelRequest method. req, resp := client.DeleteModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteResource ¶
func (c *APIGateway) DeleteResource(input *DeleteResourceInput) (*DeleteResourceOutput, error)
Deletes a Resource resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteResourceInput{ ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.DeleteResource(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteResourceRequest ¶
func (c *APIGateway) DeleteResourceRequest(input *DeleteResourceInput) (req *request.Request, output *DeleteResourceOutput)
DeleteResourceRequest generates a "aws/request.Request" representing the client's request for the DeleteResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteResourceRequest method. req, resp := client.DeleteResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteRestApi ¶
func (c *APIGateway) DeleteRestApi(input *DeleteRestApiInput) (*DeleteRestApiOutput, error)
Deletes the specified API.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteRestApiInput{ RestApiId: aws.String("String"), // Required } resp, err := svc.DeleteRestApi(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteRestApiRequest ¶
func (c *APIGateway) DeleteRestApiRequest(input *DeleteRestApiInput) (req *request.Request, output *DeleteRestApiOutput)
DeleteRestApiRequest generates a "aws/request.Request" representing the client's request for the DeleteRestApi operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteRestApiRequest method. req, resp := client.DeleteRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteStage ¶
func (c *APIGateway) DeleteStage(input *DeleteStageInput) (*DeleteStageOutput, error)
Deletes a Stage resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteStageInput{ RestApiId: aws.String("String"), // Required StageName: aws.String("String"), // Required } resp, err := svc.DeleteStage(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteStageRequest ¶
func (c *APIGateway) DeleteStageRequest(input *DeleteStageInput) (req *request.Request, output *DeleteStageOutput)
DeleteStageRequest generates a "aws/request.Request" representing the client's request for the DeleteStage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteStage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteStageRequest method. req, resp := client.DeleteStageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteUsagePlan ¶ added in v1.4.2
func (c *APIGateway) DeleteUsagePlan(input *DeleteUsagePlanInput) (*DeleteUsagePlanOutput, error)
Deletes a usage plan of a given plan Id.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteUsagePlanInput{ UsagePlanId: aws.String("String"), // Required } resp, err := svc.DeleteUsagePlan(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) DeleteUsagePlanKey ¶ added in v1.4.2
func (c *APIGateway) DeleteUsagePlanKey(input *DeleteUsagePlanKeyInput) (*DeleteUsagePlanKeyOutput, error)
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.DeleteUsagePlanKeyInput{ KeyId: aws.String("String"), // Required UsagePlanId: aws.String("String"), // Required } resp, err := svc.DeleteUsagePlanKey(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteUsagePlanKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteUsagePlanKeyRequest method. req, resp := client.DeleteUsagePlanKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) 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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteUsagePlan method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteUsagePlanRequest method. req, resp := client.DeleteUsagePlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) FlushStageAuthorizersCache ¶ added in v1.1.8
func (c *APIGateway) FlushStageAuthorizersCache(input *FlushStageAuthorizersCacheInput) (*FlushStageAuthorizersCacheOutput, error)
Flushes all authorizer cache entries on a stage.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.FlushStageAuthorizersCacheInput{ RestApiId: aws.String("String"), // Required StageName: aws.String("String"), // Required } resp, err := svc.FlushStageAuthorizersCache(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the FlushStageAuthorizersCache method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the FlushStageAuthorizersCacheRequest method. req, resp := client.FlushStageAuthorizersCacheRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) FlushStageCache ¶
func (c *APIGateway) FlushStageCache(input *FlushStageCacheInput) (*FlushStageCacheOutput, error)
Flushes a stage's cache.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.FlushStageCacheInput{ RestApiId: aws.String("String"), // Required StageName: aws.String("String"), // Required } resp, err := svc.FlushStageCache(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) FlushStageCacheRequest ¶
func (c *APIGateway) FlushStageCacheRequest(input *FlushStageCacheInput) (req *request.Request, output *FlushStageCacheOutput)
FlushStageCacheRequest generates a "aws/request.Request" representing the client's request for the FlushStageCache operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the FlushStageCache method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the FlushStageCacheRequest method. req, resp := client.FlushStageCacheRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GenerateClientCertificate ¶
func (c *APIGateway) GenerateClientCertificate(input *GenerateClientCertificateInput) (*ClientCertificate, error)
Generates a ClientCertificate resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GenerateClientCertificateInput{ Description: aws.String("String"), } resp, err := svc.GenerateClientCertificate(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GenerateClientCertificateRequest ¶
func (c *APIGateway) GenerateClientCertificateRequest(input *GenerateClientCertificateInput) (req *request.Request, output *ClientCertificate)
GenerateClientCertificateRequest generates a "aws/request.Request" representing the client's request for the GenerateClientCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GenerateClientCertificate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GenerateClientCertificateRequest method. req, resp := client.GenerateClientCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetAccount ¶
func (c *APIGateway) GetAccount(input *GetAccountInput) (*Account, error)
Gets information about the current Account resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) var params *apigateway.GetAccountInput resp, err := svc.GetAccount(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetAccountRequest ¶
func (c *APIGateway) GetAccountRequest(input *GetAccountInput) (req *request.Request, output *Account)
GetAccountRequest generates a "aws/request.Request" representing the client's request for the GetAccount operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetAccount method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetAccountRequest method. req, resp := client.GetAccountRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetApiKey ¶
func (c *APIGateway) GetApiKey(input *GetApiKeyInput) (*ApiKey, error)
Gets information about the current ApiKey resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetApiKeyInput{ ApiKey: aws.String("String"), // Required IncludeValue: aws.Bool(true), } resp, err := svc.GetApiKey(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetApiKeyRequest ¶
func (c *APIGateway) GetApiKeyRequest(input *GetApiKeyInput) (req *request.Request, output *ApiKey)
GetApiKeyRequest generates a "aws/request.Request" representing the client's request for the GetApiKey operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetApiKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetApiKeyRequest method. req, resp := client.GetApiKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetApiKeys ¶
func (c *APIGateway) GetApiKeys(input *GetApiKeysInput) (*GetApiKeysOutput, error)
Gets information about the current ApiKeys resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetApiKeysInput{ IncludeValues: aws.Bool(true), Limit: aws.Int64(1), NameQuery: aws.String("String"), Position: aws.String("String"), } resp, err := svc.GetApiKeys(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetApiKeysPages ¶
func (c *APIGateway) GetApiKeysPages(input *GetApiKeysInput, fn func(p *GetApiKeysOutput, lastPage bool) (shouldContinue 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) GetApiKeysRequest ¶
func (c *APIGateway) GetApiKeysRequest(input *GetApiKeysInput) (req *request.Request, output *GetApiKeysOutput)
GetApiKeysRequest generates a "aws/request.Request" representing the client's request for the GetApiKeys operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetApiKeys method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetApiKeysRequest method. req, resp := client.GetApiKeysRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetAuthorizer ¶ added in v1.1.2
func (c *APIGateway) GetAuthorizer(input *GetAuthorizerInput) (*Authorizer, error)
Describe an existing Authorizer resource.
AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html)
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetAuthorizerInput{ AuthorizerId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.GetAuthorizer(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetAuthorizerRequest method. req, resp := client.GetAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetAuthorizers ¶ added in v1.1.2
func (c *APIGateway) GetAuthorizers(input *GetAuthorizersInput) (*GetAuthorizersOutput, error)
Describe an existing Authorizers resource.
AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html)
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetAuthorizersInput{ RestApiId: aws.String("String"), // Required Limit: aws.Int64(1), Position: aws.String("String"), } resp, err := svc.GetAuthorizers(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetAuthorizers method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetAuthorizersRequest method. req, resp := client.GetAuthorizersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetBasePathMapping ¶
func (c *APIGateway) GetBasePathMapping(input *GetBasePathMappingInput) (*BasePathMapping, error)
Describe a BasePathMapping resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetBasePathMappingInput{ BasePath: aws.String("String"), // Required DomainName: aws.String("String"), // Required } resp, err := svc.GetBasePathMapping(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetBasePathMappingRequest ¶
func (c *APIGateway) GetBasePathMappingRequest(input *GetBasePathMappingInput) (req *request.Request, output *BasePathMapping)
GetBasePathMappingRequest generates a "aws/request.Request" representing the client's request for the GetBasePathMapping operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetBasePathMapping method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetBasePathMappingRequest method. req, resp := client.GetBasePathMappingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetBasePathMappings ¶
func (c *APIGateway) GetBasePathMappings(input *GetBasePathMappingsInput) (*GetBasePathMappingsOutput, error)
Represents a collection of BasePathMapping resources.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetBasePathMappingsInput{ DomainName: aws.String("String"), // Required Limit: aws.Int64(1), Position: aws.String("String"), } resp, err := svc.GetBasePathMappings(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetBasePathMappingsPages ¶
func (c *APIGateway) GetBasePathMappingsPages(input *GetBasePathMappingsInput, fn func(p *GetBasePathMappingsOutput, lastPage bool) (shouldContinue 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) GetBasePathMappingsRequest ¶
func (c *APIGateway) GetBasePathMappingsRequest(input *GetBasePathMappingsInput) (req *request.Request, output *GetBasePathMappingsOutput)
GetBasePathMappingsRequest generates a "aws/request.Request" representing the client's request for the GetBasePathMappings operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetBasePathMappings method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetBasePathMappingsRequest method. req, resp := client.GetBasePathMappingsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetClientCertificate ¶
func (c *APIGateway) GetClientCertificate(input *GetClientCertificateInput) (*ClientCertificate, error)
Gets information about the current ClientCertificate resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetClientCertificateInput{ ClientCertificateId: aws.String("String"), // Required } resp, err := svc.GetClientCertificate(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetClientCertificateRequest ¶
func (c *APIGateway) GetClientCertificateRequest(input *GetClientCertificateInput) (req *request.Request, output *ClientCertificate)
GetClientCertificateRequest generates a "aws/request.Request" representing the client's request for the GetClientCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetClientCertificate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetClientCertificateRequest method. req, resp := client.GetClientCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetClientCertificates ¶
func (c *APIGateway) GetClientCertificates(input *GetClientCertificatesInput) (*GetClientCertificatesOutput, error)
Gets a collection of ClientCertificate resources.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetClientCertificatesInput{ Limit: aws.Int64(1), Position: aws.String("String"), } resp, err := svc.GetClientCertificates(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetClientCertificatesPages ¶
func (c *APIGateway) GetClientCertificatesPages(input *GetClientCertificatesInput, fn func(p *GetClientCertificatesOutput, lastPage bool) (shouldContinue 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) GetClientCertificatesRequest ¶
func (c *APIGateway) GetClientCertificatesRequest(input *GetClientCertificatesInput) (req *request.Request, output *GetClientCertificatesOutput)
GetClientCertificatesRequest generates a "aws/request.Request" representing the client's request for the GetClientCertificates operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetClientCertificates method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetClientCertificatesRequest method. req, resp := client.GetClientCertificatesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDeployment ¶
func (c *APIGateway) GetDeployment(input *GetDeploymentInput) (*Deployment, error)
Gets information about a Deployment resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetDeploymentInput{ DeploymentId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.GetDeployment(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetDeploymentRequest ¶
func (c *APIGateway) GetDeploymentRequest(input *GetDeploymentInput) (req *request.Request, output *Deployment)
GetDeploymentRequest generates a "aws/request.Request" representing the client's request for the GetDeployment operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDeployment method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDeploymentRequest method. req, resp := client.GetDeploymentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDeployments ¶
func (c *APIGateway) GetDeployments(input *GetDeploymentsInput) (*GetDeploymentsOutput, error)
Gets information about a Deployments collection.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetDeploymentsInput{ RestApiId: aws.String("String"), // Required Limit: aws.Int64(1), Position: aws.String("String"), } resp, err := svc.GetDeployments(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetDeploymentsPages ¶
func (c *APIGateway) GetDeploymentsPages(input *GetDeploymentsInput, fn func(p *GetDeploymentsOutput, lastPage bool) (shouldContinue 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) GetDeploymentsRequest ¶
func (c *APIGateway) GetDeploymentsRequest(input *GetDeploymentsInput) (req *request.Request, output *GetDeploymentsOutput)
GetDeploymentsRequest generates a "aws/request.Request" representing the client's request for the GetDeployments operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDeployments method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDeploymentsRequest method. req, resp := client.GetDeploymentsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDomainName ¶
func (c *APIGateway) GetDomainName(input *GetDomainNameInput) (*DomainName, error)
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetDomainNameInput{ DomainName: aws.String("String"), // Required } resp, err := svc.GetDomainName(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetDomainNameRequest ¶
func (c *APIGateway) GetDomainNameRequest(input *GetDomainNameInput) (req *request.Request, output *DomainName)
GetDomainNameRequest generates a "aws/request.Request" representing the client's request for the GetDomainName operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDomainName method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDomainNameRequest method. req, resp := client.GetDomainNameRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDomainNames ¶
func (c *APIGateway) GetDomainNames(input *GetDomainNamesInput) (*GetDomainNamesOutput, error)
Represents a collection of DomainName resources.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetDomainNamesInput{ Limit: aws.Int64(1), Position: aws.String("String"), } resp, err := svc.GetDomainNames(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetDomainNamesPages ¶
func (c *APIGateway) GetDomainNamesPages(input *GetDomainNamesInput, fn func(p *GetDomainNamesOutput, lastPage bool) (shouldContinue 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) GetDomainNamesRequest ¶
func (c *APIGateway) GetDomainNamesRequest(input *GetDomainNamesInput) (req *request.Request, output *GetDomainNamesOutput)
GetDomainNamesRequest generates a "aws/request.Request" representing the client's request for the GetDomainNames operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDomainNames method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDomainNamesRequest method. req, resp := client.GetDomainNamesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetExport ¶ added in v1.1.2
func (c *APIGateway) GetExport(input *GetExportInput) (*GetExportOutput, error)
Exports a deployed version of a RestApi in a specified format.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetExportInput{ ExportType: aws.String("String"), // Required RestApiId: aws.String("String"), // Required StageName: aws.String("String"), // Required Accepts: aws.String("String"), Parameters: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, } resp, err := svc.GetExport(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetExport method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetExportRequest method. req, resp := client.GetExportRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetIntegration ¶
func (c *APIGateway) GetIntegration(input *GetIntegrationInput) (*Integration, error)
Represents a get integration.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetIntegrationInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.GetIntegration(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetIntegrationRequest ¶
func (c *APIGateway) GetIntegrationRequest(input *GetIntegrationInput) (req *request.Request, output *Integration)
GetIntegrationRequest generates a "aws/request.Request" representing the client's request for the GetIntegration operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetIntegration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetIntegrationRequest method. req, resp := client.GetIntegrationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetIntegrationResponse ¶
func (c *APIGateway) GetIntegrationResponse(input *GetIntegrationResponseInput) (*IntegrationResponse, error)
Represents a get integration response.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetIntegrationResponseInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required StatusCode: aws.String("StatusCode"), // Required } resp, err := svc.GetIntegrationResponse(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetIntegrationResponseRequest ¶
func (c *APIGateway) GetIntegrationResponseRequest(input *GetIntegrationResponseInput) (req *request.Request, output *IntegrationResponse)
GetIntegrationResponseRequest generates a "aws/request.Request" representing the client's request for the GetIntegrationResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetIntegrationResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetIntegrationResponseRequest method. req, resp := client.GetIntegrationResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetMethod ¶
func (c *APIGateway) GetMethod(input *GetMethodInput) (*Method, error)
Describe an existing Method resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetMethodInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.GetMethod(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetMethodRequest ¶
func (c *APIGateway) GetMethodRequest(input *GetMethodInput) (req *request.Request, output *Method)
GetMethodRequest generates a "aws/request.Request" representing the client's request for the GetMethod operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetMethodRequest method. req, resp := client.GetMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetMethodResponse ¶
func (c *APIGateway) GetMethodResponse(input *GetMethodResponseInput) (*MethodResponse, error)
Describes a MethodResponse resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetMethodResponseInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required StatusCode: aws.String("StatusCode"), // Required } resp, err := svc.GetMethodResponse(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetMethodResponseRequest ¶
func (c *APIGateway) GetMethodResponseRequest(input *GetMethodResponseInput) (req *request.Request, output *MethodResponse)
GetMethodResponseRequest generates a "aws/request.Request" representing the client's request for the GetMethodResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetMethodResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetMethodResponseRequest method. req, resp := client.GetMethodResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetModel ¶
func (c *APIGateway) GetModel(input *GetModelInput) (*Model, error)
Describes an existing model defined for a RestApi resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetModelInput{ ModelName: aws.String("String"), // Required RestApiId: aws.String("String"), // Required Flatten: aws.Bool(true), } resp, err := svc.GetModel(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetModelRequest ¶
func (c *APIGateway) GetModelRequest(input *GetModelInput) (req *request.Request, output *Model)
GetModelRequest generates a "aws/request.Request" representing the client's request for the GetModel operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetModel method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetModelRequest method. req, resp := client.GetModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetModelTemplate ¶
func (c *APIGateway) GetModelTemplate(input *GetModelTemplateInput) (*GetModelTemplateOutput, error)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetModelTemplateInput{ ModelName: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.GetModelTemplate(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetModelTemplateRequest ¶
func (c *APIGateway) GetModelTemplateRequest(input *GetModelTemplateInput) (req *request.Request, output *GetModelTemplateOutput)
GetModelTemplateRequest generates a "aws/request.Request" representing the client's request for the GetModelTemplate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetModelTemplate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetModelTemplateRequest method. req, resp := client.GetModelTemplateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetModels ¶
func (c *APIGateway) GetModels(input *GetModelsInput) (*GetModelsOutput, error)
Describes existing Models defined for a RestApi resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetModelsInput{ RestApiId: aws.String("String"), // Required Limit: aws.Int64(1), Position: aws.String("String"), } resp, err := svc.GetModels(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetModelsPages ¶
func (c *APIGateway) GetModelsPages(input *GetModelsInput, fn func(p *GetModelsOutput, lastPage bool) (shouldContinue 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) GetModelsRequest ¶
func (c *APIGateway) GetModelsRequest(input *GetModelsInput) (req *request.Request, output *GetModelsOutput)
GetModelsRequest generates a "aws/request.Request" representing the client's request for the GetModels operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetModels method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetModelsRequest method. req, resp := client.GetModelsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetResource ¶
func (c *APIGateway) GetResource(input *GetResourceInput) (*Resource, error)
Lists information about a resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetResourceInput{ ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.GetResource(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetResourceRequest ¶
func (c *APIGateway) GetResourceRequest(input *GetResourceInput) (req *request.Request, output *Resource)
GetResourceRequest generates a "aws/request.Request" representing the client's request for the GetResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetResourceRequest method. req, resp := client.GetResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetResources ¶
func (c *APIGateway) GetResources(input *GetResourcesInput) (*GetResourcesOutput, error)
Lists information about a collection of Resource resources.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetResourcesInput{ RestApiId: aws.String("String"), // Required Limit: aws.Int64(1), Position: aws.String("String"), } resp, err := svc.GetResources(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetResourcesPages ¶
func (c *APIGateway) GetResourcesPages(input *GetResourcesInput, fn func(p *GetResourcesOutput, lastPage bool) (shouldContinue 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) GetResourcesRequest ¶
func (c *APIGateway) GetResourcesRequest(input *GetResourcesInput) (req *request.Request, output *GetResourcesOutput)
GetResourcesRequest generates a "aws/request.Request" representing the client's request for the GetResources operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetResources method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetResourcesRequest method. req, resp := client.GetResourcesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetRestApi ¶
func (c *APIGateway) GetRestApi(input *GetRestApiInput) (*RestApi, error)
Lists the RestApi resource in the collection.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetRestApiInput{ RestApiId: aws.String("String"), // Required } resp, err := svc.GetRestApi(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetRestApiRequest ¶
func (c *APIGateway) GetRestApiRequest(input *GetRestApiInput) (req *request.Request, output *RestApi)
GetRestApiRequest generates a "aws/request.Request" representing the client's request for the GetRestApi operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetRestApiRequest method. req, resp := client.GetRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetRestApis ¶
func (c *APIGateway) GetRestApis(input *GetRestApisInput) (*GetRestApisOutput, error)
Lists the RestApis resources for your collection.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetRestApisInput{ Limit: aws.Int64(1), Position: aws.String("String"), } resp, err := svc.GetRestApis(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetRestApisPages ¶
func (c *APIGateway) GetRestApisPages(input *GetRestApisInput, fn func(p *GetRestApisOutput, lastPage bool) (shouldContinue 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) GetRestApisRequest ¶
func (c *APIGateway) GetRestApisRequest(input *GetRestApisInput) (req *request.Request, output *GetRestApisOutput)
GetRestApisRequest generates a "aws/request.Request" representing the client's request for the GetRestApis operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetRestApis method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetRestApisRequest method. req, resp := client.GetRestApisRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetSdk ¶
func (c *APIGateway) GetSdk(input *GetSdkInput) (*GetSdkOutput, error)
Generates a client SDK for a RestApi and Stage.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetSdkInput{ RestApiId: aws.String("String"), // Required SdkType: aws.String("String"), // Required StageName: aws.String("String"), // Required Parameters: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, } resp, err := svc.GetSdk(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetSdkRequest ¶
func (c *APIGateway) GetSdkRequest(input *GetSdkInput) (req *request.Request, output *GetSdkOutput)
GetSdkRequest generates a "aws/request.Request" representing the client's request for the GetSdk operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSdk method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetSdkRequest method. req, resp := client.GetSdkRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetStage ¶
func (c *APIGateway) GetStage(input *GetStageInput) (*Stage, error)
Gets information about a Stage resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetStageInput{ RestApiId: aws.String("String"), // Required StageName: aws.String("String"), // Required } resp, err := svc.GetStage(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetStageRequest ¶
func (c *APIGateway) GetStageRequest(input *GetStageInput) (req *request.Request, output *Stage)
GetStageRequest generates a "aws/request.Request" representing the client's request for the GetStage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetStage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetStageRequest method. req, resp := client.GetStageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetStages ¶
func (c *APIGateway) GetStages(input *GetStagesInput) (*GetStagesOutput, error)
Gets information about one or more Stage resources.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetStagesInput{ RestApiId: aws.String("String"), // Required DeploymentId: aws.String("String"), } resp, err := svc.GetStages(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetStagesRequest ¶
func (c *APIGateway) GetStagesRequest(input *GetStagesInput) (req *request.Request, output *GetStagesOutput)
GetStagesRequest generates a "aws/request.Request" representing the client's request for the GetStages operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetStages method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetStagesRequest method. req, resp := client.GetStagesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetUsage ¶ added in v1.4.2
func (c *APIGateway) GetUsage(input *GetUsageInput) (*Usage, error)
Gets the usage data of a usage plan in a specified time interval.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetUsageInput{ EndDate: aws.String("String"), // Required StartDate: aws.String("String"), // Required UsagePlanId: aws.String("String"), // Required KeyId: aws.String("String"), Limit: aws.Int64(1), Position: aws.String("String"), } resp, err := svc.GetUsage(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetUsagePages ¶ added in v1.4.2
func (c *APIGateway) GetUsagePages(input *GetUsageInput, fn func(p *Usage, lastPage bool) (shouldContinue 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) GetUsagePlan ¶ added in v1.4.2
func (c *APIGateway) GetUsagePlan(input *GetUsagePlanInput) (*UsagePlan, error)
Gets a usage plan of a given plan identifier.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetUsagePlanInput{ UsagePlanId: aws.String("String"), // Required } resp, err := svc.GetUsagePlan(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetUsagePlanKey ¶ added in v1.4.2
func (c *APIGateway) GetUsagePlanKey(input *GetUsagePlanKeyInput) (*UsagePlanKey, error)
Gets a usage plan key of a given key identifier.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetUsagePlanKeyInput{ KeyId: aws.String("String"), // Required UsagePlanId: aws.String("String"), // Required } resp, err := svc.GetUsagePlanKey(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsagePlanKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsagePlanKeyRequest method. req, resp := client.GetUsagePlanKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetUsagePlanKeys ¶ added in v1.4.2
func (c *APIGateway) GetUsagePlanKeys(input *GetUsagePlanKeysInput) (*GetUsagePlanKeysOutput, error)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetUsagePlanKeysInput{ UsagePlanId: aws.String("String"), // Required Limit: aws.Int64(1), NameQuery: aws.String("String"), Position: aws.String("String"), } resp, err := svc.GetUsagePlanKeys(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetUsagePlanKeysPages ¶ added in v1.4.2
func (c *APIGateway) GetUsagePlanKeysPages(input *GetUsagePlanKeysInput, fn func(p *GetUsagePlanKeysOutput, lastPage bool) (shouldContinue 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) 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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsagePlanKeys method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsagePlanKeysRequest method. req, resp := client.GetUsagePlanKeysRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) 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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsagePlan method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsagePlanRequest method. req, resp := client.GetUsagePlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetUsagePlans ¶ added in v1.4.2
func (c *APIGateway) GetUsagePlans(input *GetUsagePlansInput) (*GetUsagePlansOutput, error)
Gets all the usage plans of the caller's account.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.GetUsagePlansInput{ KeyId: aws.String("String"), Limit: aws.Int64(1), Position: aws.String("String"), } resp, err := svc.GetUsagePlans(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) GetUsagePlansPages ¶ added in v1.4.2
func (c *APIGateway) GetUsagePlansPages(input *GetUsagePlansInput, fn func(p *GetUsagePlansOutput, lastPage bool) (shouldContinue 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) 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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsagePlans method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsagePlansRequest method. req, resp := client.GetUsagePlansRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) 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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsageRequest method. req, resp := client.GetUsageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) ImportApiKeys ¶ added in v1.4.2
func (c *APIGateway) ImportApiKeys(input *ImportApiKeysInput) (*ImportApiKeysOutput, error)
Import API keys from an external source, such as a CSV-formatted file.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.ImportApiKeysInput{ Body: []byte("PAYLOAD"), // Required Format: aws.String("ApiKeysFormat"), // Required FailOnWarnings: aws.Bool(true), } resp, err := svc.ImportApiKeys(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ImportApiKeys method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ImportApiKeysRequest method. req, resp := client.ImportApiKeysRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) ImportRestApi ¶ added in v1.1.16
func (c *APIGateway) ImportRestApi(input *ImportRestApiInput) (*RestApi, error)
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.ImportRestApiInput{ Body: []byte("PAYLOAD"), // Required FailOnWarnings: aws.Bool(true), Parameters: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, } resp, err := svc.ImportRestApi(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ImportRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ImportRestApiRequest method. req, resp := client.ImportRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutIntegration ¶
func (c *APIGateway) PutIntegration(input *PutIntegrationInput) (*Integration, error)
Represents a put integration.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.PutIntegrationInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required Type: aws.String("IntegrationType"), // Required CacheKeyParameters: []*string{ aws.String("String"), // Required // More values... }, CacheNamespace: aws.String("String"), Credentials: aws.String("String"), IntegrationHttpMethod: aws.String("String"), PassthroughBehavior: aws.String("String"), RequestParameters: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, RequestTemplates: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, Uri: aws.String("String"), } resp, err := svc.PutIntegration(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) PutIntegrationRequest ¶
func (c *APIGateway) PutIntegrationRequest(input *PutIntegrationInput) (req *request.Request, output *Integration)
PutIntegrationRequest generates a "aws/request.Request" representing the client's request for the PutIntegration operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutIntegration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutIntegrationRequest method. req, resp := client.PutIntegrationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutIntegrationResponse ¶
func (c *APIGateway) PutIntegrationResponse(input *PutIntegrationResponseInput) (*IntegrationResponse, error)
Represents a put integration.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.PutIntegrationResponseInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required StatusCode: aws.String("StatusCode"), // Required ResponseParameters: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, ResponseTemplates: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, SelectionPattern: aws.String("String"), } resp, err := svc.PutIntegrationResponse(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) PutIntegrationResponseRequest ¶
func (c *APIGateway) PutIntegrationResponseRequest(input *PutIntegrationResponseInput) (req *request.Request, output *IntegrationResponse)
PutIntegrationResponseRequest generates a "aws/request.Request" representing the client's request for the PutIntegrationResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutIntegrationResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutIntegrationResponseRequest method. req, resp := client.PutIntegrationResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutMethod ¶
func (c *APIGateway) PutMethod(input *PutMethodInput) (*Method, error)
Add a method to an existing Resource resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.PutMethodInput{ AuthorizationType: aws.String("String"), // Required HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required ApiKeyRequired: aws.Bool(true), AuthorizerId: aws.String("String"), RequestModels: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, RequestParameters: map[string]*bool{ "Key": aws.Bool(true), // Required // More values... }, } resp, err := svc.PutMethod(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) PutMethodRequest ¶
func (c *APIGateway) PutMethodRequest(input *PutMethodInput) (req *request.Request, output *Method)
PutMethodRequest generates a "aws/request.Request" representing the client's request for the PutMethod operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutMethodRequest method. req, resp := client.PutMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutMethodResponse ¶
func (c *APIGateway) PutMethodResponse(input *PutMethodResponseInput) (*MethodResponse, error)
Adds a MethodResponse to an existing Method resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.PutMethodResponseInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required StatusCode: aws.String("StatusCode"), // Required ResponseModels: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, ResponseParameters: map[string]*bool{ "Key": aws.Bool(true), // Required // More values... }, } resp, err := svc.PutMethodResponse(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) PutMethodResponseRequest ¶
func (c *APIGateway) PutMethodResponseRequest(input *PutMethodResponseInput) (req *request.Request, output *MethodResponse)
PutMethodResponseRequest generates a "aws/request.Request" representing the client's request for the PutMethodResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutMethodResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutMethodResponseRequest method. req, resp := client.PutMethodResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutRestApi ¶ added in v1.1.16
func (c *APIGateway) PutRestApi(input *PutRestApiInput) (*RestApi, error)
A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.PutRestApiInput{ Body: []byte("PAYLOAD"), // Required RestApiId: aws.String("String"), // Required FailOnWarnings: aws.Bool(true), Mode: aws.String("PutMode"), Parameters: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, } resp, err := svc.PutRestApi(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutRestApiRequest method. req, resp := client.PutRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) TestInvokeAuthorizer ¶ added in v1.1.8
func (c *APIGateway) TestInvokeAuthorizer(input *TestInvokeAuthorizerInput) (*TestInvokeAuthorizerOutput, error)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
Enable custom authorizers (http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html)
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.TestInvokeAuthorizerInput{ AuthorizerId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required AdditionalContext: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, Body: aws.String("String"), Headers: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, PathWithQueryString: aws.String("String"), StageVariables: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, } resp, err := svc.TestInvokeAuthorizer(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the TestInvokeAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the TestInvokeAuthorizerRequest method. req, resp := client.TestInvokeAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) TestInvokeMethod ¶
func (c *APIGateway) TestInvokeMethod(input *TestInvokeMethodInput) (*TestInvokeMethodOutput, error)
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.TestInvokeMethodInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required Body: aws.String("String"), ClientCertificateId: aws.String("String"), Headers: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, PathWithQueryString: aws.String("String"), StageVariables: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, } resp, err := svc.TestInvokeMethod(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) TestInvokeMethodRequest ¶
func (c *APIGateway) TestInvokeMethodRequest(input *TestInvokeMethodInput) (req *request.Request, output *TestInvokeMethodOutput)
TestInvokeMethodRequest generates a "aws/request.Request" representing the client's request for the TestInvokeMethod operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the TestInvokeMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the TestInvokeMethodRequest method. req, resp := client.TestInvokeMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateAccount ¶
func (c *APIGateway) UpdateAccount(input *UpdateAccountInput) (*Account, error)
Changes information about the current Account resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateAccountInput{ PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateAccount(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateAccountRequest ¶
func (c *APIGateway) UpdateAccountRequest(input *UpdateAccountInput) (req *request.Request, output *Account)
UpdateAccountRequest generates a "aws/request.Request" representing the client's request for the UpdateAccount operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateAccount method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateAccountRequest method. req, resp := client.UpdateAccountRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateApiKey ¶
func (c *APIGateway) UpdateApiKey(input *UpdateApiKeyInput) (*ApiKey, error)
Changes information about an ApiKey resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateApiKeyInput{ ApiKey: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateApiKey(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateApiKeyRequest ¶
func (c *APIGateway) UpdateApiKeyRequest(input *UpdateApiKeyInput) (req *request.Request, output *ApiKey)
UpdateApiKeyRequest generates a "aws/request.Request" representing the client's request for the UpdateApiKey operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateApiKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateApiKeyRequest method. req, resp := client.UpdateApiKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateAuthorizer ¶ added in v1.1.2
func (c *APIGateway) UpdateAuthorizer(input *UpdateAuthorizerInput) (*Authorizer, error)
Updates an existing Authorizer resource.
AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html)
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateAuthorizerInput{ AuthorizerId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateAuthorizer(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateAuthorizerRequest method. req, resp := client.UpdateAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateBasePathMapping ¶
func (c *APIGateway) UpdateBasePathMapping(input *UpdateBasePathMappingInput) (*BasePathMapping, error)
Changes information about the BasePathMapping resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateBasePathMappingInput{ BasePath: aws.String("String"), // Required DomainName: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateBasePathMapping(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateBasePathMappingRequest ¶
func (c *APIGateway) UpdateBasePathMappingRequest(input *UpdateBasePathMappingInput) (req *request.Request, output *BasePathMapping)
UpdateBasePathMappingRequest generates a "aws/request.Request" representing the client's request for the UpdateBasePathMapping operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateBasePathMapping method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateBasePathMappingRequest method. req, resp := client.UpdateBasePathMappingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateClientCertificate ¶
func (c *APIGateway) UpdateClientCertificate(input *UpdateClientCertificateInput) (*ClientCertificate, error)
Changes information about an ClientCertificate resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateClientCertificateInput{ ClientCertificateId: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateClientCertificate(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateClientCertificateRequest ¶
func (c *APIGateway) UpdateClientCertificateRequest(input *UpdateClientCertificateInput) (req *request.Request, output *ClientCertificate)
UpdateClientCertificateRequest generates a "aws/request.Request" representing the client's request for the UpdateClientCertificate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateClientCertificate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateClientCertificateRequest method. req, resp := client.UpdateClientCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateDeployment ¶
func (c *APIGateway) UpdateDeployment(input *UpdateDeploymentInput) (*Deployment, error)
Changes information about a Deployment resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateDeploymentInput{ DeploymentId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateDeployment(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateDeploymentRequest ¶
func (c *APIGateway) UpdateDeploymentRequest(input *UpdateDeploymentInput) (req *request.Request, output *Deployment)
UpdateDeploymentRequest generates a "aws/request.Request" representing the client's request for the UpdateDeployment operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateDeployment method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateDeploymentRequest method. req, resp := client.UpdateDeploymentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateDomainName ¶
func (c *APIGateway) UpdateDomainName(input *UpdateDomainNameInput) (*DomainName, error)
Changes information about the DomainName resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateDomainNameInput{ DomainName: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateDomainName(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateDomainNameRequest ¶
func (c *APIGateway) UpdateDomainNameRequest(input *UpdateDomainNameInput) (req *request.Request, output *DomainName)
UpdateDomainNameRequest generates a "aws/request.Request" representing the client's request for the UpdateDomainName operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateDomainName method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateDomainNameRequest method. req, resp := client.UpdateDomainNameRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateIntegration ¶
func (c *APIGateway) UpdateIntegration(input *UpdateIntegrationInput) (*Integration, error)
Represents an update integration.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateIntegrationInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateIntegration(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateIntegrationRequest ¶
func (c *APIGateway) UpdateIntegrationRequest(input *UpdateIntegrationInput) (req *request.Request, output *Integration)
UpdateIntegrationRequest generates a "aws/request.Request" representing the client's request for the UpdateIntegration operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateIntegration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateIntegrationRequest method. req, resp := client.UpdateIntegrationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateIntegrationResponse ¶
func (c *APIGateway) UpdateIntegrationResponse(input *UpdateIntegrationResponseInput) (*IntegrationResponse, error)
Represents an update integration response.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateIntegrationResponseInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required StatusCode: aws.String("StatusCode"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateIntegrationResponse(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateIntegrationResponseRequest ¶
func (c *APIGateway) UpdateIntegrationResponseRequest(input *UpdateIntegrationResponseInput) (req *request.Request, output *IntegrationResponse)
UpdateIntegrationResponseRequest generates a "aws/request.Request" representing the client's request for the UpdateIntegrationResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateIntegrationResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateIntegrationResponseRequest method. req, resp := client.UpdateIntegrationResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateMethod ¶
func (c *APIGateway) UpdateMethod(input *UpdateMethodInput) (*Method, error)
Updates an existing Method resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateMethodInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateMethod(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateMethodRequest ¶
func (c *APIGateway) UpdateMethodRequest(input *UpdateMethodInput) (req *request.Request, output *Method)
UpdateMethodRequest generates a "aws/request.Request" representing the client's request for the UpdateMethod operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateMethodRequest method. req, resp := client.UpdateMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateMethodResponse ¶
func (c *APIGateway) UpdateMethodResponse(input *UpdateMethodResponseInput) (*MethodResponse, error)
Updates an existing MethodResponse resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateMethodResponseInput{ HttpMethod: aws.String("String"), // Required ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required StatusCode: aws.String("StatusCode"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateMethodResponse(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateMethodResponseRequest ¶
func (c *APIGateway) UpdateMethodResponseRequest(input *UpdateMethodResponseInput) (req *request.Request, output *MethodResponse)
UpdateMethodResponseRequest generates a "aws/request.Request" representing the client's request for the UpdateMethodResponse operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateMethodResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateMethodResponseRequest method. req, resp := client.UpdateMethodResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateModel ¶
func (c *APIGateway) UpdateModel(input *UpdateModelInput) (*Model, error)
Changes information about a model.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateModelInput{ ModelName: aws.String("String"), // Required RestApiId: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateModel(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateModelRequest ¶
func (c *APIGateway) UpdateModelRequest(input *UpdateModelInput) (req *request.Request, output *Model)
UpdateModelRequest generates a "aws/request.Request" representing the client's request for the UpdateModel operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateModel method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateModelRequest method. req, resp := client.UpdateModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateResource ¶
func (c *APIGateway) UpdateResource(input *UpdateResourceInput) (*Resource, error)
Changes information about a Resource resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateResourceInput{ ResourceId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateResource(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateResourceRequest ¶
func (c *APIGateway) UpdateResourceRequest(input *UpdateResourceInput) (req *request.Request, output *Resource)
UpdateResourceRequest generates a "aws/request.Request" representing the client's request for the UpdateResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateResourceRequest method. req, resp := client.UpdateResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateRestApi ¶
func (c *APIGateway) UpdateRestApi(input *UpdateRestApiInput) (*RestApi, error)
Changes information about the specified API.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateRestApiInput{ RestApiId: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateRestApi(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateRestApiRequest ¶
func (c *APIGateway) UpdateRestApiRequest(input *UpdateRestApiInput) (req *request.Request, output *RestApi)
UpdateRestApiRequest generates a "aws/request.Request" representing the client's request for the UpdateRestApi operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateRestApiRequest method. req, resp := client.UpdateRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateStage ¶
func (c *APIGateway) UpdateStage(input *UpdateStageInput) (*Stage, error)
Changes information about a Stage resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateStageInput{ RestApiId: aws.String("String"), // Required StageName: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateStage(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateStageRequest ¶
func (c *APIGateway) UpdateStageRequest(input *UpdateStageInput) (req *request.Request, output *Stage)
UpdateStageRequest generates a "aws/request.Request" representing the client's request for the UpdateStage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateStage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateStageRequest method. req, resp := client.UpdateStageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateUsage ¶ added in v1.4.2
func (c *APIGateway) UpdateUsage(input *UpdateUsageInput) (*Usage, error)
Grants a temporary extension to the reamining quota of a usage plan associated with a specified API key.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateUsageInput{ KeyId: aws.String("String"), // Required UsagePlanId: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateUsage(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*APIGateway) UpdateUsagePlan ¶ added in v1.4.2
func (c *APIGateway) UpdateUsagePlan(input *UpdateUsagePlanInput) (*UsagePlan, error)
Updates a usage plan of a given plan Id.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/apigateway" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := apigateway.New(sess) params := &apigateway.UpdateUsagePlanInput{ UsagePlanId: aws.String("String"), // Required PatchOperations: []*apigateway.PatchOperation{ { // Required From: aws.String("String"), Op: aws.String("op"), Path: aws.String("String"), Value: aws.String("String"), }, // More values... }, } resp, err := svc.UpdateUsagePlan(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateUsagePlan method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateUsagePlanRequest method. req, resp := client.UpdateUsagePlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) 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 can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateUsage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateUsageRequest method. req, resp := client.UpdateUsageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
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)
type ApiKey ¶
type ApiKey struct { // The date when the API Key was created, in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm" // target="_blank). CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"` // 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"` // When the API Key was last updated, in ISO 8601 format. 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)
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/exports. Has no // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the credentials required for the authorizer, if any. Two options // are available. To specify an IAM role for Amazon API Gateway to assume, use // the role's Amazon Resource Name (ARN). To use resource-based permissions // on the Lambda function, specify null. AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"` // The TTL in seconds of cached authorizer results. If greater than 0, API Gateway // will cache authorizer responses. If this field is not set, the default value // is 300. The maximum value is 3600, or 1 hour. AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` // [Required] Specifies the authorizer's Uniform Resource Identifier (URI). // For TOKEN authorizers, this must be a well-formed Lambda function URI. The // URI should be of the form arn:aws:apigateway:{region}:lambda:path/{service_api}. // Region is used to determine the right endpoint. In this case, path is used // to indicate that the remaining substring in the URI should be treated as // the path to the resource, including the initial /. For Lambda functions, // this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations AuthorizerUri *string `locationName:"authorizerUri" type:"string"` // The identifier for the authorizer resource. Id *string `locationName:"id" type:"string"` // [Required] The source of the identity in an incoming request. For TOKEN authorizers, // this value is a mapping expression with the same syntax as integration parameter // mappings. The only valid source for tokens is 'header', so the expression // should match 'method.request.header.[headerName]'. The value of the header // '[headerName]' will be interpreted as the incoming token. IdentitySource *string `locationName:"identitySource" type:"string"` // A validation expression for the incoming identity. For TOKEN authorizers, // this value should be a regular expression. The incoming token from the client // is matched against this expression, and will proceed if the token matches. // If the token doesn't match, the client receives a 401 Unauthorized response. IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` // [Required] The name of the authorizer. Name *string `locationName:"name" type:"string"` // A list of the provider ARNs of the authorizer. ProviderARNs []*string `locationName:"providerARNs" type:"list"` // [Required] The type of the authorizer. Currently, the only valid type is // TOKEN. 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) 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 name of the API. RestApiId *string `locationName:"restApiId" type:"string"` // The name of the API's stage. Stage *string `locationName:"stage" type:"string"` // contains filtered or unexported fields }
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) 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 date when the client certificate was created, in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm" // target="_blank). CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"` // The description of the client certificate. Description *string `locationName:"description" type:"string"` // The date when the client certificate will expire, in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm" // target="_blank). 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 authenticate an API by the back-end server. To authenticate an API client (or user), use a custom Authorizer. Use Client-Side Certificate (http://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)
func (ClientCertificate) GoString ¶
func (s ClientCertificate) GoString() string
GoString returns the string representation
func (ClientCertificate) String ¶
func (s ClientCertificate) String() string
String returns the string representation
type CreateApiKeyInput ¶
type CreateApiKeyInput struct { // 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) 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/exports. Has no // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the credentials required for the authorizer, if any. AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"` // The TTL of cached authorizer results. AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` // [Required] Specifies the authorizer's Uniform Resource Identifier (URI). AuthorizerUri *string `locationName:"authorizerUri" type:"string"` // [Required] The source of the identity in an incoming request. IdentitySource *string `locationName:"identitySource" type:"string" required:"true"` // A validation expression for the incoming identity. IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` // [Required] The name of the authorizer. Name *string `locationName:"name" type:"string" required:"true"` // A list of the Cognito Your User Pool authorizer's provider ARNs. ProviderARNs []*string `locationName:"providerARNs" type:"list"` // The RestApi identifier under which the Authorizer will be created. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The type of the authorizer. 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) 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 *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // The name of the API that you want to apply this mapping to. 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) 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 RestApi resource identifier for the Deployment resource to create. 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" required:"true"` // 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) 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 CreateDomainNameInput ¶
type CreateDomainNameInput struct { // The body of the server certificate provided by your certificate authority. CertificateBody *string `locationName:"certificateBody" type:"string" required:"true"` // The intermediate certificates and optionally the root certificate, one after // the other without any blank lines. If you include the root certificate, your // certificate chain must start with intermediate certificates and end with // the root certificate. Use the intermediate certificates that were provided // by your certificate authority. Do not include any intermediaries that are // not in the chain of trust path. CertificateChain *string `locationName:"certificateChain" type:"string" required:"true"` // The name of the certificate. CertificateName *string `locationName:"certificateName" type:"string" required:"true"` // Your certificate's private key. CertificatePrivateKey *string `locationName:"certificatePrivateKey" type:"string" required:"true"` // The name of the DomainName resource. DomainName *string `locationName:"domainName" type:"string" required:"true"` // contains filtered or unexported fields }
A request to create a new domain name.
func (CreateDomainNameInput) GoString ¶
func (s CreateDomainNameInput) GoString() string
GoString returns the string representation
func (CreateDomainNameInput) 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 *string `locationName:"contentType" type:"string" required:"true"` // The description of the model. Description *string `locationName:"description" type:"string"` // The name of the model. Name *string `locationName:"name" type:"string" required:"true"` // The RestApi identifier under which the Model will be created. 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" target="_blank) 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) 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 CreateResourceInput ¶
type CreateResourceInput struct { // The parent resource's identifier. ParentId *string `location:"uri" locationName:"parent_id" type:"string" required:"true"` // The last path segment for this resource. PathPart *string `locationName:"pathPart" type:"string" required:"true"` // The identifier of the RestApi for the resource. 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) 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 ID of the RestApi that you want to clone from. CloneFrom *string `locationName:"cloneFrom" type:"string"` // The description of the RestApi. Description *string `locationName:"description" type:"string"` // The name of the RestApi. Name *string `locationName:"name" type:"string" required:"true"` // 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) 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 *string `locationName:"deploymentId" type:"string" required:"true"` // The description of the Stage resource. Description *string `locationName:"description" type:"string"` // The identifier of the RestApi resource for the Stage resource to create. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name for the Stage resource. 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) 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 *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) 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 *string `locationName:"keyId" type:"string" required:"true"` // The type of a UsagePlanKey resource for a plan customer. 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 *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) 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 *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) 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 *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // The RestApi identifier for the Authorizer resource. 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) 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 *string `location:"uri" locationName:"base_path" type:"string" required:"true"` // The domain name of the BasePathMapping resource to delete. 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) 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 *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) 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 *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` // The identifier of the RestApi resource for the Deployment resource to delete. 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) 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 DeleteDomainNameInput ¶
type DeleteDomainNameInput struct { // The name of the DomainName resource to be deleted. 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) 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 DeleteIntegrationInput ¶
type DeleteIntegrationInput struct { // Specifies a delete integration request's HTTP method. HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a delete integration request's resource identifier. ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies a delete integration request's API identifier. 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) 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 *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a delete integration response request's resource identifier. ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies a delete integration response request's API identifier. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies a delete integration response request's status code. 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) 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 *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the Method resource. ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the Method resource. 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) 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 *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the MethodResponse resource. ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the MethodResponse resource. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The status code identifier for the MethodResponse resource. 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) 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 *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // The RestApi under which the model will be deleted. 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) 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 DeleteResourceInput ¶
type DeleteResourceInput struct { // The identifier of the Resource resource. ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the Resource resource. 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) 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 ID of the RestApi you want to delete. 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) 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 identifier of the RestApi resource for the Stage resource to delete. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the Stage resource to delete. 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) 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 *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The DELETE request to delete a uasge 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) 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 *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 *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) 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) String ¶
func (s Deployment) String() string
String returns the string representation
type DomainName ¶
type DomainName struct { // The name of the certificate. CertificateName *string `locationName:"certificateName" type:"string"` // The date when the certificate was uploaded, in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm" // target="_blank). CertificateUploadDate *time.Time `locationName:"certificateUploadDate" type:"timestamp" timestampFormat:"unix"` // The domain name of the Amazon CloudFront distribution. For more information, // see the Amazon CloudFront documentation (http://aws.amazon.com/documentation/cloudfront/" // target="_blank). DistributionDomainName *string `locationName:"distributionDomainName" type:"string"` // The name of the DomainName resource. DomainName *string `locationName:"domainName" type:"string"` // contains filtered or unexported fields }
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
Use Client-Side Certificate (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (DomainName) GoString ¶
func (s DomainName) GoString() string
GoString returns the string representation
func (DomainName) String ¶
func (s DomainName) String() string
String returns the string representation
type FlushStageAuthorizersCacheInput ¶ added in v1.1.8
type FlushStageAuthorizersCacheInput struct { // The API identifier of the stage to flush. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the stage to flush. 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) 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 API identifier of the stage to flush its cache. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the stage to flush its cache. 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) 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) 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 *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) 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 { // A boolean flag to specify whether (true) or not (false) the result contains // key values. IncludeValues *bool `location:"querystring" locationName:"includeValues" type:"boolean"` // The maximum number of ApiKeys to get information about. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The name of queried API keys. NameQuery *string `location:"querystring" locationName:"name" type:"string"` // The position of the current ApiKeys resource to get information about. 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) String ¶
func (s GetApiKeysInput) String() string
String returns the string representation
type GetApiKeysOutput ¶
type GetApiKeysOutput struct { // The current page of any ApiKey resources in the collection of ApiKey resources. Items []*ApiKey `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // A list of warning messages logged during the import of API keys when the // failOnWarnings option is set to true. Warnings []*string `locationName:"warnings" type:"list"` // contains filtered or unexported fields }
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) 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 *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // The RestApi identifier for the Authorizer resource. 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) 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 { // Limit the number of Authorizer resources in the response. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // If not all Authorizer resources in the response were present, the position // will specify where to start the next page of results. Position *string `location:"querystring" locationName:"position" type:"string"` // The RestApi identifier for the Authorizers resource. 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) 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 { // Gets the current list of Authorizer resources in the collection. Items []*Authorizer `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
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) 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 *string `location:"uri" locationName:"base_path" type:"string" required:"true"` // The domain name of the BasePathMapping resource to be described. 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) 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 *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // The maximum number of BasePathMapping resources in the collection to get // information about. The default limit is 25. It should be an integer between // 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The position of the current BasePathMapping resource in the collection to // get information about. 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) 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 any BasePathMapping resources in the collection of base // path mapping resources. Items []*BasePathMapping `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
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) 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 *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) 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 ClientCertificate resources in the collection to get // information about. The default limit is 25. It should be an integer between // 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The position of the current ClientCertificate resource in the collection // to get information about. 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) String ¶
func (s GetClientCertificatesInput) String() string
String returns the string representation
type GetClientCertificatesOutput ¶
type GetClientCertificatesOutput struct { // The current page of any ClientCertificate resources in the collection of // ClientCertificate resources. Items []*ClientCertificate `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
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) 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 *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` // The identifier of the RestApi resource for the Deployment resource to get // information about. 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) 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 Deployment resources in the collection to get information // about. The default limit is 25. It should be an integer between 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The position of the current Deployment resource in the collection to get // information about. Position *string `location:"querystring" locationName:"position" type:"string"` // The identifier of the RestApi resource for the collection of Deployment resources // to get information about. RestApiId *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) 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 any Deployment resources in the collection of deployment // resources. Items []*Deployment `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
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) String ¶
func (s GetDeploymentsOutput) String() string
String returns the string representation
type GetDomainNameInput ¶
type GetDomainNameInput struct { // The name of the DomainName resource. 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) 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 DomainName resources in the collection to get information // about. The default limit is 25. It should be an integer between 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The position of the current domain names to get information about. 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) String ¶
func (s GetDomainNamesInput) String() string
String returns the string representation
type GetDomainNamesOutput ¶
type GetDomainNamesOutput struct { // The current page of any DomainName resources in the collection of DomainName // resources. Items []*DomainName `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
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) 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 *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 exportType swagger, any // combination of the following parameters are supported: integrations will // export the API with x-amazon-apigateway-integration extensions. authorizers // will export the API with x-amazon-apigateway-authorizer extensions. postman // will export the API with Postman extensions, allowing for import to the Postman // tool Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // The identifier of the RestApi to be exported. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the Stage that will be exported. 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) 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) String ¶ added in v1.1.2
func (s GetExportOutput) String() string
String returns the string representation
type GetIntegrationInput ¶
type GetIntegrationInput struct { // Specifies a get integration request's HTTP method. HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a get integration request's resource identifier ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies a get integration request's API identifier. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a get integration request.
func (GetIntegrationInput) GoString ¶
func (s GetIntegrationInput) GoString() string
GoString returns the string representation
func (GetIntegrationInput) 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 *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a get integration response request's resource identifier. ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies a get integration response request's API identifier. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies a get integration response request's status code. 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) 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 *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the Method resource. ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the Method resource. 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) 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 *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the MethodResponse resource. ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the MethodResponse resource. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The status code for the MethodResponse resource. 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) 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 *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // The RestApi identifier under which the Model exists. 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) 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 *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // The ID of the RestApi under which the model exists. 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) 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" // target="_blank) 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) String ¶
func (s GetModelTemplateOutput) String() string
String returns the string representation
type GetModelsInput ¶
type GetModelsInput struct { // The maximum number of models in the collection to get information about. // The default limit is 25. It should be an integer between 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The position of the next set of results in the Models resource to get information // about. Position *string `location:"querystring" locationName:"position" type:"string"` // The RestApi identifier. 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) 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 { // Gets the current Model resource in the collection. Items []*Model `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
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) String ¶
func (s GetModelsOutput) String() string
String returns the string representation
type GetResourceInput ¶
type GetResourceInput struct { // The identifier for the Resource resource. ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the resource. 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) 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 { // The maximum number of Resource resources in the collection to get information // about. The default limit is 25. It should be an integer between 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The position of the next set of results in the current Resources resource // to get information about. Position *string `location:"querystring" locationName:"position" type:"string"` // The RestApi identifier for the Resource. 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) 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 { // Gets the current Resource resource in the collection. Items []*Resource `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
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) String ¶
func (s GetResourcesOutput) String() string
String returns the string representation
type GetRestApiInput ¶
type GetRestApiInput struct { // The identifier of the RestApi resource. 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) 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 RestApi resources in the collection to get information // about. The default limit is 25. It should be an integer between 1 - 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The position of the current RestApis resource in the collection to get information // about. 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) String ¶
func (s GetRestApisInput) String() string
String returns the string representation
type GetRestApisOutput ¶
type GetRestApisOutput struct { // An array of links to the current page of RestApi resources. Items []*RestApi `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
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) String ¶
func (s GetRestApisOutput) String() string
String returns the string representation
type GetSdkInput ¶
type GetSdkInput struct { // A key-value map of query string parameters that specify properties of the // SDK, depending on the requested sdkType. For sdkType of objectivec, a parameter // named classPrefix is required. For sdkType of android, parameters named groupId, // artifactId, artifactVersion, and invokerPackage are required. Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // The identifier of the RestApi that the SDK will use. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The language for the generated SDK. Currently javascript, android, and objectivec // (for iOS) are supported. SdkType *string `location:"uri" locationName:"sdk_type" type:"string" required:"true"` // The name of the Stage that the SDK will use. 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) 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) String ¶
func (s GetSdkOutput) String() string
String returns the string representation
type GetStageInput ¶
type GetStageInput struct { // The identifier of the RestApi resource for the Stage resource to get information // about. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the Stage resource to get information about. 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) 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 stages' API identifiers. 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) 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 { // An individual Stage resource. 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) 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 *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 results to be returned. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // Position Position *string `location:"querystring" locationName:"position" type:"string"` // The starting date (e.g., 2016-01-01) of the usage data. StartDate *string `location:"querystring" locationName:"startDate" type:"string" required:"true"` // The Id of the usage plan associated with the usage data. 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) 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 *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) 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 *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 *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) 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 { // A query parameter specifying the maximum number usage plan keys returned // by the GET request. 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"` // A query parameter specifying the zero-based index specifying the position // of a usage plan key. 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 *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) 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 { // Gets the current item of the usage plan keys collection. Items []*UsagePlanKey `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
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) 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 number of UsagePlan resources to be returned as the result. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The zero-based array index specifying the position of the to-be-retrieved // UsagePlan resource. 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) 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 { // Gets the current item when enumerating the collection of UsagePlan. Items []*UsagePlan `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
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) 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 []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 *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) 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 API key used to reference an API key in a usage plan.
func (ImportApiKeysOutput) GoString ¶ added in v1.4.2
func (s ImportApiKeysOutput) GoString() string
GoString returns the string representation
func (ImportApiKeysOutput) String ¶ added in v1.4.2
func (s ImportApiKeysOutput) 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. Body []byte `locationName:"body" type:"blob" required:"true"` // A query parameter to indicate whether to rollback the API creation (true) // or not (false) when a warning is encountered. The default value is false. FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` // Custom header parameters as part of the request. Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // contains filtered or unexported fields }
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) 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 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 OK status 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" } Creating an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) IntegrationResponses map[string]*IntegrationResponse `locationName:"integrationResponses" type:"map"` // Specifies how the method request body of an unmapped content type will be // passed through the integration request to the back end without transformation. // A content type is unmapped if no mapping template is defined in the integration // or the content type does not match any of the mapped content types, as specified // in requestTemplates. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, // and NEVER. // // WHEN_NO_MATCH passes the method request body through the integration request // to the back end without transformation when the method request content type // does not match any content type associated with the mapping templates defined // in the integration request. WHEN_NO_TEMPLATES passes the method request // body through the integration request to the back end without transformation // when no mapping template is defined in the integration request. If a template // is defined when this option is selected, the method request of an unmapped // content-type will be rejected with an HTTP 415 Unsupported Media Type response. // NEVER rejects the method request with an HTTP 415 Unsupported Media Type // response when either the method request content type does not match any content // type associated with the mapping templates defined in the integration request // or no mapping template is defined in the integration request. PassthroughBehavior *string `locationName:"passthroughBehavior" type:"string"` // A key-value map specifying request parameters that are passed from the method // request to the back end. The key is an integration request parameter name // and the associated value is a method request parameter value or static value // that must be enclosed within single quotes and pre-encoded as required by // the back end. The method request parameter value must match the pattern of // method.request.{location}.{name}, where location is querystring, path, or // header and name must be a valid and unique method request parameter name. RequestParameters map[string]*string `locationName:"requestParameters" type:"map"` // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the // value. RequestTemplates map[string]*string `locationName:"requestTemplates" type:"map"` // Specifies the integration's type. The valid value is HTTP, AWS, or MOCK. 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://www.ietf.org/rfc/rfc3986.txt" target="_blank). 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, AWS, 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) String ¶
func (s Integration) String() string
String returns the string representation
type IntegrationResponse ¶
type IntegrationResponse struct { // 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) 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. 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 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 } ], "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" } } // } AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html) 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" } // AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) MethodResponses map[string]*MethodResponse `locationName:"methodResponses" type:"map"` // 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"` // 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)
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" }
Method, IntegrationResponse, Integration Creating an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (MethodResponse) GoString ¶
func (s MethodResponse) GoString() string
GoString returns the string representation
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) 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"` // Specifies the type of authorization used for the method. 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) 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. 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" target="_blank) 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)
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. 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) String ¶
func (s PatchOperation) String() string
String returns the string representation
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 whether credentials are required for a put integration. Credentials *string `locationName:"credentials" type:"string"` // Specifies a put integration request's HTTP method. 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 *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies a put integration request's API identifier. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies a put integration input's type. Type *string `locationName:"type" type:"string" required:"true" enum:"IntegrationType"` // Specifies a put integration input's Uniform Resource Identifier (URI). When // the integration type is HTTP or AWS, this field is required. For integration // with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' // format. Uri *string `locationName:"uri" type:"string"` // contains filtered or unexported fields }
Represents a put integration request.
func (PutIntegrationInput) GoString ¶
func (s PutIntegrationInput) GoString() string
GoString returns the string representation
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 a put integration response request's HTTP method. HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a put integration response request's resource identifier. ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // A key-value map specifying response parameters that are passed to the method // response from the back end. The key is a method response header parameter // name and the mapped value is an integration response header value, a static // value enclosed within a pair of single quotes, or a JSON expression from // the integration response body. The mapping key must match the pattern of // method.response.header.{name}, where name is a valid and unique header name. // The mapped non-static value must match the pattern of integration.response.header.{name} // or integration.response.body.{JSON-expression}, where name must be a valid // and unique response header name and JSON-expression a valid JSON expression // without the $ prefix. ResponseParameters map[string]*string `locationName:"responseParameters" type:"map"` // Specifies a put integration response's templates. ResponseTemplates map[string]*string `locationName:"responseTemplates" type:"map"` // Specifies a put integration response request's API identifier. RestApiId *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 *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) 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"` // Specifies the type of authorization used for the method. 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 *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // 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 Resource identifier for the new Method resource. ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the new Method resource. 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) 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 *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the Method resource. ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies the Model resources used for the response's content type. Response // models are represented as a key/value map, with a content type as the key // and a Model name as the value. ResponseModels map[string]*string `locationName:"responseModels" type:"map"` // A key-value map specifying required or optional response parameters that // Amazon API Gateway can send back to the caller. A key defines a method response // header name and the associated value is a Boolean flag indicating whether // the method response parameter is required or not. The method response header // names must match the pattern of method.response.header.{name}, where name // is a valid and unique header name. The response parameter names defined here // are available in the integration response to be mapped from an integration // response header expressed in integration.response.header.{name}, a static // value enclosed within a pair of single quotes (e.g., 'application/json'), // or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, // where JSON-expression is a valid JSON expression without the $ prefix.) ResponseParameters map[string]*bool `locationName:"responseParameters" type:"map"` // The RestApi identifier for the Method resource. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The method response's status code. 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) 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. Body []byte `locationName:"body" type:"blob" required:"true"` // A query parameter to indicate whether to rollback the API update (true) or // not (false) when a warning is encountered. The default value is false. FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` // The mode query parameter to specify the update mode. Valid values are "merge" // and "overwrite". By default, the update mode is "merge". Mode *string `location:"querystring" locationName:"mode" type:"string" enum:"PutMode"` // Custom headers supplied as part of the request. Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // The identifier of the RestApi to be updated. RestApiId *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) 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) 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: 20160608T031827Z // Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160608/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)
type RestApi ¶
type RestApi struct { // The date when the API was created, in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm" // target="_blank). CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"` // The API's description. Description *string `locationName:"description" type:"string"` // The API's identifier. This identifier is unique across all of your APIs in // Amazon API Gateway. Id *string `locationName:"id" type:"string"` // The API's name. Name *string `locationName:"name" type:"string"` // 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)
type Stage ¶
type Stage struct { // Specifies whether a cache cluster is enabled for the stage. CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` // The size of the cache cluster for the stage, if enabled. CacheClusterSize *string `locationName:"cacheClusterSize" type:"string" enum:"CacheClusterSize"` // The status of the cache cluster for the stage, if enabled. CacheClusterStatus *string `locationName:"cacheClusterStatus" type:"string" enum:"CacheClusterStatus"` // The identifier of a client certificate for an API stage. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // The date and time that the stage was created, in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm" // target="_blank). 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 date and time that information about the stage was last updated, in ISO // 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm" target="_blank). 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. Any forward slash ("/") characters in the resource_path part must // be encoded as "~1" as in, for example, ~1resource~1sub-resource/GET. 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)
type StageKey ¶
type StageKey struct { // A list of Stage resources that are associated with the ApiKey resource. RestApiId *string `locationName:"restApiId" type:"string"` // The stage name in the RestApi that the stage key references. StageName *string `locationName:"stageName" type:"string"` // contains filtered or unexported fields }
A reference to a unique stage identified in the format {restApiId}/{stage}.
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 *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // [Optional] The simulated request body of an incoming invocation request. Body *string `locationName:"body" type:"string"` // [Required] A key-value map of headers to simulate an incoming invocation // request. This is where the incoming authorization token, or identity source, // should be specified. Headers map[string]*string `locationName:"headers" type:"map"` // [Optional] The URI path, including query string, of the simulated invocation // request. Use this to specify path parameters and query string parameters. PathWithQueryString *string `locationName:"pathWithQueryString" type:"string"` // Specifies a test invoke authorizer request's RestApi identifier. RestApiId *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) 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) 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 *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 *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies a test invoke method request's API identifier. 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) 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) 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) 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) 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 *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) 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 *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The RestApi identifier for the Authorizer resource. RestApiId *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) 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 *string `location:"uri" locationName:"base_path" type:"string" required:"true"` // The domain name of the BasePathMapping resource to change. 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) 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 *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) 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 *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The replacement identifier of the RestApi resource for the Deployment resource // to change information about. RestApiId *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) 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 UpdateDomainNameInput ¶
type UpdateDomainNameInput struct { // The name of the DomainName resource to be changed. 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) 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 UpdateIntegrationInput ¶
type UpdateIntegrationInput struct { // Represents an update integration request's HTTP method. 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 *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Represents an update integration request's API identifier. 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) 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 *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 *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies an update integration response request's API identifier. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies an update integration response request's status code. 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) 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 *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 *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the Method resource. 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) 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 *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 *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the MethodResponse resource. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The status code for the MethodResponse resource. 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) 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 *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The RestApi identifier under which the model exists. RestApiId *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) 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 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 *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the Resource resource. 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) 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 ID of the RestApi you want to update. 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) 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 identifier of the RestApi resource for the Stage resource to change information // about. RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the Stage resource to change information about. 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) 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 *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 *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The PATCH request to grant a temporary extension to the reamining 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) 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 *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) 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)
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 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)
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) String ¶ added in v1.4.2
func (s UsagePlanKey) String() string
String returns the string representation
Directories ¶
Path | Synopsis |
---|---|
Package apigatewayiface provides an interface for the Amazon API Gateway.
|
Package apigatewayiface provides an interface for the Amazon API Gateway. |