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) CreateDocumentationPart(input *CreateDocumentationPartInput) (*DocumentationPart, error)
- func (c *APIGateway) CreateDocumentationPartRequest(input *CreateDocumentationPartInput) (req *request.Request, output *DocumentationPart)
- func (c *APIGateway) CreateDocumentationVersion(input *CreateDocumentationVersionInput) (*DocumentationVersion, error)
- func (c *APIGateway) CreateDocumentationVersionRequest(input *CreateDocumentationVersionInput) (req *request.Request, output *DocumentationVersion)
- 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) DeleteDocumentationPart(input *DeleteDocumentationPartInput) (*DeleteDocumentationPartOutput, error)
- func (c *APIGateway) DeleteDocumentationPartRequest(input *DeleteDocumentationPartInput) (req *request.Request, output *DeleteDocumentationPartOutput)
- func (c *APIGateway) DeleteDocumentationVersion(input *DeleteDocumentationVersionInput) (*DeleteDocumentationVersionOutput, error)
- func (c *APIGateway) DeleteDocumentationVersionRequest(input *DeleteDocumentationVersionInput) (req *request.Request, output *DeleteDocumentationVersionOutput)
- 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) GetDocumentationPart(input *GetDocumentationPartInput) (*DocumentationPart, error)
- func (c *APIGateway) GetDocumentationPartRequest(input *GetDocumentationPartInput) (req *request.Request, output *DocumentationPart)
- func (c *APIGateway) GetDocumentationParts(input *GetDocumentationPartsInput) (*GetDocumentationPartsOutput, error)
- func (c *APIGateway) GetDocumentationPartsRequest(input *GetDocumentationPartsInput) (req *request.Request, output *GetDocumentationPartsOutput)
- func (c *APIGateway) GetDocumentationVersion(input *GetDocumentationVersionInput) (*DocumentationVersion, error)
- func (c *APIGateway) GetDocumentationVersionRequest(input *GetDocumentationVersionInput) (req *request.Request, output *DocumentationVersion)
- func (c *APIGateway) GetDocumentationVersions(input *GetDocumentationVersionsInput) (*GetDocumentationVersionsOutput, error)
- func (c *APIGateway) GetDocumentationVersionsRequest(input *GetDocumentationVersionsInput) (req *request.Request, output *GetDocumentationVersionsOutput)
- 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) GetSdkType(input *GetSdkTypeInput) (*SdkType, error)
- func (c *APIGateway) GetSdkTypeRequest(input *GetSdkTypeInput) (req *request.Request, output *SdkType)
- func (c *APIGateway) GetSdkTypes(input *GetSdkTypesInput) (*GetSdkTypesOutput, error)
- func (c *APIGateway) GetSdkTypesRequest(input *GetSdkTypesInput) (req *request.Request, output *GetSdkTypesOutput)
- 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) ImportDocumentationParts(input *ImportDocumentationPartsInput) (*ImportDocumentationPartsOutput, error)
- func (c *APIGateway) ImportDocumentationPartsRequest(input *ImportDocumentationPartsInput) (req *request.Request, output *ImportDocumentationPartsOutput)
- 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) UpdateDocumentationPart(input *UpdateDocumentationPartInput) (*DocumentationPart, error)
- func (c *APIGateway) UpdateDocumentationPartRequest(input *UpdateDocumentationPartInput) (req *request.Request, output *DocumentationPart)
- func (c *APIGateway) UpdateDocumentationVersion(input *UpdateDocumentationVersionInput) (*DocumentationVersion, error)
- func (c *APIGateway) UpdateDocumentationVersionRequest(input *UpdateDocumentationVersionInput) (req *request.Request, output *DocumentationVersion)
- 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
- func (s ApiKey) GoString() string
- func (s *ApiKey) SetCreatedDate(v time.Time) *ApiKey
- func (s *ApiKey) SetCustomerId(v string) *ApiKey
- func (s *ApiKey) SetDescription(v string) *ApiKey
- func (s *ApiKey) SetEnabled(v bool) *ApiKey
- func (s *ApiKey) SetId(v string) *ApiKey
- func (s *ApiKey) SetLastUpdatedDate(v time.Time) *ApiKey
- func (s *ApiKey) SetName(v string) *ApiKey
- func (s *ApiKey) SetStageKeys(v []*string) *ApiKey
- func (s *ApiKey) SetValue(v string) *ApiKey
- func (s ApiKey) String() string
- type ApiStage
- type Authorizer
- func (s Authorizer) GoString() string
- func (s *Authorizer) SetAuthType(v string) *Authorizer
- func (s *Authorizer) SetAuthorizerCredentials(v string) *Authorizer
- func (s *Authorizer) SetAuthorizerResultTtlInSeconds(v int64) *Authorizer
- func (s *Authorizer) SetAuthorizerUri(v string) *Authorizer
- func (s *Authorizer) SetId(v string) *Authorizer
- func (s *Authorizer) SetIdentitySource(v string) *Authorizer
- func (s *Authorizer) SetIdentityValidationExpression(v string) *Authorizer
- func (s *Authorizer) SetName(v string) *Authorizer
- func (s *Authorizer) SetProviderARNs(v []*string) *Authorizer
- func (s *Authorizer) SetType(v string) *Authorizer
- func (s Authorizer) String() string
- type BasePathMapping
- type ClientCertificate
- func (s ClientCertificate) GoString() string
- func (s *ClientCertificate) SetClientCertificateId(v string) *ClientCertificate
- func (s *ClientCertificate) SetCreatedDate(v time.Time) *ClientCertificate
- func (s *ClientCertificate) SetDescription(v string) *ClientCertificate
- func (s *ClientCertificate) SetExpirationDate(v time.Time) *ClientCertificate
- func (s *ClientCertificate) SetPemEncodedCertificate(v string) *ClientCertificate
- func (s ClientCertificate) String() string
- type CreateApiKeyInput
- func (s CreateApiKeyInput) GoString() string
- func (s *CreateApiKeyInput) SetCustomerId(v string) *CreateApiKeyInput
- func (s *CreateApiKeyInput) SetDescription(v string) *CreateApiKeyInput
- func (s *CreateApiKeyInput) SetEnabled(v bool) *CreateApiKeyInput
- func (s *CreateApiKeyInput) SetGenerateDistinctId(v bool) *CreateApiKeyInput
- func (s *CreateApiKeyInput) SetName(v string) *CreateApiKeyInput
- func (s *CreateApiKeyInput) SetStageKeys(v []*StageKey) *CreateApiKeyInput
- func (s *CreateApiKeyInput) SetValue(v string) *CreateApiKeyInput
- func (s CreateApiKeyInput) String() string
- type CreateAuthorizerInput
- func (s CreateAuthorizerInput) GoString() string
- func (s *CreateAuthorizerInput) SetAuthType(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetAuthorizerCredentials(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetAuthorizerResultTtlInSeconds(v int64) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetAuthorizerUri(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetIdentitySource(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetIdentityValidationExpression(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetName(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetProviderARNs(v []*string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetRestApiId(v string) *CreateAuthorizerInput
- func (s *CreateAuthorizerInput) SetType(v string) *CreateAuthorizerInput
- func (s CreateAuthorizerInput) String() string
- func (s *CreateAuthorizerInput) Validate() error
- type CreateBasePathMappingInput
- func (s CreateBasePathMappingInput) GoString() string
- func (s *CreateBasePathMappingInput) SetBasePath(v string) *CreateBasePathMappingInput
- func (s *CreateBasePathMappingInput) SetDomainName(v string) *CreateBasePathMappingInput
- func (s *CreateBasePathMappingInput) SetRestApiId(v string) *CreateBasePathMappingInput
- func (s *CreateBasePathMappingInput) SetStage(v string) *CreateBasePathMappingInput
- func (s CreateBasePathMappingInput) String() string
- func (s *CreateBasePathMappingInput) Validate() error
- type CreateDeploymentInput
- func (s CreateDeploymentInput) GoString() string
- func (s *CreateDeploymentInput) SetCacheClusterEnabled(v bool) *CreateDeploymentInput
- func (s *CreateDeploymentInput) SetCacheClusterSize(v string) *CreateDeploymentInput
- func (s *CreateDeploymentInput) SetDescription(v string) *CreateDeploymentInput
- func (s *CreateDeploymentInput) SetRestApiId(v string) *CreateDeploymentInput
- func (s *CreateDeploymentInput) SetStageDescription(v string) *CreateDeploymentInput
- func (s *CreateDeploymentInput) SetStageName(v string) *CreateDeploymentInput
- func (s *CreateDeploymentInput) SetVariables(v map[string]*string) *CreateDeploymentInput
- func (s CreateDeploymentInput) String() string
- func (s *CreateDeploymentInput) Validate() error
- type CreateDocumentationPartInput
- func (s CreateDocumentationPartInput) GoString() string
- func (s *CreateDocumentationPartInput) SetLocation(v *DocumentationPartLocation) *CreateDocumentationPartInput
- func (s *CreateDocumentationPartInput) SetProperties(v string) *CreateDocumentationPartInput
- func (s *CreateDocumentationPartInput) SetRestApiId(v string) *CreateDocumentationPartInput
- func (s CreateDocumentationPartInput) String() string
- func (s *CreateDocumentationPartInput) Validate() error
- type CreateDocumentationVersionInput
- func (s CreateDocumentationVersionInput) GoString() string
- func (s *CreateDocumentationVersionInput) SetDescription(v string) *CreateDocumentationVersionInput
- func (s *CreateDocumentationVersionInput) SetDocumentationVersion(v string) *CreateDocumentationVersionInput
- func (s *CreateDocumentationVersionInput) SetRestApiId(v string) *CreateDocumentationVersionInput
- func (s *CreateDocumentationVersionInput) SetStageName(v string) *CreateDocumentationVersionInput
- func (s CreateDocumentationVersionInput) String() string
- func (s *CreateDocumentationVersionInput) Validate() error
- type CreateDomainNameInput
- func (s CreateDomainNameInput) GoString() string
- func (s *CreateDomainNameInput) SetCertificateBody(v string) *CreateDomainNameInput
- func (s *CreateDomainNameInput) SetCertificateChain(v string) *CreateDomainNameInput
- func (s *CreateDomainNameInput) SetCertificateName(v string) *CreateDomainNameInput
- func (s *CreateDomainNameInput) SetCertificatePrivateKey(v string) *CreateDomainNameInput
- func (s *CreateDomainNameInput) SetDomainName(v string) *CreateDomainNameInput
- func (s CreateDomainNameInput) String() string
- func (s *CreateDomainNameInput) Validate() error
- type CreateModelInput
- func (s CreateModelInput) GoString() string
- func (s *CreateModelInput) SetContentType(v string) *CreateModelInput
- func (s *CreateModelInput) SetDescription(v string) *CreateModelInput
- func (s *CreateModelInput) SetName(v string) *CreateModelInput
- func (s *CreateModelInput) SetRestApiId(v string) *CreateModelInput
- func (s *CreateModelInput) SetSchema(v string) *CreateModelInput
- func (s CreateModelInput) String() string
- func (s *CreateModelInput) Validate() error
- type CreateResourceInput
- func (s CreateResourceInput) GoString() string
- func (s *CreateResourceInput) SetParentId(v string) *CreateResourceInput
- func (s *CreateResourceInput) SetPathPart(v string) *CreateResourceInput
- func (s *CreateResourceInput) SetRestApiId(v string) *CreateResourceInput
- func (s CreateResourceInput) String() string
- func (s *CreateResourceInput) Validate() error
- type CreateRestApiInput
- func (s CreateRestApiInput) GoString() string
- func (s *CreateRestApiInput) SetBinaryMediaTypes(v []*string) *CreateRestApiInput
- func (s *CreateRestApiInput) SetCloneFrom(v string) *CreateRestApiInput
- func (s *CreateRestApiInput) SetDescription(v string) *CreateRestApiInput
- func (s *CreateRestApiInput) SetName(v string) *CreateRestApiInput
- func (s *CreateRestApiInput) SetVersion(v string) *CreateRestApiInput
- func (s CreateRestApiInput) String() string
- func (s *CreateRestApiInput) Validate() error
- type CreateStageInput
- func (s CreateStageInput) GoString() string
- func (s *CreateStageInput) SetCacheClusterEnabled(v bool) *CreateStageInput
- func (s *CreateStageInput) SetCacheClusterSize(v string) *CreateStageInput
- func (s *CreateStageInput) SetDeploymentId(v string) *CreateStageInput
- func (s *CreateStageInput) SetDescription(v string) *CreateStageInput
- func (s *CreateStageInput) SetDocumentationVersion(v string) *CreateStageInput
- func (s *CreateStageInput) SetRestApiId(v string) *CreateStageInput
- func (s *CreateStageInput) SetStageName(v string) *CreateStageInput
- func (s *CreateStageInput) SetVariables(v map[string]*string) *CreateStageInput
- func (s CreateStageInput) String() string
- func (s *CreateStageInput) Validate() error
- type CreateUsagePlanInput
- func (s CreateUsagePlanInput) GoString() string
- func (s *CreateUsagePlanInput) SetApiStages(v []*ApiStage) *CreateUsagePlanInput
- func (s *CreateUsagePlanInput) SetDescription(v string) *CreateUsagePlanInput
- func (s *CreateUsagePlanInput) SetName(v string) *CreateUsagePlanInput
- func (s *CreateUsagePlanInput) SetQuota(v *QuotaSettings) *CreateUsagePlanInput
- func (s *CreateUsagePlanInput) SetThrottle(v *ThrottleSettings) *CreateUsagePlanInput
- func (s CreateUsagePlanInput) String() string
- func (s *CreateUsagePlanInput) Validate() error
- type CreateUsagePlanKeyInput
- func (s CreateUsagePlanKeyInput) GoString() string
- func (s *CreateUsagePlanKeyInput) SetKeyId(v string) *CreateUsagePlanKeyInput
- func (s *CreateUsagePlanKeyInput) SetKeyType(v string) *CreateUsagePlanKeyInput
- func (s *CreateUsagePlanKeyInput) SetUsagePlanId(v string) *CreateUsagePlanKeyInput
- func (s CreateUsagePlanKeyInput) String() string
- func (s *CreateUsagePlanKeyInput) Validate() error
- type DeleteApiKeyInput
- type DeleteApiKeyOutput
- type DeleteAuthorizerInput
- func (s DeleteAuthorizerInput) GoString() string
- func (s *DeleteAuthorizerInput) SetAuthorizerId(v string) *DeleteAuthorizerInput
- func (s *DeleteAuthorizerInput) SetRestApiId(v string) *DeleteAuthorizerInput
- func (s DeleteAuthorizerInput) String() string
- func (s *DeleteAuthorizerInput) Validate() error
- type DeleteAuthorizerOutput
- type DeleteBasePathMappingInput
- func (s DeleteBasePathMappingInput) GoString() string
- func (s *DeleteBasePathMappingInput) SetBasePath(v string) *DeleteBasePathMappingInput
- func (s *DeleteBasePathMappingInput) SetDomainName(v string) *DeleteBasePathMappingInput
- func (s DeleteBasePathMappingInput) String() string
- func (s *DeleteBasePathMappingInput) Validate() error
- type DeleteBasePathMappingOutput
- type DeleteClientCertificateInput
- type DeleteClientCertificateOutput
- type DeleteDeploymentInput
- func (s DeleteDeploymentInput) GoString() string
- func (s *DeleteDeploymentInput) SetDeploymentId(v string) *DeleteDeploymentInput
- func (s *DeleteDeploymentInput) SetRestApiId(v string) *DeleteDeploymentInput
- func (s DeleteDeploymentInput) String() string
- func (s *DeleteDeploymentInput) Validate() error
- type DeleteDeploymentOutput
- type DeleteDocumentationPartInput
- func (s DeleteDocumentationPartInput) GoString() string
- func (s *DeleteDocumentationPartInput) SetDocumentationPartId(v string) *DeleteDocumentationPartInput
- func (s *DeleteDocumentationPartInput) SetRestApiId(v string) *DeleteDocumentationPartInput
- func (s DeleteDocumentationPartInput) String() string
- func (s *DeleteDocumentationPartInput) Validate() error
- type DeleteDocumentationPartOutput
- type DeleteDocumentationVersionInput
- func (s DeleteDocumentationVersionInput) GoString() string
- func (s *DeleteDocumentationVersionInput) SetDocumentationVersion(v string) *DeleteDocumentationVersionInput
- func (s *DeleteDocumentationVersionInput) SetRestApiId(v string) *DeleteDocumentationVersionInput
- func (s DeleteDocumentationVersionInput) String() string
- func (s *DeleteDocumentationVersionInput) Validate() error
- type DeleteDocumentationVersionOutput
- type DeleteDomainNameInput
- type DeleteDomainNameOutput
- type DeleteIntegrationInput
- func (s DeleteIntegrationInput) GoString() string
- func (s *DeleteIntegrationInput) SetHttpMethod(v string) *DeleteIntegrationInput
- func (s *DeleteIntegrationInput) SetResourceId(v string) *DeleteIntegrationInput
- func (s *DeleteIntegrationInput) SetRestApiId(v string) *DeleteIntegrationInput
- func (s DeleteIntegrationInput) String() string
- func (s *DeleteIntegrationInput) Validate() error
- type DeleteIntegrationOutput
- type DeleteIntegrationResponseInput
- func (s DeleteIntegrationResponseInput) GoString() string
- func (s *DeleteIntegrationResponseInput) SetHttpMethod(v string) *DeleteIntegrationResponseInput
- func (s *DeleteIntegrationResponseInput) SetResourceId(v string) *DeleteIntegrationResponseInput
- func (s *DeleteIntegrationResponseInput) SetRestApiId(v string) *DeleteIntegrationResponseInput
- func (s *DeleteIntegrationResponseInput) SetStatusCode(v string) *DeleteIntegrationResponseInput
- func (s DeleteIntegrationResponseInput) String() string
- func (s *DeleteIntegrationResponseInput) Validate() error
- type DeleteIntegrationResponseOutput
- type DeleteMethodInput
- func (s DeleteMethodInput) GoString() string
- func (s *DeleteMethodInput) SetHttpMethod(v string) *DeleteMethodInput
- func (s *DeleteMethodInput) SetResourceId(v string) *DeleteMethodInput
- func (s *DeleteMethodInput) SetRestApiId(v string) *DeleteMethodInput
- func (s DeleteMethodInput) String() string
- func (s *DeleteMethodInput) Validate() error
- type DeleteMethodOutput
- type DeleteMethodResponseInput
- func (s DeleteMethodResponseInput) GoString() string
- func (s *DeleteMethodResponseInput) SetHttpMethod(v string) *DeleteMethodResponseInput
- func (s *DeleteMethodResponseInput) SetResourceId(v string) *DeleteMethodResponseInput
- func (s *DeleteMethodResponseInput) SetRestApiId(v string) *DeleteMethodResponseInput
- func (s *DeleteMethodResponseInput) SetStatusCode(v string) *DeleteMethodResponseInput
- func (s DeleteMethodResponseInput) String() string
- func (s *DeleteMethodResponseInput) Validate() error
- type DeleteMethodResponseOutput
- type DeleteModelInput
- type DeleteModelOutput
- type DeleteResourceInput
- type DeleteResourceOutput
- type DeleteRestApiInput
- type DeleteRestApiOutput
- type DeleteStageInput
- type DeleteStageOutput
- type DeleteUsagePlanInput
- type DeleteUsagePlanKeyInput
- func (s DeleteUsagePlanKeyInput) GoString() string
- func (s *DeleteUsagePlanKeyInput) SetKeyId(v string) *DeleteUsagePlanKeyInput
- func (s *DeleteUsagePlanKeyInput) SetUsagePlanId(v string) *DeleteUsagePlanKeyInput
- func (s DeleteUsagePlanKeyInput) String() string
- func (s *DeleteUsagePlanKeyInput) Validate() error
- type DeleteUsagePlanKeyOutput
- type DeleteUsagePlanOutput
- type Deployment
- func (s Deployment) GoString() string
- func (s *Deployment) SetApiSummary(v map[string]map[string]*MethodSnapshot) *Deployment
- func (s *Deployment) SetCreatedDate(v time.Time) *Deployment
- func (s *Deployment) SetDescription(v string) *Deployment
- func (s *Deployment) SetId(v string) *Deployment
- func (s Deployment) String() string
- type DocumentationPart
- func (s DocumentationPart) GoString() string
- func (s *DocumentationPart) SetId(v string) *DocumentationPart
- func (s *DocumentationPart) SetLocation(v *DocumentationPartLocation) *DocumentationPart
- func (s *DocumentationPart) SetProperties(v string) *DocumentationPart
- func (s DocumentationPart) String() string
- type DocumentationPartLocation
- func (s DocumentationPartLocation) GoString() string
- func (s *DocumentationPartLocation) SetMethod(v string) *DocumentationPartLocation
- func (s *DocumentationPartLocation) SetName(v string) *DocumentationPartLocation
- func (s *DocumentationPartLocation) SetPath(v string) *DocumentationPartLocation
- func (s *DocumentationPartLocation) SetStatusCode(v string) *DocumentationPartLocation
- func (s *DocumentationPartLocation) SetType(v string) *DocumentationPartLocation
- func (s DocumentationPartLocation) String() string
- func (s *DocumentationPartLocation) Validate() error
- type DocumentationVersion
- func (s DocumentationVersion) GoString() string
- func (s *DocumentationVersion) SetCreatedDate(v time.Time) *DocumentationVersion
- func (s *DocumentationVersion) SetDescription(v string) *DocumentationVersion
- func (s *DocumentationVersion) SetVersion(v string) *DocumentationVersion
- func (s DocumentationVersion) String() string
- type DomainName
- func (s DomainName) GoString() string
- func (s *DomainName) SetCertificateName(v string) *DomainName
- func (s *DomainName) SetCertificateUploadDate(v time.Time) *DomainName
- func (s *DomainName) SetDistributionDomainName(v string) *DomainName
- func (s *DomainName) SetDomainName(v string) *DomainName
- func (s DomainName) String() string
- type FlushStageAuthorizersCacheInput
- func (s FlushStageAuthorizersCacheInput) GoString() string
- func (s *FlushStageAuthorizersCacheInput) SetRestApiId(v string) *FlushStageAuthorizersCacheInput
- func (s *FlushStageAuthorizersCacheInput) SetStageName(v string) *FlushStageAuthorizersCacheInput
- func (s FlushStageAuthorizersCacheInput) String() string
- func (s *FlushStageAuthorizersCacheInput) Validate() error
- type FlushStageAuthorizersCacheOutput
- type FlushStageCacheInput
- type FlushStageCacheOutput
- type GenerateClientCertificateInput
- type GetAccountInput
- type GetApiKeyInput
- type GetApiKeysInput
- func (s GetApiKeysInput) GoString() string
- func (s *GetApiKeysInput) SetCustomerId(v string) *GetApiKeysInput
- func (s *GetApiKeysInput) SetIncludeValues(v bool) *GetApiKeysInput
- func (s *GetApiKeysInput) SetLimit(v int64) *GetApiKeysInput
- func (s *GetApiKeysInput) SetNameQuery(v string) *GetApiKeysInput
- func (s *GetApiKeysInput) SetPosition(v string) *GetApiKeysInput
- func (s GetApiKeysInput) String() string
- type GetApiKeysOutput
- type GetAuthorizerInput
- type GetAuthorizersInput
- func (s GetAuthorizersInput) GoString() string
- func (s *GetAuthorizersInput) SetLimit(v int64) *GetAuthorizersInput
- func (s *GetAuthorizersInput) SetPosition(v string) *GetAuthorizersInput
- func (s *GetAuthorizersInput) SetRestApiId(v string) *GetAuthorizersInput
- func (s GetAuthorizersInput) String() string
- func (s *GetAuthorizersInput) Validate() error
- type GetAuthorizersOutput
- type GetBasePathMappingInput
- func (s GetBasePathMappingInput) GoString() string
- func (s *GetBasePathMappingInput) SetBasePath(v string) *GetBasePathMappingInput
- func (s *GetBasePathMappingInput) SetDomainName(v string) *GetBasePathMappingInput
- func (s GetBasePathMappingInput) String() string
- func (s *GetBasePathMappingInput) Validate() error
- type GetBasePathMappingsInput
- func (s GetBasePathMappingsInput) GoString() string
- func (s *GetBasePathMappingsInput) SetDomainName(v string) *GetBasePathMappingsInput
- func (s *GetBasePathMappingsInput) SetLimit(v int64) *GetBasePathMappingsInput
- func (s *GetBasePathMappingsInput) SetPosition(v string) *GetBasePathMappingsInput
- func (s GetBasePathMappingsInput) String() string
- func (s *GetBasePathMappingsInput) Validate() error
- type GetBasePathMappingsOutput
- type GetClientCertificateInput
- type GetClientCertificatesInput
- type GetClientCertificatesOutput
- type GetDeploymentInput
- type GetDeploymentsInput
- func (s GetDeploymentsInput) GoString() string
- func (s *GetDeploymentsInput) SetLimit(v int64) *GetDeploymentsInput
- func (s *GetDeploymentsInput) SetPosition(v string) *GetDeploymentsInput
- func (s *GetDeploymentsInput) SetRestApiId(v string) *GetDeploymentsInput
- func (s GetDeploymentsInput) String() string
- func (s *GetDeploymentsInput) Validate() error
- type GetDeploymentsOutput
- type GetDocumentationPartInput
- func (s GetDocumentationPartInput) GoString() string
- func (s *GetDocumentationPartInput) SetDocumentationPartId(v string) *GetDocumentationPartInput
- func (s *GetDocumentationPartInput) SetRestApiId(v string) *GetDocumentationPartInput
- func (s GetDocumentationPartInput) String() string
- func (s *GetDocumentationPartInput) Validate() error
- type GetDocumentationPartsInput
- func (s GetDocumentationPartsInput) GoString() string
- func (s *GetDocumentationPartsInput) SetLimit(v int64) *GetDocumentationPartsInput
- func (s *GetDocumentationPartsInput) SetNameQuery(v string) *GetDocumentationPartsInput
- func (s *GetDocumentationPartsInput) SetPath(v string) *GetDocumentationPartsInput
- func (s *GetDocumentationPartsInput) SetPosition(v string) *GetDocumentationPartsInput
- func (s *GetDocumentationPartsInput) SetRestApiId(v string) *GetDocumentationPartsInput
- func (s *GetDocumentationPartsInput) SetType(v string) *GetDocumentationPartsInput
- func (s GetDocumentationPartsInput) String() string
- func (s *GetDocumentationPartsInput) Validate() error
- type GetDocumentationPartsOutput
- type GetDocumentationVersionInput
- func (s GetDocumentationVersionInput) GoString() string
- func (s *GetDocumentationVersionInput) SetDocumentationVersion(v string) *GetDocumentationVersionInput
- func (s *GetDocumentationVersionInput) SetRestApiId(v string) *GetDocumentationVersionInput
- func (s GetDocumentationVersionInput) String() string
- func (s *GetDocumentationVersionInput) Validate() error
- type GetDocumentationVersionsInput
- func (s GetDocumentationVersionsInput) GoString() string
- func (s *GetDocumentationVersionsInput) SetLimit(v int64) *GetDocumentationVersionsInput
- func (s *GetDocumentationVersionsInput) SetPosition(v string) *GetDocumentationVersionsInput
- func (s *GetDocumentationVersionsInput) SetRestApiId(v string) *GetDocumentationVersionsInput
- func (s GetDocumentationVersionsInput) String() string
- func (s *GetDocumentationVersionsInput) Validate() error
- type GetDocumentationVersionsOutput
- func (s GetDocumentationVersionsOutput) GoString() string
- func (s *GetDocumentationVersionsOutput) SetItems(v []*DocumentationVersion) *GetDocumentationVersionsOutput
- func (s *GetDocumentationVersionsOutput) SetPosition(v string) *GetDocumentationVersionsOutput
- func (s GetDocumentationVersionsOutput) String() string
- type GetDomainNameInput
- type GetDomainNamesInput
- type GetDomainNamesOutput
- type GetExportInput
- func (s GetExportInput) GoString() string
- func (s *GetExportInput) SetAccepts(v string) *GetExportInput
- func (s *GetExportInput) SetExportType(v string) *GetExportInput
- func (s *GetExportInput) SetParameters(v map[string]*string) *GetExportInput
- func (s *GetExportInput) SetRestApiId(v string) *GetExportInput
- func (s *GetExportInput) SetStageName(v string) *GetExportInput
- func (s GetExportInput) String() string
- func (s *GetExportInput) Validate() error
- type GetExportOutput
- type GetIntegrationInput
- func (s GetIntegrationInput) GoString() string
- func (s *GetIntegrationInput) SetHttpMethod(v string) *GetIntegrationInput
- func (s *GetIntegrationInput) SetResourceId(v string) *GetIntegrationInput
- func (s *GetIntegrationInput) SetRestApiId(v string) *GetIntegrationInput
- func (s GetIntegrationInput) String() string
- func (s *GetIntegrationInput) Validate() error
- type GetIntegrationResponseInput
- func (s GetIntegrationResponseInput) GoString() string
- func (s *GetIntegrationResponseInput) SetHttpMethod(v string) *GetIntegrationResponseInput
- func (s *GetIntegrationResponseInput) SetResourceId(v string) *GetIntegrationResponseInput
- func (s *GetIntegrationResponseInput) SetRestApiId(v string) *GetIntegrationResponseInput
- func (s *GetIntegrationResponseInput) SetStatusCode(v string) *GetIntegrationResponseInput
- func (s GetIntegrationResponseInput) String() string
- func (s *GetIntegrationResponseInput) Validate() error
- type GetMethodInput
- func (s GetMethodInput) GoString() string
- func (s *GetMethodInput) SetHttpMethod(v string) *GetMethodInput
- func (s *GetMethodInput) SetResourceId(v string) *GetMethodInput
- func (s *GetMethodInput) SetRestApiId(v string) *GetMethodInput
- func (s GetMethodInput) String() string
- func (s *GetMethodInput) Validate() error
- type GetMethodResponseInput
- func (s GetMethodResponseInput) GoString() string
- func (s *GetMethodResponseInput) SetHttpMethod(v string) *GetMethodResponseInput
- func (s *GetMethodResponseInput) SetResourceId(v string) *GetMethodResponseInput
- func (s *GetMethodResponseInput) SetRestApiId(v string) *GetMethodResponseInput
- func (s *GetMethodResponseInput) SetStatusCode(v string) *GetMethodResponseInput
- func (s GetMethodResponseInput) String() string
- func (s *GetMethodResponseInput) Validate() error
- type GetModelInput
- func (s GetModelInput) GoString() string
- func (s *GetModelInput) SetFlatten(v bool) *GetModelInput
- func (s *GetModelInput) SetModelName(v string) *GetModelInput
- func (s *GetModelInput) SetRestApiId(v string) *GetModelInput
- func (s GetModelInput) String() string
- func (s *GetModelInput) Validate() error
- type GetModelTemplateInput
- func (s GetModelTemplateInput) GoString() string
- func (s *GetModelTemplateInput) SetModelName(v string) *GetModelTemplateInput
- func (s *GetModelTemplateInput) SetRestApiId(v string) *GetModelTemplateInput
- func (s GetModelTemplateInput) String() string
- func (s *GetModelTemplateInput) Validate() error
- type GetModelTemplateOutput
- type GetModelsInput
- func (s GetModelsInput) GoString() string
- func (s *GetModelsInput) SetLimit(v int64) *GetModelsInput
- func (s *GetModelsInput) SetPosition(v string) *GetModelsInput
- func (s *GetModelsInput) SetRestApiId(v string) *GetModelsInput
- func (s GetModelsInput) String() string
- func (s *GetModelsInput) Validate() error
- type GetModelsOutput
- type GetResourceInput
- type GetResourcesInput
- func (s GetResourcesInput) GoString() string
- func (s *GetResourcesInput) SetLimit(v int64) *GetResourcesInput
- func (s *GetResourcesInput) SetPosition(v string) *GetResourcesInput
- func (s *GetResourcesInput) SetRestApiId(v string) *GetResourcesInput
- func (s GetResourcesInput) String() string
- func (s *GetResourcesInput) Validate() error
- type GetResourcesOutput
- type GetRestApiInput
- type GetRestApisInput
- type GetRestApisOutput
- type GetSdkInput
- func (s GetSdkInput) GoString() string
- func (s *GetSdkInput) SetParameters(v map[string]*string) *GetSdkInput
- func (s *GetSdkInput) SetRestApiId(v string) *GetSdkInput
- func (s *GetSdkInput) SetSdkType(v string) *GetSdkInput
- func (s *GetSdkInput) SetStageName(v string) *GetSdkInput
- func (s GetSdkInput) String() string
- func (s *GetSdkInput) Validate() error
- type GetSdkOutput
- type GetSdkTypeInput
- type GetSdkTypesInput
- type GetSdkTypesOutput
- type GetStageInput
- type GetStagesInput
- type GetStagesOutput
- type GetUsageInput
- func (s GetUsageInput) GoString() string
- func (s *GetUsageInput) SetEndDate(v string) *GetUsageInput
- func (s *GetUsageInput) SetKeyId(v string) *GetUsageInput
- func (s *GetUsageInput) SetLimit(v int64) *GetUsageInput
- func (s *GetUsageInput) SetPosition(v string) *GetUsageInput
- func (s *GetUsageInput) SetStartDate(v string) *GetUsageInput
- func (s *GetUsageInput) SetUsagePlanId(v string) *GetUsageInput
- func (s GetUsageInput) String() string
- func (s *GetUsageInput) Validate() error
- type GetUsagePlanInput
- type GetUsagePlanKeyInput
- type GetUsagePlanKeysInput
- func (s GetUsagePlanKeysInput) GoString() string
- func (s *GetUsagePlanKeysInput) SetLimit(v int64) *GetUsagePlanKeysInput
- func (s *GetUsagePlanKeysInput) SetNameQuery(v string) *GetUsagePlanKeysInput
- func (s *GetUsagePlanKeysInput) SetPosition(v string) *GetUsagePlanKeysInput
- func (s *GetUsagePlanKeysInput) SetUsagePlanId(v string) *GetUsagePlanKeysInput
- func (s GetUsagePlanKeysInput) String() string
- func (s *GetUsagePlanKeysInput) Validate() error
- type GetUsagePlanKeysOutput
- type GetUsagePlansInput
- type GetUsagePlansOutput
- type ImportApiKeysInput
- func (s ImportApiKeysInput) GoString() string
- func (s *ImportApiKeysInput) SetBody(v []byte) *ImportApiKeysInput
- func (s *ImportApiKeysInput) SetFailOnWarnings(v bool) *ImportApiKeysInput
- func (s *ImportApiKeysInput) SetFormat(v string) *ImportApiKeysInput
- func (s ImportApiKeysInput) String() string
- func (s *ImportApiKeysInput) Validate() error
- type ImportApiKeysOutput
- type ImportDocumentationPartsInput
- func (s ImportDocumentationPartsInput) GoString() string
- func (s *ImportDocumentationPartsInput) SetBody(v []byte) *ImportDocumentationPartsInput
- func (s *ImportDocumentationPartsInput) SetFailOnWarnings(v bool) *ImportDocumentationPartsInput
- func (s *ImportDocumentationPartsInput) SetMode(v string) *ImportDocumentationPartsInput
- func (s *ImportDocumentationPartsInput) SetRestApiId(v string) *ImportDocumentationPartsInput
- func (s ImportDocumentationPartsInput) String() string
- func (s *ImportDocumentationPartsInput) Validate() error
- type ImportDocumentationPartsOutput
- func (s ImportDocumentationPartsOutput) GoString() string
- func (s *ImportDocumentationPartsOutput) SetIds(v []*string) *ImportDocumentationPartsOutput
- func (s *ImportDocumentationPartsOutput) SetWarnings(v []*string) *ImportDocumentationPartsOutput
- func (s ImportDocumentationPartsOutput) String() string
- type ImportRestApiInput
- func (s ImportRestApiInput) GoString() string
- func (s *ImportRestApiInput) SetBody(v []byte) *ImportRestApiInput
- func (s *ImportRestApiInput) SetFailOnWarnings(v bool) *ImportRestApiInput
- func (s *ImportRestApiInput) SetParameters(v map[string]*string) *ImportRestApiInput
- func (s ImportRestApiInput) String() string
- func (s *ImportRestApiInput) Validate() error
- type Integration
- func (s Integration) GoString() string
- func (s *Integration) SetCacheKeyParameters(v []*string) *Integration
- func (s *Integration) SetCacheNamespace(v string) *Integration
- func (s *Integration) SetContentHandling(v string) *Integration
- func (s *Integration) SetCredentials(v string) *Integration
- func (s *Integration) SetHttpMethod(v string) *Integration
- func (s *Integration) SetIntegrationResponses(v map[string]*IntegrationResponse) *Integration
- func (s *Integration) SetPassthroughBehavior(v string) *Integration
- func (s *Integration) SetRequestParameters(v map[string]*string) *Integration
- func (s *Integration) SetRequestTemplates(v map[string]*string) *Integration
- func (s *Integration) SetType(v string) *Integration
- func (s *Integration) SetUri(v string) *Integration
- func (s Integration) String() string
- type IntegrationResponse
- func (s IntegrationResponse) GoString() string
- func (s *IntegrationResponse) SetContentHandling(v string) *IntegrationResponse
- func (s *IntegrationResponse) SetResponseParameters(v map[string]*string) *IntegrationResponse
- func (s *IntegrationResponse) SetResponseTemplates(v map[string]*string) *IntegrationResponse
- func (s *IntegrationResponse) SetSelectionPattern(v string) *IntegrationResponse
- func (s *IntegrationResponse) SetStatusCode(v string) *IntegrationResponse
- func (s IntegrationResponse) String() string
- type Method
- func (s Method) GoString() string
- func (s *Method) SetApiKeyRequired(v bool) *Method
- func (s *Method) SetAuthorizationType(v string) *Method
- func (s *Method) SetAuthorizerId(v string) *Method
- func (s *Method) SetHttpMethod(v string) *Method
- func (s *Method) SetMethodIntegration(v *Integration) *Method
- func (s *Method) SetMethodResponses(v map[string]*MethodResponse) *Method
- func (s *Method) SetOperationName(v string) *Method
- func (s *Method) SetRequestModels(v map[string]*string) *Method
- func (s *Method) SetRequestParameters(v map[string]*bool) *Method
- func (s Method) String() string
- type MethodResponse
- func (s MethodResponse) GoString() string
- func (s *MethodResponse) SetResponseModels(v map[string]*string) *MethodResponse
- func (s *MethodResponse) SetResponseParameters(v map[string]*bool) *MethodResponse
- func (s *MethodResponse) SetStatusCode(v string) *MethodResponse
- func (s MethodResponse) String() string
- type MethodSetting
- func (s MethodSetting) GoString() string
- func (s *MethodSetting) SetCacheDataEncrypted(v bool) *MethodSetting
- func (s *MethodSetting) SetCacheTtlInSeconds(v int64) *MethodSetting
- func (s *MethodSetting) SetCachingEnabled(v bool) *MethodSetting
- func (s *MethodSetting) SetDataTraceEnabled(v bool) *MethodSetting
- func (s *MethodSetting) SetLoggingLevel(v string) *MethodSetting
- func (s *MethodSetting) SetMetricsEnabled(v bool) *MethodSetting
- func (s *MethodSetting) SetRequireAuthorizationForCacheControl(v bool) *MethodSetting
- func (s *MethodSetting) SetThrottlingBurstLimit(v int64) *MethodSetting
- func (s *MethodSetting) SetThrottlingRateLimit(v float64) *MethodSetting
- func (s *MethodSetting) SetUnauthorizedCacheControlHeaderStrategy(v string) *MethodSetting
- func (s MethodSetting) String() string
- type MethodSnapshot
- type Model
- type PatchOperation
- func (s PatchOperation) GoString() string
- func (s *PatchOperation) SetFrom(v string) *PatchOperation
- func (s *PatchOperation) SetOp(v string) *PatchOperation
- func (s *PatchOperation) SetPath(v string) *PatchOperation
- func (s *PatchOperation) SetValue(v string) *PatchOperation
- func (s PatchOperation) String() string
- type PutIntegrationInput
- func (s PutIntegrationInput) GoString() string
- func (s *PutIntegrationInput) SetCacheKeyParameters(v []*string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetCacheNamespace(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetContentHandling(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetCredentials(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetHttpMethod(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetIntegrationHttpMethod(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetPassthroughBehavior(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetRequestParameters(v map[string]*string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetRequestTemplates(v map[string]*string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetResourceId(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetRestApiId(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetType(v string) *PutIntegrationInput
- func (s *PutIntegrationInput) SetUri(v string) *PutIntegrationInput
- func (s PutIntegrationInput) String() string
- func (s *PutIntegrationInput) Validate() error
- type PutIntegrationResponseInput
- func (s PutIntegrationResponseInput) GoString() string
- func (s *PutIntegrationResponseInput) SetContentHandling(v string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetHttpMethod(v string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetResourceId(v string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetResponseParameters(v map[string]*string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetResponseTemplates(v map[string]*string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetRestApiId(v string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetSelectionPattern(v string) *PutIntegrationResponseInput
- func (s *PutIntegrationResponseInput) SetStatusCode(v string) *PutIntegrationResponseInput
- func (s PutIntegrationResponseInput) String() string
- func (s *PutIntegrationResponseInput) Validate() error
- type PutMethodInput
- func (s PutMethodInput) GoString() string
- func (s *PutMethodInput) SetApiKeyRequired(v bool) *PutMethodInput
- func (s *PutMethodInput) SetAuthorizationType(v string) *PutMethodInput
- func (s *PutMethodInput) SetAuthorizerId(v string) *PutMethodInput
- func (s *PutMethodInput) SetHttpMethod(v string) *PutMethodInput
- func (s *PutMethodInput) SetOperationName(v string) *PutMethodInput
- func (s *PutMethodInput) SetRequestModels(v map[string]*string) *PutMethodInput
- func (s *PutMethodInput) SetRequestParameters(v map[string]*bool) *PutMethodInput
- func (s *PutMethodInput) SetResourceId(v string) *PutMethodInput
- func (s *PutMethodInput) SetRestApiId(v string) *PutMethodInput
- func (s PutMethodInput) String() string
- func (s *PutMethodInput) Validate() error
- type PutMethodResponseInput
- func (s PutMethodResponseInput) GoString() string
- func (s *PutMethodResponseInput) SetHttpMethod(v string) *PutMethodResponseInput
- func (s *PutMethodResponseInput) SetResourceId(v string) *PutMethodResponseInput
- func (s *PutMethodResponseInput) SetResponseModels(v map[string]*string) *PutMethodResponseInput
- func (s *PutMethodResponseInput) SetResponseParameters(v map[string]*bool) *PutMethodResponseInput
- func (s *PutMethodResponseInput) SetRestApiId(v string) *PutMethodResponseInput
- func (s *PutMethodResponseInput) SetStatusCode(v string) *PutMethodResponseInput
- func (s PutMethodResponseInput) String() string
- func (s *PutMethodResponseInput) Validate() error
- type PutRestApiInput
- func (s PutRestApiInput) GoString() string
- func (s *PutRestApiInput) SetBody(v []byte) *PutRestApiInput
- func (s *PutRestApiInput) SetFailOnWarnings(v bool) *PutRestApiInput
- func (s *PutRestApiInput) SetMode(v string) *PutRestApiInput
- func (s *PutRestApiInput) SetParameters(v map[string]*string) *PutRestApiInput
- func (s *PutRestApiInput) SetRestApiId(v string) *PutRestApiInput
- func (s PutRestApiInput) String() string
- func (s *PutRestApiInput) Validate() error
- type QuotaSettings
- type Resource
- func (s Resource) GoString() string
- func (s *Resource) SetId(v string) *Resource
- func (s *Resource) SetParentId(v string) *Resource
- func (s *Resource) SetPath(v string) *Resource
- func (s *Resource) SetPathPart(v string) *Resource
- func (s *Resource) SetResourceMethods(v map[string]*Method) *Resource
- func (s Resource) String() string
- type RestApi
- func (s RestApi) GoString() string
- func (s *RestApi) SetBinaryMediaTypes(v []*string) *RestApi
- func (s *RestApi) SetCreatedDate(v time.Time) *RestApi
- func (s *RestApi) SetDescription(v string) *RestApi
- func (s *RestApi) SetId(v string) *RestApi
- func (s *RestApi) SetName(v string) *RestApi
- func (s *RestApi) SetVersion(v string) *RestApi
- func (s *RestApi) SetWarnings(v []*string) *RestApi
- func (s RestApi) String() string
- type SdkConfigurationProperty
- func (s SdkConfigurationProperty) GoString() string
- func (s *SdkConfigurationProperty) SetDefaultValue(v string) *SdkConfigurationProperty
- func (s *SdkConfigurationProperty) SetDescription(v string) *SdkConfigurationProperty
- func (s *SdkConfigurationProperty) SetFriendlyName(v string) *SdkConfigurationProperty
- func (s *SdkConfigurationProperty) SetName(v string) *SdkConfigurationProperty
- func (s *SdkConfigurationProperty) SetRequired(v bool) *SdkConfigurationProperty
- func (s SdkConfigurationProperty) String() string
- type SdkType
- func (s SdkType) GoString() string
- func (s *SdkType) SetConfigurationProperties(v []*SdkConfigurationProperty) *SdkType
- func (s *SdkType) SetDescription(v string) *SdkType
- func (s *SdkType) SetFriendlyName(v string) *SdkType
- func (s *SdkType) SetId(v string) *SdkType
- func (s SdkType) String() string
- type Stage
- func (s Stage) GoString() string
- func (s *Stage) SetCacheClusterEnabled(v bool) *Stage
- func (s *Stage) SetCacheClusterSize(v string) *Stage
- func (s *Stage) SetCacheClusterStatus(v string) *Stage
- func (s *Stage) SetClientCertificateId(v string) *Stage
- func (s *Stage) SetCreatedDate(v time.Time) *Stage
- func (s *Stage) SetDeploymentId(v string) *Stage
- func (s *Stage) SetDescription(v string) *Stage
- func (s *Stage) SetDocumentationVersion(v string) *Stage
- func (s *Stage) SetLastUpdatedDate(v time.Time) *Stage
- func (s *Stage) SetMethodSettings(v map[string]*MethodSetting) *Stage
- func (s *Stage) SetStageName(v string) *Stage
- func (s *Stage) SetVariables(v map[string]*string) *Stage
- func (s Stage) String() string
- type StageKey
- type TestInvokeAuthorizerInput
- func (s TestInvokeAuthorizerInput) GoString() string
- func (s *TestInvokeAuthorizerInput) SetAdditionalContext(v map[string]*string) *TestInvokeAuthorizerInput
- func (s *TestInvokeAuthorizerInput) SetAuthorizerId(v string) *TestInvokeAuthorizerInput
- func (s *TestInvokeAuthorizerInput) SetBody(v string) *TestInvokeAuthorizerInput
- func (s *TestInvokeAuthorizerInput) SetHeaders(v map[string]*string) *TestInvokeAuthorizerInput
- func (s *TestInvokeAuthorizerInput) SetPathWithQueryString(v string) *TestInvokeAuthorizerInput
- func (s *TestInvokeAuthorizerInput) SetRestApiId(v string) *TestInvokeAuthorizerInput
- func (s *TestInvokeAuthorizerInput) SetStageVariables(v map[string]*string) *TestInvokeAuthorizerInput
- func (s TestInvokeAuthorizerInput) String() string
- func (s *TestInvokeAuthorizerInput) Validate() error
- type TestInvokeAuthorizerOutput
- func (s TestInvokeAuthorizerOutput) GoString() string
- func (s *TestInvokeAuthorizerOutput) SetAuthorization(v map[string][]*string) *TestInvokeAuthorizerOutput
- func (s *TestInvokeAuthorizerOutput) SetClaims(v map[string]*string) *TestInvokeAuthorizerOutput
- func (s *TestInvokeAuthorizerOutput) SetClientStatus(v int64) *TestInvokeAuthorizerOutput
- func (s *TestInvokeAuthorizerOutput) SetLatency(v int64) *TestInvokeAuthorizerOutput
- func (s *TestInvokeAuthorizerOutput) SetLog(v string) *TestInvokeAuthorizerOutput
- func (s *TestInvokeAuthorizerOutput) SetPolicy(v string) *TestInvokeAuthorizerOutput
- func (s *TestInvokeAuthorizerOutput) SetPrincipalId(v string) *TestInvokeAuthorizerOutput
- func (s TestInvokeAuthorizerOutput) String() string
- type TestInvokeMethodInput
- func (s TestInvokeMethodInput) GoString() string
- func (s *TestInvokeMethodInput) SetBody(v string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetClientCertificateId(v string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetHeaders(v map[string]*string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetHttpMethod(v string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetPathWithQueryString(v string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetResourceId(v string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetRestApiId(v string) *TestInvokeMethodInput
- func (s *TestInvokeMethodInput) SetStageVariables(v map[string]*string) *TestInvokeMethodInput
- func (s TestInvokeMethodInput) String() string
- func (s *TestInvokeMethodInput) Validate() error
- type TestInvokeMethodOutput
- func (s TestInvokeMethodOutput) GoString() string
- func (s *TestInvokeMethodOutput) SetBody(v string) *TestInvokeMethodOutput
- func (s *TestInvokeMethodOutput) SetHeaders(v map[string]*string) *TestInvokeMethodOutput
- func (s *TestInvokeMethodOutput) SetLatency(v int64) *TestInvokeMethodOutput
- func (s *TestInvokeMethodOutput) SetLog(v string) *TestInvokeMethodOutput
- func (s *TestInvokeMethodOutput) SetStatus(v int64) *TestInvokeMethodOutput
- func (s TestInvokeMethodOutput) String() string
- type ThrottleSettings
- type UpdateAccountInput
- type UpdateApiKeyInput
- type UpdateAuthorizerInput
- func (s UpdateAuthorizerInput) GoString() string
- func (s *UpdateAuthorizerInput) SetAuthorizerId(v string) *UpdateAuthorizerInput
- func (s *UpdateAuthorizerInput) SetPatchOperations(v []*PatchOperation) *UpdateAuthorizerInput
- func (s *UpdateAuthorizerInput) SetRestApiId(v string) *UpdateAuthorizerInput
- func (s UpdateAuthorizerInput) String() string
- func (s *UpdateAuthorizerInput) Validate() error
- type UpdateBasePathMappingInput
- func (s UpdateBasePathMappingInput) GoString() string
- func (s *UpdateBasePathMappingInput) SetBasePath(v string) *UpdateBasePathMappingInput
- func (s *UpdateBasePathMappingInput) SetDomainName(v string) *UpdateBasePathMappingInput
- func (s *UpdateBasePathMappingInput) SetPatchOperations(v []*PatchOperation) *UpdateBasePathMappingInput
- func (s UpdateBasePathMappingInput) String() string
- func (s *UpdateBasePathMappingInput) Validate() error
- type UpdateClientCertificateInput
- func (s UpdateClientCertificateInput) GoString() string
- func (s *UpdateClientCertificateInput) SetClientCertificateId(v string) *UpdateClientCertificateInput
- func (s *UpdateClientCertificateInput) SetPatchOperations(v []*PatchOperation) *UpdateClientCertificateInput
- func (s UpdateClientCertificateInput) String() string
- func (s *UpdateClientCertificateInput) Validate() error
- type UpdateDeploymentInput
- func (s UpdateDeploymentInput) GoString() string
- func (s *UpdateDeploymentInput) SetDeploymentId(v string) *UpdateDeploymentInput
- func (s *UpdateDeploymentInput) SetPatchOperations(v []*PatchOperation) *UpdateDeploymentInput
- func (s *UpdateDeploymentInput) SetRestApiId(v string) *UpdateDeploymentInput
- func (s UpdateDeploymentInput) String() string
- func (s *UpdateDeploymentInput) Validate() error
- type UpdateDocumentationPartInput
- func (s UpdateDocumentationPartInput) GoString() string
- func (s *UpdateDocumentationPartInput) SetDocumentationPartId(v string) *UpdateDocumentationPartInput
- func (s *UpdateDocumentationPartInput) SetPatchOperations(v []*PatchOperation) *UpdateDocumentationPartInput
- func (s *UpdateDocumentationPartInput) SetRestApiId(v string) *UpdateDocumentationPartInput
- func (s UpdateDocumentationPartInput) String() string
- func (s *UpdateDocumentationPartInput) Validate() error
- type UpdateDocumentationVersionInput
- func (s UpdateDocumentationVersionInput) GoString() string
- func (s *UpdateDocumentationVersionInput) SetDocumentationVersion(v string) *UpdateDocumentationVersionInput
- func (s *UpdateDocumentationVersionInput) SetPatchOperations(v []*PatchOperation) *UpdateDocumentationVersionInput
- func (s *UpdateDocumentationVersionInput) SetRestApiId(v string) *UpdateDocumentationVersionInput
- func (s UpdateDocumentationVersionInput) String() string
- func (s *UpdateDocumentationVersionInput) Validate() error
- type UpdateDomainNameInput
- func (s UpdateDomainNameInput) GoString() string
- func (s *UpdateDomainNameInput) SetDomainName(v string) *UpdateDomainNameInput
- func (s *UpdateDomainNameInput) SetPatchOperations(v []*PatchOperation) *UpdateDomainNameInput
- func (s UpdateDomainNameInput) String() string
- func (s *UpdateDomainNameInput) Validate() error
- type UpdateIntegrationInput
- func (s UpdateIntegrationInput) GoString() string
- func (s *UpdateIntegrationInput) SetHttpMethod(v string) *UpdateIntegrationInput
- func (s *UpdateIntegrationInput) SetPatchOperations(v []*PatchOperation) *UpdateIntegrationInput
- func (s *UpdateIntegrationInput) SetResourceId(v string) *UpdateIntegrationInput
- func (s *UpdateIntegrationInput) SetRestApiId(v string) *UpdateIntegrationInput
- func (s UpdateIntegrationInput) String() string
- func (s *UpdateIntegrationInput) Validate() error
- type UpdateIntegrationResponseInput
- func (s UpdateIntegrationResponseInput) GoString() string
- func (s *UpdateIntegrationResponseInput) SetHttpMethod(v string) *UpdateIntegrationResponseInput
- func (s *UpdateIntegrationResponseInput) SetPatchOperations(v []*PatchOperation) *UpdateIntegrationResponseInput
- func (s *UpdateIntegrationResponseInput) SetResourceId(v string) *UpdateIntegrationResponseInput
- func (s *UpdateIntegrationResponseInput) SetRestApiId(v string) *UpdateIntegrationResponseInput
- func (s *UpdateIntegrationResponseInput) SetStatusCode(v string) *UpdateIntegrationResponseInput
- func (s UpdateIntegrationResponseInput) String() string
- func (s *UpdateIntegrationResponseInput) Validate() error
- type UpdateMethodInput
- func (s UpdateMethodInput) GoString() string
- func (s *UpdateMethodInput) SetHttpMethod(v string) *UpdateMethodInput
- func (s *UpdateMethodInput) SetPatchOperations(v []*PatchOperation) *UpdateMethodInput
- func (s *UpdateMethodInput) SetResourceId(v string) *UpdateMethodInput
- func (s *UpdateMethodInput) SetRestApiId(v string) *UpdateMethodInput
- func (s UpdateMethodInput) String() string
- func (s *UpdateMethodInput) Validate() error
- type UpdateMethodResponseInput
- func (s UpdateMethodResponseInput) GoString() string
- func (s *UpdateMethodResponseInput) SetHttpMethod(v string) *UpdateMethodResponseInput
- func (s *UpdateMethodResponseInput) SetPatchOperations(v []*PatchOperation) *UpdateMethodResponseInput
- func (s *UpdateMethodResponseInput) SetResourceId(v string) *UpdateMethodResponseInput
- func (s *UpdateMethodResponseInput) SetRestApiId(v string) *UpdateMethodResponseInput
- func (s *UpdateMethodResponseInput) SetStatusCode(v string) *UpdateMethodResponseInput
- func (s UpdateMethodResponseInput) String() string
- func (s *UpdateMethodResponseInput) Validate() error
- type UpdateModelInput
- func (s UpdateModelInput) GoString() string
- func (s *UpdateModelInput) SetModelName(v string) *UpdateModelInput
- func (s *UpdateModelInput) SetPatchOperations(v []*PatchOperation) *UpdateModelInput
- func (s *UpdateModelInput) SetRestApiId(v string) *UpdateModelInput
- func (s UpdateModelInput) String() string
- func (s *UpdateModelInput) Validate() error
- type UpdateResourceInput
- func (s UpdateResourceInput) GoString() string
- func (s *UpdateResourceInput) SetPatchOperations(v []*PatchOperation) *UpdateResourceInput
- func (s *UpdateResourceInput) SetResourceId(v string) *UpdateResourceInput
- func (s *UpdateResourceInput) SetRestApiId(v string) *UpdateResourceInput
- func (s UpdateResourceInput) String() string
- func (s *UpdateResourceInput) Validate() error
- type UpdateRestApiInput
- type UpdateStageInput
- func (s UpdateStageInput) GoString() string
- func (s *UpdateStageInput) SetPatchOperations(v []*PatchOperation) *UpdateStageInput
- func (s *UpdateStageInput) SetRestApiId(v string) *UpdateStageInput
- func (s *UpdateStageInput) SetStageName(v string) *UpdateStageInput
- func (s UpdateStageInput) String() string
- func (s *UpdateStageInput) Validate() error
- type UpdateUsageInput
- func (s UpdateUsageInput) GoString() string
- func (s *UpdateUsageInput) SetKeyId(v string) *UpdateUsageInput
- func (s *UpdateUsageInput) SetPatchOperations(v []*PatchOperation) *UpdateUsageInput
- func (s *UpdateUsageInput) SetUsagePlanId(v string) *UpdateUsageInput
- func (s UpdateUsageInput) String() string
- func (s *UpdateUsageInput) Validate() error
- type UpdateUsagePlanInput
- func (s UpdateUsagePlanInput) GoString() string
- func (s *UpdateUsagePlanInput) SetPatchOperations(v []*PatchOperation) *UpdateUsagePlanInput
- func (s *UpdateUsagePlanInput) SetUsagePlanId(v string) *UpdateUsagePlanInput
- func (s UpdateUsagePlanInput) String() string
- func (s *UpdateUsagePlanInput) Validate() error
- type Usage
- func (s Usage) GoString() string
- func (s *Usage) SetEndDate(v string) *Usage
- func (s *Usage) SetItems(v map[string][][]*int64) *Usage
- func (s *Usage) SetPosition(v string) *Usage
- func (s *Usage) SetStartDate(v string) *Usage
- func (s *Usage) SetUsagePlanId(v string) *Usage
- func (s Usage) String() string
- type UsagePlan
- func (s UsagePlan) GoString() string
- func (s *UsagePlan) SetApiStages(v []*ApiStage) *UsagePlan
- func (s *UsagePlan) SetDescription(v string) *UsagePlan
- func (s *UsagePlan) SetId(v string) *UsagePlan
- func (s *UsagePlan) SetName(v string) *UsagePlan
- func (s *UsagePlan) SetProductCode(v string) *UsagePlan
- func (s *UsagePlan) SetQuota(v *QuotaSettings) *UsagePlan
- func (s *UsagePlan) SetThrottle(v *ThrottleSettings) *UsagePlan
- func (s UsagePlan) String() string
- type UsagePlanKey
Examples ¶
- APIGateway.CreateApiKey
- APIGateway.CreateAuthorizer
- APIGateway.CreateBasePathMapping
- APIGateway.CreateDeployment
- APIGateway.CreateDocumentationPart
- APIGateway.CreateDocumentationVersion
- 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.DeleteDocumentationPart
- APIGateway.DeleteDocumentationVersion
- 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.GetDocumentationPart
- APIGateway.GetDocumentationParts
- APIGateway.GetDocumentationVersion
- APIGateway.GetDocumentationVersions
- 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.GetSdkType
- APIGateway.GetSdkTypes
- APIGateway.GetStage
- APIGateway.GetStages
- APIGateway.GetUsage
- APIGateway.GetUsagePlan
- APIGateway.GetUsagePlanKey
- APIGateway.GetUsagePlanKeys
- APIGateway.GetUsagePlans
- APIGateway.ImportApiKeys
- APIGateway.ImportDocumentationParts
- 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.UpdateDocumentationPart
- APIGateway.UpdateDocumentationVersion
- APIGateway.UpdateDomainName
- APIGateway.UpdateIntegration
- APIGateway.UpdateIntegrationResponse
- APIGateway.UpdateMethod
- APIGateway.UpdateMethodResponse
- APIGateway.UpdateModel
- APIGateway.UpdateResource
- APIGateway.UpdateRestApi
- APIGateway.UpdateStage
- APIGateway.UpdateUsage
- APIGateway.UpdateUsagePlan
Constants ¶
const ( // AuthorizerTypeToken is a AuthorizerType enum value AuthorizerTypeToken = "TOKEN" // AuthorizerTypeCognitoUserPools is a AuthorizerType enum value AuthorizerTypeCognitoUserPools = "COGNITO_USER_POOLS" )
The authorizer type. the current value is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito Your User Pool.
const ( // CacheClusterSize05 is a CacheClusterSize enum value CacheClusterSize05 = "0.5" // CacheClusterSize16 is a CacheClusterSize enum value CacheClusterSize16 = "1.6" // CacheClusterSize61 is a CacheClusterSize enum value CacheClusterSize61 = "6.1" // CacheClusterSize135 is a CacheClusterSize enum value CacheClusterSize135 = "13.5" // CacheClusterSize284 is a CacheClusterSize enum value CacheClusterSize284 = "28.4" // CacheClusterSize582 is a CacheClusterSize enum value CacheClusterSize582 = "58.2" // CacheClusterSize118 is a CacheClusterSize enum value CacheClusterSize118 = "118" // CacheClusterSize237 is a CacheClusterSize enum value CacheClusterSize237 = "237" )
Returns the size of the CacheCluster.
const ( // CacheClusterStatusCreateInProgress is a CacheClusterStatus enum value CacheClusterStatusCreateInProgress = "CREATE_IN_PROGRESS" // CacheClusterStatusAvailable is a CacheClusterStatus enum value CacheClusterStatusAvailable = "AVAILABLE" // CacheClusterStatusDeleteInProgress is a CacheClusterStatus enum value CacheClusterStatusDeleteInProgress = "DELETE_IN_PROGRESS" // CacheClusterStatusNotAvailable is a CacheClusterStatus enum value CacheClusterStatusNotAvailable = "NOT_AVAILABLE" // CacheClusterStatusFlushInProgress is a CacheClusterStatus enum value CacheClusterStatusFlushInProgress = "FLUSH_IN_PROGRESS" )
Returns the status of the CacheCluster.
const ( // ContentHandlingStrategyConvertToBinary is a ContentHandlingStrategy enum value ContentHandlingStrategyConvertToBinary = "CONVERT_TO_BINARY" // ContentHandlingStrategyConvertToText is a ContentHandlingStrategy enum value ContentHandlingStrategyConvertToText = "CONVERT_TO_TEXT" )
const ( // DocumentationPartTypeApi is a DocumentationPartType enum value DocumentationPartTypeApi = "API" // DocumentationPartTypeAuthorizer is a DocumentationPartType enum value DocumentationPartTypeAuthorizer = "AUTHORIZER" // DocumentationPartTypeModel is a DocumentationPartType enum value DocumentationPartTypeModel = "MODEL" // DocumentationPartTypeResource is a DocumentationPartType enum value DocumentationPartTypeResource = "RESOURCE" // DocumentationPartTypeMethod is a DocumentationPartType enum value DocumentationPartTypeMethod = "METHOD" // DocumentationPartTypePathParameter is a DocumentationPartType enum value DocumentationPartTypePathParameter = "PATH_PARAMETER" // DocumentationPartTypeQueryParameter is a DocumentationPartType enum value DocumentationPartTypeQueryParameter = "QUERY_PARAMETER" // DocumentationPartTypeRequestHeader is a DocumentationPartType enum value DocumentationPartTypeRequestHeader = "REQUEST_HEADER" // DocumentationPartTypeRequestBody is a DocumentationPartType enum value DocumentationPartTypeRequestBody = "REQUEST_BODY" // DocumentationPartTypeResponse is a DocumentationPartType enum value DocumentationPartTypeResponse = "RESPONSE" // DocumentationPartTypeResponseHeader is a DocumentationPartType enum value DocumentationPartTypeResponseHeader = "RESPONSE_HEADER" // DocumentationPartTypeResponseBody is a DocumentationPartType enum value DocumentationPartTypeResponseBody = "RESPONSE_BODY" )
const ( // IntegrationTypeHttp is a IntegrationType enum value IntegrationTypeHttp = "HTTP" // IntegrationTypeAws is a IntegrationType enum value IntegrationTypeAws = "AWS" // IntegrationTypeMock is a IntegrationType enum value IntegrationTypeMock = "MOCK" // IntegrationTypeHttpProxy is a IntegrationType enum value IntegrationTypeHttpProxy = "HTTP_PROXY" // IntegrationTypeAwsProxy is a IntegrationType enum value IntegrationTypeAwsProxy = "AWS_PROXY" )
The integration type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
const ( // OpAdd is a Op enum value OpAdd = "add" // OpRemove is a Op enum value OpRemove = "remove" // OpReplace is a Op enum value OpReplace = "replace" // OpMove is a Op enum value OpMove = "move" // OpCopy is a Op enum value OpCopy = "copy" // OpTest is a Op enum value OpTest = "test" )
const ( // PutModeMerge is a PutMode enum value PutModeMerge = "merge" // PutModeOverwrite is a PutMode enum value PutModeOverwrite = "overwrite" )
const ( // QuotaPeriodTypeDay is a QuotaPeriodType enum value QuotaPeriodTypeDay = "DAY" // QuotaPeriodTypeWeek is a QuotaPeriodType enum value QuotaPeriodTypeWeek = "WEEK" // QuotaPeriodTypeMonth is a QuotaPeriodType enum value QuotaPeriodTypeMonth = "MONTH" )
const (UnauthorizedCacheControlHeaderStrategyFailWith403 = "FAIL_WITH_403" UnauthorizedCacheControlHeaderStrategySucceedWithResponseHeader = "SUCCEED_WITH_RESPONSE_HEADER" UnauthorizedCacheControlHeaderStrategySucceedWithoutResponseHeader = "SUCCEED_WITHOUT_RESPONSE_HEADER" )
const ( ServiceName = "apigateway" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
const (
// ApiKeysFormatCsv is a ApiKeysFormat enum value
ApiKeysFormatCsv = "csv"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIGateway ¶
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)
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{ CustomerId: aws.String("String"), 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.
See CreateApiKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateApiKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateApiKeyRequest method. req, resp := client.CreateApiKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateAuthorizer ¶ added in v1.1.2
func (c *APIGateway) CreateAuthorizer(input *CreateAuthorizerInput) (*Authorizer, error)
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.
See CreateAuthorizer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateAuthorizerRequest method. req, resp := client.CreateAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateBasePathMapping ¶
func (c *APIGateway) CreateBasePathMapping(input *CreateBasePathMappingInput) (*BasePathMapping, error)
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.
See CreateBasePathMapping for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateBasePathMapping method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateBasePathMappingRequest method. req, resp := client.CreateBasePathMappingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateDeployment ¶
func (c *APIGateway) CreateDeployment(input *CreateDeploymentInput) (*Deployment, error)
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 CacheClusterEnabled: aws.Bool(true), CacheClusterSize: aws.String("CacheClusterSize"), Description: aws.String("String"), StageDescription: aws.String("String"), StageName: 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.
See CreateDeployment for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDeployment method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateDeploymentRequest method. req, resp := client.CreateDeploymentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateDocumentationPart ¶ added in v1.5.13
func (c *APIGateway) CreateDocumentationPart(input *CreateDocumentationPartInput) (*DocumentationPart, error)
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.CreateDocumentationPartInput{ Location: &apigateway.DocumentationPartLocation{ // Required Type: aws.String("DocumentationPartType"), // Required Method: aws.String("String"), Name: aws.String("String"), Path: aws.String("String"), StatusCode: aws.String("DocumentationPartLocationStatusCode"), }, Properties: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.CreateDocumentationPart(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) CreateDocumentationPartRequest ¶ added in v1.5.13
func (c *APIGateway) CreateDocumentationPartRequest(input *CreateDocumentationPartInput) (req *request.Request, output *DocumentationPart)
CreateDocumentationPartRequest generates a "aws/request.Request" representing the client's request for the CreateDocumentationPart operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateDocumentationPart for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDocumentationPart method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateDocumentationPartRequest method. req, resp := client.CreateDocumentationPartRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateDocumentationVersion ¶ added in v1.5.13
func (c *APIGateway) CreateDocumentationVersion(input *CreateDocumentationVersionInput) (*DocumentationVersion, error)
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.CreateDocumentationVersionInput{ DocumentationVersion: aws.String("String"), // Required RestApiId: aws.String("String"), // Required Description: aws.String("String"), StageName: aws.String("String"), } resp, err := svc.CreateDocumentationVersion(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) CreateDocumentationVersionRequest ¶ added in v1.5.13
func (c *APIGateway) CreateDocumentationVersionRequest(input *CreateDocumentationVersionInput) (req *request.Request, output *DocumentationVersion)
CreateDocumentationVersionRequest generates a "aws/request.Request" representing the client's request for the CreateDocumentationVersion operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateDocumentationVersion for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDocumentationVersion method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateDocumentationVersionRequest method. req, resp := client.CreateDocumentationVersionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateDomainName ¶
func (c *APIGateway) CreateDomainName(input *CreateDomainNameInput) (*DomainName, error)
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.
See CreateDomainName for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDomainName method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateDomainNameRequest method. req, resp := client.CreateDomainNameRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateModel ¶
func (c *APIGateway) CreateModel(input *CreateModelInput) (*Model, error)
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.
See CreateModel for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateModel method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateModelRequest method. req, resp := client.CreateModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateResource ¶
func (c *APIGateway) CreateResource(input *CreateResourceInput) (*Resource, error)
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.
See CreateResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateResourceRequest method. req, resp := client.CreateResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateRestApi ¶
func (c *APIGateway) CreateRestApi(input *CreateRestApiInput) (*RestApi, error)
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 BinaryMediaTypes: []*string{ aws.String("String"), // Required // More values... }, CloneFrom: aws.String("String"), Description: aws.String("String"), Version: 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.
See CreateRestApi for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateRestApiRequest method. req, resp := client.CreateRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateStage ¶
func (c *APIGateway) CreateStage(input *CreateStageInput) (*Stage, error)
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"), DocumentationVersion: 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.
See CreateStage for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateStage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateStageRequest method. req, resp := client.CreateStageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) CreateUsagePlan ¶ added in v1.4.2
func (c *APIGateway) CreateUsagePlan(input *CreateUsagePlanInput) (*UsagePlan, error)
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)
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.
See CreateUsagePlanKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateUsagePlanKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateUsagePlanKeyRequest method. req, resp := client.CreateUsagePlanKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) 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.
See CreateUsagePlan for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateUsagePlan method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateUsagePlanRequest method. req, resp := client.CreateUsagePlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteApiKey ¶
func (c *APIGateway) DeleteApiKey(input *DeleteApiKeyInput) (*DeleteApiKeyOutput, error)
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.
See DeleteApiKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteApiKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteApiKeyRequest method. req, resp := client.DeleteApiKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteAuthorizer ¶ added in v1.1.2
func (c *APIGateway) DeleteAuthorizer(input *DeleteAuthorizerInput) (*DeleteAuthorizerOutput, error)
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.
See DeleteAuthorizer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteAuthorizerRequest method. req, resp := client.DeleteAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteBasePathMapping ¶
func (c *APIGateway) DeleteBasePathMapping(input *DeleteBasePathMappingInput) (*DeleteBasePathMappingOutput, error)
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.
See DeleteBasePathMapping for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteBasePathMapping method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteBasePathMappingRequest method. req, resp := client.DeleteBasePathMappingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteClientCertificate ¶
func (c *APIGateway) DeleteClientCertificate(input *DeleteClientCertificateInput) (*DeleteClientCertificateOutput, error)
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.
See DeleteClientCertificate for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteClientCertificate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteClientCertificateRequest method. req, resp := client.DeleteClientCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteDeployment ¶
func (c *APIGateway) DeleteDeployment(input *DeleteDeploymentInput) (*DeleteDeploymentOutput, error)
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.
See DeleteDeployment for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDeployment method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteDeploymentRequest method. req, resp := client.DeleteDeploymentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteDocumentationPart ¶ added in v1.5.13
func (c *APIGateway) DeleteDocumentationPart(input *DeleteDocumentationPartInput) (*DeleteDocumentationPartOutput, error)
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.DeleteDocumentationPartInput{ DocumentationPartId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.DeleteDocumentationPart(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) DeleteDocumentationPartRequest ¶ added in v1.5.13
func (c *APIGateway) DeleteDocumentationPartRequest(input *DeleteDocumentationPartInput) (req *request.Request, output *DeleteDocumentationPartOutput)
DeleteDocumentationPartRequest generates a "aws/request.Request" representing the client's request for the DeleteDocumentationPart operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteDocumentationPart for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDocumentationPart method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteDocumentationPartRequest method. req, resp := client.DeleteDocumentationPartRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteDocumentationVersion ¶ added in v1.5.13
func (c *APIGateway) DeleteDocumentationVersion(input *DeleteDocumentationVersionInput) (*DeleteDocumentationVersionOutput, error)
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.DeleteDocumentationVersionInput{ DocumentationVersion: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.DeleteDocumentationVersion(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) DeleteDocumentationVersionRequest ¶ added in v1.5.13
func (c *APIGateway) DeleteDocumentationVersionRequest(input *DeleteDocumentationVersionInput) (req *request.Request, output *DeleteDocumentationVersionOutput)
DeleteDocumentationVersionRequest generates a "aws/request.Request" representing the client's request for the DeleteDocumentationVersion operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteDocumentationVersion for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDocumentationVersion method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteDocumentationVersionRequest method. req, resp := client.DeleteDocumentationVersionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteDomainName ¶
func (c *APIGateway) DeleteDomainName(input *DeleteDomainNameInput) (*DeleteDomainNameOutput, error)
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.
See DeleteDomainName for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDomainName method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteDomainNameRequest method. req, resp := client.DeleteDomainNameRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteIntegration ¶
func (c *APIGateway) DeleteIntegration(input *DeleteIntegrationInput) (*DeleteIntegrationOutput, error)
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.
See DeleteIntegration for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteIntegration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteIntegrationRequest method. req, resp := client.DeleteIntegrationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteIntegrationResponse ¶
func (c *APIGateway) DeleteIntegrationResponse(input *DeleteIntegrationResponseInput) (*DeleteIntegrationResponseOutput, error)
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.
See DeleteIntegrationResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteIntegrationResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteIntegrationResponseRequest method. req, resp := client.DeleteIntegrationResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteMethod ¶
func (c *APIGateway) DeleteMethod(input *DeleteMethodInput) (*DeleteMethodOutput, error)
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.
See DeleteMethod for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteMethodRequest method. req, resp := client.DeleteMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteMethodResponse ¶
func (c *APIGateway) DeleteMethodResponse(input *DeleteMethodResponseInput) (*DeleteMethodResponseOutput, error)
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.
See DeleteMethodResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteMethodResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteMethodResponseRequest method. req, resp := client.DeleteMethodResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteModel ¶
func (c *APIGateway) DeleteModel(input *DeleteModelInput) (*DeleteModelOutput, error)
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.
See DeleteModel for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteModel method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteModelRequest method. req, resp := client.DeleteModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteResource ¶
func (c *APIGateway) DeleteResource(input *DeleteResourceInput) (*DeleteResourceOutput, error)
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.
See DeleteResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteResourceRequest method. req, resp := client.DeleteResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteRestApi ¶
func (c *APIGateway) DeleteRestApi(input *DeleteRestApiInput) (*DeleteRestApiOutput, error)
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.
See DeleteRestApi for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteRestApiRequest method. req, resp := client.DeleteRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteStage ¶
func (c *APIGateway) DeleteStage(input *DeleteStageInput) (*DeleteStageOutput, error)
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.
See DeleteStage for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteStage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteStageRequest method. req, resp := client.DeleteStageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) DeleteUsagePlan ¶ added in v1.4.2
func (c *APIGateway) DeleteUsagePlan(input *DeleteUsagePlanInput) (*DeleteUsagePlanOutput, error)
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)
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.
See DeleteUsagePlanKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteUsagePlanKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteUsagePlanKeyRequest method. req, resp := client.DeleteUsagePlanKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) 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.
See DeleteUsagePlan for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteUsagePlan method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteUsagePlanRequest method. req, resp := client.DeleteUsagePlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) FlushStageAuthorizersCache ¶ added in v1.1.7
func (c *APIGateway) FlushStageAuthorizersCache(input *FlushStageAuthorizersCacheInput) (*FlushStageAuthorizersCacheOutput, error)
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.7
func (c *APIGateway) FlushStageAuthorizersCacheRequest(input *FlushStageAuthorizersCacheInput) (req *request.Request, output *FlushStageAuthorizersCacheOutput)
FlushStageAuthorizersCacheRequest generates a "aws/request.Request" representing the client's request for the FlushStageAuthorizersCache operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See FlushStageAuthorizersCache for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the FlushStageAuthorizersCache method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the FlushStageAuthorizersCacheRequest method. req, resp := client.FlushStageAuthorizersCacheRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) FlushStageCache ¶
func (c *APIGateway) FlushStageCache(input *FlushStageCacheInput) (*FlushStageCacheOutput, error)
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.
See FlushStageCache for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the FlushStageCache method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the FlushStageCacheRequest method. req, resp := client.FlushStageCacheRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GenerateClientCertificate ¶
func (c *APIGateway) GenerateClientCertificate(input *GenerateClientCertificateInput) (*ClientCertificate, error)
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.
See GenerateClientCertificate for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GenerateClientCertificate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GenerateClientCertificateRequest method. req, resp := client.GenerateClientCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetAccount ¶
func (c *APIGateway) GetAccount(input *GetAccountInput) (*Account, error)
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.
See GetAccount for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetAccount method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetAccountRequest method. req, resp := client.GetAccountRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetApiKey ¶
func (c *APIGateway) GetApiKey(input *GetApiKeyInput) (*ApiKey, error)
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.
See GetApiKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetApiKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetApiKeyRequest method. req, resp := client.GetApiKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetApiKeys ¶
func (c *APIGateway) GetApiKeys(input *GetApiKeysInput) (*GetApiKeysOutput, error)
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{ CustomerId: aws.String("String"), 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.
See GetApiKeys for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetApiKeys method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetApiKeysRequest method. req, resp := client.GetApiKeysRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetAuthorizer ¶ added in v1.1.2
func (c *APIGateway) GetAuthorizer(input *GetAuthorizerInput) (*Authorizer, error)
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.
See GetAuthorizer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetAuthorizerRequest method. req, resp := client.GetAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetAuthorizers ¶ added in v1.1.2
func (c *APIGateway) GetAuthorizers(input *GetAuthorizersInput) (*GetAuthorizersOutput, error)
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.
See GetAuthorizers for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetAuthorizers method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetAuthorizersRequest method. req, resp := client.GetAuthorizersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetBasePathMapping ¶
func (c *APIGateway) GetBasePathMapping(input *GetBasePathMappingInput) (*BasePathMapping, error)
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.
See GetBasePathMapping for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetBasePathMapping method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetBasePathMappingRequest method. req, resp := client.GetBasePathMappingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetBasePathMappings ¶
func (c *APIGateway) GetBasePathMappings(input *GetBasePathMappingsInput) (*GetBasePathMappingsOutput, error)
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.
See GetBasePathMappings for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetBasePathMappings method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetBasePathMappingsRequest method. req, resp := client.GetBasePathMappingsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetClientCertificate ¶
func (c *APIGateway) GetClientCertificate(input *GetClientCertificateInput) (*ClientCertificate, error)
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.
See GetClientCertificate for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetClientCertificate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetClientCertificateRequest method. req, resp := client.GetClientCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetClientCertificates ¶
func (c *APIGateway) GetClientCertificates(input *GetClientCertificatesInput) (*GetClientCertificatesOutput, error)
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.
See GetClientCertificates for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetClientCertificates method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetClientCertificatesRequest method. req, resp := client.GetClientCertificatesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDeployment ¶
func (c *APIGateway) GetDeployment(input *GetDeploymentInput) (*Deployment, error)
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.
See GetDeployment for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDeployment method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDeploymentRequest method. req, resp := client.GetDeploymentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDeployments ¶
func (c *APIGateway) GetDeployments(input *GetDeploymentsInput) (*GetDeploymentsOutput, error)
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.
See GetDeployments for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDeployments method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDeploymentsRequest method. req, resp := client.GetDeploymentsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDocumentationPart ¶ added in v1.5.13
func (c *APIGateway) GetDocumentationPart(input *GetDocumentationPartInput) (*DocumentationPart, error)
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.GetDocumentationPartInput{ DocumentationPartId: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.GetDocumentationPart(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) GetDocumentationPartRequest ¶ added in v1.5.13
func (c *APIGateway) GetDocumentationPartRequest(input *GetDocumentationPartInput) (req *request.Request, output *DocumentationPart)
GetDocumentationPartRequest generates a "aws/request.Request" representing the client's request for the GetDocumentationPart operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetDocumentationPart for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDocumentationPart method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDocumentationPartRequest method. req, resp := client.GetDocumentationPartRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDocumentationParts ¶ added in v1.5.13
func (c *APIGateway) GetDocumentationParts(input *GetDocumentationPartsInput) (*GetDocumentationPartsOutput, error)
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.GetDocumentationPartsInput{ RestApiId: aws.String("String"), // Required Limit: aws.Int64(1), NameQuery: aws.String("String"), Path: aws.String("String"), Position: aws.String("String"), Type: aws.String("DocumentationPartType"), } resp, err := svc.GetDocumentationParts(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) GetDocumentationPartsRequest ¶ added in v1.5.13
func (c *APIGateway) GetDocumentationPartsRequest(input *GetDocumentationPartsInput) (req *request.Request, output *GetDocumentationPartsOutput)
GetDocumentationPartsRequest generates a "aws/request.Request" representing the client's request for the GetDocumentationParts operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetDocumentationParts for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDocumentationParts method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDocumentationPartsRequest method. req, resp := client.GetDocumentationPartsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDocumentationVersion ¶ added in v1.5.13
func (c *APIGateway) GetDocumentationVersion(input *GetDocumentationVersionInput) (*DocumentationVersion, error)
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.GetDocumentationVersionInput{ DocumentationVersion: aws.String("String"), // Required RestApiId: aws.String("String"), // Required } resp, err := svc.GetDocumentationVersion(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) GetDocumentationVersionRequest ¶ added in v1.5.13
func (c *APIGateway) GetDocumentationVersionRequest(input *GetDocumentationVersionInput) (req *request.Request, output *DocumentationVersion)
GetDocumentationVersionRequest generates a "aws/request.Request" representing the client's request for the GetDocumentationVersion operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetDocumentationVersion for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDocumentationVersion method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDocumentationVersionRequest method. req, resp := client.GetDocumentationVersionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDocumentationVersions ¶ added in v1.5.13
func (c *APIGateway) GetDocumentationVersions(input *GetDocumentationVersionsInput) (*GetDocumentationVersionsOutput, error)
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.GetDocumentationVersionsInput{ RestApiId: aws.String("String"), // Required Limit: aws.Int64(1), Position: aws.String("String"), } resp, err := svc.GetDocumentationVersions(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) GetDocumentationVersionsRequest ¶ added in v1.5.13
func (c *APIGateway) GetDocumentationVersionsRequest(input *GetDocumentationVersionsInput) (req *request.Request, output *GetDocumentationVersionsOutput)
GetDocumentationVersionsRequest generates a "aws/request.Request" representing the client's request for the GetDocumentationVersions operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetDocumentationVersions for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDocumentationVersions method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDocumentationVersionsRequest method. req, resp := client.GetDocumentationVersionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDomainName ¶
func (c *APIGateway) GetDomainName(input *GetDomainNameInput) (*DomainName, error)
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.
See GetDomainName for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDomainName method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDomainNameRequest method. req, resp := client.GetDomainNameRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetDomainNames ¶
func (c *APIGateway) GetDomainNames(input *GetDomainNamesInput) (*GetDomainNamesOutput, error)
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.
See GetDomainNames for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDomainNames method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetDomainNamesRequest method. req, resp := client.GetDomainNamesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetExport ¶ added in v1.1.2
func (c *APIGateway) GetExport(input *GetExportInput) (*GetExportOutput, error)
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.
See GetExport for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetExport method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetExportRequest method. req, resp := client.GetExportRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetIntegration ¶
func (c *APIGateway) GetIntegration(input *GetIntegrationInput) (*Integration, error)
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.
See GetIntegration for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetIntegration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetIntegrationRequest method. req, resp := client.GetIntegrationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetIntegrationResponse ¶
func (c *APIGateway) GetIntegrationResponse(input *GetIntegrationResponseInput) (*IntegrationResponse, error)
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.
See GetIntegrationResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetIntegrationResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetIntegrationResponseRequest method. req, resp := client.GetIntegrationResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetMethod ¶
func (c *APIGateway) GetMethod(input *GetMethodInput) (*Method, error)
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.
See GetMethod for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetMethodRequest method. req, resp := client.GetMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetMethodResponse ¶
func (c *APIGateway) GetMethodResponse(input *GetMethodResponseInput) (*MethodResponse, error)
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.
See GetMethodResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetMethodResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetMethodResponseRequest method. req, resp := client.GetMethodResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetModel ¶
func (c *APIGateway) GetModel(input *GetModelInput) (*Model, error)
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.
See GetModel for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetModel method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetModelRequest method. req, resp := client.GetModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetModelTemplate ¶
func (c *APIGateway) GetModelTemplate(input *GetModelTemplateInput) (*GetModelTemplateOutput, error)
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.
See GetModelTemplate for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetModelTemplate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetModelTemplateRequest method. req, resp := client.GetModelTemplateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetModels ¶
func (c *APIGateway) GetModels(input *GetModelsInput) (*GetModelsOutput, error)
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.
See GetModels for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetModels method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetModelsRequest method. req, resp := client.GetModelsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetResource ¶
func (c *APIGateway) GetResource(input *GetResourceInput) (*Resource, error)
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.
See GetResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetResourceRequest method. req, resp := client.GetResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetResources ¶
func (c *APIGateway) GetResources(input *GetResourcesInput) (*GetResourcesOutput, error)
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.
See GetResources for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetResources method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetResourcesRequest method. req, resp := client.GetResourcesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetRestApi ¶
func (c *APIGateway) GetRestApi(input *GetRestApiInput) (*RestApi, error)
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.
See GetRestApi for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetRestApiRequest method. req, resp := client.GetRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetRestApis ¶
func (c *APIGateway) GetRestApis(input *GetRestApisInput) (*GetRestApisOutput, error)
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.
See GetRestApis for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetRestApis method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetRestApisRequest method. req, resp := client.GetRestApisRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetSdk ¶
func (c *APIGateway) GetSdk(input *GetSdkInput) (*GetSdkOutput, error)
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.
See GetSdk for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSdk method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetSdkRequest method. req, resp := client.GetSdkRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetSdkType ¶ added in v1.6.8
func (c *APIGateway) GetSdkType(input *GetSdkTypeInput) (*SdkType, error)
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.GetSdkTypeInput{ Id: aws.String("String"), // Required } resp, err := svc.GetSdkType(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) GetSdkTypeRequest ¶ added in v1.6.8
func (c *APIGateway) GetSdkTypeRequest(input *GetSdkTypeInput) (req *request.Request, output *SdkType)
GetSdkTypeRequest generates a "aws/request.Request" representing the client's request for the GetSdkType operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetSdkType for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSdkType method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetSdkTypeRequest method. req, resp := client.GetSdkTypeRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetSdkTypes ¶ added in v1.6.8
func (c *APIGateway) GetSdkTypes(input *GetSdkTypesInput) (*GetSdkTypesOutput, error)
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.GetSdkTypesInput{ Limit: aws.Int64(1), Position: aws.String("String"), } resp, err := svc.GetSdkTypes(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) GetSdkTypesRequest ¶ added in v1.6.8
func (c *APIGateway) GetSdkTypesRequest(input *GetSdkTypesInput) (req *request.Request, output *GetSdkTypesOutput)
GetSdkTypesRequest generates a "aws/request.Request" representing the client's request for the GetSdkTypes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetSdkTypes for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSdkTypes method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetSdkTypesRequest method. req, resp := client.GetSdkTypesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetStage ¶
func (c *APIGateway) GetStage(input *GetStageInput) (*Stage, error)
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.
See GetStage for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetStage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetStageRequest method. req, resp := client.GetStageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetStages ¶
func (c *APIGateway) GetStages(input *GetStagesInput) (*GetStagesOutput, error)
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.
See GetStages for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetStages method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetStagesRequest method. req, resp := client.GetStagesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetUsage ¶ added in v1.4.2
func (c *APIGateway) GetUsage(input *GetUsageInput) (*Usage, error)
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)
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)
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.
See GetUsagePlanKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsagePlanKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsagePlanKeyRequest method. req, resp := client.GetUsagePlanKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetUsagePlanKeys ¶ added in v1.4.2
func (c *APIGateway) GetUsagePlanKeys(input *GetUsagePlanKeysInput) (*GetUsagePlanKeysOutput, error)
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.
See GetUsagePlanKeys for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsagePlanKeys method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsagePlanKeysRequest method. req, resp := client.GetUsagePlanKeysRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) 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.
See GetUsagePlan for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsagePlan method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsagePlanRequest method. req, resp := client.GetUsagePlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) GetUsagePlans ¶ added in v1.4.2
func (c *APIGateway) GetUsagePlans(input *GetUsagePlansInput) (*GetUsagePlansOutput, error)
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.
See GetUsagePlans for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsagePlans method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsagePlansRequest method. req, resp := client.GetUsagePlansRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) 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.
See GetUsage for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetUsage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetUsageRequest method. req, resp := client.GetUsageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) ImportApiKeys ¶ added in v1.4.2
func (c *APIGateway) ImportApiKeys(input *ImportApiKeysInput) (*ImportApiKeysOutput, error)
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.
See ImportApiKeys for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ImportApiKeys method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ImportApiKeysRequest method. req, resp := client.ImportApiKeysRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) ImportDocumentationParts ¶ added in v1.5.13
func (c *APIGateway) ImportDocumentationParts(input *ImportDocumentationPartsInput) (*ImportDocumentationPartsOutput, error)
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.ImportDocumentationPartsInput{ Body: []byte("PAYLOAD"), // Required RestApiId: aws.String("String"), // Required FailOnWarnings: aws.Bool(true), Mode: aws.String("PutMode"), } resp, err := svc.ImportDocumentationParts(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) ImportDocumentationPartsRequest ¶ added in v1.5.13
func (c *APIGateway) ImportDocumentationPartsRequest(input *ImportDocumentationPartsInput) (req *request.Request, output *ImportDocumentationPartsOutput)
ImportDocumentationPartsRequest generates a "aws/request.Request" representing the client's request for the ImportDocumentationParts operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See ImportDocumentationParts for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ImportDocumentationParts method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ImportDocumentationPartsRequest method. req, resp := client.ImportDocumentationPartsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) ImportRestApi ¶ added in v1.1.16
func (c *APIGateway) ImportRestApi(input *ImportRestApiInput) (*RestApi, error)
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.
See ImportRestApi for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ImportRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ImportRestApiRequest method. req, resp := client.ImportRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutIntegration ¶
func (c *APIGateway) PutIntegration(input *PutIntegrationInput) (*Integration, error)
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"), ContentHandling: aws.String("ContentHandlingStrategy"), 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.
See PutIntegration for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutIntegration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutIntegrationRequest method. req, resp := client.PutIntegrationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutIntegrationResponse ¶
func (c *APIGateway) PutIntegrationResponse(input *PutIntegrationResponseInput) (*IntegrationResponse, error)
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 ContentHandling: aws.String("ContentHandlingStrategy"), 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.
See PutIntegrationResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutIntegrationResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutIntegrationResponseRequest method. req, resp := client.PutIntegrationResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutMethod ¶
func (c *APIGateway) PutMethod(input *PutMethodInput) (*Method, error)
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"), OperationName: 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.
See PutMethod for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutMethodRequest method. req, resp := client.PutMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutMethodResponse ¶
func (c *APIGateway) PutMethodResponse(input *PutMethodResponseInput) (*MethodResponse, error)
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.
See PutMethodResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutMethodResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutMethodResponseRequest method. req, resp := client.PutMethodResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) PutRestApi ¶ added in v1.1.16
func (c *APIGateway) PutRestApi(input *PutRestApiInput) (*RestApi, error)
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.
See PutRestApi for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the PutRestApiRequest method. req, resp := client.PutRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) TestInvokeAuthorizer ¶ added in v1.1.7
func (c *APIGateway) TestInvokeAuthorizer(input *TestInvokeAuthorizerInput) (*TestInvokeAuthorizerOutput, error)
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.7
func (c *APIGateway) TestInvokeAuthorizerRequest(input *TestInvokeAuthorizerInput) (req *request.Request, output *TestInvokeAuthorizerOutput)
TestInvokeAuthorizerRequest generates a "aws/request.Request" representing the client's request for the TestInvokeAuthorizer operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See TestInvokeAuthorizer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the TestInvokeAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the TestInvokeAuthorizerRequest method. req, resp := client.TestInvokeAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) TestInvokeMethod ¶
func (c *APIGateway) TestInvokeMethod(input *TestInvokeMethodInput) (*TestInvokeMethodOutput, error)
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.
See TestInvokeMethod for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the TestInvokeMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the TestInvokeMethodRequest method. req, resp := client.TestInvokeMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateAccount ¶
func (c *APIGateway) UpdateAccount(input *UpdateAccountInput) (*Account, error)
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.
See UpdateAccount for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateAccount method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateAccountRequest method. req, resp := client.UpdateAccountRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateApiKey ¶
func (c *APIGateway) UpdateApiKey(input *UpdateApiKeyInput) (*ApiKey, error)
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.
See UpdateApiKey for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateApiKey method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateApiKeyRequest method. req, resp := client.UpdateApiKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateAuthorizer ¶ added in v1.1.2
func (c *APIGateway) UpdateAuthorizer(input *UpdateAuthorizerInput) (*Authorizer, error)
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.
See UpdateAuthorizer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateAuthorizer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateAuthorizerRequest method. req, resp := client.UpdateAuthorizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateBasePathMapping ¶
func (c *APIGateway) UpdateBasePathMapping(input *UpdateBasePathMappingInput) (*BasePathMapping, error)
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.
See UpdateBasePathMapping for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateBasePathMapping method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateBasePathMappingRequest method. req, resp := client.UpdateBasePathMappingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateClientCertificate ¶
func (c *APIGateway) UpdateClientCertificate(input *UpdateClientCertificateInput) (*ClientCertificate, error)
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.
See UpdateClientCertificate for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateClientCertificate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateClientCertificateRequest method. req, resp := client.UpdateClientCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateDeployment ¶
func (c *APIGateway) UpdateDeployment(input *UpdateDeploymentInput) (*Deployment, error)
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.
See UpdateDeployment for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateDeployment method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateDeploymentRequest method. req, resp := client.UpdateDeploymentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateDocumentationPart ¶ added in v1.5.13
func (c *APIGateway) UpdateDocumentationPart(input *UpdateDocumentationPartInput) (*DocumentationPart, error)
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.UpdateDocumentationPartInput{ DocumentationPartId: 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.UpdateDocumentationPart(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) UpdateDocumentationPartRequest ¶ added in v1.5.13
func (c *APIGateway) UpdateDocumentationPartRequest(input *UpdateDocumentationPartInput) (req *request.Request, output *DocumentationPart)
UpdateDocumentationPartRequest generates a "aws/request.Request" representing the client's request for the UpdateDocumentationPart operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateDocumentationPart for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateDocumentationPart method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateDocumentationPartRequest method. req, resp := client.UpdateDocumentationPartRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateDocumentationVersion ¶ added in v1.5.13
func (c *APIGateway) UpdateDocumentationVersion(input *UpdateDocumentationVersionInput) (*DocumentationVersion, error)
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.UpdateDocumentationVersionInput{ DocumentationVersion: 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.UpdateDocumentationVersion(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) UpdateDocumentationVersionRequest ¶ added in v1.5.13
func (c *APIGateway) UpdateDocumentationVersionRequest(input *UpdateDocumentationVersionInput) (req *request.Request, output *DocumentationVersion)
UpdateDocumentationVersionRequest generates a "aws/request.Request" representing the client's request for the UpdateDocumentationVersion operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateDocumentationVersion for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateDocumentationVersion method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateDocumentationVersionRequest method. req, resp := client.UpdateDocumentationVersionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateDomainName ¶
func (c *APIGateway) UpdateDomainName(input *UpdateDomainNameInput) (*DomainName, error)
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.
See UpdateDomainName for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateDomainName method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateDomainNameRequest method. req, resp := client.UpdateDomainNameRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateIntegration ¶
func (c *APIGateway) UpdateIntegration(input *UpdateIntegrationInput) (*Integration, error)
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.
See UpdateIntegration for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateIntegration method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateIntegrationRequest method. req, resp := client.UpdateIntegrationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateIntegrationResponse ¶
func (c *APIGateway) UpdateIntegrationResponse(input *UpdateIntegrationResponseInput) (*IntegrationResponse, error)
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.
See UpdateIntegrationResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateIntegrationResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateIntegrationResponseRequest method. req, resp := client.UpdateIntegrationResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateMethod ¶
func (c *APIGateway) UpdateMethod(input *UpdateMethodInput) (*Method, error)
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.
See UpdateMethod for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateMethod method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateMethodRequest method. req, resp := client.UpdateMethodRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateMethodResponse ¶
func (c *APIGateway) UpdateMethodResponse(input *UpdateMethodResponseInput) (*MethodResponse, error)
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.
See UpdateMethodResponse for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateMethodResponse method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateMethodResponseRequest method. req, resp := client.UpdateMethodResponseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateModel ¶
func (c *APIGateway) UpdateModel(input *UpdateModelInput) (*Model, error)
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.
See UpdateModel for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateModel method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateModelRequest method. req, resp := client.UpdateModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateResource ¶
func (c *APIGateway) UpdateResource(input *UpdateResourceInput) (*Resource, error)
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.
See UpdateResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateResourceRequest method. req, resp := client.UpdateResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateRestApi ¶
func (c *APIGateway) UpdateRestApi(input *UpdateRestApiInput) (*RestApi, error)
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.
See UpdateRestApi for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateRestApi method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateRestApiRequest method. req, resp := client.UpdateRestApiRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateStage ¶
func (c *APIGateway) UpdateStage(input *UpdateStageInput) (*Stage, error)
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.
See UpdateStage for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateStage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateStageRequest method. req, resp := client.UpdateStageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) UpdateUsage ¶ added in v1.4.2
func (c *APIGateway) UpdateUsage(input *UpdateUsageInput) (*Usage, error)
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)
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.
See UpdateUsagePlan for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateUsagePlan method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateUsagePlanRequest method. req, resp := client.UpdateUsagePlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*APIGateway) 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.
See UpdateUsage for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateUsage method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateUsageRequest method. req, resp := client.UpdateUsageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
type Account ¶
type Account struct { // The version of the API keys used for the account. ApiKeyVersion *string `locationName:"apiKeyVersion" type:"string"` // The ARN of an Amazon CloudWatch role for the current Account. CloudwatchRoleArn *string `locationName:"cloudwatchRoleArn" type:"string"` // A list of features supported for the account. When usage plans are enabled, // the features list will include an entry of "UsagePlans". Features []*string `locationName:"features" type:"list"` // Specifies the API request limits configured for the current Account. ThrottleSettings *ThrottleSettings `locationName:"throttleSettings" type:"structure"` // contains filtered or unexported fields }
Represents an AWS account that is associated with Amazon API Gateway.
To view the account info, call GET on this resource.
Error Codes ¶
The following exception may be thrown when the request fails.
UnauthorizedException NotFoundException TooManyRequestsException For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes (http://docs.aws.amazon.com/apigateway/api-reference/handling-errors/#api-error-codes)
Example: Get the information about an account.
Request ¶
GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html", "name": "account", "templated": true }, "self": { "href": "/account" }, "account:update": { "href": "/account" } }, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": { "rateLimit": 500, "burstLimit": 1000 } } In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.
API Gateway Limits (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-limits.html)Developer Guide (http://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html), AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html)
func (*Account) SetApiKeyVersion ¶ added in v1.5.0
SetApiKeyVersion sets the ApiKeyVersion field's value.
func (*Account) SetCloudwatchRoleArn ¶ added in v1.5.0
SetCloudwatchRoleArn sets the CloudwatchRoleArn field's value.
func (*Account) SetFeatures ¶ added in v1.5.0
SetFeatures sets the Features field's value.
func (*Account) SetThrottleSettings ¶ added in v1.5.0
func (s *Account) SetThrottleSettings(v *ThrottleSettings) *Account
SetThrottleSettings sets the ThrottleSettings field's value.
type ApiKey ¶
type ApiKey struct { // The date when the API Key was created, in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm). CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"` // An AWS Marketplace customer identifier , when integrating with the AWS SaaS // Marketplace. CustomerId *string `locationName:"customerId" type:"string"` // The description of the API Key. Description *string `locationName:"description" type:"string"` // Specifies whether the API Key can be used by callers. Enabled *bool `locationName:"enabled" type:"boolean"` // The identifier of the API Key. Id *string `locationName:"id" type:"string"` // 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)
func (*ApiKey) SetCreatedDate ¶ added in v1.5.0
SetCreatedDate sets the CreatedDate field's value.
func (*ApiKey) SetCustomerId ¶ added in v1.5.13
SetCustomerId sets the CustomerId field's value.
func (*ApiKey) SetDescription ¶ added in v1.5.0
SetDescription sets the Description field's value.
func (*ApiKey) SetEnabled ¶ added in v1.5.0
SetEnabled sets the Enabled field's value.
func (*ApiKey) SetLastUpdatedDate ¶ added in v1.5.0
SetLastUpdatedDate sets the LastUpdatedDate field's value.
func (*ApiKey) SetStageKeys ¶ added in v1.5.0
SetStageKeys sets the StageKeys field's value.
type ApiStage ¶ added in v1.4.2
type ApiStage struct { // API Id of the associated API stage in a usage plan. ApiId *string `locationName:"apiId" type:"string"` // API stage name of the associated API stage in a usage plan. Stage *string `locationName:"stage" type:"string"` // contains filtered or unexported fields }
API stage name of the associated API stage in a usage plan.
type Authorizer ¶ added in v1.1.2
type Authorizer struct { // Optional customer-defined field, used in Swagger imports/exports. Has no // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the credentials required for the authorizer, if any. Two options // are available. To specify an IAM role for Amazon API Gateway to assume, use // the role's Amazon Resource Name (ARN). To use resource-based permissions // on the Lambda function, specify null. AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"` // The TTL in seconds of cached authorizer results. If greater than 0, API Gateway // will cache authorizer responses. If this field is not set, the default value // is 300. The maximum value is 3600, or 1 hour. AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` // [Required] Specifies the authorizer's Uniform Resource Identifier (URI). // For TOKEN authorizers, this must be a well-formed Lambda function URI, for // example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, // where {region} is the same as the region hosting the Lambda function, path // indicates that the remaining substring in the URI should be treated as the // path to the resource, including the initial /. For Lambda functions, this // is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. AuthorizerUri *string `locationName:"authorizerUri" type:"string"` // The identifier for the authorizer resource. Id *string `locationName:"id" type:"string"` // [Required] The source of the identity in an incoming request. For a TOKEN // authorizer, this value is a mapping expression with the same syntax as integration // parameter mappings. The only valid source for tokens is 'header', so the // expression should match 'method.request.header.[headerName]'. The value of // the header '[headerName]' will be interpreted as the incoming token. For // COGNITO_USER_POOLS authorizers, this property is used. IdentitySource *string `locationName:"identitySource" type:"string"` // A validation expression for the incoming identity. For TOKEN authorizers, // this value should be a regular expression. The incoming token from the client // is matched against this expression, and will proceed if the token matches. // If the token doesn't match, the client receives a 401 Unauthorized response. IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` // [Required] The name of the authorizer. Name *string `locationName:"name" type:"string"` // A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this // is not defined. For authorizers of the COGNITO_USER_POOLS type, each element // corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. ProviderARNs []*string `locationName:"providerARNs" type:"list"` // [Required] The type of the authorizer. Currently, the valid type is TOKEN // for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool. Type *string `locationName:"type" type:"string" enum:"AuthorizerType"` // contains filtered or unexported fields }
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
Enable custom authorization (http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html)
func (Authorizer) GoString ¶ added in v1.1.2
func (s Authorizer) GoString() string
GoString returns the string representation
func (*Authorizer) SetAuthType ¶ added in v1.5.0
func (s *Authorizer) SetAuthType(v string) *Authorizer
SetAuthType sets the AuthType field's value.
func (*Authorizer) SetAuthorizerCredentials ¶ added in v1.5.0
func (s *Authorizer) SetAuthorizerCredentials(v string) *Authorizer
SetAuthorizerCredentials sets the AuthorizerCredentials field's value.
func (*Authorizer) SetAuthorizerResultTtlInSeconds ¶ added in v1.5.0
func (s *Authorizer) SetAuthorizerResultTtlInSeconds(v int64) *Authorizer
SetAuthorizerResultTtlInSeconds sets the AuthorizerResultTtlInSeconds field's value.
func (*Authorizer) SetAuthorizerUri ¶ added in v1.5.0
func (s *Authorizer) SetAuthorizerUri(v string) *Authorizer
SetAuthorizerUri sets the AuthorizerUri field's value.
func (*Authorizer) SetId ¶ added in v1.5.0
func (s *Authorizer) SetId(v string) *Authorizer
SetId sets the Id field's value.
func (*Authorizer) SetIdentitySource ¶ added in v1.5.0
func (s *Authorizer) SetIdentitySource(v string) *Authorizer
SetIdentitySource sets the IdentitySource field's value.
func (*Authorizer) SetIdentityValidationExpression ¶ added in v1.5.0
func (s *Authorizer) SetIdentityValidationExpression(v string) *Authorizer
SetIdentityValidationExpression sets the IdentityValidationExpression field's value.
func (*Authorizer) SetName ¶ added in v1.5.0
func (s *Authorizer) SetName(v string) *Authorizer
SetName sets the Name field's value.
func (*Authorizer) SetProviderARNs ¶ added in v1.5.0
func (s *Authorizer) SetProviderARNs(v []*string) *Authorizer
SetProviderARNs sets the ProviderARNs field's value.
func (*Authorizer) SetType ¶ added in v1.5.0
func (s *Authorizer) SetType(v string) *Authorizer
SetType sets the Type field's value.
func (Authorizer) String ¶ added in v1.1.2
func (s Authorizer) String() string
String returns the string representation
type BasePathMapping ¶
type BasePathMapping struct { // The base path name that callers of the API must provide as part of the URL // after the domain name. BasePath *string `locationName:"basePath" type:"string"` // The 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) SetBasePath ¶ added in v1.5.0
func (s *BasePathMapping) SetBasePath(v string) *BasePathMapping
SetBasePath sets the BasePath field's value.
func (*BasePathMapping) SetRestApiId ¶ added in v1.5.0
func (s *BasePathMapping) SetRestApiId(v string) *BasePathMapping
SetRestApiId sets the RestApiId field's value.
func (*BasePathMapping) SetStage ¶ added in v1.5.0
func (s *BasePathMapping) SetStage(v string) *BasePathMapping
SetStage sets the Stage field's value.
func (BasePathMapping) String ¶
func (s BasePathMapping) String() string
String returns the string representation
type ClientCertificate ¶
type ClientCertificate struct { // The identifier of the client certificate. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // The date when the client certificate was created, in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm). 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). 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) SetClientCertificateId ¶ added in v1.5.0
func (s *ClientCertificate) SetClientCertificateId(v string) *ClientCertificate
SetClientCertificateId sets the ClientCertificateId field's value.
func (*ClientCertificate) SetCreatedDate ¶ added in v1.5.0
func (s *ClientCertificate) SetCreatedDate(v time.Time) *ClientCertificate
SetCreatedDate sets the CreatedDate field's value.
func (*ClientCertificate) SetDescription ¶ added in v1.5.0
func (s *ClientCertificate) SetDescription(v string) *ClientCertificate
SetDescription sets the Description field's value.
func (*ClientCertificate) SetExpirationDate ¶ added in v1.5.0
func (s *ClientCertificate) SetExpirationDate(v time.Time) *ClientCertificate
SetExpirationDate sets the ExpirationDate field's value.
func (*ClientCertificate) SetPemEncodedCertificate ¶ added in v1.5.0
func (s *ClientCertificate) SetPemEncodedCertificate(v string) *ClientCertificate
SetPemEncodedCertificate sets the PemEncodedCertificate field's value.
func (ClientCertificate) String ¶
func (s ClientCertificate) String() string
String returns the string representation
type CreateApiKeyInput ¶
type CreateApiKeyInput struct { // An AWS Marketplace customer identifier , when integrating with the AWS SaaS // Marketplace. CustomerId *string `locationName:"customerId" type:"string"` // The description of the ApiKey. Description *string `locationName:"description" type:"string"` // Specifies whether the ApiKey can be used by callers. Enabled *bool `locationName:"enabled" type:"boolean"` // Specifies whether (true) or not (false) the key identifier is distinct from // the created API key value. GenerateDistinctId *bool `locationName:"generateDistinctId" type:"boolean"` // The name of the ApiKey. Name *string `locationName:"name" type:"string"` // DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. StageKeys []*StageKey `locationName:"stageKeys" type:"list"` // Specifies a value of the API key. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
Request to create an ApiKey resource.
func (CreateApiKeyInput) GoString ¶
func (s CreateApiKeyInput) GoString() string
GoString returns the string representation
func (*CreateApiKeyInput) SetCustomerId ¶ added in v1.5.13
func (s *CreateApiKeyInput) SetCustomerId(v string) *CreateApiKeyInput
SetCustomerId sets the CustomerId field's value.
func (*CreateApiKeyInput) SetDescription ¶ added in v1.5.0
func (s *CreateApiKeyInput) SetDescription(v string) *CreateApiKeyInput
SetDescription sets the Description field's value.
func (*CreateApiKeyInput) SetEnabled ¶ added in v1.5.0
func (s *CreateApiKeyInput) SetEnabled(v bool) *CreateApiKeyInput
SetEnabled sets the Enabled field's value.
func (*CreateApiKeyInput) SetGenerateDistinctId ¶ added in v1.5.0
func (s *CreateApiKeyInput) SetGenerateDistinctId(v bool) *CreateApiKeyInput
SetGenerateDistinctId sets the GenerateDistinctId field's value.
func (*CreateApiKeyInput) SetName ¶ added in v1.5.0
func (s *CreateApiKeyInput) SetName(v string) *CreateApiKeyInput
SetName sets the Name field's value.
func (*CreateApiKeyInput) SetStageKeys ¶ added in v1.5.0
func (s *CreateApiKeyInput) SetStageKeys(v []*StageKey) *CreateApiKeyInput
SetStageKeys sets the StageKeys field's value.
func (*CreateApiKeyInput) SetValue ¶ added in v1.5.0
func (s *CreateApiKeyInput) SetValue(v string) *CreateApiKeyInput
SetValue sets the Value field's value.
func (CreateApiKeyInput) String ¶
func (s CreateApiKeyInput) String() string
String returns the string representation
type CreateAuthorizerInput ¶ added in v1.1.2
type CreateAuthorizerInput struct { // Optional customer-defined field, used in Swagger imports/exports. Has no // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the credentials required for the authorizer, if any. AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"` // The TTL of cached authorizer results. AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` // [Required] Specifies the authorizer's Uniform Resource Identifier (URI). AuthorizerUri *string `locationName:"authorizerUri" type:"string"` // [Required] The source of the identity in an incoming request. // // IdentitySource is a required field IdentitySource *string `locationName:"identitySource" type:"string" required:"true"` // A validation expression for the incoming identity. IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` // [Required] The name of the authorizer. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // A list of the Cognito Your User Pool authorizer's provider ARNs. ProviderARNs []*string `locationName:"providerARNs" type:"list"` // The RestApi identifier under which the Authorizer will be created. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The type of the authorizer. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"AuthorizerType"` // contains filtered or unexported fields }
Request to add a new Authorizer to an existing RestApi resource.
func (CreateAuthorizerInput) GoString ¶ added in v1.1.2
func (s CreateAuthorizerInput) GoString() string
GoString returns the string representation
func (*CreateAuthorizerInput) SetAuthType ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetAuthType(v string) *CreateAuthorizerInput
SetAuthType sets the AuthType field's value.
func (*CreateAuthorizerInput) SetAuthorizerCredentials ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetAuthorizerCredentials(v string) *CreateAuthorizerInput
SetAuthorizerCredentials sets the AuthorizerCredentials field's value.
func (*CreateAuthorizerInput) SetAuthorizerResultTtlInSeconds ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetAuthorizerResultTtlInSeconds(v int64) *CreateAuthorizerInput
SetAuthorizerResultTtlInSeconds sets the AuthorizerResultTtlInSeconds field's value.
func (*CreateAuthorizerInput) SetAuthorizerUri ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetAuthorizerUri(v string) *CreateAuthorizerInput
SetAuthorizerUri sets the AuthorizerUri field's value.
func (*CreateAuthorizerInput) SetIdentitySource ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetIdentitySource(v string) *CreateAuthorizerInput
SetIdentitySource sets the IdentitySource field's value.
func (*CreateAuthorizerInput) SetIdentityValidationExpression ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetIdentityValidationExpression(v string) *CreateAuthorizerInput
SetIdentityValidationExpression sets the IdentityValidationExpression field's value.
func (*CreateAuthorizerInput) SetName ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetName(v string) *CreateAuthorizerInput
SetName sets the Name field's value.
func (*CreateAuthorizerInput) SetProviderARNs ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetProviderARNs(v []*string) *CreateAuthorizerInput
SetProviderARNs sets the ProviderARNs field's value.
func (*CreateAuthorizerInput) SetRestApiId ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetRestApiId(v string) *CreateAuthorizerInput
SetRestApiId sets the RestApiId field's value.
func (*CreateAuthorizerInput) SetType ¶ added in v1.5.0
func (s *CreateAuthorizerInput) SetType(v string) *CreateAuthorizerInput
SetType sets the Type field's value.
func (CreateAuthorizerInput) String ¶ added in v1.1.2
func (s CreateAuthorizerInput) String() string
String returns the string representation
func (*CreateAuthorizerInput) Validate ¶ added in v1.1.21
func (s *CreateAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateBasePathMappingInput ¶
type CreateBasePathMappingInput struct { // The base path name that callers of the API must provide as part of the URL // after the domain name. This value must be unique for all of the mappings // across a single API. Leave this blank if you do not want callers to specify // a base path name after the domain name. BasePath *string `locationName:"basePath" type:"string"` // The domain name of the BasePathMapping resource to create. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // The name of the API that you want to apply this mapping to. // // RestApiId is a required field RestApiId *string `locationName:"restApiId" type:"string" required:"true"` // The name of the API's stage that you want to use for this mapping. Leave // this blank if you do not want callers to explicitly specify the stage name // after any base path name. Stage *string `locationName:"stage" type:"string"` // contains filtered or unexported fields }
Requests Amazon API Gateway to create a new BasePathMapping resource.
func (CreateBasePathMappingInput) GoString ¶
func (s CreateBasePathMappingInput) GoString() string
GoString returns the string representation
func (*CreateBasePathMappingInput) SetBasePath ¶ added in v1.5.0
func (s *CreateBasePathMappingInput) SetBasePath(v string) *CreateBasePathMappingInput
SetBasePath sets the BasePath field's value.
func (*CreateBasePathMappingInput) SetDomainName ¶ added in v1.5.0
func (s *CreateBasePathMappingInput) SetDomainName(v string) *CreateBasePathMappingInput
SetDomainName sets the DomainName field's value.
func (*CreateBasePathMappingInput) SetRestApiId ¶ added in v1.5.0
func (s *CreateBasePathMappingInput) SetRestApiId(v string) *CreateBasePathMappingInput
SetRestApiId sets the RestApiId field's value.
func (*CreateBasePathMappingInput) SetStage ¶ added in v1.5.0
func (s *CreateBasePathMappingInput) SetStage(v string) *CreateBasePathMappingInput
SetStage sets the Stage field's value.
func (CreateBasePathMappingInput) String ¶
func (s CreateBasePathMappingInput) String() string
String returns the string representation
func (*CreateBasePathMappingInput) Validate ¶ added in v1.1.21
func (s *CreateBasePathMappingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDeploymentInput ¶
type CreateDeploymentInput struct { // Enables a cache cluster for the Stage resource specified in the input. CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` // Specifies the cache cluster size for the Stage resource specified in the // input, if a cache cluster is enabled. CacheClusterSize *string `locationName:"cacheClusterSize" type:"string" enum:"CacheClusterSize"` // The description for the Deployment resource to create. Description *string `locationName:"description" type:"string"` // The RestApi resource identifier for the Deployment resource to create. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The description of the Stage resource for the Deployment resource to create. StageDescription *string `locationName:"stageDescription" type:"string"` // The name of the Stage resource for the Deployment resource to create. StageName *string `locationName:"stageName" type:"string"` // A map that defines the stage variables for the Stage resource that is associated // with the new deployment. Variable names can have alphanumeric and underscore // characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Variables map[string]*string `locationName:"variables" type:"map"` // contains filtered or unexported fields }
Requests Amazon API Gateway to create a Deployment resource.
func (CreateDeploymentInput) GoString ¶
func (s CreateDeploymentInput) GoString() string
GoString returns the string representation
func (*CreateDeploymentInput) SetCacheClusterEnabled ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetCacheClusterEnabled(v bool) *CreateDeploymentInput
SetCacheClusterEnabled sets the CacheClusterEnabled field's value.
func (*CreateDeploymentInput) SetCacheClusterSize ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetCacheClusterSize(v string) *CreateDeploymentInput
SetCacheClusterSize sets the CacheClusterSize field's value.
func (*CreateDeploymentInput) SetDescription ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetDescription(v string) *CreateDeploymentInput
SetDescription sets the Description field's value.
func (*CreateDeploymentInput) SetRestApiId ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetRestApiId(v string) *CreateDeploymentInput
SetRestApiId sets the RestApiId field's value.
func (*CreateDeploymentInput) SetStageDescription ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetStageDescription(v string) *CreateDeploymentInput
SetStageDescription sets the StageDescription field's value.
func (*CreateDeploymentInput) SetStageName ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetStageName(v string) *CreateDeploymentInput
SetStageName sets the StageName field's value.
func (*CreateDeploymentInput) SetVariables ¶ added in v1.5.0
func (s *CreateDeploymentInput) SetVariables(v map[string]*string) *CreateDeploymentInput
SetVariables sets the Variables field's value.
func (CreateDeploymentInput) String ¶
func (s CreateDeploymentInput) String() string
String returns the string representation
func (*CreateDeploymentInput) Validate ¶ added in v1.1.21
func (s *CreateDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDocumentationPartInput ¶ added in v1.5.13
type CreateDocumentationPartInput struct { // [Required] The location of the targeted API entity of the to-be-created documentation // part. // // Location is a required field Location *DocumentationPartLocation `locationName:"location" type:"structure" required:"true"` // [Required] The new documentation content map of the targeted API entity. // Enclosed key-value pairs are API-specific, but only Swagger-compliant key-value // pairs can be exported and, hence, published. // // Properties is a required field Properties *string `locationName:"properties" type:"string" required:"true"` // [Required] The identifier of an API of the to-be-created documentation part. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Creates a new documentation part of a given API.
func (CreateDocumentationPartInput) GoString ¶ added in v1.5.13
func (s CreateDocumentationPartInput) GoString() string
GoString returns the string representation
func (*CreateDocumentationPartInput) SetLocation ¶ added in v1.5.13
func (s *CreateDocumentationPartInput) SetLocation(v *DocumentationPartLocation) *CreateDocumentationPartInput
SetLocation sets the Location field's value.
func (*CreateDocumentationPartInput) SetProperties ¶ added in v1.5.13
func (s *CreateDocumentationPartInput) SetProperties(v string) *CreateDocumentationPartInput
SetProperties sets the Properties field's value.
func (*CreateDocumentationPartInput) SetRestApiId ¶ added in v1.5.13
func (s *CreateDocumentationPartInput) SetRestApiId(v string) *CreateDocumentationPartInput
SetRestApiId sets the RestApiId field's value.
func (CreateDocumentationPartInput) String ¶ added in v1.5.13
func (s CreateDocumentationPartInput) String() string
String returns the string representation
func (*CreateDocumentationPartInput) Validate ¶ added in v1.5.13
func (s *CreateDocumentationPartInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDocumentationVersionInput ¶ added in v1.5.13
type CreateDocumentationVersionInput struct { // A description about the new documentation snapshot. Description *string `locationName:"description" type:"string"` // [Required] The version identifier of the new snapshot. // // DocumentationVersion is a required field DocumentationVersion *string `locationName:"documentationVersion" type:"string" required:"true"` // [Required] Specifies the API identifier of the to-be-created documentation // version. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The stage name to be associated with the new documentation snapshot. StageName *string `locationName:"stageName" type:"string"` // contains filtered or unexported fields }
Creates a new documentation version of a given API.
func (CreateDocumentationVersionInput) GoString ¶ added in v1.5.13
func (s CreateDocumentationVersionInput) GoString() string
GoString returns the string representation
func (*CreateDocumentationVersionInput) SetDescription ¶ added in v1.5.13
func (s *CreateDocumentationVersionInput) SetDescription(v string) *CreateDocumentationVersionInput
SetDescription sets the Description field's value.
func (*CreateDocumentationVersionInput) SetDocumentationVersion ¶ added in v1.5.13
func (s *CreateDocumentationVersionInput) SetDocumentationVersion(v string) *CreateDocumentationVersionInput
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*CreateDocumentationVersionInput) SetRestApiId ¶ added in v1.5.13
func (s *CreateDocumentationVersionInput) SetRestApiId(v string) *CreateDocumentationVersionInput
SetRestApiId sets the RestApiId field's value.
func (*CreateDocumentationVersionInput) SetStageName ¶ added in v1.5.13
func (s *CreateDocumentationVersionInput) SetStageName(v string) *CreateDocumentationVersionInput
SetStageName sets the StageName field's value.
func (CreateDocumentationVersionInput) String ¶ added in v1.5.13
func (s CreateDocumentationVersionInput) String() string
String returns the string representation
func (*CreateDocumentationVersionInput) Validate ¶ added in v1.5.13
func (s *CreateDocumentationVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDomainNameInput ¶
type CreateDomainNameInput struct { // The body of the server certificate provided by your certificate authority. // // CertificateBody is a required field 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 is a required field CertificateChain *string `locationName:"certificateChain" type:"string" required:"true"` // The name of the certificate. // // CertificateName is a required field CertificateName *string `locationName:"certificateName" type:"string" required:"true"` // Your certificate's private key. // // CertificatePrivateKey is a required field CertificatePrivateKey *string `locationName:"certificatePrivateKey" type:"string" required:"true"` // The name of the DomainName resource. // // DomainName is a required field DomainName *string `locationName:"domainName" type:"string" required:"true"` // contains filtered or unexported fields }
A request to create a new domain name.
func (CreateDomainNameInput) GoString ¶
func (s CreateDomainNameInput) GoString() string
GoString returns the string representation
func (*CreateDomainNameInput) SetCertificateBody ¶ added in v1.5.0
func (s *CreateDomainNameInput) SetCertificateBody(v string) *CreateDomainNameInput
SetCertificateBody sets the CertificateBody field's value.
func (*CreateDomainNameInput) SetCertificateChain ¶ added in v1.5.0
func (s *CreateDomainNameInput) SetCertificateChain(v string) *CreateDomainNameInput
SetCertificateChain sets the CertificateChain field's value.
func (*CreateDomainNameInput) SetCertificateName ¶ added in v1.5.0
func (s *CreateDomainNameInput) SetCertificateName(v string) *CreateDomainNameInput
SetCertificateName sets the CertificateName field's value.
func (*CreateDomainNameInput) SetCertificatePrivateKey ¶ added in v1.5.0
func (s *CreateDomainNameInput) SetCertificatePrivateKey(v string) *CreateDomainNameInput
SetCertificatePrivateKey sets the CertificatePrivateKey field's value.
func (*CreateDomainNameInput) SetDomainName ¶ added in v1.5.0
func (s *CreateDomainNameInput) SetDomainName(v string) *CreateDomainNameInput
SetDomainName sets the DomainName field's value.
func (CreateDomainNameInput) String ¶
func (s CreateDomainNameInput) String() string
String returns the string representation
func (*CreateDomainNameInput) Validate ¶ added in v1.1.21
func (s *CreateDomainNameInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateModelInput ¶
type CreateModelInput struct { // The content-type for the model. // // ContentType is a required field ContentType *string `locationName:"contentType" type:"string" required:"true"` // The description of the model. Description *string `locationName:"description" type:"string"` // The name of the model. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // The RestApi identifier under which the Model will be created. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The schema for the model. For application/json models, this should be JSON-schema // draft v4 (http://json-schema.org/documentation.html) model. Schema *string `locationName:"schema" type:"string"` // contains filtered or unexported fields }
Request to add a new Model to an existing RestApi resource.
func (CreateModelInput) GoString ¶
func (s CreateModelInput) GoString() string
GoString returns the string representation
func (*CreateModelInput) SetContentType ¶ added in v1.5.0
func (s *CreateModelInput) SetContentType(v string) *CreateModelInput
SetContentType sets the ContentType field's value.
func (*CreateModelInput) SetDescription ¶ added in v1.5.0
func (s *CreateModelInput) SetDescription(v string) *CreateModelInput
SetDescription sets the Description field's value.
func (*CreateModelInput) SetName ¶ added in v1.5.0
func (s *CreateModelInput) SetName(v string) *CreateModelInput
SetName sets the Name field's value.
func (*CreateModelInput) SetRestApiId ¶ added in v1.5.0
func (s *CreateModelInput) SetRestApiId(v string) *CreateModelInput
SetRestApiId sets the RestApiId field's value.
func (*CreateModelInput) SetSchema ¶ added in v1.5.0
func (s *CreateModelInput) SetSchema(v string) *CreateModelInput
SetSchema sets the Schema field's value.
func (CreateModelInput) String ¶
func (s CreateModelInput) String() string
String returns the string representation
func (*CreateModelInput) Validate ¶ added in v1.1.21
func (s *CreateModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateResourceInput ¶
type CreateResourceInput struct { // The parent resource's identifier. // // ParentId is a required field ParentId *string `location:"uri" locationName:"parent_id" type:"string" required:"true"` // The last path segment for this resource. // // PathPart is a required field PathPart *string `locationName:"pathPart" type:"string" required:"true"` // The identifier of the RestApi for the resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to create a Resource resource.
func (CreateResourceInput) GoString ¶
func (s CreateResourceInput) GoString() string
GoString returns the string representation
func (*CreateResourceInput) SetParentId ¶ added in v1.5.0
func (s *CreateResourceInput) SetParentId(v string) *CreateResourceInput
SetParentId sets the ParentId field's value.
func (*CreateResourceInput) SetPathPart ¶ added in v1.5.0
func (s *CreateResourceInput) SetPathPart(v string) *CreateResourceInput
SetPathPart sets the PathPart field's value.
func (*CreateResourceInput) SetRestApiId ¶ added in v1.5.0
func (s *CreateResourceInput) SetRestApiId(v string) *CreateResourceInput
SetRestApiId sets the RestApiId field's value.
func (CreateResourceInput) String ¶
func (s CreateResourceInput) String() string
String returns the string representation
func (*CreateResourceInput) Validate ¶ added in v1.1.21
func (s *CreateResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateRestApiInput ¶
type CreateRestApiInput struct { // The list of binary media types supported by the RestApi. By default, the // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []*string `locationName:"binaryMediaTypes" type:"list"` // The ID of the RestApi that you want to clone from. CloneFrom *string `locationName:"cloneFrom" type:"string"` // The description of the RestApi. Description *string `locationName:"description" type:"string"` // The name of the RestApi. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // A version identifier for the API. Version *string `locationName:"version" type:"string"` // contains filtered or unexported fields }
The POST Request to add a new RestApi resource to your collection.
func (CreateRestApiInput) GoString ¶
func (s CreateRestApiInput) GoString() string
GoString returns the string representation
func (*CreateRestApiInput) SetBinaryMediaTypes ¶ added in v1.5.7
func (s *CreateRestApiInput) SetBinaryMediaTypes(v []*string) *CreateRestApiInput
SetBinaryMediaTypes sets the BinaryMediaTypes field's value.
func (*CreateRestApiInput) SetCloneFrom ¶ added in v1.5.0
func (s *CreateRestApiInput) SetCloneFrom(v string) *CreateRestApiInput
SetCloneFrom sets the CloneFrom field's value.
func (*CreateRestApiInput) SetDescription ¶ added in v1.5.0
func (s *CreateRestApiInput) SetDescription(v string) *CreateRestApiInput
SetDescription sets the Description field's value.
func (*CreateRestApiInput) SetName ¶ added in v1.5.0
func (s *CreateRestApiInput) SetName(v string) *CreateRestApiInput
SetName sets the Name field's value.
func (*CreateRestApiInput) SetVersion ¶ added in v1.5.13
func (s *CreateRestApiInput) SetVersion(v string) *CreateRestApiInput
SetVersion sets the Version field's value.
func (CreateRestApiInput) String ¶
func (s CreateRestApiInput) String() string
String returns the string representation
func (*CreateRestApiInput) Validate ¶ added in v1.1.21
func (s *CreateRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateStageInput ¶
type CreateStageInput struct { // Whether cache clustering is enabled for the stage. CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` // The stage's cache cluster size. CacheClusterSize *string `locationName:"cacheClusterSize" type:"string" enum:"CacheClusterSize"` // The identifier of the Deployment resource for the Stage resource. // // DeploymentId is a required field DeploymentId *string `locationName:"deploymentId" type:"string" required:"true"` // The description of the Stage resource. Description *string `locationName:"description" type:"string"` // The version of the associated API documentation. DocumentationVersion *string `locationName:"documentationVersion" type:"string"` // The identifier of the RestApi resource for the Stage resource to create. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name for the Stage resource. // // StageName is a required field StageName *string `locationName:"stageName" type:"string" required:"true"` // A map that defines the stage variables for the new Stage resource. Variable // names can have alphanumeric and underscore characters, and the values must // match [A-Za-z0-9-._~:/?#&=,]+. Variables map[string]*string `locationName:"variables" type:"map"` // contains filtered or unexported fields }
Requests Amazon API Gateway to create a Stage resource.
func (CreateStageInput) GoString ¶
func (s CreateStageInput) GoString() string
GoString returns the string representation
func (*CreateStageInput) SetCacheClusterEnabled ¶ added in v1.5.0
func (s *CreateStageInput) SetCacheClusterEnabled(v bool) *CreateStageInput
SetCacheClusterEnabled sets the CacheClusterEnabled field's value.
func (*CreateStageInput) SetCacheClusterSize ¶ added in v1.5.0
func (s *CreateStageInput) SetCacheClusterSize(v string) *CreateStageInput
SetCacheClusterSize sets the CacheClusterSize field's value.
func (*CreateStageInput) SetDeploymentId ¶ added in v1.5.0
func (s *CreateStageInput) SetDeploymentId(v string) *CreateStageInput
SetDeploymentId sets the DeploymentId field's value.
func (*CreateStageInput) SetDescription ¶ added in v1.5.0
func (s *CreateStageInput) SetDescription(v string) *CreateStageInput
SetDescription sets the Description field's value.
func (*CreateStageInput) SetDocumentationVersion ¶ added in v1.5.13
func (s *CreateStageInput) SetDocumentationVersion(v string) *CreateStageInput
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*CreateStageInput) SetRestApiId ¶ added in v1.5.0
func (s *CreateStageInput) SetRestApiId(v string) *CreateStageInput
SetRestApiId sets the RestApiId field's value.
func (*CreateStageInput) SetStageName ¶ added in v1.5.0
func (s *CreateStageInput) SetStageName(v string) *CreateStageInput
SetStageName sets the StageName field's value.
func (*CreateStageInput) SetVariables ¶ added in v1.5.0
func (s *CreateStageInput) SetVariables(v map[string]*string) *CreateStageInput
SetVariables sets the Variables field's value.
func (CreateStageInput) String ¶
func (s CreateStageInput) String() string
String returns the string representation
func (*CreateStageInput) Validate ¶ added in v1.1.21
func (s *CreateStageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUsagePlanInput ¶ added in v1.4.2
type CreateUsagePlanInput struct { // The associated API stages of the usage plan. ApiStages []*ApiStage `locationName:"apiStages" type:"list"` // The description of the usage plan. Description *string `locationName:"description" type:"string"` // The name of the usage plan. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // The quota of the usage plan. Quota *QuotaSettings `locationName:"quota" type:"structure"` // The throttling limits of the usage plan. Throttle *ThrottleSettings `locationName:"throttle" type:"structure"` // contains filtered or unexported fields }
The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.
func (CreateUsagePlanInput) GoString ¶ added in v1.4.2
func (s CreateUsagePlanInput) GoString() string
GoString returns the string representation
func (*CreateUsagePlanInput) SetApiStages ¶ added in v1.5.0
func (s *CreateUsagePlanInput) SetApiStages(v []*ApiStage) *CreateUsagePlanInput
SetApiStages sets the ApiStages field's value.
func (*CreateUsagePlanInput) SetDescription ¶ added in v1.5.0
func (s *CreateUsagePlanInput) SetDescription(v string) *CreateUsagePlanInput
SetDescription sets the Description field's value.
func (*CreateUsagePlanInput) SetName ¶ added in v1.5.0
func (s *CreateUsagePlanInput) SetName(v string) *CreateUsagePlanInput
SetName sets the Name field's value.
func (*CreateUsagePlanInput) SetQuota ¶ added in v1.5.0
func (s *CreateUsagePlanInput) SetQuota(v *QuotaSettings) *CreateUsagePlanInput
SetQuota sets the Quota field's value.
func (*CreateUsagePlanInput) SetThrottle ¶ added in v1.5.0
func (s *CreateUsagePlanInput) SetThrottle(v *ThrottleSettings) *CreateUsagePlanInput
SetThrottle sets the Throttle field's value.
func (CreateUsagePlanInput) String ¶ added in v1.4.2
func (s CreateUsagePlanInput) String() string
String returns the string representation
func (*CreateUsagePlanInput) Validate ¶ added in v1.4.2
func (s *CreateUsagePlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUsagePlanKeyInput ¶ added in v1.4.2
type CreateUsagePlanKeyInput struct { // The identifier of a UsagePlanKey resource for a plan customer. // // KeyId is a required field KeyId *string `locationName:"keyId" type:"string" required:"true"` // The type of a UsagePlanKey resource for a plan customer. // // KeyType is a required field KeyType *string `locationName:"keyType" type:"string" required:"true"` // The Id of the UsagePlan resource representing the usage plan containing the // to-be-created UsagePlanKey resource representing a plan customer. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The POST request to create a usage plan key for adding an existing API key to a usage plan.
func (CreateUsagePlanKeyInput) GoString ¶ added in v1.4.2
func (s CreateUsagePlanKeyInput) GoString() string
GoString returns the string representation
func (*CreateUsagePlanKeyInput) SetKeyId ¶ added in v1.5.0
func (s *CreateUsagePlanKeyInput) SetKeyId(v string) *CreateUsagePlanKeyInput
SetKeyId sets the KeyId field's value.
func (*CreateUsagePlanKeyInput) SetKeyType ¶ added in v1.5.0
func (s *CreateUsagePlanKeyInput) SetKeyType(v string) *CreateUsagePlanKeyInput
SetKeyType sets the KeyType field's value.
func (*CreateUsagePlanKeyInput) SetUsagePlanId ¶ added in v1.5.0
func (s *CreateUsagePlanKeyInput) SetUsagePlanId(v string) *CreateUsagePlanKeyInput
SetUsagePlanId sets the UsagePlanId field's value.
func (CreateUsagePlanKeyInput) String ¶ added in v1.4.2
func (s CreateUsagePlanKeyInput) String() string
String returns the string representation
func (*CreateUsagePlanKeyInput) Validate ¶ added in v1.4.2
func (s *CreateUsagePlanKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApiKeyInput ¶
type DeleteApiKeyInput struct { // The identifier of the ApiKey resource to be deleted. // // ApiKey is a required field ApiKey *string `location:"uri" locationName:"api_Key" type:"string" required:"true"` // contains filtered or unexported fields }
A request to delete the ApiKey resource.
func (DeleteApiKeyInput) GoString ¶
func (s DeleteApiKeyInput) GoString() string
GoString returns the string representation
func (*DeleteApiKeyInput) SetApiKey ¶ added in v1.5.0
func (s *DeleteApiKeyInput) SetApiKey(v string) *DeleteApiKeyInput
SetApiKey sets the ApiKey field's value.
func (DeleteApiKeyInput) String ¶
func (s DeleteApiKeyInput) String() string
String returns the string representation
func (*DeleteApiKeyInput) Validate ¶ added in v1.1.21
func (s *DeleteApiKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApiKeyOutput ¶
type DeleteApiKeyOutput struct {
// contains filtered or unexported fields
}
func (DeleteApiKeyOutput) GoString ¶
func (s DeleteApiKeyOutput) GoString() string
GoString returns the string representation
func (DeleteApiKeyOutput) String ¶
func (s DeleteApiKeyOutput) String() string
String returns the string representation
type DeleteAuthorizerInput ¶ added in v1.1.2
type DeleteAuthorizerInput struct { // The identifier of the Authorizer resource. // // AuthorizerId is a required field AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // The RestApi identifier for the Authorizer resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete an existing Authorizer resource.
func (DeleteAuthorizerInput) GoString ¶ added in v1.1.2
func (s DeleteAuthorizerInput) GoString() string
GoString returns the string representation
func (*DeleteAuthorizerInput) SetAuthorizerId ¶ added in v1.5.0
func (s *DeleteAuthorizerInput) SetAuthorizerId(v string) *DeleteAuthorizerInput
SetAuthorizerId sets the AuthorizerId field's value.
func (*DeleteAuthorizerInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteAuthorizerInput) SetRestApiId(v string) *DeleteAuthorizerInput
SetRestApiId sets the RestApiId field's value.
func (DeleteAuthorizerInput) String ¶ added in v1.1.2
func (s DeleteAuthorizerInput) String() string
String returns the string representation
func (*DeleteAuthorizerInput) Validate ¶ added in v1.1.21
func (s *DeleteAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAuthorizerOutput ¶ added in v1.1.2
type DeleteAuthorizerOutput struct {
// contains filtered or unexported fields
}
func (DeleteAuthorizerOutput) GoString ¶ added in v1.1.2
func (s DeleteAuthorizerOutput) GoString() string
GoString returns the string representation
func (DeleteAuthorizerOutput) String ¶ added in v1.1.2
func (s DeleteAuthorizerOutput) String() string
String returns the string representation
type DeleteBasePathMappingInput ¶
type DeleteBasePathMappingInput struct { // The base path name of the BasePathMapping resource to delete. // // BasePath is a required field BasePath *string `location:"uri" locationName:"base_path" type:"string" required:"true"` // The domain name of the BasePathMapping resource to delete. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // contains filtered or unexported fields }
A request to delete the BasePathMapping resource.
func (DeleteBasePathMappingInput) GoString ¶
func (s DeleteBasePathMappingInput) GoString() string
GoString returns the string representation
func (*DeleteBasePathMappingInput) SetBasePath ¶ added in v1.5.0
func (s *DeleteBasePathMappingInput) SetBasePath(v string) *DeleteBasePathMappingInput
SetBasePath sets the BasePath field's value.
func (*DeleteBasePathMappingInput) SetDomainName ¶ added in v1.5.0
func (s *DeleteBasePathMappingInput) SetDomainName(v string) *DeleteBasePathMappingInput
SetDomainName sets the DomainName field's value.
func (DeleteBasePathMappingInput) String ¶
func (s DeleteBasePathMappingInput) String() string
String returns the string representation
func (*DeleteBasePathMappingInput) Validate ¶ added in v1.1.21
func (s *DeleteBasePathMappingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBasePathMappingOutput ¶
type DeleteBasePathMappingOutput struct {
// contains filtered or unexported fields
}
func (DeleteBasePathMappingOutput) GoString ¶
func (s DeleteBasePathMappingOutput) GoString() string
GoString returns the string representation
func (DeleteBasePathMappingOutput) String ¶
func (s DeleteBasePathMappingOutput) String() string
String returns the string representation
type DeleteClientCertificateInput ¶
type DeleteClientCertificateInput struct { // The identifier of the ClientCertificate resource to be deleted. // // ClientCertificateId is a required field ClientCertificateId *string `location:"uri" locationName:"clientcertificate_id" type:"string" required:"true"` // contains filtered or unexported fields }
A request to delete the ClientCertificate resource.
func (DeleteClientCertificateInput) GoString ¶
func (s DeleteClientCertificateInput) GoString() string
GoString returns the string representation
func (*DeleteClientCertificateInput) SetClientCertificateId ¶ added in v1.5.0
func (s *DeleteClientCertificateInput) SetClientCertificateId(v string) *DeleteClientCertificateInput
SetClientCertificateId sets the ClientCertificateId field's value.
func (DeleteClientCertificateInput) String ¶
func (s DeleteClientCertificateInput) String() string
String returns the string representation
func (*DeleteClientCertificateInput) Validate ¶ added in v1.1.21
func (s *DeleteClientCertificateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteClientCertificateOutput ¶
type DeleteClientCertificateOutput struct {
// contains filtered or unexported fields
}
func (DeleteClientCertificateOutput) GoString ¶
func (s DeleteClientCertificateOutput) GoString() string
GoString returns the string representation
func (DeleteClientCertificateOutput) String ¶
func (s DeleteClientCertificateOutput) String() string
String returns the string representation
type DeleteDeploymentInput ¶
type DeleteDeploymentInput struct { // The identifier of the Deployment resource to delete. // // DeploymentId is a required field DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` // The identifier of the RestApi resource for the Deployment resource to delete. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to delete a Deployment resource.
func (DeleteDeploymentInput) GoString ¶
func (s DeleteDeploymentInput) GoString() string
GoString returns the string representation
func (*DeleteDeploymentInput) SetDeploymentId ¶ added in v1.5.0
func (s *DeleteDeploymentInput) SetDeploymentId(v string) *DeleteDeploymentInput
SetDeploymentId sets the DeploymentId field's value.
func (*DeleteDeploymentInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteDeploymentInput) SetRestApiId(v string) *DeleteDeploymentInput
SetRestApiId sets the RestApiId field's value.
func (DeleteDeploymentInput) String ¶
func (s DeleteDeploymentInput) String() string
String returns the string representation
func (*DeleteDeploymentInput) Validate ¶ added in v1.1.21
func (s *DeleteDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDeploymentOutput ¶
type DeleteDeploymentOutput struct {
// contains filtered or unexported fields
}
func (DeleteDeploymentOutput) GoString ¶
func (s DeleteDeploymentOutput) GoString() string
GoString returns the string representation
func (DeleteDeploymentOutput) String ¶
func (s DeleteDeploymentOutput) String() string
String returns the string representation
type DeleteDocumentationPartInput ¶ added in v1.5.13
type DeleteDocumentationPartInput struct { // [Required] The identifier of the to-be-deleted documentation part. // // DocumentationPartId is a required field DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"` // [Required] Specifies the identifier of an API of the to-be-deleted documentation // part. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Deletes an existing documentation part of an API.
func (DeleteDocumentationPartInput) GoString ¶ added in v1.5.13
func (s DeleteDocumentationPartInput) GoString() string
GoString returns the string representation
func (*DeleteDocumentationPartInput) SetDocumentationPartId ¶ added in v1.5.13
func (s *DeleteDocumentationPartInput) SetDocumentationPartId(v string) *DeleteDocumentationPartInput
SetDocumentationPartId sets the DocumentationPartId field's value.
func (*DeleteDocumentationPartInput) SetRestApiId ¶ added in v1.5.13
func (s *DeleteDocumentationPartInput) SetRestApiId(v string) *DeleteDocumentationPartInput
SetRestApiId sets the RestApiId field's value.
func (DeleteDocumentationPartInput) String ¶ added in v1.5.13
func (s DeleteDocumentationPartInput) String() string
String returns the string representation
func (*DeleteDocumentationPartInput) Validate ¶ added in v1.5.13
func (s *DeleteDocumentationPartInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDocumentationPartOutput ¶ added in v1.5.13
type DeleteDocumentationPartOutput struct {
// contains filtered or unexported fields
}
func (DeleteDocumentationPartOutput) GoString ¶ added in v1.5.13
func (s DeleteDocumentationPartOutput) GoString() string
GoString returns the string representation
func (DeleteDocumentationPartOutput) String ¶ added in v1.5.13
func (s DeleteDocumentationPartOutput) String() string
String returns the string representation
type DeleteDocumentationVersionInput ¶ added in v1.5.13
type DeleteDocumentationVersionInput struct { // [Required] The version identifier of a to-be-deleted documentation snapshot. // // DocumentationVersion is a required field DocumentationVersion *string `location:"uri" locationName:"doc_version" type:"string" required:"true"` // [Required] The identifier of an API of a to-be-deleted documentation snapshot. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Deletes an existing documentation version of an API.
func (DeleteDocumentationVersionInput) GoString ¶ added in v1.5.13
func (s DeleteDocumentationVersionInput) GoString() string
GoString returns the string representation
func (*DeleteDocumentationVersionInput) SetDocumentationVersion ¶ added in v1.5.13
func (s *DeleteDocumentationVersionInput) SetDocumentationVersion(v string) *DeleteDocumentationVersionInput
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*DeleteDocumentationVersionInput) SetRestApiId ¶ added in v1.5.13
func (s *DeleteDocumentationVersionInput) SetRestApiId(v string) *DeleteDocumentationVersionInput
SetRestApiId sets the RestApiId field's value.
func (DeleteDocumentationVersionInput) String ¶ added in v1.5.13
func (s DeleteDocumentationVersionInput) String() string
String returns the string representation
func (*DeleteDocumentationVersionInput) Validate ¶ added in v1.5.13
func (s *DeleteDocumentationVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDocumentationVersionOutput ¶ added in v1.5.13
type DeleteDocumentationVersionOutput struct {
// contains filtered or unexported fields
}
func (DeleteDocumentationVersionOutput) GoString ¶ added in v1.5.13
func (s DeleteDocumentationVersionOutput) GoString() string
GoString returns the string representation
func (DeleteDocumentationVersionOutput) String ¶ added in v1.5.13
func (s DeleteDocumentationVersionOutput) String() string
String returns the string representation
type DeleteDomainNameInput ¶
type DeleteDomainNameInput struct { // The name of the DomainName resource to be deleted. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // contains filtered or unexported fields }
A request to delete the DomainName resource.
func (DeleteDomainNameInput) GoString ¶
func (s DeleteDomainNameInput) GoString() string
GoString returns the string representation
func (*DeleteDomainNameInput) SetDomainName ¶ added in v1.5.0
func (s *DeleteDomainNameInput) SetDomainName(v string) *DeleteDomainNameInput
SetDomainName sets the DomainName field's value.
func (DeleteDomainNameInput) String ¶
func (s DeleteDomainNameInput) String() string
String returns the string representation
func (*DeleteDomainNameInput) Validate ¶ added in v1.1.21
func (s *DeleteDomainNameInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDomainNameOutput ¶
type DeleteDomainNameOutput struct {
// contains filtered or unexported fields
}
func (DeleteDomainNameOutput) GoString ¶
func (s DeleteDomainNameOutput) GoString() string
GoString returns the string representation
func (DeleteDomainNameOutput) String ¶
func (s DeleteDomainNameOutput) String() string
String returns the string representation
type DeleteIntegrationInput ¶
type DeleteIntegrationInput struct { // Specifies a delete integration request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a delete integration request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies a delete integration request's API identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a delete integration request.
func (DeleteIntegrationInput) GoString ¶
func (s DeleteIntegrationInput) GoString() string
GoString returns the string representation
func (*DeleteIntegrationInput) SetHttpMethod ¶ added in v1.5.0
func (s *DeleteIntegrationInput) SetHttpMethod(v string) *DeleteIntegrationInput
SetHttpMethod sets the HttpMethod field's value.
func (*DeleteIntegrationInput) SetResourceId ¶ added in v1.5.0
func (s *DeleteIntegrationInput) SetResourceId(v string) *DeleteIntegrationInput
SetResourceId sets the ResourceId field's value.
func (*DeleteIntegrationInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteIntegrationInput) SetRestApiId(v string) *DeleteIntegrationInput
SetRestApiId sets the RestApiId field's value.
func (DeleteIntegrationInput) String ¶
func (s DeleteIntegrationInput) String() string
String returns the string representation
func (*DeleteIntegrationInput) Validate ¶ added in v1.1.21
func (s *DeleteIntegrationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteIntegrationOutput ¶
type DeleteIntegrationOutput struct {
// contains filtered or unexported fields
}
func (DeleteIntegrationOutput) GoString ¶
func (s DeleteIntegrationOutput) GoString() string
GoString returns the string representation
func (DeleteIntegrationOutput) String ¶
func (s DeleteIntegrationOutput) String() string
String returns the string representation
type DeleteIntegrationResponseInput ¶
type DeleteIntegrationResponseInput struct { // Specifies a delete integration response request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a delete integration response request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies a delete integration response request's API identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies a delete integration response request's status code. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a delete integration response request.
func (DeleteIntegrationResponseInput) GoString ¶
func (s DeleteIntegrationResponseInput) GoString() string
GoString returns the string representation
func (*DeleteIntegrationResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *DeleteIntegrationResponseInput) SetHttpMethod(v string) *DeleteIntegrationResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*DeleteIntegrationResponseInput) SetResourceId ¶ added in v1.5.0
func (s *DeleteIntegrationResponseInput) SetResourceId(v string) *DeleteIntegrationResponseInput
SetResourceId sets the ResourceId field's value.
func (*DeleteIntegrationResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteIntegrationResponseInput) SetRestApiId(v string) *DeleteIntegrationResponseInput
SetRestApiId sets the RestApiId field's value.
func (*DeleteIntegrationResponseInput) SetStatusCode ¶ added in v1.5.0
func (s *DeleteIntegrationResponseInput) SetStatusCode(v string) *DeleteIntegrationResponseInput
SetStatusCode sets the StatusCode field's value.
func (DeleteIntegrationResponseInput) String ¶
func (s DeleteIntegrationResponseInput) String() string
String returns the string representation
func (*DeleteIntegrationResponseInput) Validate ¶ added in v1.1.21
func (s *DeleteIntegrationResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteIntegrationResponseOutput ¶
type DeleteIntegrationResponseOutput struct {
// contains filtered or unexported fields
}
func (DeleteIntegrationResponseOutput) GoString ¶
func (s DeleteIntegrationResponseOutput) GoString() string
GoString returns the string representation
func (DeleteIntegrationResponseOutput) String ¶
func (s DeleteIntegrationResponseOutput) String() string
String returns the string representation
type DeleteMethodInput ¶
type DeleteMethodInput struct { // The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the Method resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete an existing Method resource.
func (DeleteMethodInput) GoString ¶
func (s DeleteMethodInput) GoString() string
GoString returns the string representation
func (*DeleteMethodInput) SetHttpMethod ¶ added in v1.5.0
func (s *DeleteMethodInput) SetHttpMethod(v string) *DeleteMethodInput
SetHttpMethod sets the HttpMethod field's value.
func (*DeleteMethodInput) SetResourceId ¶ added in v1.5.0
func (s *DeleteMethodInput) SetResourceId(v string) *DeleteMethodInput
SetResourceId sets the ResourceId field's value.
func (*DeleteMethodInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteMethodInput) SetRestApiId(v string) *DeleteMethodInput
SetRestApiId sets the RestApiId field's value.
func (DeleteMethodInput) String ¶
func (s DeleteMethodInput) String() string
String returns the string representation
func (*DeleteMethodInput) Validate ¶ added in v1.1.21
func (s *DeleteMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteMethodOutput ¶
type DeleteMethodOutput struct {
// contains filtered or unexported fields
}
func (DeleteMethodOutput) GoString ¶
func (s DeleteMethodOutput) GoString() string
GoString returns the string representation
func (DeleteMethodOutput) String ¶
func (s DeleteMethodOutput) String() string
String returns the string representation
type DeleteMethodResponseInput ¶
type DeleteMethodResponseInput struct { // The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the MethodResponse resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the MethodResponse resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The status code identifier for the MethodResponse resource. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
A request to delete an existing MethodResponse resource.
func (DeleteMethodResponseInput) GoString ¶
func (s DeleteMethodResponseInput) GoString() string
GoString returns the string representation
func (*DeleteMethodResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *DeleteMethodResponseInput) SetHttpMethod(v string) *DeleteMethodResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*DeleteMethodResponseInput) SetResourceId ¶ added in v1.5.0
func (s *DeleteMethodResponseInput) SetResourceId(v string) *DeleteMethodResponseInput
SetResourceId sets the ResourceId field's value.
func (*DeleteMethodResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteMethodResponseInput) SetRestApiId(v string) *DeleteMethodResponseInput
SetRestApiId sets the RestApiId field's value.
func (*DeleteMethodResponseInput) SetStatusCode ¶ added in v1.5.0
func (s *DeleteMethodResponseInput) SetStatusCode(v string) *DeleteMethodResponseInput
SetStatusCode sets the StatusCode field's value.
func (DeleteMethodResponseInput) String ¶
func (s DeleteMethodResponseInput) String() string
String returns the string representation
func (*DeleteMethodResponseInput) Validate ¶ added in v1.1.21
func (s *DeleteMethodResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteMethodResponseOutput ¶
type DeleteMethodResponseOutput struct {
// contains filtered or unexported fields
}
func (DeleteMethodResponseOutput) GoString ¶
func (s DeleteMethodResponseOutput) GoString() string
GoString returns the string representation
func (DeleteMethodResponseOutput) String ¶
func (s DeleteMethodResponseOutput) String() string
String returns the string representation
type DeleteModelInput ¶
type DeleteModelInput struct { // The name of the model to delete. // // ModelName is a required field ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // The RestApi under which the model will be deleted. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete an existing model in an existing RestApi resource.
func (DeleteModelInput) GoString ¶
func (s DeleteModelInput) GoString() string
GoString returns the string representation
func (*DeleteModelInput) SetModelName ¶ added in v1.5.0
func (s *DeleteModelInput) SetModelName(v string) *DeleteModelInput
SetModelName sets the ModelName field's value.
func (*DeleteModelInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteModelInput) SetRestApiId(v string) *DeleteModelInput
SetRestApiId sets the RestApiId field's value.
func (DeleteModelInput) String ¶
func (s DeleteModelInput) String() string
String returns the string representation
func (*DeleteModelInput) Validate ¶ added in v1.1.21
func (s *DeleteModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteModelOutput ¶
type DeleteModelOutput struct {
// contains filtered or unexported fields
}
func (DeleteModelOutput) GoString ¶
func (s DeleteModelOutput) GoString() string
GoString returns the string representation
func (DeleteModelOutput) String ¶
func (s DeleteModelOutput) String() string
String returns the string representation
type DeleteResourceInput ¶
type DeleteResourceInput struct { // The identifier of the Resource resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the Resource resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete a Resource.
func (DeleteResourceInput) GoString ¶
func (s DeleteResourceInput) GoString() string
GoString returns the string representation
func (*DeleteResourceInput) SetResourceId ¶ added in v1.5.0
func (s *DeleteResourceInput) SetResourceId(v string) *DeleteResourceInput
SetResourceId sets the ResourceId field's value.
func (*DeleteResourceInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteResourceInput) SetRestApiId(v string) *DeleteResourceInput
SetRestApiId sets the RestApiId field's value.
func (DeleteResourceInput) String ¶
func (s DeleteResourceInput) String() string
String returns the string representation
func (*DeleteResourceInput) Validate ¶ added in v1.1.21
func (s *DeleteResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteResourceOutput ¶
type DeleteResourceOutput struct {
// contains filtered or unexported fields
}
func (DeleteResourceOutput) GoString ¶
func (s DeleteResourceOutput) GoString() string
GoString returns the string representation
func (DeleteResourceOutput) String ¶
func (s DeleteResourceOutput) String() string
String returns the string representation
type DeleteRestApiInput ¶
type DeleteRestApiInput struct { // The ID of the RestApi you want to delete. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete the specified API from your collection.
func (DeleteRestApiInput) GoString ¶
func (s DeleteRestApiInput) GoString() string
GoString returns the string representation
func (*DeleteRestApiInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteRestApiInput) SetRestApiId(v string) *DeleteRestApiInput
SetRestApiId sets the RestApiId field's value.
func (DeleteRestApiInput) String ¶
func (s DeleteRestApiInput) String() string
String returns the string representation
func (*DeleteRestApiInput) Validate ¶ added in v1.1.21
func (s *DeleteRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteRestApiOutput ¶
type DeleteRestApiOutput struct {
// contains filtered or unexported fields
}
func (DeleteRestApiOutput) GoString ¶
func (s DeleteRestApiOutput) GoString() string
GoString returns the string representation
func (DeleteRestApiOutput) String ¶
func (s DeleteRestApiOutput) String() string
String returns the string representation
type DeleteStageInput ¶
type DeleteStageInput struct { // The identifier of the RestApi resource for the Stage resource to delete. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the Stage resource to delete. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to delete a Stage resource.
func (DeleteStageInput) GoString ¶
func (s DeleteStageInput) GoString() string
GoString returns the string representation
func (*DeleteStageInput) SetRestApiId ¶ added in v1.5.0
func (s *DeleteStageInput) SetRestApiId(v string) *DeleteStageInput
SetRestApiId sets the RestApiId field's value.
func (*DeleteStageInput) SetStageName ¶ added in v1.5.0
func (s *DeleteStageInput) SetStageName(v string) *DeleteStageInput
SetStageName sets the StageName field's value.
func (DeleteStageInput) String ¶
func (s DeleteStageInput) String() string
String returns the string representation
func (*DeleteStageInput) Validate ¶ added in v1.1.21
func (s *DeleteStageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteStageOutput ¶
type DeleteStageOutput struct {
// contains filtered or unexported fields
}
func (DeleteStageOutput) GoString ¶
func (s DeleteStageOutput) GoString() string
GoString returns the string representation
func (DeleteStageOutput) String ¶
func (s DeleteStageOutput) String() string
String returns the string representation
type DeleteUsagePlanInput ¶ added in v1.4.2
type DeleteUsagePlanInput struct { // The Id of the to-be-deleted usage plan. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The DELETE request to delete a 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) SetUsagePlanId ¶ added in v1.5.0
func (s *DeleteUsagePlanInput) SetUsagePlanId(v string) *DeleteUsagePlanInput
SetUsagePlanId sets the UsagePlanId field's value.
func (DeleteUsagePlanInput) String ¶ added in v1.4.2
func (s DeleteUsagePlanInput) String() string
String returns the string representation
func (*DeleteUsagePlanInput) Validate ¶ added in v1.4.2
func (s *DeleteUsagePlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUsagePlanKeyInput ¶ added in v1.4.2
type DeleteUsagePlanKeyInput struct { // The Id of the UsagePlanKey resource to be deleted. // // KeyId is a required field KeyId *string `location:"uri" locationName:"keyId" type:"string" required:"true"` // The Id of the UsagePlan resource representing the usage plan containing the // to-be-deleted UsagePlanKey resource representing a plan customer. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
func (DeleteUsagePlanKeyInput) GoString ¶ added in v1.4.2
func (s DeleteUsagePlanKeyInput) GoString() string
GoString returns the string representation
func (*DeleteUsagePlanKeyInput) SetKeyId ¶ added in v1.5.0
func (s *DeleteUsagePlanKeyInput) SetKeyId(v string) *DeleteUsagePlanKeyInput
SetKeyId sets the KeyId field's value.
func (*DeleteUsagePlanKeyInput) SetUsagePlanId ¶ added in v1.5.0
func (s *DeleteUsagePlanKeyInput) SetUsagePlanId(v string) *DeleteUsagePlanKeyInput
SetUsagePlanId sets the UsagePlanId field's value.
func (DeleteUsagePlanKeyInput) String ¶ added in v1.4.2
func (s DeleteUsagePlanKeyInput) String() string
String returns the string representation
func (*DeleteUsagePlanKeyInput) Validate ¶ added in v1.4.2
func (s *DeleteUsagePlanKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUsagePlanKeyOutput ¶ added in v1.4.2
type DeleteUsagePlanKeyOutput struct {
// contains filtered or unexported fields
}
func (DeleteUsagePlanKeyOutput) GoString ¶ added in v1.4.2
func (s DeleteUsagePlanKeyOutput) GoString() string
GoString returns the string representation
func (DeleteUsagePlanKeyOutput) String ¶ added in v1.4.2
func (s DeleteUsagePlanKeyOutput) String() string
String returns the string representation
type DeleteUsagePlanOutput ¶ added in v1.4.2
type DeleteUsagePlanOutput struct {
// contains filtered or unexported fields
}
func (DeleteUsagePlanOutput) GoString ¶ added in v1.4.2
func (s DeleteUsagePlanOutput) GoString() string
GoString returns the string representation
func (DeleteUsagePlanOutput) String ¶ added in v1.4.2
func (s DeleteUsagePlanOutput) String() string
String returns the string representation
type Deployment ¶
type Deployment struct { // A summary of the RestApi at the date and time that the deployment resource // was created. ApiSummary map[string]map[string]*MethodSnapshot `locationName:"apiSummary" type:"map"` // The date and time that the deployment resource was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"` // The description for the deployment resource. Description *string `locationName:"description" type:"string"` // The identifier for the deployment resource. Id *string `locationName:"id" type:"string"` // contains filtered or unexported fields }
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
To create a deployment, call POST on the Deployments resource of a RestApi. To view, update, or delete a deployment, call GET, PATCH, or DELETE on the specified deployment resource (/restapis/{restapi_id}/deployments/{deployment_id}).
RestApi, Deployments, Stage, AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html), AWS SDKs (https://aws.amazon.com/tools/)
func (Deployment) GoString ¶
func (s Deployment) GoString() string
GoString returns the string representation
func (*Deployment) SetApiSummary ¶ added in v1.5.0
func (s *Deployment) SetApiSummary(v map[string]map[string]*MethodSnapshot) *Deployment
SetApiSummary sets the ApiSummary field's value.
func (*Deployment) SetCreatedDate ¶ added in v1.5.0
func (s *Deployment) SetCreatedDate(v time.Time) *Deployment
SetCreatedDate sets the CreatedDate field's value.
func (*Deployment) SetDescription ¶ added in v1.5.0
func (s *Deployment) SetDescription(v string) *Deployment
SetDescription sets the Description field's value.
func (*Deployment) SetId ¶ added in v1.5.0
func (s *Deployment) SetId(v string) *Deployment
SetId sets the Id field's value.
func (Deployment) String ¶
func (s Deployment) String() string
String returns the string representation
type DocumentationPart ¶ added in v1.5.13
type DocumentationPart struct { // The DocumentationPart identifier, generated by Amazon API Gateway when the // DocumentationPart is created. Id *string `locationName:"id" type:"string"` // The location of the API entity to which the documentation applies. Valid // fields depend on the targeted API entity type. All the valid location fields // are not required. If not explicitly specified, a valid location field is // treated as a wildcard and associated documentation content may be inherited // by matching entities, unless overridden. Location *DocumentationPartLocation `locationName:"location" type:"structure"` // A content map of API-specific key-value pairs describing the targeted API // entity. The map must be encoded as a JSON string, e.g., "{ \"description\": // \"The API does ...\" }". Only Swagger-compliant documentation-related fields // from the properties map are exported and, hence, published as part of the // API entity definitions, while the original documentation parts are exported // in a Swagger extension of x-amazon-apigateway-documentation. Properties *string `locationName:"properties" type:"string"` // contains filtered or unexported fields }
A documentation part for a targeted API entity.
A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.
The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.
Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationParts
func (DocumentationPart) GoString ¶ added in v1.5.13
func (s DocumentationPart) GoString() string
GoString returns the string representation
func (*DocumentationPart) SetId ¶ added in v1.5.13
func (s *DocumentationPart) SetId(v string) *DocumentationPart
SetId sets the Id field's value.
func (*DocumentationPart) SetLocation ¶ added in v1.5.13
func (s *DocumentationPart) SetLocation(v *DocumentationPartLocation) *DocumentationPart
SetLocation sets the Location field's value.
func (*DocumentationPart) SetProperties ¶ added in v1.5.13
func (s *DocumentationPart) SetProperties(v string) *DocumentationPart
SetProperties sets the Properties field's value.
func (DocumentationPart) String ¶ added in v1.5.13
func (s DocumentationPart) String() string
String returns the string representation
type DocumentationPartLocation ¶ added in v1.5.13
type DocumentationPartLocation struct { // The HTTP verb of a method. It is a valid field for the API entity types of // METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, // RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. // When an applicable child entity inherits the content of an entity of the // same type with more general specifications of the other location attributes, // the child entity's method attribute must match that of the parent entity // exactly. Method *string `locationName:"method" type:"string"` // The name of the targeted API entity. It is a valid and required field for // the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, // REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field // for any other entity type. Name *string `locationName:"name" type:"string"` // The URL path of the target. It is a valid field for the API entity types // of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, // RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for // the root resource. When an applicable child entity inherits the content of // another entity of the same type with more general specifications of the other // location attributes, the child entity's path attribute must match that of // the parent entity as a prefix. Path *string `locationName:"path" type:"string"` // The HTTP status code of a response. It is a valid field for the API entity // types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value // is * for any status code. When an applicable child entity inherits the content // of an entity of the same type with more general specifications of the other // location attributes, the child entity's statusCode attribute must match that // of the parent entity exactly. StatusCode *string `locationName:"statusCode" type:"string"` // The type of API entity to which the documentation content applies. It is // a valid and required field for API entity types of API, AUTHORIZER, MODEL, // RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, // RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not // apply to any entity of the API, AUTHROZER, MODEL, or RESOURCE type. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"DocumentationPartType"` // contains filtered or unexported fields }
Specifies the target API entity to which the documentation applies.
func (DocumentationPartLocation) GoString ¶ added in v1.5.13
func (s DocumentationPartLocation) GoString() string
GoString returns the string representation
func (*DocumentationPartLocation) SetMethod ¶ added in v1.5.13
func (s *DocumentationPartLocation) SetMethod(v string) *DocumentationPartLocation
SetMethod sets the Method field's value.
func (*DocumentationPartLocation) SetName ¶ added in v1.5.13
func (s *DocumentationPartLocation) SetName(v string) *DocumentationPartLocation
SetName sets the Name field's value.
func (*DocumentationPartLocation) SetPath ¶ added in v1.5.13
func (s *DocumentationPartLocation) SetPath(v string) *DocumentationPartLocation
SetPath sets the Path field's value.
func (*DocumentationPartLocation) SetStatusCode ¶ added in v1.5.13
func (s *DocumentationPartLocation) SetStatusCode(v string) *DocumentationPartLocation
SetStatusCode sets the StatusCode field's value.
func (*DocumentationPartLocation) SetType ¶ added in v1.5.13
func (s *DocumentationPartLocation) SetType(v string) *DocumentationPartLocation
SetType sets the Type field's value.
func (DocumentationPartLocation) String ¶ added in v1.5.13
func (s DocumentationPartLocation) String() string
String returns the string representation
func (*DocumentationPartLocation) Validate ¶ added in v1.5.13
func (s *DocumentationPartLocation) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DocumentationVersion ¶ added in v1.5.13
type DocumentationVersion struct { // The date when the API documentation snapshot is created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"` // The description of the API documentation snapshot. Description *string `locationName:"description" type:"string"` // The version identifier of the API documentation snapshot. Version *string `locationName:"version" type:"string"` // contains filtered or unexported fields }
A snapshot of the documentation of an API.
Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.
Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart, DocumentationVersions
func (DocumentationVersion) GoString ¶ added in v1.5.13
func (s DocumentationVersion) GoString() string
GoString returns the string representation
func (*DocumentationVersion) SetCreatedDate ¶ added in v1.5.13
func (s *DocumentationVersion) SetCreatedDate(v time.Time) *DocumentationVersion
SetCreatedDate sets the CreatedDate field's value.
func (*DocumentationVersion) SetDescription ¶ added in v1.5.13
func (s *DocumentationVersion) SetDescription(v string) *DocumentationVersion
SetDescription sets the Description field's value.
func (*DocumentationVersion) SetVersion ¶ added in v1.5.13
func (s *DocumentationVersion) SetVersion(v string) *DocumentationVersion
SetVersion sets the Version field's value.
func (DocumentationVersion) String ¶ added in v1.5.13
func (s DocumentationVersion) String() string
String returns the string representation
type DomainName ¶
type DomainName struct { // The 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). CertificateUploadDate *time.Time `locationName:"certificateUploadDate" type:"timestamp" timestampFormat:"unix"` // The domain name of the Amazon CloudFront distribution. For more information, // see the Amazon CloudFront documentation (http://aws.amazon.com/documentation/cloudfront/). DistributionDomainName *string `locationName:"distributionDomainName" type:"string"` // The name of the DomainName resource. DomainName *string `locationName:"domainName" type:"string"` // contains filtered or unexported fields }
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
Use Client-Side Certificate (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (DomainName) GoString ¶
func (s DomainName) GoString() string
GoString returns the string representation
func (*DomainName) SetCertificateName ¶ added in v1.5.0
func (s *DomainName) SetCertificateName(v string) *DomainName
SetCertificateName sets the CertificateName field's value.
func (*DomainName) SetCertificateUploadDate ¶ added in v1.5.0
func (s *DomainName) SetCertificateUploadDate(v time.Time) *DomainName
SetCertificateUploadDate sets the CertificateUploadDate field's value.
func (*DomainName) SetDistributionDomainName ¶ added in v1.5.0
func (s *DomainName) SetDistributionDomainName(v string) *DomainName
SetDistributionDomainName sets the DistributionDomainName field's value.
func (*DomainName) SetDomainName ¶ added in v1.5.0
func (s *DomainName) SetDomainName(v string) *DomainName
SetDomainName sets the DomainName field's value.
func (DomainName) String ¶
func (s DomainName) String() string
String returns the string representation
type FlushStageAuthorizersCacheInput ¶ added in v1.1.7
type FlushStageAuthorizersCacheInput struct { // The API identifier of the stage to flush. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the stage to flush. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Request to flush authorizer cache entries on a specified stage.
func (FlushStageAuthorizersCacheInput) GoString ¶ added in v1.1.7
func (s FlushStageAuthorizersCacheInput) GoString() string
GoString returns the string representation
func (*FlushStageAuthorizersCacheInput) SetRestApiId ¶ added in v1.5.0
func (s *FlushStageAuthorizersCacheInput) SetRestApiId(v string) *FlushStageAuthorizersCacheInput
SetRestApiId sets the RestApiId field's value.
func (*FlushStageAuthorizersCacheInput) SetStageName ¶ added in v1.5.0
func (s *FlushStageAuthorizersCacheInput) SetStageName(v string) *FlushStageAuthorizersCacheInput
SetStageName sets the StageName field's value.
func (FlushStageAuthorizersCacheInput) String ¶ added in v1.1.7
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.7
type FlushStageAuthorizersCacheOutput struct {
// contains filtered or unexported fields
}
func (FlushStageAuthorizersCacheOutput) GoString ¶ added in v1.1.7
func (s FlushStageAuthorizersCacheOutput) GoString() string
GoString returns the string representation
func (FlushStageAuthorizersCacheOutput) String ¶ added in v1.1.7
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 is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the stage to flush its cache. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to flush a stage's cache.
func (FlushStageCacheInput) GoString ¶
func (s FlushStageCacheInput) GoString() string
GoString returns the string representation
func (*FlushStageCacheInput) SetRestApiId ¶ added in v1.5.0
func (s *FlushStageCacheInput) SetRestApiId(v string) *FlushStageCacheInput
SetRestApiId sets the RestApiId field's value.
func (*FlushStageCacheInput) SetStageName ¶ added in v1.5.0
func (s *FlushStageCacheInput) SetStageName(v string) *FlushStageCacheInput
SetStageName sets the StageName field's value.
func (FlushStageCacheInput) String ¶
func (s FlushStageCacheInput) String() string
String returns the string representation
func (*FlushStageCacheInput) Validate ¶ added in v1.1.21
func (s *FlushStageCacheInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type FlushStageCacheOutput ¶
type FlushStageCacheOutput struct {
// contains filtered or unexported fields
}
func (FlushStageCacheOutput) GoString ¶
func (s FlushStageCacheOutput) GoString() string
GoString returns the string representation
func (FlushStageCacheOutput) String ¶
func (s FlushStageCacheOutput) String() string
String returns the string representation
type GenerateClientCertificateInput ¶
type GenerateClientCertificateInput struct { // The description of the ClientCertificate. Description *string `locationName:"description" type:"string"` // contains filtered or unexported fields }
A request to generate a ClientCertificate resource.
func (GenerateClientCertificateInput) GoString ¶
func (s GenerateClientCertificateInput) GoString() string
GoString returns the string representation
func (*GenerateClientCertificateInput) SetDescription ¶ added in v1.5.0
func (s *GenerateClientCertificateInput) SetDescription(v string) *GenerateClientCertificateInput
SetDescription sets the Description field's value.
func (GenerateClientCertificateInput) String ¶
func (s GenerateClientCertificateInput) String() string
String returns the string representation
type GetAccountInput ¶
type GetAccountInput struct {
// contains filtered or unexported fields
}
Requests Amazon API Gateway to get information about the current Account resource.
func (GetAccountInput) GoString ¶
func (s GetAccountInput) GoString() string
GoString returns the string representation
func (GetAccountInput) String ¶
func (s GetAccountInput) String() string
String returns the string representation
type GetApiKeyInput ¶
type GetApiKeyInput struct { // The identifier of the ApiKey resource. // // ApiKey is a required field ApiKey *string `location:"uri" locationName:"api_Key" type:"string" required:"true"` // A boolean flag to specify whether (true) or not (false) the result contains // the key value. IncludeValue *bool `location:"querystring" locationName:"includeValue" type:"boolean"` // contains filtered or unexported fields }
A request to get information about the current ApiKey resource.
func (GetApiKeyInput) GoString ¶
func (s GetApiKeyInput) GoString() string
GoString returns the string representation
func (*GetApiKeyInput) SetApiKey ¶ added in v1.5.0
func (s *GetApiKeyInput) SetApiKey(v string) *GetApiKeyInput
SetApiKey sets the ApiKey field's value.
func (*GetApiKeyInput) SetIncludeValue ¶ added in v1.5.0
func (s *GetApiKeyInput) SetIncludeValue(v bool) *GetApiKeyInput
SetIncludeValue sets the IncludeValue field's value.
func (GetApiKeyInput) String ¶
func (s GetApiKeyInput) String() string
String returns the string representation
func (*GetApiKeyInput) Validate ¶ added in v1.1.21
func (s *GetApiKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetApiKeysInput ¶
type GetApiKeysInput struct { // The identifier of a customer in AWS Marketplace or an external system, such // as a developer portal. CustomerId *string `location:"querystring" locationName:"customerId" type:"string"` // A boolean flag to specify whether (true) or not (false) the result contains // key values. IncludeValues *bool `location:"querystring" locationName:"includeValues" type:"boolean"` // The maximum number of 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) SetCustomerId ¶ added in v1.5.7
func (s *GetApiKeysInput) SetCustomerId(v string) *GetApiKeysInput
SetCustomerId sets the CustomerId field's value.
func (*GetApiKeysInput) SetIncludeValues ¶ added in v1.5.0
func (s *GetApiKeysInput) SetIncludeValues(v bool) *GetApiKeysInput
SetIncludeValues sets the IncludeValues field's value.
func (*GetApiKeysInput) SetLimit ¶ added in v1.5.0
func (s *GetApiKeysInput) SetLimit(v int64) *GetApiKeysInput
SetLimit sets the Limit field's value.
func (*GetApiKeysInput) SetNameQuery ¶ added in v1.5.0
func (s *GetApiKeysInput) SetNameQuery(v string) *GetApiKeysInput
SetNameQuery sets the NameQuery field's value.
func (*GetApiKeysInput) SetPosition ¶ added in v1.5.0
func (s *GetApiKeysInput) SetPosition(v string) *GetApiKeysInput
SetPosition sets the Position field's value.
func (GetApiKeysInput) String ¶
func (s GetApiKeysInput) String() string
String returns the string representation
type GetApiKeysOutput ¶
type GetApiKeysOutput struct { // The current page of 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) SetItems ¶ added in v1.5.0
func (s *GetApiKeysOutput) SetItems(v []*ApiKey) *GetApiKeysOutput
SetItems sets the Items field's value.
func (*GetApiKeysOutput) SetPosition ¶ added in v1.5.0
func (s *GetApiKeysOutput) SetPosition(v string) *GetApiKeysOutput
SetPosition sets the Position field's value.
func (*GetApiKeysOutput) SetWarnings ¶ added in v1.5.0
func (s *GetApiKeysOutput) SetWarnings(v []*string) *GetApiKeysOutput
SetWarnings sets the Warnings field's value.
func (GetApiKeysOutput) String ¶
func (s GetApiKeysOutput) String() string
String returns the string representation
type GetAuthorizerInput ¶ added in v1.1.2
type GetAuthorizerInput struct { // The identifier of the Authorizer resource. // // AuthorizerId is a required field AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // The RestApi identifier for the Authorizer resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe an existing Authorizer resource.
func (GetAuthorizerInput) GoString ¶ added in v1.1.2
func (s GetAuthorizerInput) GoString() string
GoString returns the string representation
func (*GetAuthorizerInput) SetAuthorizerId ¶ added in v1.5.0
func (s *GetAuthorizerInput) SetAuthorizerId(v string) *GetAuthorizerInput
SetAuthorizerId sets the AuthorizerId field's value.
func (*GetAuthorizerInput) SetRestApiId ¶ added in v1.5.0
func (s *GetAuthorizerInput) SetRestApiId(v string) *GetAuthorizerInput
SetRestApiId sets the RestApiId field's value.
func (GetAuthorizerInput) String ¶ added in v1.1.2
func (s GetAuthorizerInput) String() string
String returns the string representation
func (*GetAuthorizerInput) Validate ¶ added in v1.1.21
func (s *GetAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAuthorizersInput ¶ added in v1.1.2
type GetAuthorizersInput struct { // 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 is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe an existing Authorizers resource.
func (GetAuthorizersInput) GoString ¶ added in v1.1.2
func (s GetAuthorizersInput) GoString() string
GoString returns the string representation
func (*GetAuthorizersInput) SetLimit ¶ added in v1.5.0
func (s *GetAuthorizersInput) SetLimit(v int64) *GetAuthorizersInput
SetLimit sets the Limit field's value.
func (*GetAuthorizersInput) SetPosition ¶ added in v1.5.0
func (s *GetAuthorizersInput) SetPosition(v string) *GetAuthorizersInput
SetPosition sets the Position field's value.
func (*GetAuthorizersInput) SetRestApiId ¶ added in v1.5.0
func (s *GetAuthorizersInput) SetRestApiId(v string) *GetAuthorizersInput
SetRestApiId sets the RestApiId field's value.
func (GetAuthorizersInput) String ¶ added in v1.1.2
func (s GetAuthorizersInput) String() string
String returns the string representation
func (*GetAuthorizersInput) Validate ¶ added in v1.1.21
func (s *GetAuthorizersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAuthorizersOutput ¶ added in v1.1.2
type GetAuthorizersOutput struct { // 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) SetItems ¶ added in v1.5.0
func (s *GetAuthorizersOutput) SetItems(v []*Authorizer) *GetAuthorizersOutput
SetItems sets the Items field's value.
func (*GetAuthorizersOutput) SetPosition ¶ added in v1.5.0
func (s *GetAuthorizersOutput) SetPosition(v string) *GetAuthorizersOutput
SetPosition sets the Position field's value.
func (GetAuthorizersOutput) String ¶ added in v1.1.2
func (s GetAuthorizersOutput) String() string
String returns the string representation
type GetBasePathMappingInput ¶
type GetBasePathMappingInput struct { // The base path name that callers of the API must provide as part of the URL // after the domain name. This value must be unique for all of the mappings // across a single API. Leave this blank if you do not want callers to specify // any base path name after the domain name. // // BasePath is a required field BasePath *string `location:"uri" locationName:"base_path" type:"string" required:"true"` // The domain name of the BasePathMapping resource to be described. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe a BasePathMapping resource.
func (GetBasePathMappingInput) GoString ¶
func (s GetBasePathMappingInput) GoString() string
GoString returns the string representation
func (*GetBasePathMappingInput) SetBasePath ¶ added in v1.5.0
func (s *GetBasePathMappingInput) SetBasePath(v string) *GetBasePathMappingInput
SetBasePath sets the BasePath field's value.
func (*GetBasePathMappingInput) SetDomainName ¶ added in v1.5.0
func (s *GetBasePathMappingInput) SetDomainName(v string) *GetBasePathMappingInput
SetDomainName sets the DomainName field's value.
func (GetBasePathMappingInput) String ¶
func (s GetBasePathMappingInput) String() string
String returns the string representation
func (*GetBasePathMappingInput) Validate ¶ added in v1.1.21
func (s *GetBasePathMappingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetBasePathMappingsInput ¶
type GetBasePathMappingsInput struct { // The domain name of a BasePathMapping resource. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // The maximum number of 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) SetDomainName ¶ added in v1.5.0
func (s *GetBasePathMappingsInput) SetDomainName(v string) *GetBasePathMappingsInput
SetDomainName sets the DomainName field's value.
func (*GetBasePathMappingsInput) SetLimit ¶ added in v1.5.0
func (s *GetBasePathMappingsInput) SetLimit(v int64) *GetBasePathMappingsInput
SetLimit sets the Limit field's value.
func (*GetBasePathMappingsInput) SetPosition ¶ added in v1.5.0
func (s *GetBasePathMappingsInput) SetPosition(v string) *GetBasePathMappingsInput
SetPosition sets the Position field's value.
func (GetBasePathMappingsInput) String ¶
func (s GetBasePathMappingsInput) String() string
String returns the string representation
func (*GetBasePathMappingsInput) Validate ¶ added in v1.1.21
func (s *GetBasePathMappingsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetBasePathMappingsOutput ¶
type GetBasePathMappingsOutput struct { // The current page of 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) SetItems ¶ added in v1.5.0
func (s *GetBasePathMappingsOutput) SetItems(v []*BasePathMapping) *GetBasePathMappingsOutput
SetItems sets the Items field's value.
func (*GetBasePathMappingsOutput) SetPosition ¶ added in v1.5.0
func (s *GetBasePathMappingsOutput) SetPosition(v string) *GetBasePathMappingsOutput
SetPosition sets the Position field's value.
func (GetBasePathMappingsOutput) String ¶
func (s GetBasePathMappingsOutput) String() string
String returns the string representation
type GetClientCertificateInput ¶
type GetClientCertificateInput struct { // The identifier of the ClientCertificate resource to be described. // // ClientCertificateId is a required field ClientCertificateId *string `location:"uri" locationName:"clientcertificate_id" type:"string" required:"true"` // contains filtered or unexported fields }
A request to get information about the current ClientCertificate resource.
func (GetClientCertificateInput) GoString ¶
func (s GetClientCertificateInput) GoString() string
GoString returns the string representation
func (*GetClientCertificateInput) SetClientCertificateId ¶ added in v1.5.0
func (s *GetClientCertificateInput) SetClientCertificateId(v string) *GetClientCertificateInput
SetClientCertificateId sets the ClientCertificateId field's value.
func (GetClientCertificateInput) String ¶
func (s GetClientCertificateInput) String() string
String returns the string representation
func (*GetClientCertificateInput) Validate ¶ added in v1.1.21
func (s *GetClientCertificateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetClientCertificatesInput ¶
type GetClientCertificatesInput struct { // The maximum number of 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) SetLimit ¶ added in v1.5.0
func (s *GetClientCertificatesInput) SetLimit(v int64) *GetClientCertificatesInput
SetLimit sets the Limit field's value.
func (*GetClientCertificatesInput) SetPosition ¶ added in v1.5.0
func (s *GetClientCertificatesInput) SetPosition(v string) *GetClientCertificatesInput
SetPosition sets the Position field's value.
func (GetClientCertificatesInput) String ¶
func (s GetClientCertificatesInput) String() string
String returns the string representation
type GetClientCertificatesOutput ¶
type GetClientCertificatesOutput struct { // The current page of 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) SetItems ¶ added in v1.5.0
func (s *GetClientCertificatesOutput) SetItems(v []*ClientCertificate) *GetClientCertificatesOutput
SetItems sets the Items field's value.
func (*GetClientCertificatesOutput) SetPosition ¶ added in v1.5.0
func (s *GetClientCertificatesOutput) SetPosition(v string) *GetClientCertificatesOutput
SetPosition sets the Position field's value.
func (GetClientCertificatesOutput) String ¶
func (s GetClientCertificatesOutput) String() string
String returns the string representation
type GetDeploymentInput ¶
type GetDeploymentInput struct { // The identifier of the Deployment resource to get information about. // // DeploymentId is a required field DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` // The identifier of the RestApi resource for the Deployment resource to get // information about. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to get information about a Deployment resource.
func (GetDeploymentInput) GoString ¶
func (s GetDeploymentInput) GoString() string
GoString returns the string representation
func (*GetDeploymentInput) SetDeploymentId ¶ added in v1.5.0
func (s *GetDeploymentInput) SetDeploymentId(v string) *GetDeploymentInput
SetDeploymentId sets the DeploymentId field's value.
func (*GetDeploymentInput) SetRestApiId ¶ added in v1.5.0
func (s *GetDeploymentInput) SetRestApiId(v string) *GetDeploymentInput
SetRestApiId sets the RestApiId field's value.
func (GetDeploymentInput) String ¶
func (s GetDeploymentInput) String() string
String returns the string representation
func (*GetDeploymentInput) Validate ¶ added in v1.1.21
func (s *GetDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDeploymentsInput ¶
type GetDeploymentsInput struct { // The maximum number of 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 is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to get information about a Deployments collection.
func (GetDeploymentsInput) GoString ¶
func (s GetDeploymentsInput) GoString() string
GoString returns the string representation
func (*GetDeploymentsInput) SetLimit ¶ added in v1.5.0
func (s *GetDeploymentsInput) SetLimit(v int64) *GetDeploymentsInput
SetLimit sets the Limit field's value.
func (*GetDeploymentsInput) SetPosition ¶ added in v1.5.0
func (s *GetDeploymentsInput) SetPosition(v string) *GetDeploymentsInput
SetPosition sets the Position field's value.
func (*GetDeploymentsInput) SetRestApiId ¶ added in v1.5.0
func (s *GetDeploymentsInput) SetRestApiId(v string) *GetDeploymentsInput
SetRestApiId sets the RestApiId field's value.
func (GetDeploymentsInput) String ¶
func (s GetDeploymentsInput) String() string
String returns the string representation
func (*GetDeploymentsInput) Validate ¶ added in v1.1.21
func (s *GetDeploymentsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDeploymentsOutput ¶
type GetDeploymentsOutput struct { // The current page of 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) SetItems ¶ added in v1.5.0
func (s *GetDeploymentsOutput) SetItems(v []*Deployment) *GetDeploymentsOutput
SetItems sets the Items field's value.
func (*GetDeploymentsOutput) SetPosition ¶ added in v1.5.0
func (s *GetDeploymentsOutput) SetPosition(v string) *GetDeploymentsOutput
SetPosition sets the Position field's value.
func (GetDeploymentsOutput) String ¶
func (s GetDeploymentsOutput) String() string
String returns the string representation
type GetDocumentationPartInput ¶ added in v1.5.13
type GetDocumentationPartInput struct { // [Required] The identifier of the to-be-retrieved documentation part. // // DocumentationPartId is a required field DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"` // [Required] The identifier of an API of the to-be-retrieved documentation // part. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets a specified documentation part of a given API.
func (GetDocumentationPartInput) GoString ¶ added in v1.5.13
func (s GetDocumentationPartInput) GoString() string
GoString returns the string representation
func (*GetDocumentationPartInput) SetDocumentationPartId ¶ added in v1.5.13
func (s *GetDocumentationPartInput) SetDocumentationPartId(v string) *GetDocumentationPartInput
SetDocumentationPartId sets the DocumentationPartId field's value.
func (*GetDocumentationPartInput) SetRestApiId ¶ added in v1.5.13
func (s *GetDocumentationPartInput) SetRestApiId(v string) *GetDocumentationPartInput
SetRestApiId sets the RestApiId field's value.
func (GetDocumentationPartInput) String ¶ added in v1.5.13
func (s GetDocumentationPartInput) String() string
String returns the string representation
func (*GetDocumentationPartInput) Validate ¶ added in v1.5.13
func (s *GetDocumentationPartInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDocumentationPartsInput ¶ added in v1.5.13
type GetDocumentationPartsInput struct { // The size of the paged results. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The name of API entities of the to-be-retrieved documentation parts. NameQuery *string `location:"querystring" locationName:"name" type:"string"` // The path of API entities of the to-be-retrieved documentation parts. Path *string `location:"querystring" locationName:"path" type:"string"` // The position of the to-be-retrieved documentation part in the DocumentationParts // collection. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The identifier of the API of the to-be-retrieved documentation // parts. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The type of API entities of the to-be-retrieved documentation parts. Type *string `location:"querystring" locationName:"type" type:"string" enum:"DocumentationPartType"` // contains filtered or unexported fields }
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
func (GetDocumentationPartsInput) GoString ¶ added in v1.5.13
func (s GetDocumentationPartsInput) GoString() string
GoString returns the string representation
func (*GetDocumentationPartsInput) SetLimit ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) SetLimit(v int64) *GetDocumentationPartsInput
SetLimit sets the Limit field's value.
func (*GetDocumentationPartsInput) SetNameQuery ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) SetNameQuery(v string) *GetDocumentationPartsInput
SetNameQuery sets the NameQuery field's value.
func (*GetDocumentationPartsInput) SetPath ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) SetPath(v string) *GetDocumentationPartsInput
SetPath sets the Path field's value.
func (*GetDocumentationPartsInput) SetPosition ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) SetPosition(v string) *GetDocumentationPartsInput
SetPosition sets the Position field's value.
func (*GetDocumentationPartsInput) SetRestApiId ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) SetRestApiId(v string) *GetDocumentationPartsInput
SetRestApiId sets the RestApiId field's value.
func (*GetDocumentationPartsInput) SetType ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) SetType(v string) *GetDocumentationPartsInput
SetType sets the Type field's value.
func (GetDocumentationPartsInput) String ¶ added in v1.5.13
func (s GetDocumentationPartsInput) String() string
String returns the string representation
func (*GetDocumentationPartsInput) Validate ¶ added in v1.5.13
func (s *GetDocumentationPartsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDocumentationPartsOutput ¶ added in v1.5.13
type GetDocumentationPartsOutput struct { // The current page of DocumentationPart resources in the DocumentationParts // collection. Items []*DocumentationPart `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
The collection of documentation parts of an API.
Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart
func (GetDocumentationPartsOutput) GoString ¶ added in v1.5.13
func (s GetDocumentationPartsOutput) GoString() string
GoString returns the string representation
func (*GetDocumentationPartsOutput) SetItems ¶ added in v1.5.13
func (s *GetDocumentationPartsOutput) SetItems(v []*DocumentationPart) *GetDocumentationPartsOutput
SetItems sets the Items field's value.
func (*GetDocumentationPartsOutput) SetPosition ¶ added in v1.5.13
func (s *GetDocumentationPartsOutput) SetPosition(v string) *GetDocumentationPartsOutput
SetPosition sets the Position field's value.
func (GetDocumentationPartsOutput) String ¶ added in v1.5.13
func (s GetDocumentationPartsOutput) String() string
String returns the string representation
type GetDocumentationVersionInput ¶ added in v1.5.13
type GetDocumentationVersionInput struct { // [Required] The version identifier of the to-be-retrieved documentation snapshot. // // DocumentationVersion is a required field DocumentationVersion *string `location:"uri" locationName:"doc_version" type:"string" required:"true"` // [Required] The identifier of the API of the to-be-retrieved documentation // snapshot. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets a documentation snapshot of an API.
func (GetDocumentationVersionInput) GoString ¶ added in v1.5.13
func (s GetDocumentationVersionInput) GoString() string
GoString returns the string representation
func (*GetDocumentationVersionInput) SetDocumentationVersion ¶ added in v1.5.13
func (s *GetDocumentationVersionInput) SetDocumentationVersion(v string) *GetDocumentationVersionInput
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*GetDocumentationVersionInput) SetRestApiId ¶ added in v1.5.13
func (s *GetDocumentationVersionInput) SetRestApiId(v string) *GetDocumentationVersionInput
SetRestApiId sets the RestApiId field's value.
func (GetDocumentationVersionInput) String ¶ added in v1.5.13
func (s GetDocumentationVersionInput) String() string
String returns the string representation
func (*GetDocumentationVersionInput) Validate ¶ added in v1.5.13
func (s *GetDocumentationVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDocumentationVersionsInput ¶ added in v1.5.13
type GetDocumentationVersionsInput struct { // The page size of the returned documentation versions. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The position of the returned DocumentationVersion in the DocumentationVersions // collection. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The identifier of an API of the to-be-retrieved documentation // versions. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets the documentation versions of an API.
func (GetDocumentationVersionsInput) GoString ¶ added in v1.5.13
func (s GetDocumentationVersionsInput) GoString() string
GoString returns the string representation
func (*GetDocumentationVersionsInput) SetLimit ¶ added in v1.5.13
func (s *GetDocumentationVersionsInput) SetLimit(v int64) *GetDocumentationVersionsInput
SetLimit sets the Limit field's value.
func (*GetDocumentationVersionsInput) SetPosition ¶ added in v1.5.13
func (s *GetDocumentationVersionsInput) SetPosition(v string) *GetDocumentationVersionsInput
SetPosition sets the Position field's value.
func (*GetDocumentationVersionsInput) SetRestApiId ¶ added in v1.5.13
func (s *GetDocumentationVersionsInput) SetRestApiId(v string) *GetDocumentationVersionsInput
SetRestApiId sets the RestApiId field's value.
func (GetDocumentationVersionsInput) String ¶ added in v1.5.13
func (s GetDocumentationVersionsInput) String() string
String returns the string representation
func (*GetDocumentationVersionsInput) Validate ¶ added in v1.5.13
func (s *GetDocumentationVersionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDocumentationVersionsOutput ¶ added in v1.5.13
type GetDocumentationVersionsOutput struct { // The current page of DocumentationVersion items from the DocumentationVersions // collection of an API. Items []*DocumentationVersion `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
The collection of documentation snapshots of an API.
Use the DocumentationVersions to manage documentation snapshots associated with various API stages.
Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart, DocumentationVersion
func (GetDocumentationVersionsOutput) GoString ¶ added in v1.5.13
func (s GetDocumentationVersionsOutput) GoString() string
GoString returns the string representation
func (*GetDocumentationVersionsOutput) SetItems ¶ added in v1.5.13
func (s *GetDocumentationVersionsOutput) SetItems(v []*DocumentationVersion) *GetDocumentationVersionsOutput
SetItems sets the Items field's value.
func (*GetDocumentationVersionsOutput) SetPosition ¶ added in v1.5.13
func (s *GetDocumentationVersionsOutput) SetPosition(v string) *GetDocumentationVersionsOutput
SetPosition sets the Position field's value.
func (GetDocumentationVersionsOutput) String ¶ added in v1.5.13
func (s GetDocumentationVersionsOutput) String() string
String returns the string representation
type GetDomainNameInput ¶
type GetDomainNameInput struct { // The name of the DomainName resource. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // contains filtered or unexported fields }
Request to get the name of a DomainName resource.
func (GetDomainNameInput) GoString ¶
func (s GetDomainNameInput) GoString() string
GoString returns the string representation
func (*GetDomainNameInput) SetDomainName ¶ added in v1.5.0
func (s *GetDomainNameInput) SetDomainName(v string) *GetDomainNameInput
SetDomainName sets the DomainName field's value.
func (GetDomainNameInput) String ¶
func (s GetDomainNameInput) String() string
String returns the string representation
func (*GetDomainNameInput) Validate ¶ added in v1.1.21
func (s *GetDomainNameInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDomainNamesInput ¶
type GetDomainNamesInput struct { // The maximum number of 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) SetLimit ¶ added in v1.5.0
func (s *GetDomainNamesInput) SetLimit(v int64) *GetDomainNamesInput
SetLimit sets the Limit field's value.
func (*GetDomainNamesInput) SetPosition ¶ added in v1.5.0
func (s *GetDomainNamesInput) SetPosition(v string) *GetDomainNamesInput
SetPosition sets the Position field's value.
func (GetDomainNamesInput) String ¶
func (s GetDomainNamesInput) String() string
String returns the string representation
type GetDomainNamesOutput ¶
type GetDomainNamesOutput struct { // The current page of 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) SetItems ¶ added in v1.5.0
func (s *GetDomainNamesOutput) SetItems(v []*DomainName) *GetDomainNamesOutput
SetItems sets the Items field's value.
func (*GetDomainNamesOutput) SetPosition ¶ added in v1.5.0
func (s *GetDomainNamesOutput) SetPosition(v string) *GetDomainNamesOutput
SetPosition sets the Position field's value.
func (GetDomainNamesOutput) String ¶
func (s GetDomainNamesOutput) String() string
String returns the string representation
type GetExportInput ¶ added in v1.1.2
type GetExportInput struct { // The content-type of the export, for example application/json. Currently application/json // and application/yaml are supported for exportType of swagger. This should // be specified in the Accept header for direct API requests. Accepts *string `location:"header" locationName:"Accept" type:"string"` // The type of export. Currently only 'swagger' is supported. // // ExportType is a required field ExportType *string `location:"uri" locationName:"export_type" type:"string" required:"true"` // A key-value map of query string parameters that specify properties of the // export, depending on the requested exportType. For exportTypeswagger, any // combination of the following parameters are supported: integrations will // export the API with x-amazon-apigateway-integration extensions. authorizers // will export the API with x-amazon-apigateway-authorizer extensions. postman // will export the API with Postman extensions, allowing for import to the Postman // tool Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // The identifier of the RestApi to be exported. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the Stage that will be exported. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Request a new export of a RestApi for a particular Stage.
func (GetExportInput) GoString ¶ added in v1.1.2
func (s GetExportInput) GoString() string
GoString returns the string representation
func (*GetExportInput) SetAccepts ¶ added in v1.5.0
func (s *GetExportInput) SetAccepts(v string) *GetExportInput
SetAccepts sets the Accepts field's value.
func (*GetExportInput) SetExportType ¶ added in v1.5.0
func (s *GetExportInput) SetExportType(v string) *GetExportInput
SetExportType sets the ExportType field's value.
func (*GetExportInput) SetParameters ¶ added in v1.5.0
func (s *GetExportInput) SetParameters(v map[string]*string) *GetExportInput
SetParameters sets the Parameters field's value.
func (*GetExportInput) SetRestApiId ¶ added in v1.5.0
func (s *GetExportInput) SetRestApiId(v string) *GetExportInput
SetRestApiId sets the RestApiId field's value.
func (*GetExportInput) SetStageName ¶ added in v1.5.0
func (s *GetExportInput) SetStageName(v string) *GetExportInput
SetStageName sets the StageName field's value.
func (GetExportInput) String ¶ added in v1.1.2
func (s GetExportInput) String() string
String returns the string representation
func (*GetExportInput) Validate ¶ added in v1.1.21
func (s *GetExportInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetExportOutput ¶ added in v1.1.2
type GetExportOutput struct { // The binary blob response to GetExport, which contains the export. Body []byte `locationName:"body" type:"blob"` // The content-disposition header value in the HTTP response. ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"` // The content-type header value in the HTTP response. This will correspond // to a valid 'accept' type in the request. ContentType *string `location:"header" locationName:"Content-Type" type:"string"` // contains filtered or unexported fields }
The binary blob response to GetExport, which contains the generated SDK.
func (GetExportOutput) GoString ¶ added in v1.1.2
func (s GetExportOutput) GoString() string
GoString returns the string representation
func (*GetExportOutput) SetBody ¶ added in v1.5.0
func (s *GetExportOutput) SetBody(v []byte) *GetExportOutput
SetBody sets the Body field's value.
func (*GetExportOutput) SetContentDisposition ¶ added in v1.5.0
func (s *GetExportOutput) SetContentDisposition(v string) *GetExportOutput
SetContentDisposition sets the ContentDisposition field's value.
func (*GetExportOutput) SetContentType ¶ added in v1.5.0
func (s *GetExportOutput) SetContentType(v string) *GetExportOutput
SetContentType sets the ContentType field's value.
func (GetExportOutput) String ¶ added in v1.1.2
func (s GetExportOutput) String() string
String returns the string representation
type GetIntegrationInput ¶
type GetIntegrationInput struct { // Specifies a get integration request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a get integration request's resource identifier // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies a get integration request's API identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a get integration request.
func (GetIntegrationInput) GoString ¶
func (s GetIntegrationInput) GoString() string
GoString returns the string representation
func (*GetIntegrationInput) SetHttpMethod ¶ added in v1.5.0
func (s *GetIntegrationInput) SetHttpMethod(v string) *GetIntegrationInput
SetHttpMethod sets the HttpMethod field's value.
func (*GetIntegrationInput) SetResourceId ¶ added in v1.5.0
func (s *GetIntegrationInput) SetResourceId(v string) *GetIntegrationInput
SetResourceId sets the ResourceId field's value.
func (*GetIntegrationInput) SetRestApiId ¶ added in v1.5.0
func (s *GetIntegrationInput) SetRestApiId(v string) *GetIntegrationInput
SetRestApiId sets the RestApiId field's value.
func (GetIntegrationInput) String ¶
func (s GetIntegrationInput) String() string
String returns the string representation
func (*GetIntegrationInput) Validate ¶ added in v1.1.21
func (s *GetIntegrationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetIntegrationResponseInput ¶
type GetIntegrationResponseInput struct { // Specifies a get integration response request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a get integration response request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies a get integration response request's API identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies a get integration response request's status code. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a get integration response request.
func (GetIntegrationResponseInput) GoString ¶
func (s GetIntegrationResponseInput) GoString() string
GoString returns the string representation
func (*GetIntegrationResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *GetIntegrationResponseInput) SetHttpMethod(v string) *GetIntegrationResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*GetIntegrationResponseInput) SetResourceId ¶ added in v1.5.0
func (s *GetIntegrationResponseInput) SetResourceId(v string) *GetIntegrationResponseInput
SetResourceId sets the ResourceId field's value.
func (*GetIntegrationResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *GetIntegrationResponseInput) SetRestApiId(v string) *GetIntegrationResponseInput
SetRestApiId sets the RestApiId field's value.
func (*GetIntegrationResponseInput) SetStatusCode ¶ added in v1.5.0
func (s *GetIntegrationResponseInput) SetStatusCode(v string) *GetIntegrationResponseInput
SetStatusCode sets the StatusCode field's value.
func (GetIntegrationResponseInput) String ¶
func (s GetIntegrationResponseInput) String() string
String returns the string representation
func (*GetIntegrationResponseInput) Validate ¶ added in v1.1.21
func (s *GetIntegrationResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetMethodInput ¶
type GetMethodInput struct { // Specifies the method request's HTTP method type. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the Method resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe an existing Method resource.
func (GetMethodInput) GoString ¶
func (s GetMethodInput) GoString() string
GoString returns the string representation
func (*GetMethodInput) SetHttpMethod ¶ added in v1.5.0
func (s *GetMethodInput) SetHttpMethod(v string) *GetMethodInput
SetHttpMethod sets the HttpMethod field's value.
func (*GetMethodInput) SetResourceId ¶ added in v1.5.0
func (s *GetMethodInput) SetResourceId(v string) *GetMethodInput
SetResourceId sets the ResourceId field's value.
func (*GetMethodInput) SetRestApiId ¶ added in v1.5.0
func (s *GetMethodInput) SetRestApiId(v string) *GetMethodInput
SetRestApiId sets the RestApiId field's value.
func (GetMethodInput) String ¶
func (s GetMethodInput) String() string
String returns the string representation
func (*GetMethodInput) Validate ¶ added in v1.1.21
func (s *GetMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetMethodResponseInput ¶
type GetMethodResponseInput struct { // The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the MethodResponse resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the MethodResponse resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The status code for the MethodResponse resource. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe a MethodResponse resource.
func (GetMethodResponseInput) GoString ¶
func (s GetMethodResponseInput) GoString() string
GoString returns the string representation
func (*GetMethodResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *GetMethodResponseInput) SetHttpMethod(v string) *GetMethodResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*GetMethodResponseInput) SetResourceId ¶ added in v1.5.0
func (s *GetMethodResponseInput) SetResourceId(v string) *GetMethodResponseInput
SetResourceId sets the ResourceId field's value.
func (*GetMethodResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *GetMethodResponseInput) SetRestApiId(v string) *GetMethodResponseInput
SetRestApiId sets the RestApiId field's value.
func (*GetMethodResponseInput) SetStatusCode ¶ added in v1.5.0
func (s *GetMethodResponseInput) SetStatusCode(v string) *GetMethodResponseInput
SetStatusCode sets the StatusCode field's value.
func (GetMethodResponseInput) String ¶
func (s GetMethodResponseInput) String() string
String returns the string representation
func (*GetMethodResponseInput) Validate ¶ added in v1.1.21
func (s *GetMethodResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetModelInput ¶
type GetModelInput struct { // A query parameter of a Boolean value to resolve (true) all external model // references and returns a flattened model schema or not (false) The default // is false. Flatten *bool `location:"querystring" locationName:"flatten" type:"boolean"` // The name of the model as an identifier. // // ModelName is a required field ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // The RestApi identifier under which the Model exists. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to list information about a model in an existing RestApi resource.
func (GetModelInput) GoString ¶
func (s GetModelInput) GoString() string
GoString returns the string representation
func (*GetModelInput) SetFlatten ¶ added in v1.5.0
func (s *GetModelInput) SetFlatten(v bool) *GetModelInput
SetFlatten sets the Flatten field's value.
func (*GetModelInput) SetModelName ¶ added in v1.5.0
func (s *GetModelInput) SetModelName(v string) *GetModelInput
SetModelName sets the ModelName field's value.
func (*GetModelInput) SetRestApiId ¶ added in v1.5.0
func (s *GetModelInput) SetRestApiId(v string) *GetModelInput
SetRestApiId sets the RestApiId field's value.
func (GetModelInput) String ¶
func (s GetModelInput) String() string
String returns the string representation
func (*GetModelInput) Validate ¶ added in v1.1.21
func (s *GetModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetModelTemplateInput ¶
type GetModelTemplateInput struct { // The name of the model for which to generate a template. // // ModelName is a required field ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // The ID of the RestApi under which the model exists. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to generate a sample mapping template used to transform the payload.
func (GetModelTemplateInput) GoString ¶
func (s GetModelTemplateInput) GoString() string
GoString returns the string representation
func (*GetModelTemplateInput) SetModelName ¶ added in v1.5.0
func (s *GetModelTemplateInput) SetModelName(v string) *GetModelTemplateInput
SetModelName sets the ModelName field's value.
func (*GetModelTemplateInput) SetRestApiId ¶ added in v1.5.0
func (s *GetModelTemplateInput) SetRestApiId(v string) *GetModelTemplateInput
SetRestApiId sets the RestApiId field's value.
func (GetModelTemplateInput) String ¶
func (s GetModelTemplateInput) String() string
String returns the string representation
func (*GetModelTemplateInput) Validate ¶ added in v1.1.21
func (s *GetModelTemplateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetModelTemplateOutput ¶
type GetModelTemplateOutput struct { // The Apache Velocity Template Language (VTL) (http://velocity.apache.org/engine/devel/vtl-reference-guide.html) // template content used for the template resource. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
Represents a mapping template used to transform a payload.
Mapping Templates (http://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html#models-mappings-mappings)
func (GetModelTemplateOutput) GoString ¶
func (s GetModelTemplateOutput) GoString() string
GoString returns the string representation
func (*GetModelTemplateOutput) SetValue ¶ added in v1.5.0
func (s *GetModelTemplateOutput) SetValue(v string) *GetModelTemplateOutput
SetValue sets the Value field's value.
func (GetModelTemplateOutput) String ¶
func (s GetModelTemplateOutput) String() string
String returns the string representation
type GetModelsInput ¶
type GetModelsInput struct { // The maximum number of 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 is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to list existing Models defined for a RestApi resource.
func (GetModelsInput) GoString ¶
func (s GetModelsInput) GoString() string
GoString returns the string representation
func (*GetModelsInput) SetLimit ¶ added in v1.5.0
func (s *GetModelsInput) SetLimit(v int64) *GetModelsInput
SetLimit sets the Limit field's value.
func (*GetModelsInput) SetPosition ¶ added in v1.5.0
func (s *GetModelsInput) SetPosition(v string) *GetModelsInput
SetPosition sets the Position field's value.
func (*GetModelsInput) SetRestApiId ¶ added in v1.5.0
func (s *GetModelsInput) SetRestApiId(v string) *GetModelsInput
SetRestApiId sets the RestApiId field's value.
func (GetModelsInput) String ¶
func (s GetModelsInput) String() string
String returns the string representation
func (*GetModelsInput) Validate ¶ added in v1.1.21
func (s *GetModelsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetModelsOutput ¶
type GetModelsOutput struct { // 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) SetItems ¶ added in v1.5.0
func (s *GetModelsOutput) SetItems(v []*Model) *GetModelsOutput
SetItems sets the Items field's value.
func (*GetModelsOutput) SetPosition ¶ added in v1.5.0
func (s *GetModelsOutput) SetPosition(v string) *GetModelsOutput
SetPosition sets the Position field's value.
func (GetModelsOutput) String ¶
func (s GetModelsOutput) String() string
String returns the string representation
type GetResourceInput ¶
type GetResourceInput struct { // The identifier for the Resource resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to list information about a resource.
func (GetResourceInput) GoString ¶
func (s GetResourceInput) GoString() string
GoString returns the string representation
func (*GetResourceInput) SetResourceId ¶ added in v1.5.0
func (s *GetResourceInput) SetResourceId(v string) *GetResourceInput
SetResourceId sets the ResourceId field's value.
func (*GetResourceInput) SetRestApiId ¶ added in v1.5.0
func (s *GetResourceInput) SetRestApiId(v string) *GetResourceInput
SetRestApiId sets the RestApiId field's value.
func (GetResourceInput) String ¶
func (s GetResourceInput) String() string
String returns the string representation
func (*GetResourceInput) Validate ¶ added in v1.1.21
func (s *GetResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetResourcesInput ¶
type GetResourcesInput struct { // 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 is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to list information about a collection of resources.
func (GetResourcesInput) GoString ¶
func (s GetResourcesInput) GoString() string
GoString returns the string representation
func (*GetResourcesInput) SetLimit ¶ added in v1.5.0
func (s *GetResourcesInput) SetLimit(v int64) *GetResourcesInput
SetLimit sets the Limit field's value.
func (*GetResourcesInput) SetPosition ¶ added in v1.5.0
func (s *GetResourcesInput) SetPosition(v string) *GetResourcesInput
SetPosition sets the Position field's value.
func (*GetResourcesInput) SetRestApiId ¶ added in v1.5.0
func (s *GetResourcesInput) SetRestApiId(v string) *GetResourcesInput
SetRestApiId sets the RestApiId field's value.
func (GetResourcesInput) String ¶
func (s GetResourcesInput) String() string
String returns the string representation
func (*GetResourcesInput) Validate ¶ added in v1.1.21
func (s *GetResourcesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetResourcesOutput ¶
type GetResourcesOutput struct { // 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) SetItems ¶ added in v1.5.0
func (s *GetResourcesOutput) SetItems(v []*Resource) *GetResourcesOutput
SetItems sets the Items field's value.
func (*GetResourcesOutput) SetPosition ¶ added in v1.5.0
func (s *GetResourcesOutput) SetPosition(v string) *GetResourcesOutput
SetPosition sets the Position field's value.
func (GetResourcesOutput) String ¶
func (s GetResourcesOutput) String() string
String returns the string representation
type GetRestApiInput ¶
type GetRestApiInput struct { // The identifier of the RestApi resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
The GET request to list an existing RestApi defined for your collection.
func (GetRestApiInput) GoString ¶
func (s GetRestApiInput) GoString() string
GoString returns the string representation
func (*GetRestApiInput) SetRestApiId ¶ added in v1.5.0
func (s *GetRestApiInput) SetRestApiId(v string) *GetRestApiInput
SetRestApiId sets the RestApiId field's value.
func (GetRestApiInput) String ¶
func (s GetRestApiInput) String() string
String returns the string representation
func (*GetRestApiInput) Validate ¶ added in v1.1.21
func (s *GetRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRestApisInput ¶
type GetRestApisInput struct { // The maximum number of 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) SetLimit ¶ added in v1.5.0
func (s *GetRestApisInput) SetLimit(v int64) *GetRestApisInput
SetLimit sets the Limit field's value.
func (*GetRestApisInput) SetPosition ¶ added in v1.5.0
func (s *GetRestApisInput) SetPosition(v string) *GetRestApisInput
SetPosition sets the Position field's value.
func (GetRestApisInput) String ¶
func (s GetRestApisInput) String() string
String returns the string representation
type GetRestApisOutput ¶
type GetRestApisOutput struct { // 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) SetItems ¶ added in v1.5.0
func (s *GetRestApisOutput) SetItems(v []*RestApi) *GetRestApisOutput
SetItems sets the Items field's value.
func (*GetRestApisOutput) SetPosition ¶ added in v1.5.0
func (s *GetRestApisOutput) SetPosition(v string) *GetRestApisOutput
SetPosition sets the Position field's value.
func (GetRestApisOutput) String ¶
func (s GetRestApisOutput) String() string
String returns the string representation
type GetSdkInput ¶
type GetSdkInput struct { // A key-value map of query string parameters that specify properties of the // SDK, depending on the requested sdkType. For sdkType of objectivec, a parameter // named classPrefix is required. For sdkType of android, parameters named groupId, // artifactId, artifactVersion, and invokerPackage are required. Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // The identifier of the RestApi that the SDK will use. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The language for the generated SDK. Currently javascript, android, and objectivec // (for iOS) are supported. // // SdkType is a required field SdkType *string `location:"uri" locationName:"sdk_type" type:"string" required:"true"` // The name of the Stage that the SDK will use. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Request a new generated client SDK for a RestApi and Stage.
func (GetSdkInput) GoString ¶
func (s GetSdkInput) GoString() string
GoString returns the string representation
func (*GetSdkInput) SetParameters ¶ added in v1.5.0
func (s *GetSdkInput) SetParameters(v map[string]*string) *GetSdkInput
SetParameters sets the Parameters field's value.
func (*GetSdkInput) SetRestApiId ¶ added in v1.5.0
func (s *GetSdkInput) SetRestApiId(v string) *GetSdkInput
SetRestApiId sets the RestApiId field's value.
func (*GetSdkInput) SetSdkType ¶ added in v1.5.0
func (s *GetSdkInput) SetSdkType(v string) *GetSdkInput
SetSdkType sets the SdkType field's value.
func (*GetSdkInput) SetStageName ¶ added in v1.5.0
func (s *GetSdkInput) SetStageName(v string) *GetSdkInput
SetStageName sets the StageName field's value.
func (GetSdkInput) String ¶
func (s GetSdkInput) String() string
String returns the string representation
func (*GetSdkInput) Validate ¶ added in v1.1.21
func (s *GetSdkInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSdkOutput ¶
type GetSdkOutput struct { // The binary blob response to GetSdk, which contains the generated SDK. Body []byte `locationName:"body" type:"blob"` // The content-disposition header value in the HTTP response. ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"` // The content-type header value in the HTTP response. ContentType *string `location:"header" locationName:"Content-Type" type:"string"` // contains filtered or unexported fields }
The binary blob response to GetSdk, which contains the generated SDK.
func (GetSdkOutput) GoString ¶
func (s GetSdkOutput) GoString() string
GoString returns the string representation
func (*GetSdkOutput) SetBody ¶ added in v1.5.0
func (s *GetSdkOutput) SetBody(v []byte) *GetSdkOutput
SetBody sets the Body field's value.
func (*GetSdkOutput) SetContentDisposition ¶ added in v1.5.0
func (s *GetSdkOutput) SetContentDisposition(v string) *GetSdkOutput
SetContentDisposition sets the ContentDisposition field's value.
func (*GetSdkOutput) SetContentType ¶ added in v1.5.0
func (s *GetSdkOutput) SetContentType(v string) *GetSdkOutput
SetContentType sets the ContentType field's value.
func (GetSdkOutput) String ¶
func (s GetSdkOutput) String() string
String returns the string representation
type GetSdkTypeInput ¶ added in v1.6.8
type GetSdkTypeInput struct { // The identifier of the queried SdkType instance. // // Id is a required field Id *string `location:"uri" locationName:"sdktype_id" type:"string" required:"true"` // contains filtered or unexported fields }
Get an SdkType instance.
func (GetSdkTypeInput) GoString ¶ added in v1.6.8
func (s GetSdkTypeInput) GoString() string
GoString returns the string representation
func (*GetSdkTypeInput) SetId ¶ added in v1.6.8
func (s *GetSdkTypeInput) SetId(v string) *GetSdkTypeInput
SetId sets the Id field's value.
func (GetSdkTypeInput) String ¶ added in v1.6.8
func (s GetSdkTypeInput) String() string
String returns the string representation
func (*GetSdkTypeInput) Validate ¶ added in v1.6.8
func (s *GetSdkTypeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSdkTypesInput ¶ added in v1.6.8
type GetSdkTypesInput struct { // The maximum number of SdkType instances to be returned. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The position of the last fetched element in the SdkTypes collection. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
Get the SdkTypes collection.
func (GetSdkTypesInput) GoString ¶ added in v1.6.8
func (s GetSdkTypesInput) GoString() string
GoString returns the string representation
func (*GetSdkTypesInput) SetLimit ¶ added in v1.6.8
func (s *GetSdkTypesInput) SetLimit(v int64) *GetSdkTypesInput
SetLimit sets the Limit field's value.
func (*GetSdkTypesInput) SetPosition ¶ added in v1.6.8
func (s *GetSdkTypesInput) SetPosition(v string) *GetSdkTypesInput
SetPosition sets the Position field's value.
func (GetSdkTypesInput) String ¶ added in v1.6.8
func (s GetSdkTypesInput) String() string
String returns the string representation
type GetSdkTypesOutput ¶ added in v1.6.8
type GetSdkTypesOutput struct { // The set of SdkType items that comprise this view of the SdkTypes collection. Items []*SdkType `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
The collection of SdkType instances.
func (GetSdkTypesOutput) GoString ¶ added in v1.6.8
func (s GetSdkTypesOutput) GoString() string
GoString returns the string representation
func (*GetSdkTypesOutput) SetItems ¶ added in v1.6.8
func (s *GetSdkTypesOutput) SetItems(v []*SdkType) *GetSdkTypesOutput
SetItems sets the Items field's value.
func (*GetSdkTypesOutput) SetPosition ¶ added in v1.6.8
func (s *GetSdkTypesOutput) SetPosition(v string) *GetSdkTypesOutput
SetPosition sets the Position field's value.
func (GetSdkTypesOutput) String ¶ added in v1.6.8
func (s GetSdkTypesOutput) String() string
String returns the string representation
type GetStageInput ¶
type GetStageInput struct { // The identifier of the RestApi resource for the Stage resource to get information // about. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the Stage resource to get information about. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to get information about a Stage resource.
func (GetStageInput) GoString ¶
func (s GetStageInput) GoString() string
GoString returns the string representation
func (*GetStageInput) SetRestApiId ¶ added in v1.5.0
func (s *GetStageInput) SetRestApiId(v string) *GetStageInput
SetRestApiId sets the RestApiId field's value.
func (*GetStageInput) SetStageName ¶ added in v1.5.0
func (s *GetStageInput) SetStageName(v string) *GetStageInput
SetStageName sets the StageName field's value.
func (GetStageInput) String ¶
func (s GetStageInput) String() string
String returns the string representation
func (*GetStageInput) Validate ¶ added in v1.1.21
func (s *GetStageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetStagesInput ¶
type GetStagesInput struct { // The stages' deployment identifiers. DeploymentId *string `location:"querystring" locationName:"deploymentId" type:"string"` // The stages' API identifiers. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to get information about one or more Stage resources.
func (GetStagesInput) GoString ¶
func (s GetStagesInput) GoString() string
GoString returns the string representation
func (*GetStagesInput) SetDeploymentId ¶ added in v1.5.0
func (s *GetStagesInput) SetDeploymentId(v string) *GetStagesInput
SetDeploymentId sets the DeploymentId field's value.
func (*GetStagesInput) SetRestApiId ¶ added in v1.5.0
func (s *GetStagesInput) SetRestApiId(v string) *GetStagesInput
SetRestApiId sets the RestApiId field's value.
func (GetStagesInput) String ¶
func (s GetStagesInput) String() string
String returns the string representation
func (*GetStagesInput) Validate ¶ added in v1.1.21
func (s *GetStagesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetStagesOutput ¶
type GetStagesOutput struct { // 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) SetItem ¶ added in v1.5.0
func (s *GetStagesOutput) SetItem(v []*Stage) *GetStagesOutput
SetItem sets the Item field's value.
func (GetStagesOutput) String ¶
func (s GetStagesOutput) String() string
String returns the string representation
type GetUsageInput ¶ added in v1.4.2
type GetUsageInput struct { // The ending date (e.g., 2016-12-31) of the usage data. // // EndDate is a required field EndDate *string `location:"querystring" locationName:"endDate" type:"string" required:"true"` // The Id of the API key associated with the resultant usage data. KeyId *string `location:"querystring" locationName:"keyId" type:"string"` // The maximum number of 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 is a required field StartDate *string `location:"querystring" locationName:"startDate" type:"string" required:"true"` // The Id of the usage plan associated with the usage data. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The GET request to get the usage data of a usage plan in a specified time interval.
func (GetUsageInput) GoString ¶ added in v1.4.2
func (s GetUsageInput) GoString() string
GoString returns the string representation
func (*GetUsageInput) SetEndDate ¶ added in v1.5.0
func (s *GetUsageInput) SetEndDate(v string) *GetUsageInput
SetEndDate sets the EndDate field's value.
func (*GetUsageInput) SetKeyId ¶ added in v1.5.0
func (s *GetUsageInput) SetKeyId(v string) *GetUsageInput
SetKeyId sets the KeyId field's value.
func (*GetUsageInput) SetLimit ¶ added in v1.5.0
func (s *GetUsageInput) SetLimit(v int64) *GetUsageInput
SetLimit sets the Limit field's value.
func (*GetUsageInput) SetPosition ¶ added in v1.5.0
func (s *GetUsageInput) SetPosition(v string) *GetUsageInput
SetPosition sets the Position field's value.
func (*GetUsageInput) SetStartDate ¶ added in v1.5.0
func (s *GetUsageInput) SetStartDate(v string) *GetUsageInput
SetStartDate sets the StartDate field's value.
func (*GetUsageInput) SetUsagePlanId ¶ added in v1.5.0
func (s *GetUsageInput) SetUsagePlanId(v string) *GetUsageInput
SetUsagePlanId sets the UsagePlanId field's value.
func (GetUsageInput) String ¶ added in v1.4.2
func (s GetUsageInput) String() string
String returns the string representation
func (*GetUsageInput) Validate ¶ added in v1.4.2
func (s *GetUsageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUsagePlanInput ¶ added in v1.4.2
type GetUsagePlanInput struct { // The identifier of the UsagePlan resource to be retrieved. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The GET request to get a usage plan of a given plan identifier.
func (GetUsagePlanInput) GoString ¶ added in v1.4.2
func (s GetUsagePlanInput) GoString() string
GoString returns the string representation
func (*GetUsagePlanInput) SetUsagePlanId ¶ added in v1.5.0
func (s *GetUsagePlanInput) SetUsagePlanId(v string) *GetUsagePlanInput
SetUsagePlanId sets the UsagePlanId field's value.
func (GetUsagePlanInput) String ¶ added in v1.4.2
func (s GetUsagePlanInput) String() string
String returns the string representation
func (*GetUsagePlanInput) Validate ¶ added in v1.4.2
func (s *GetUsagePlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUsagePlanKeyInput ¶ added in v1.4.2
type GetUsagePlanKeyInput struct { // The key Id of the to-be-retrieved UsagePlanKey resource representing a plan // customer. // // KeyId is a required field KeyId *string `location:"uri" locationName:"keyId" type:"string" required:"true"` // The Id of the UsagePlan resource representing the usage plan containing the // to-be-retrieved UsagePlanKey resource representing a plan customer. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The GET request to get a usage plan key of a given key identifier.
func (GetUsagePlanKeyInput) GoString ¶ added in v1.4.2
func (s GetUsagePlanKeyInput) GoString() string
GoString returns the string representation
func (*GetUsagePlanKeyInput) SetKeyId ¶ added in v1.5.0
func (s *GetUsagePlanKeyInput) SetKeyId(v string) *GetUsagePlanKeyInput
SetKeyId sets the KeyId field's value.
func (*GetUsagePlanKeyInput) SetUsagePlanId ¶ added in v1.5.0
func (s *GetUsagePlanKeyInput) SetUsagePlanId(v string) *GetUsagePlanKeyInput
SetUsagePlanId sets the UsagePlanId field's value.
func (GetUsagePlanKeyInput) String ¶ added in v1.4.2
func (s GetUsagePlanKeyInput) String() string
String returns the string representation
func (*GetUsagePlanKeyInput) Validate ¶ added in v1.4.2
func (s *GetUsagePlanKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUsagePlanKeysInput ¶ added in v1.4.2
type GetUsagePlanKeysInput struct { // 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 is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
func (GetUsagePlanKeysInput) GoString ¶ added in v1.4.2
func (s GetUsagePlanKeysInput) GoString() string
GoString returns the string representation
func (*GetUsagePlanKeysInput) SetLimit ¶ added in v1.5.0
func (s *GetUsagePlanKeysInput) SetLimit(v int64) *GetUsagePlanKeysInput
SetLimit sets the Limit field's value.
func (*GetUsagePlanKeysInput) SetNameQuery ¶ added in v1.5.0
func (s *GetUsagePlanKeysInput) SetNameQuery(v string) *GetUsagePlanKeysInput
SetNameQuery sets the NameQuery field's value.
func (*GetUsagePlanKeysInput) SetPosition ¶ added in v1.5.0
func (s *GetUsagePlanKeysInput) SetPosition(v string) *GetUsagePlanKeysInput
SetPosition sets the Position field's value.
func (*GetUsagePlanKeysInput) SetUsagePlanId ¶ added in v1.5.0
func (s *GetUsagePlanKeysInput) SetUsagePlanId(v string) *GetUsagePlanKeysInput
SetUsagePlanId sets the UsagePlanId field's value.
func (GetUsagePlanKeysInput) String ¶ added in v1.4.2
func (s GetUsagePlanKeysInput) String() string
String returns the string representation
func (*GetUsagePlanKeysInput) Validate ¶ added in v1.4.2
func (s *GetUsagePlanKeysInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUsagePlanKeysOutput ¶ added in v1.4.2
type GetUsagePlanKeysOutput struct { // 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) SetItems ¶ added in v1.5.0
func (s *GetUsagePlanKeysOutput) SetItems(v []*UsagePlanKey) *GetUsagePlanKeysOutput
SetItems sets the Items field's value.
func (*GetUsagePlanKeysOutput) SetPosition ¶ added in v1.5.0
func (s *GetUsagePlanKeysOutput) SetPosition(v string) *GetUsagePlanKeysOutput
SetPosition sets the Position field's value.
func (GetUsagePlanKeysOutput) String ¶ added in v1.4.2
func (s GetUsagePlanKeysOutput) String() string
String returns the string representation
type GetUsagePlansInput ¶ added in v1.4.2
type GetUsagePlansInput struct { // The identifier of the API key associated with the usage plans. KeyId *string `location:"querystring" locationName:"keyId" type:"string"` // The 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) SetKeyId ¶ added in v1.5.0
func (s *GetUsagePlansInput) SetKeyId(v string) *GetUsagePlansInput
SetKeyId sets the KeyId field's value.
func (*GetUsagePlansInput) SetLimit ¶ added in v1.5.0
func (s *GetUsagePlansInput) SetLimit(v int64) *GetUsagePlansInput
SetLimit sets the Limit field's value.
func (*GetUsagePlansInput) SetPosition ¶ added in v1.5.0
func (s *GetUsagePlansInput) SetPosition(v string) *GetUsagePlansInput
SetPosition sets the Position field's value.
func (GetUsagePlansInput) String ¶ added in v1.4.2
func (s GetUsagePlansInput) String() string
String returns the string representation
type GetUsagePlansOutput ¶ added in v1.4.2
type GetUsagePlansOutput struct { // 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) SetItems ¶ added in v1.5.0
func (s *GetUsagePlansOutput) SetItems(v []*UsagePlan) *GetUsagePlansOutput
SetItems sets the Items field's value.
func (*GetUsagePlansOutput) SetPosition ¶ added in v1.5.0
func (s *GetUsagePlansOutput) SetPosition(v string) *GetUsagePlansOutput
SetPosition sets the Position field's value.
func (GetUsagePlansOutput) String ¶ added in v1.4.2
func (s GetUsagePlansOutput) String() string
String returns the string representation
type ImportApiKeysInput ¶ added in v1.4.2
type ImportApiKeysInput struct { // The payload of the POST request to import API keys. For the payload format, // see API Key File Format (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html). // // Body is a required field Body []byte `locationName:"body" type:"blob" required:"true"` // A query parameter to indicate whether to rollback ApiKey importation (true) // or not (false) when error is encountered. FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` // A query parameter to specify the input format to imported API keys. Currently, // only the csv format is supported. // // Format is a required field Format *string `location:"querystring" locationName:"format" type:"string" required:"true" enum:"ApiKeysFormat"` // contains filtered or unexported fields }
The POST request to import API keys from an external source, such as a CSV-formatted file.
func (ImportApiKeysInput) GoString ¶ added in v1.4.2
func (s ImportApiKeysInput) GoString() string
GoString returns the string representation
func (*ImportApiKeysInput) SetBody ¶ added in v1.5.0
func (s *ImportApiKeysInput) SetBody(v []byte) *ImportApiKeysInput
SetBody sets the Body field's value.
func (*ImportApiKeysInput) SetFailOnWarnings ¶ added in v1.5.0
func (s *ImportApiKeysInput) SetFailOnWarnings(v bool) *ImportApiKeysInput
SetFailOnWarnings sets the FailOnWarnings field's value.
func (*ImportApiKeysInput) SetFormat ¶ added in v1.5.0
func (s *ImportApiKeysInput) SetFormat(v string) *ImportApiKeysInput
SetFormat sets the Format field's value.
func (ImportApiKeysInput) String ¶ added in v1.4.2
func (s ImportApiKeysInput) String() string
String returns the string representation
func (*ImportApiKeysInput) Validate ¶ added in v1.4.2
func (s *ImportApiKeysInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportApiKeysOutput ¶ added in v1.4.2
type ImportApiKeysOutput struct { // A list of all the ApiKey identifiers. Ids []*string `locationName:"ids" type:"list"` // A list of warning messages. Warnings []*string `locationName:"warnings" type:"list"` // contains filtered or unexported fields }
The identifier of an ApiKey used in a UsagePlan.
func (ImportApiKeysOutput) GoString ¶ added in v1.4.2
func (s ImportApiKeysOutput) GoString() string
GoString returns the string representation
func (*ImportApiKeysOutput) SetIds ¶ added in v1.5.0
func (s *ImportApiKeysOutput) SetIds(v []*string) *ImportApiKeysOutput
SetIds sets the Ids field's value.
func (*ImportApiKeysOutput) SetWarnings ¶ added in v1.5.0
func (s *ImportApiKeysOutput) SetWarnings(v []*string) *ImportApiKeysOutput
SetWarnings sets the Warnings field's value.
func (ImportApiKeysOutput) String ¶ added in v1.4.2
func (s ImportApiKeysOutput) String() string
String returns the string representation
type ImportDocumentationPartsInput ¶ added in v1.5.13
type ImportDocumentationPartsInput struct { // [Required] Raw byte array representing the to-be-imported documentation parts. // To import from a Swagger file, this is a JSON object. // // Body is a required field Body []byte `locationName:"body" type:"blob" required:"true"` // A query parameter to specify whether to rollback the documentation importation // (true) or not (false) when a warning is encountered. The default value is // false. FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` // A query parameter to indicate whether to overwrite (OVERWRITE) any existing // DocumentationParts definition or to merge (MERGE) the new definition into // the existing one. The default value is MERGE. Mode *string `location:"querystring" locationName:"mode" type:"string" enum:"PutMode"` // [Required] The identifier of an API of the to-be-imported documentation parts. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Import documentation parts from an external (e.g., Swagger) definition file.
func (ImportDocumentationPartsInput) GoString ¶ added in v1.5.13
func (s ImportDocumentationPartsInput) GoString() string
GoString returns the string representation
func (*ImportDocumentationPartsInput) SetBody ¶ added in v1.5.13
func (s *ImportDocumentationPartsInput) SetBody(v []byte) *ImportDocumentationPartsInput
SetBody sets the Body field's value.
func (*ImportDocumentationPartsInput) SetFailOnWarnings ¶ added in v1.5.13
func (s *ImportDocumentationPartsInput) SetFailOnWarnings(v bool) *ImportDocumentationPartsInput
SetFailOnWarnings sets the FailOnWarnings field's value.
func (*ImportDocumentationPartsInput) SetMode ¶ added in v1.5.13
func (s *ImportDocumentationPartsInput) SetMode(v string) *ImportDocumentationPartsInput
SetMode sets the Mode field's value.
func (*ImportDocumentationPartsInput) SetRestApiId ¶ added in v1.5.13
func (s *ImportDocumentationPartsInput) SetRestApiId(v string) *ImportDocumentationPartsInput
SetRestApiId sets the RestApiId field's value.
func (ImportDocumentationPartsInput) String ¶ added in v1.5.13
func (s ImportDocumentationPartsInput) String() string
String returns the string representation
func (*ImportDocumentationPartsInput) Validate ¶ added in v1.5.13
func (s *ImportDocumentationPartsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportDocumentationPartsOutput ¶ added in v1.5.13
type ImportDocumentationPartsOutput struct { // A list of the returned documentation part identifiers. Ids []*string `locationName:"ids" type:"list"` // A list of warning messages reported during import of documentation parts. Warnings []*string `locationName:"warnings" type:"list"` // contains filtered or unexported fields }
A collection of the imported DocumentationPart identifiers.
This is used to return the result when documentation parts in an external (e.g., Swagger) file are imported into Amazon API Gateway Documenting an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), documentationpart:import (http://docs.aws.amazon.com/apigateway/api-reference/link-relation/documentationpart-import/), DocumentationPart
func (ImportDocumentationPartsOutput) GoString ¶ added in v1.5.13
func (s ImportDocumentationPartsOutput) GoString() string
GoString returns the string representation
func (*ImportDocumentationPartsOutput) SetIds ¶ added in v1.5.13
func (s *ImportDocumentationPartsOutput) SetIds(v []*string) *ImportDocumentationPartsOutput
SetIds sets the Ids field's value.
func (*ImportDocumentationPartsOutput) SetWarnings ¶ added in v1.5.13
func (s *ImportDocumentationPartsOutput) SetWarnings(v []*string) *ImportDocumentationPartsOutput
SetWarnings sets the Warnings field's value.
func (ImportDocumentationPartsOutput) String ¶ added in v1.5.13
func (s ImportDocumentationPartsOutput) String() string
String returns the string representation
type ImportRestApiInput ¶ added in v1.1.16
type ImportRestApiInput struct { // The POST request body containing external API definitions. Currently, only // Swagger definition JSON files are supported. // // Body is a required field Body []byte `locationName:"body" type:"blob" required:"true"` // A query parameter to indicate whether to rollback the API creation (true) // or not (false) when a warning is encountered. The default value is false. FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` // Custom header parameters as part of the request. Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // contains filtered or unexported fields }
A POST request to import an API to Amazon API Gateway using an input of an API definition file.
func (ImportRestApiInput) GoString ¶ added in v1.1.16
func (s ImportRestApiInput) GoString() string
GoString returns the string representation
func (*ImportRestApiInput) SetBody ¶ added in v1.5.0
func (s *ImportRestApiInput) SetBody(v []byte) *ImportRestApiInput
SetBody sets the Body field's value.
func (*ImportRestApiInput) SetFailOnWarnings ¶ added in v1.5.0
func (s *ImportRestApiInput) SetFailOnWarnings(v bool) *ImportRestApiInput
SetFailOnWarnings sets the FailOnWarnings field's value.
func (*ImportRestApiInput) SetParameters ¶ added in v1.5.0
func (s *ImportRestApiInput) SetParameters(v map[string]*string) *ImportRestApiInput
SetParameters sets the Parameters field's value.
func (ImportRestApiInput) String ¶ added in v1.1.16
func (s ImportRestApiInput) String() string
String returns the string representation
func (*ImportRestApiInput) Validate ¶ added in v1.1.21
func (s *ImportRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Integration ¶
type Integration struct { // Specifies the integration's cache key parameters. CacheKeyParameters []*string `locationName:"cacheKeyParameters" type:"list"` // Specifies the integration's cache namespace. CacheNamespace *string `locationName:"cacheNamespace" type:"string"` // Specifies how to handle request payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: // // * CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded // string to the corresponding binary blob. // // * CONVERT_TO_TEXT: Converts a request payload from a binary blob to a // Base64-encoded string. // // If this property is not defined, the request payload will be passed through // from the method request to integration request without modification, provided // that the passthroughBehaviors is configured to support payload pass-through. ContentHandling *string `locationName:"contentHandling" type:"string" enum:"ContentHandlingStrategy"` // Specifies the credentials required for the integration, if any. For AWS integrations, // three options are available. To specify an IAM Role for Amazon API Gateway // to assume, use the role's Amazon Resource Name (ARN). To require that the // caller's identity be passed through from the request, specify the string // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS // services, specify null. Credentials *string `locationName:"credentials" type:"string"` // Specifies the integration's HTTP method type. HttpMethod *string `locationName:"httpMethod" type:"string"` // Specifies the integration's responses. // // Example: Get integration responses of a method // // Request // // GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 // HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns 200 OKstatus and a payload as follows: // // { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", // "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" // }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" // } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" // }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream // in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" // }, "statusCode": "200" } IntegrationResponses map[string]*IntegrationResponse `locationName:"integrationResponses" type:"map"` // Specifies how the method request body of an unmapped content type will be // passed through the integration request to the back end without transformation. // A content type is unmapped if no mapping template is defined in the integration // or the content type does not match any of the mapped content types, as specified // in requestTemplates. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, // and NEVER. // // WHEN_NO_MATCH passes the method request body through the integration request // to the back end without transformation when the method request content type // does not match any content type associated with the mapping templates defined // in the integration request. // WHEN_NO_TEMPLATES passes the method request body through the integration // request to the back end without transformation when no mapping template is // defined in the integration request. If a template is defined when this option // is selected, the method request of an unmapped content-type will be rejected // with an HTTP 415 Unsupported Media Type response. // NEVER rejects the method request with an HTTP 415 Unsupported Media Type // response when either the method request content type does not match any content // type associated with the mapping templates defined in the integration request // or no mapping template is defined in the integration request. PassthroughBehavior *string `locationName:"passthroughBehavior" type:"string"` // A key-value map specifying request parameters that are passed from the method // request to the back end. The key is an integration request parameter name // and the associated value is a method request parameter value or static value // that must be enclosed within single quotes and pre-encoded as required by // the back end. The method request parameter value must match the pattern of // method.request.{location}.{name}, where location is querystring, path, or // header and name must be a valid and unique method request parameter name. RequestParameters map[string]*string `locationName:"requestParameters" type:"map"` // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the // value. RequestTemplates map[string]*string `locationName:"requestTemplates" type:"map"` // Specifies the integration's type. The valid value is HTTP for integrating // with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing // without actually invoking the back end, HTTP_PROXY for integrating with the // HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy // integration type. Type *string `locationName:"type" type:"string" enum:"IntegrationType"` // Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, // the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 // specification (https://en.wikipedia.org/wiki/Uniform_Resource_Identifier). // For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. // Region, subdomain and service are used to determine the right endpoint. For // AWS services that use the Action= query string parameter, service_api should // be a valid action for the desired service. For RESTful AWS service APIs, // path is used to indicate that the remaining substring in the URI should be // treated as the path to the resource, including the initial /. Uri *string `locationName:"uri" type:"string"` // contains filtered or unexported fields }
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
In the API Gateway console, the built-in Lambda integration is an AWS integration.
Creating an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (Integration) GoString ¶
func (s Integration) GoString() string
GoString returns the string representation
func (*Integration) SetCacheKeyParameters ¶ added in v1.5.0
func (s *Integration) SetCacheKeyParameters(v []*string) *Integration
SetCacheKeyParameters sets the CacheKeyParameters field's value.
func (*Integration) SetCacheNamespace ¶ added in v1.5.0
func (s *Integration) SetCacheNamespace(v string) *Integration
SetCacheNamespace sets the CacheNamespace field's value.
func (*Integration) SetContentHandling ¶ added in v1.5.7
func (s *Integration) SetContentHandling(v string) *Integration
SetContentHandling sets the ContentHandling field's value.
func (*Integration) SetCredentials ¶ added in v1.5.0
func (s *Integration) SetCredentials(v string) *Integration
SetCredentials sets the Credentials field's value.
func (*Integration) SetHttpMethod ¶ added in v1.5.0
func (s *Integration) SetHttpMethod(v string) *Integration
SetHttpMethod sets the HttpMethod field's value.
func (*Integration) SetIntegrationResponses ¶ added in v1.5.0
func (s *Integration) SetIntegrationResponses(v map[string]*IntegrationResponse) *Integration
SetIntegrationResponses sets the IntegrationResponses field's value.
func (*Integration) SetPassthroughBehavior ¶ added in v1.5.0
func (s *Integration) SetPassthroughBehavior(v string) *Integration
SetPassthroughBehavior sets the PassthroughBehavior field's value.
func (*Integration) SetRequestParameters ¶ added in v1.5.0
func (s *Integration) SetRequestParameters(v map[string]*string) *Integration
SetRequestParameters sets the RequestParameters field's value.
func (*Integration) SetRequestTemplates ¶ added in v1.5.0
func (s *Integration) SetRequestTemplates(v map[string]*string) *Integration
SetRequestTemplates sets the RequestTemplates field's value.
func (*Integration) SetType ¶ added in v1.5.0
func (s *Integration) SetType(v string) *Integration
SetType sets the Type field's value.
func (*Integration) SetUri ¶ added in v1.5.0
func (s *Integration) SetUri(v string) *Integration
SetUri sets the Uri field's value.
func (Integration) String ¶
func (s Integration) String() string
String returns the string representation
type IntegrationResponse ¶
type IntegrationResponse struct { // Specifies how to handle response payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: // // * CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded // string to the corresponding binary blob. // // * CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. // // If this property is not defined, the response payload will be passed through // from the integration response to the method response without modification. ContentHandling *string `locationName:"contentHandling" type:"string" enum:"ContentHandlingStrategy"` // A key-value map specifying response parameters that are passed to the method // response from the back end. The key is a method response header parameter // name and the mapped value is an integration response header value, a static // value enclosed within a pair of single quotes, or a JSON expression from // the integration response body. The mapping key must match the pattern of // method.response.header.{name}, where name is a valid and unique header name. // The mapped non-static value must match the pattern of integration.response.header.{name} // or integration.response.body.{JSON-expression}, where name is a valid and // unique response header name and JSON-expression is a valid JSON expression // without the $ prefix. ResponseParameters map[string]*string `locationName:"responseParameters" type:"map"` // Specifies the templates used to transform the integration response body. // Response templates are represented as a key/value map, with a content-type // as the key and a template as the value. ResponseTemplates map[string]*string `locationName:"responseTemplates" type:"map"` // Specifies the regular expression (regex) pattern used to choose an integration // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you // could use the .+ regex to match error response. However, make sure that the // error response does not contain any newline (\n) character in such cases. // If the back end is an AWS Lambda function, the AWS Lambda function error // header is matched. For all other HTTP and AWS back ends, the HTTP status // code is matched. SelectionPattern *string `locationName:"selectionPattern" type:"string"` // Specifies the status code that is used to map the integration response to // an existing MethodResponse. StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
Creating an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (IntegrationResponse) GoString ¶
func (s IntegrationResponse) GoString() string
GoString returns the string representation
func (*IntegrationResponse) SetContentHandling ¶ added in v1.5.7
func (s *IntegrationResponse) SetContentHandling(v string) *IntegrationResponse
SetContentHandling sets the ContentHandling field's value.
func (*IntegrationResponse) SetResponseParameters ¶ added in v1.5.0
func (s *IntegrationResponse) SetResponseParameters(v map[string]*string) *IntegrationResponse
SetResponseParameters sets the ResponseParameters field's value.
func (*IntegrationResponse) SetResponseTemplates ¶ added in v1.5.0
func (s *IntegrationResponse) SetResponseTemplates(v map[string]*string) *IntegrationResponse
SetResponseTemplates sets the ResponseTemplates field's value.
func (*IntegrationResponse) SetSelectionPattern ¶ added in v1.5.0
func (s *IntegrationResponse) SetSelectionPattern(v string) *IntegrationResponse
SetSelectionPattern sets the SelectionPattern field's value.
func (*IntegrationResponse) SetStatusCode ¶ added in v1.5.0
func (s *IntegrationResponse) SetStatusCode(v string) *IntegrationResponse
SetStatusCode sets the StatusCode field's value.
func (IntegrationResponse) String ¶
func (s IntegrationResponse) String() string
String returns the string representation
type Method ¶
type Method struct { // A boolean flag specifying whether a valid ApiKey is required to invoke this // method. ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"` // The method's authorization type. AuthorizationType *string `locationName:"authorizationType" type:"string"` // The identifier of an Authorizer to use on this method. The authorizationType // must be CUSTOM. AuthorizerId *string `locationName:"authorizerId" type:"string"` // The method's HTTP verb. HttpMethod *string `locationName:"httpMethod" type:"string"` // Gets the method's integration responsible for passing the client-submitted // request to the back end and performing necessary transformations to make // the request compliant with the back end. // // Example: // // Request // // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: // 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns a 200 OKstatus code and a payload similar to the following: // // { "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", // "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" // }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" // }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", // "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" // }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", // "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", // "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": // "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": // "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", // \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", // "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", // "name": "200", "title": "200" }, "integrationresponse:delete": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" // }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" // } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", // "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": // "integration.response.body.a" }, "responseTemplates": { "application/json": // "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op // => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n // \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } // } MethodIntegration *Integration `locationName:"methodIntegration" type:"structure"` // Gets a method response associated with a given HTTP status code. // // The collection of method responses are encapsulated in a key-value map, where // the key is a response's HTTP status code and the value is a MethodResponse // resource that specifies the response returned to the caller from the back // end through the integration response. // // Example: Get a 200 OK response of a GET method // // Request // // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns a 200 OK status code and a payload similar // to the following: // // { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", // "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", // "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" // }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" // } }, "responseModels": { "application/json": "Empty" }, "responseParameters": // { "method.response.header.operator": false, "method.response.header.operand_2": // false, "method.response.header.operand_1": false }, "statusCode": "200" // } MethodResponses map[string]*MethodResponse `locationName:"methodResponses" type:"map"` // A human-friendly operation identifier for the method. For example, you can // assign the operationName of ListPets for the GET /pets method in PetStore // (http://petstore-demo-endpoint.execute-api.com/petstore/pets) example. OperationName *string `locationName:"operationName" type:"string"` // A key-value map specifying data schemas, represented by Model resources, // (as the mapped value) of the request payloads of given content types (as // the mapping key). RequestModels map[string]*string `locationName:"requestModels" type:"map"` // A key-value map defining required or optional method request parameters that // can be accepted by Amazon API Gateway. A key is a method request parameter // name matching the pattern of method.request.{location}.{name}, where location // is querystring, path, or header and name is a valid and unique parameter // name. The value associated with the key is a Boolean flag indicating whether // the parameter is required (true) or optional (false). The method request // parameter names defined here are available in Integration to be mapped to // integration request parameters or templates. RequestParameters map[string]*bool `locationName:"requestParameters" type:"map"` // contains filtered or unexported fields }
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
Example: Retrive the GET method on a specified resource
Request ¶
The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri).
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": true, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E\")" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }
In the example above, the response template for the 200 OK response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E and the output is decoded using the $util.urlDecode() (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#util-templat-reference) helper function.
MethodResponse, Integration, IntegrationResponse, Resource, Set up an API's method (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html)
func (*Method) SetApiKeyRequired ¶ added in v1.5.0
SetApiKeyRequired sets the ApiKeyRequired field's value.
func (*Method) SetAuthorizationType ¶ added in v1.5.0
SetAuthorizationType sets the AuthorizationType field's value.
func (*Method) SetAuthorizerId ¶ added in v1.5.0
SetAuthorizerId sets the AuthorizerId field's value.
func (*Method) SetHttpMethod ¶ added in v1.5.0
SetHttpMethod sets the HttpMethod field's value.
func (*Method) SetMethodIntegration ¶ added in v1.5.0
func (s *Method) SetMethodIntegration(v *Integration) *Method
SetMethodIntegration sets the MethodIntegration field's value.
func (*Method) SetMethodResponses ¶ added in v1.5.0
func (s *Method) SetMethodResponses(v map[string]*MethodResponse) *Method
SetMethodResponses sets the MethodResponses field's value.
func (*Method) SetOperationName ¶ added in v1.6.8
SetOperationName sets the OperationName field's value.
func (*Method) SetRequestModels ¶ added in v1.5.0
SetRequestModels sets the RequestModels field's value.
func (*Method) SetRequestParameters ¶ added in v1.5.0
SetRequestParameters sets the RequestParameters field's value.
type MethodResponse ¶
type MethodResponse struct { // Specifies the Model resources used for the response's content-type. Response // models are represented as a key/value map, with a content-type as the key // and a Model name as the value. ResponseModels map[string]*string `locationName:"responseModels" type:"map"` // A key-value map specifying required or optional response parameters that // Amazon API Gateway can send back to the caller. A key defines a method response // header and the value specifies whether the associated method response header // is required or not. The expression of the key must match the pattern method.response.header.{name}, // where name is a valid and unique header name. Amazon API Gateway passes certain // integration response data to the method response headers specified here according // to the mapping you prescribe in the API's IntegrationResponse. The integration // response data that can be mapped include an integration response header expressed // in integration.response.header.{name}, a static value enclosed within a pair // of single quotes (e.g., 'application/json'), or a JSON expression from the // back-end response payload in the form of integration.response.body.{JSON-expression}, // where JSON-expression is a valid JSON expression without the $ prefix.) ResponseParameters map[string]*bool `locationName:"responseParameters" type:"map"` // The method response's status code. StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
Example: A MethodResponse instance of an API
Request ¶
The example request retrieves a MethodResponse of the 200 status code.
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" }
func (MethodResponse) GoString ¶
func (s MethodResponse) GoString() string
GoString returns the string representation
func (*MethodResponse) SetResponseModels ¶ added in v1.5.0
func (s *MethodResponse) SetResponseModels(v map[string]*string) *MethodResponse
SetResponseModels sets the ResponseModels field's value.
func (*MethodResponse) SetResponseParameters ¶ added in v1.5.0
func (s *MethodResponse) SetResponseParameters(v map[string]*bool) *MethodResponse
SetResponseParameters sets the ResponseParameters field's value.
func (*MethodResponse) SetStatusCode ¶ added in v1.5.0
func (s *MethodResponse) SetStatusCode(v string) *MethodResponse
SetStatusCode sets the StatusCode field's value.
func (MethodResponse) String ¶
func (s MethodResponse) String() string
String returns the string representation
type MethodSetting ¶
type MethodSetting struct { // Specifies whether the cached responses are encrypted. The PATCH path for // this setting is /{method_setting_key}/caching/dataEncrypted, and the value // is a Boolean. CacheDataEncrypted *bool `locationName:"cacheDataEncrypted" type:"boolean"` // Specifies the time to live (TTL), in seconds, for cached responses. The higher // the TTL, the longer the response will be cached. The PATCH path for this // setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an // integer. CacheTtlInSeconds *int64 `locationName:"cacheTtlInSeconds" type:"integer"` // Specifies whether responses should be cached and returned for requests. A // cache cluster must be enabled on the stage for responses to be cached. The // PATCH path for this setting is /{method_setting_key}/caching/enabled, and // the value is a Boolean. CachingEnabled *bool `locationName:"cachingEnabled" type:"boolean"` // Specifies whether data trace logging is enabled for this method, which effects // the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this // setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean. DataTraceEnabled *bool `locationName:"dataTraceEnabled" type:"boolean"` // Specifies the logging level for this method, which effects the log entries // pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, // and the available levels are OFF, ERROR, and INFO. LoggingLevel *string `locationName:"loggingLevel" type:"string"` // Specifies whether Amazon CloudWatch metrics are enabled for this method. // The PATCH path for this setting is /{method_setting_key}/metrics/enabled, // and the value is a Boolean. MetricsEnabled *bool `locationName:"metricsEnabled" type:"boolean"` // Specifies whether authorization is required for a cache invalidation request. // The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, // and the value is a Boolean. RequireAuthorizationForCacheControl *bool `locationName:"requireAuthorizationForCacheControl" type:"boolean"` // Specifies the throttling burst limit. The PATCH path for this setting is // /{method_setting_key}/throttling/burstLimit, and the value is an integer. ThrottlingBurstLimit *int64 `locationName:"throttlingBurstLimit" type:"integer"` // Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, // and the value is a double. ThrottlingRateLimit *float64 `locationName:"throttlingRateLimit" type:"double"` // PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, // and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, // SUCCEED_WITHOUT_RESPONSE_HEADER. UnauthorizedCacheControlHeaderStrategy *string `locationName:"unauthorizedCacheControlHeaderStrategy" type:"string" enum:"UnauthorizedCacheControlHeaderStrategy"` // contains filtered or unexported fields }
Specifies the method setting properties.
func (MethodSetting) GoString ¶
func (s MethodSetting) GoString() string
GoString returns the string representation
func (*MethodSetting) SetCacheDataEncrypted ¶ added in v1.5.0
func (s *MethodSetting) SetCacheDataEncrypted(v bool) *MethodSetting
SetCacheDataEncrypted sets the CacheDataEncrypted field's value.
func (*MethodSetting) SetCacheTtlInSeconds ¶ added in v1.5.0
func (s *MethodSetting) SetCacheTtlInSeconds(v int64) *MethodSetting
SetCacheTtlInSeconds sets the CacheTtlInSeconds field's value.
func (*MethodSetting) SetCachingEnabled ¶ added in v1.5.0
func (s *MethodSetting) SetCachingEnabled(v bool) *MethodSetting
SetCachingEnabled sets the CachingEnabled field's value.
func (*MethodSetting) SetDataTraceEnabled ¶ added in v1.5.0
func (s *MethodSetting) SetDataTraceEnabled(v bool) *MethodSetting
SetDataTraceEnabled sets the DataTraceEnabled field's value.
func (*MethodSetting) SetLoggingLevel ¶ added in v1.5.0
func (s *MethodSetting) SetLoggingLevel(v string) *MethodSetting
SetLoggingLevel sets the LoggingLevel field's value.
func (*MethodSetting) SetMetricsEnabled ¶ added in v1.5.0
func (s *MethodSetting) SetMetricsEnabled(v bool) *MethodSetting
SetMetricsEnabled sets the MetricsEnabled field's value.
func (*MethodSetting) SetRequireAuthorizationForCacheControl ¶ added in v1.5.0
func (s *MethodSetting) SetRequireAuthorizationForCacheControl(v bool) *MethodSetting
SetRequireAuthorizationForCacheControl sets the RequireAuthorizationForCacheControl field's value.
func (*MethodSetting) SetThrottlingBurstLimit ¶ added in v1.5.0
func (s *MethodSetting) SetThrottlingBurstLimit(v int64) *MethodSetting
SetThrottlingBurstLimit sets the ThrottlingBurstLimit field's value.
func (*MethodSetting) SetThrottlingRateLimit ¶ added in v1.5.0
func (s *MethodSetting) SetThrottlingRateLimit(v float64) *MethodSetting
SetThrottlingRateLimit sets the ThrottlingRateLimit field's value.
func (*MethodSetting) SetUnauthorizedCacheControlHeaderStrategy ¶ added in v1.5.0
func (s *MethodSetting) SetUnauthorizedCacheControlHeaderStrategy(v string) *MethodSetting
SetUnauthorizedCacheControlHeaderStrategy sets the UnauthorizedCacheControlHeaderStrategy field's value.
func (MethodSetting) String ¶
func (s MethodSetting) String() string
String returns the string representation
type MethodSnapshot ¶
type MethodSnapshot struct { // Specifies whether the method requires a valid ApiKey. ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"` // 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) SetApiKeyRequired ¶ added in v1.5.0
func (s *MethodSnapshot) SetApiKeyRequired(v bool) *MethodSnapshot
SetApiKeyRequired sets the ApiKeyRequired field's value.
func (*MethodSnapshot) SetAuthorizationType ¶ added in v1.5.0
func (s *MethodSnapshot) SetAuthorizationType(v string) *MethodSnapshot
SetAuthorizationType sets the AuthorizationType field's value.
func (MethodSnapshot) String ¶
func (s MethodSnapshot) String() string
String returns the string representation
type Model ¶
type Model struct { // The content-type for the model. ContentType *string `locationName:"contentType" type:"string"` // The description of the model. Description *string `locationName:"description" type:"string"` // The identifier for the model resource. Id *string `locationName:"id" type:"string"` // The name of the model. Name *string `locationName:"name" type:"string"` // The schema for the model. For application/json models, this should be JSON-schema // draft v4 (http://json-schema.org/documentation.html) model. Do not include // "\*/" characters in the description of any properties because such "\*/" // characters may be interpreted as the closing marker for comments in some // languages, such as Java or JavaScript, causing the installation of your API's // SDK generated by API Gateway to fail. Schema *string `locationName:"schema" type:"string"` // contains filtered or unexported fields }
Represents the data structure of a method's request or response payload.
A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.
A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.
Method, MethodResponse, Models and Mappings (http://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html)
func (*Model) SetContentType ¶ added in v1.5.0
SetContentType sets the ContentType field's value.
func (*Model) SetDescription ¶ added in v1.5.0
SetDescription sets the Description field's value.
type PatchOperation ¶
type PatchOperation struct { // Not supported. From *string `locationName:"from" type:"string"` // An update operation to be performed with this PATCH request. The valid value // can be "add", "remove", or "replace". Not all valid operations are supported // for a given resource. Support of the operations depends on specific operational // contexts. Attempts to apply an unsupported operation on a resource will return // an error message. Op *string `locationName:"op" type:"string" enum:"Op"` // The op operation's target, as identified by a JSON Pointer (https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08) // value that references a location within the targeted resource. For example, // if the target resource has an updateable property of {"name":"value"}, the // path for this property is /name. If the name property value is a JSON object // (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name // property will be /name/child~1name. Any slash ("/") character appearing in // path names must be escaped with "~1", as shown in the example above. Each // op operation can have only one path associated with it. Path *string `locationName:"path" type:"string"` // The new target value of the update operation. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.
func (PatchOperation) GoString ¶
func (s PatchOperation) GoString() string
GoString returns the string representation
func (*PatchOperation) SetFrom ¶ added in v1.5.0
func (s *PatchOperation) SetFrom(v string) *PatchOperation
SetFrom sets the From field's value.
func (*PatchOperation) SetOp ¶ added in v1.5.0
func (s *PatchOperation) SetOp(v string) *PatchOperation
SetOp sets the Op field's value.
func (*PatchOperation) SetPath ¶ added in v1.5.0
func (s *PatchOperation) SetPath(v string) *PatchOperation
SetPath sets the Path field's value.
func (*PatchOperation) SetValue ¶ added in v1.5.0
func (s *PatchOperation) SetValue(v string) *PatchOperation
SetValue sets the Value field's value.
func (PatchOperation) String ¶
func (s PatchOperation) String() string
String returns the string representation
type PutIntegrationInput ¶
type PutIntegrationInput struct { // Specifies a put integration input's cache key parameters. CacheKeyParameters []*string `locationName:"cacheKeyParameters" type:"list"` // Specifies a put integration input's cache namespace. CacheNamespace *string `locationName:"cacheNamespace" type:"string"` // Specifies how to handle request payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: // // * CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded // string to the corresponding binary blob. // // * CONVERT_TO_TEXT: Converts a request payload from a binary blob to a // Base64-encoded string. // // If this property is not defined, the request payload will be passed through // from the method request to integration request without modification, provided // that the passthroughBehaviors is configured to support payload pass-through. ContentHandling *string `locationName:"contentHandling" type:"string" enum:"ContentHandlingStrategy"` // Specifies whether credentials are required for a put integration. Credentials *string `locationName:"credentials" type:"string"` // Specifies a put integration request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a put integration HTTP method. When the integration type is HTTP // or AWS, this field is required. IntegrationHttpMethod *string `locationName:"httpMethod" type:"string"` // Specifies the pass-through behavior for incoming requests based on the Content-Type // header in the request, and the available mapping templates specified as the // requestTemplates property on the Integration resource. There are three valid // values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. // // * WHEN_NO_MATCH passes the request body for unmapped content types through // to the integration back end without transformation. // // * NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media // Type' response. // // * WHEN_NO_TEMPLATES allows pass-through when the integration has NO content // types mapped to templates. However if there is at least one content type // defined, unmapped content types will be rejected with the same 415 response. PassthroughBehavior *string `locationName:"passthroughBehavior" type:"string"` // A key-value map specifying request parameters that are passed from the method // request to the back end. The key is an integration request parameter name // and the associated value is a method request parameter value or static value // that must be enclosed within single quotes and pre-encoded as required by // the back end. The method request parameter value must match the pattern of // method.request.{location}.{name}, where location is querystring, path, or // header and name must be a valid and unique method request parameter name. RequestParameters map[string]*string `locationName:"requestParameters" type:"map"` // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the // value. RequestTemplates map[string]*string `locationName:"requestTemplates" type:"map"` // Specifies a put integration request's resource ID. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies a put integration request's API identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies a put integration input's type. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"IntegrationType"` // Specifies a put integration input's Uniform Resource Identifier (URI). When // the integration type is HTTP or AWS, this field is required. For integration // with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' // format. Uri *string `locationName:"uri" type:"string"` // contains filtered or unexported fields }
Represents a put integration request.
func (PutIntegrationInput) GoString ¶
func (s PutIntegrationInput) GoString() string
GoString returns the string representation
func (*PutIntegrationInput) SetCacheKeyParameters ¶ added in v1.5.0
func (s *PutIntegrationInput) SetCacheKeyParameters(v []*string) *PutIntegrationInput
SetCacheKeyParameters sets the CacheKeyParameters field's value.
func (*PutIntegrationInput) SetCacheNamespace ¶ added in v1.5.0
func (s *PutIntegrationInput) SetCacheNamespace(v string) *PutIntegrationInput
SetCacheNamespace sets the CacheNamespace field's value.
func (*PutIntegrationInput) SetContentHandling ¶ added in v1.5.7
func (s *PutIntegrationInput) SetContentHandling(v string) *PutIntegrationInput
SetContentHandling sets the ContentHandling field's value.
func (*PutIntegrationInput) SetCredentials ¶ added in v1.5.0
func (s *PutIntegrationInput) SetCredentials(v string) *PutIntegrationInput
SetCredentials sets the Credentials field's value.
func (*PutIntegrationInput) SetHttpMethod ¶ added in v1.5.0
func (s *PutIntegrationInput) SetHttpMethod(v string) *PutIntegrationInput
SetHttpMethod sets the HttpMethod field's value.
func (*PutIntegrationInput) SetIntegrationHttpMethod ¶ added in v1.5.0
func (s *PutIntegrationInput) SetIntegrationHttpMethod(v string) *PutIntegrationInput
SetIntegrationHttpMethod sets the IntegrationHttpMethod field's value.
func (*PutIntegrationInput) SetPassthroughBehavior ¶ added in v1.5.0
func (s *PutIntegrationInput) SetPassthroughBehavior(v string) *PutIntegrationInput
SetPassthroughBehavior sets the PassthroughBehavior field's value.
func (*PutIntegrationInput) SetRequestParameters ¶ added in v1.5.0
func (s *PutIntegrationInput) SetRequestParameters(v map[string]*string) *PutIntegrationInput
SetRequestParameters sets the RequestParameters field's value.
func (*PutIntegrationInput) SetRequestTemplates ¶ added in v1.5.0
func (s *PutIntegrationInput) SetRequestTemplates(v map[string]*string) *PutIntegrationInput
SetRequestTemplates sets the RequestTemplates field's value.
func (*PutIntegrationInput) SetResourceId ¶ added in v1.5.0
func (s *PutIntegrationInput) SetResourceId(v string) *PutIntegrationInput
SetResourceId sets the ResourceId field's value.
func (*PutIntegrationInput) SetRestApiId ¶ added in v1.5.0
func (s *PutIntegrationInput) SetRestApiId(v string) *PutIntegrationInput
SetRestApiId sets the RestApiId field's value.
func (*PutIntegrationInput) SetType ¶ added in v1.5.0
func (s *PutIntegrationInput) SetType(v string) *PutIntegrationInput
SetType sets the Type field's value.
func (*PutIntegrationInput) SetUri ¶ added in v1.5.0
func (s *PutIntegrationInput) SetUri(v string) *PutIntegrationInput
SetUri sets the Uri field's value.
func (PutIntegrationInput) String ¶
func (s PutIntegrationInput) String() string
String returns the string representation
func (*PutIntegrationInput) Validate ¶ added in v1.1.21
func (s *PutIntegrationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutIntegrationResponseInput ¶
type PutIntegrationResponseInput struct { // Specifies how to handle response payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: // // * CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded // string to the corresponding binary blob. // // * CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. // // If this property is not defined, the response payload will be passed through // from the integration response to the method response without modification. ContentHandling *string `locationName:"contentHandling" type:"string" enum:"ContentHandlingStrategy"` // Specifies a put integration response request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // Specifies a put integration response request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // A key-value map specifying response parameters that are passed to the method // response from the back end. The key is a method response header parameter // name and the mapped value is an integration response header value, a static // value enclosed within a pair of single quotes, or a JSON expression from // the integration response body. The mapping key must match the pattern of // method.response.header.{name}, where name is a valid and unique header name. // The mapped non-static value must match the pattern of integration.response.header.{name} // or integration.response.body.{JSON-expression}, where name must be a valid // and unique response header name and JSON-expression a valid JSON expression // without the $ prefix. ResponseParameters map[string]*string `locationName:"responseParameters" type:"map"` // Specifies a put integration response's templates. ResponseTemplates map[string]*string `locationName:"responseTemplates" type:"map"` // Specifies a put integration response request's API identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies the selection pattern of a put integration response. SelectionPattern *string `locationName:"selectionPattern" type:"string"` // Specifies the status code that is used to map the integration response to // an existing MethodResponse. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a put integration response request.
func (PutIntegrationResponseInput) GoString ¶
func (s PutIntegrationResponseInput) GoString() string
GoString returns the string representation
func (*PutIntegrationResponseInput) SetContentHandling ¶ added in v1.5.7
func (s *PutIntegrationResponseInput) SetContentHandling(v string) *PutIntegrationResponseInput
SetContentHandling sets the ContentHandling field's value.
func (*PutIntegrationResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetHttpMethod(v string) *PutIntegrationResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*PutIntegrationResponseInput) SetResourceId ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetResourceId(v string) *PutIntegrationResponseInput
SetResourceId sets the ResourceId field's value.
func (*PutIntegrationResponseInput) SetResponseParameters ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetResponseParameters(v map[string]*string) *PutIntegrationResponseInput
SetResponseParameters sets the ResponseParameters field's value.
func (*PutIntegrationResponseInput) SetResponseTemplates ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetResponseTemplates(v map[string]*string) *PutIntegrationResponseInput
SetResponseTemplates sets the ResponseTemplates field's value.
func (*PutIntegrationResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetRestApiId(v string) *PutIntegrationResponseInput
SetRestApiId sets the RestApiId field's value.
func (*PutIntegrationResponseInput) SetSelectionPattern ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetSelectionPattern(v string) *PutIntegrationResponseInput
SetSelectionPattern sets the SelectionPattern field's value.
func (*PutIntegrationResponseInput) SetStatusCode ¶ added in v1.5.0
func (s *PutIntegrationResponseInput) SetStatusCode(v string) *PutIntegrationResponseInput
SetStatusCode sets the StatusCode field's value.
func (PutIntegrationResponseInput) String ¶
func (s PutIntegrationResponseInput) String() string
String returns the string representation
func (*PutIntegrationResponseInput) Validate ¶ added in v1.1.21
func (s *PutIntegrationResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutMethodInput ¶
type PutMethodInput struct { // Specifies whether the method required a valid ApiKey. ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"` // Specifies the type of authorization used for the method. // // AuthorizationType is a required field AuthorizationType *string `locationName:"authorizationType" type:"string" required:"true"` // Specifies the identifier of an Authorizer to use on this Method, if the type // is CUSTOM. AuthorizerId *string `locationName:"authorizerId" type:"string"` // Specifies the method request's HTTP method type. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // A human-friendly operation identifier for the method. For example, you can // assign the operationName of ListPets for the GET /pets method in PetStore // (http://petstore-demo-endpoint.execute-api.com/petstore/pets) example. OperationName *string `locationName:"operationName" type:"string"` // Specifies the Model resources used for the request's content type. Request // models are represented as a key/value map, with a content type as the key // and a Model name as the value. RequestModels map[string]*string `locationName:"requestModels" type:"map"` // A key-value map defining required or optional method request parameters that // can be accepted by Amazon API Gateway. A key defines a method request parameter // name matching the pattern of method.request.{location}.{name}, where location // is querystring, path, or header and name is a valid and unique parameter // name. The value associated with the key is a Boolean flag indicating whether // the parameter is required (true) or optional (false). The method request // parameter names defined here are available in Integration to be mapped to // integration request parameters or body-mapping templates. RequestParameters map[string]*bool `locationName:"requestParameters" type:"map"` // The Resource identifier for the new Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the new Method resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to add a method to an existing Resource resource.
func (PutMethodInput) GoString ¶
func (s PutMethodInput) GoString() string
GoString returns the string representation
func (*PutMethodInput) SetApiKeyRequired ¶ added in v1.5.0
func (s *PutMethodInput) SetApiKeyRequired(v bool) *PutMethodInput
SetApiKeyRequired sets the ApiKeyRequired field's value.
func (*PutMethodInput) SetAuthorizationType ¶ added in v1.5.0
func (s *PutMethodInput) SetAuthorizationType(v string) *PutMethodInput
SetAuthorizationType sets the AuthorizationType field's value.
func (*PutMethodInput) SetAuthorizerId ¶ added in v1.5.0
func (s *PutMethodInput) SetAuthorizerId(v string) *PutMethodInput
SetAuthorizerId sets the AuthorizerId field's value.
func (*PutMethodInput) SetHttpMethod ¶ added in v1.5.0
func (s *PutMethodInput) SetHttpMethod(v string) *PutMethodInput
SetHttpMethod sets the HttpMethod field's value.
func (*PutMethodInput) SetOperationName ¶ added in v1.6.8
func (s *PutMethodInput) SetOperationName(v string) *PutMethodInput
SetOperationName sets the OperationName field's value.
func (*PutMethodInput) SetRequestModels ¶ added in v1.5.0
func (s *PutMethodInput) SetRequestModels(v map[string]*string) *PutMethodInput
SetRequestModels sets the RequestModels field's value.
func (*PutMethodInput) SetRequestParameters ¶ added in v1.5.0
func (s *PutMethodInput) SetRequestParameters(v map[string]*bool) *PutMethodInput
SetRequestParameters sets the RequestParameters field's value.
func (*PutMethodInput) SetResourceId ¶ added in v1.5.0
func (s *PutMethodInput) SetResourceId(v string) *PutMethodInput
SetResourceId sets the ResourceId field's value.
func (*PutMethodInput) SetRestApiId ¶ added in v1.5.0
func (s *PutMethodInput) SetRestApiId(v string) *PutMethodInput
SetRestApiId sets the RestApiId field's value.
func (PutMethodInput) String ¶
func (s PutMethodInput) String() string
String returns the string representation
func (*PutMethodInput) Validate ¶ added in v1.1.21
func (s *PutMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutMethodResponseInput ¶
type PutMethodResponseInput struct { // The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The Resource identifier for the Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies the Model resources used for the response's content type. Response // models are represented as a key/value map, with a content type as the key // and a Model name as the value. ResponseModels map[string]*string `locationName:"responseModels" type:"map"` // A key-value map specifying required or optional response parameters that // Amazon API Gateway can send back to the caller. A key defines a method response // header name and the associated value is a Boolean flag indicating whether // the method response parameter is required or not. The method response header // names must match the pattern of method.response.header.{name}, where name // is a valid and unique header name. The response parameter names defined here // are available in the integration response to be mapped from an integration // response header expressed in integration.response.header.{name}, a static // value enclosed within a pair of single quotes (e.g., 'application/json'), // or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, // where JSON-expression is a valid JSON expression without the $ prefix.) ResponseParameters map[string]*bool `locationName:"responseParameters" type:"map"` // The RestApi identifier for the Method resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The method response's status code. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
Request to add a MethodResponse to an existing Method resource.
func (PutMethodResponseInput) GoString ¶
func (s PutMethodResponseInput) GoString() string
GoString returns the string representation
func (*PutMethodResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *PutMethodResponseInput) SetHttpMethod(v string) *PutMethodResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*PutMethodResponseInput) SetResourceId ¶ added in v1.5.0
func (s *PutMethodResponseInput) SetResourceId(v string) *PutMethodResponseInput
SetResourceId sets the ResourceId field's value.
func (*PutMethodResponseInput) SetResponseModels ¶ added in v1.5.0
func (s *PutMethodResponseInput) SetResponseModels(v map[string]*string) *PutMethodResponseInput
SetResponseModels sets the ResponseModels field's value.
func (*PutMethodResponseInput) SetResponseParameters ¶ added in v1.5.0
func (s *PutMethodResponseInput) SetResponseParameters(v map[string]*bool) *PutMethodResponseInput
SetResponseParameters sets the ResponseParameters field's value.
func (*PutMethodResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *PutMethodResponseInput) SetRestApiId(v string) *PutMethodResponseInput
SetRestApiId sets the RestApiId field's value.
func (*PutMethodResponseInput) SetStatusCode ¶ added in v1.5.0
func (s *PutMethodResponseInput) SetStatusCode(v string) *PutMethodResponseInput
SetStatusCode sets the StatusCode field's value.
func (PutMethodResponseInput) String ¶
func (s PutMethodResponseInput) String() string
String returns the string representation
func (*PutMethodResponseInput) Validate ¶ added in v1.1.21
func (s *PutMethodResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutRestApiInput ¶ added in v1.1.16
type PutRestApiInput struct { // The PUT request body containing external API definitions. Currently, only // Swagger definition JSON files are supported. // // Body is a required field Body []byte `locationName:"body" type:"blob" required:"true"` // A query parameter to indicate whether to rollback the API update (true) or // not (false) when a warning is encountered. The default value is false. FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` // The mode query parameter to specify the update mode. Valid values are "merge" // and "overwrite". By default, the update mode is "merge". Mode *string `location:"querystring" locationName:"mode" type:"string" enum:"PutMode"` // Custom headers supplied as part of the request. Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` // The identifier of the RestApi to be updated. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
A PUT request to update an existing API, with external API definitions specified as the request body.
func (PutRestApiInput) GoString ¶ added in v1.1.16
func (s PutRestApiInput) GoString() string
GoString returns the string representation
func (*PutRestApiInput) SetBody ¶ added in v1.5.0
func (s *PutRestApiInput) SetBody(v []byte) *PutRestApiInput
SetBody sets the Body field's value.
func (*PutRestApiInput) SetFailOnWarnings ¶ added in v1.5.0
func (s *PutRestApiInput) SetFailOnWarnings(v bool) *PutRestApiInput
SetFailOnWarnings sets the FailOnWarnings field's value.
func (*PutRestApiInput) SetMode ¶ added in v1.5.0
func (s *PutRestApiInput) SetMode(v string) *PutRestApiInput
SetMode sets the Mode field's value.
func (*PutRestApiInput) SetParameters ¶ added in v1.5.0
func (s *PutRestApiInput) SetParameters(v map[string]*string) *PutRestApiInput
SetParameters sets the Parameters field's value.
func (*PutRestApiInput) SetRestApiId ¶ added in v1.5.0
func (s *PutRestApiInput) SetRestApiId(v string) *PutRestApiInput
SetRestApiId sets the RestApiId field's value.
func (PutRestApiInput) String ¶ added in v1.1.16
func (s PutRestApiInput) String() string
String returns the string representation
func (*PutRestApiInput) Validate ¶ added in v1.1.21
func (s *PutRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type QuotaSettings ¶ added in v1.4.2
type QuotaSettings struct { // The maximum number of requests that can be made in a given time period. Limit *int64 `locationName:"limit" type:"integer"` // The number of requests subtracted from the given limit in the initial time // period. Offset *int64 `locationName:"offset" type:"integer"` // The time period in which the limit applies. Valid values are "DAY", "WEEK" // or "MONTH". Period *string `locationName:"period" type:"string" enum:"QuotaPeriodType"` // contains filtered or unexported fields }
Quotas configured for a usage plan.
func (QuotaSettings) GoString ¶ added in v1.4.2
func (s QuotaSettings) GoString() string
GoString returns the string representation
func (*QuotaSettings) SetLimit ¶ added in v1.5.0
func (s *QuotaSettings) SetLimit(v int64) *QuotaSettings
SetLimit sets the Limit field's value.
func (*QuotaSettings) SetOffset ¶ added in v1.5.0
func (s *QuotaSettings) SetOffset(v int64) *QuotaSettings
SetOffset sets the Offset field's value.
func (*QuotaSettings) SetPeriod ¶ added in v1.5.0
func (s *QuotaSettings) SetPeriod(v string) *QuotaSettings
SetPeriod sets the Period field's value.
func (QuotaSettings) String ¶ added in v1.4.2
func (s QuotaSettings) String() string
String returns the string representation
type Resource ¶
type Resource struct { // The resource's identifier. Id *string `locationName:"id" type:"string"` // The parent resource's identifier. ParentId *string `locationName:"parentId" type:"string"` // The full path for this resource. Path *string `locationName:"path" type:"string"` // The last path segment for this resource. PathPart *string `locationName:"pathPart" type:"string"` // Gets an API resource's method of a given HTTP verb. // // The resource methods are a map of methods indexed by methods' HTTP verbs // enabled on the resource. This method map is included in the 200 OK response // of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods // request. // // Example: Get the GET method of an API resource // // Request // // GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: // application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 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)
func (*Resource) SetParentId ¶ added in v1.5.0
SetParentId sets the ParentId field's value.
func (*Resource) SetPathPart ¶ added in v1.5.0
SetPathPart sets the PathPart field's value.
func (*Resource) SetResourceMethods ¶ added in v1.5.0
SetResourceMethods sets the ResourceMethods field's value.
type RestApi ¶
type RestApi struct { // The list of binary media types supported by the RestApi. By default, the // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []*string `locationName:"binaryMediaTypes" type:"list"` // The date when the API was created, in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm). CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"` // The API's description. Description *string `locationName:"description" type:"string"` // The API's identifier. This identifier is unique across all of your APIs in // Amazon API Gateway. Id *string `locationName:"id" type:"string"` // The API's name. Name *string `locationName:"name" type:"string"` // A version identifier for the API. Version *string `locationName:"version" type:"string"` // The warning messages reported when failonwarnings is turned on during API // import. Warnings []*string `locationName:"warnings" type:"list"` // contains filtered or unexported fields }
Represents a REST API.
Create an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (*RestApi) SetBinaryMediaTypes ¶ added in v1.5.7
SetBinaryMediaTypes sets the BinaryMediaTypes field's value.
func (*RestApi) SetCreatedDate ¶ added in v1.5.0
SetCreatedDate sets the CreatedDate field's value.
func (*RestApi) SetDescription ¶ added in v1.5.0
SetDescription sets the Description field's value.
func (*RestApi) SetVersion ¶ added in v1.5.13
SetVersion sets the Version field's value.
func (*RestApi) SetWarnings ¶ added in v1.5.0
SetWarnings sets the Warnings field's value.
type SdkConfigurationProperty ¶ added in v1.6.8
type SdkConfigurationProperty struct { // The default value of an SdkType configuration property. DefaultValue *string `locationName:"defaultValue" type:"string"` // The description of an SdkType configuration property. Description *string `locationName:"description" type:"string"` // The user-friendly name of an SdkType configuration property. FriendlyName *string `locationName:"friendlyName" type:"string"` // The name of a an SdkType configuration property. Name *string `locationName:"name" type:"string"` // A boolean flag of an SdkType configuration property to indicate if the associated // SDK configuration property is required (true) or not (false). Required *bool `locationName:"required" type:"boolean"` // contains filtered or unexported fields }
A configuration property of an SDK type.
func (SdkConfigurationProperty) GoString ¶ added in v1.6.8
func (s SdkConfigurationProperty) GoString() string
GoString returns the string representation
func (*SdkConfigurationProperty) SetDefaultValue ¶ added in v1.6.8
func (s *SdkConfigurationProperty) SetDefaultValue(v string) *SdkConfigurationProperty
SetDefaultValue sets the DefaultValue field's value.
func (*SdkConfigurationProperty) SetDescription ¶ added in v1.6.8
func (s *SdkConfigurationProperty) SetDescription(v string) *SdkConfigurationProperty
SetDescription sets the Description field's value.
func (*SdkConfigurationProperty) SetFriendlyName ¶ added in v1.6.8
func (s *SdkConfigurationProperty) SetFriendlyName(v string) *SdkConfigurationProperty
SetFriendlyName sets the FriendlyName field's value.
func (*SdkConfigurationProperty) SetName ¶ added in v1.6.8
func (s *SdkConfigurationProperty) SetName(v string) *SdkConfigurationProperty
SetName sets the Name field's value.
func (*SdkConfigurationProperty) SetRequired ¶ added in v1.6.8
func (s *SdkConfigurationProperty) SetRequired(v bool) *SdkConfigurationProperty
SetRequired sets the Required field's value.
func (SdkConfigurationProperty) String ¶ added in v1.6.8
func (s SdkConfigurationProperty) String() string
String returns the string representation
type SdkType ¶ added in v1.6.8
type SdkType struct { // A list of configuration properties of an SdkType. ConfigurationProperties []*SdkConfigurationProperty `locationName:"configurationProperties" type:"list"` // The description of an SdkType. Description *string `locationName:"description" type:"string"` // The user-friendly name of an SdkType instance. FriendlyName *string `locationName:"friendlyName" type:"string"` // The identifier of an SdkType instance. Id *string `locationName:"id" type:"string"` // contains filtered or unexported fields }
A type of SDK that API Gateway can generate.
func (*SdkType) SetConfigurationProperties ¶ added in v1.6.8
func (s *SdkType) SetConfigurationProperties(v []*SdkConfigurationProperty) *SdkType
SetConfigurationProperties sets the ConfigurationProperties field's value.
func (*SdkType) SetDescription ¶ added in v1.6.8
SetDescription sets the Description field's value.
func (*SdkType) SetFriendlyName ¶ added in v1.6.8
SetFriendlyName sets the FriendlyName field's value.
type Stage ¶
type Stage struct { // 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). CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"` // The identifier of the Deployment that the stage points to. DeploymentId *string `locationName:"deploymentId" type:"string"` // The stage's description. Description *string `locationName:"description" type:"string"` // The version of the associated API documentation. DocumentationVersion *string `locationName:"documentationVersion" type:"string"` // The date and time that information about the stage was last updated, in ISO // 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm). LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp" timestampFormat:"unix"` // A map that defines the method settings for a Stage resource. Keys (designated // as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} // for an individual method override, or /\*/\* for overriding all methods in // the stage. MethodSettings map[string]*MethodSetting `locationName:"methodSettings" type:"map"` // The name of the stage is the first path segment in the Uniform Resource Identifier // (URI) of a call to Amazon API Gateway. StageName *string `locationName:"stageName" type:"string"` // A map that defines the stage variables for a Stage resource. Variable names // can have alphanumeric and underscore characters, and the values must match // [A-Za-z0-9-._~:/?#&=,]+. Variables map[string]*string `locationName:"variables" type:"map"` // contains filtered or unexported fields }
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Deploy an API (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html)
func (*Stage) SetCacheClusterEnabled ¶ added in v1.5.0
SetCacheClusterEnabled sets the CacheClusterEnabled field's value.
func (*Stage) SetCacheClusterSize ¶ added in v1.5.0
SetCacheClusterSize sets the CacheClusterSize field's value.
func (*Stage) SetCacheClusterStatus ¶ added in v1.5.0
SetCacheClusterStatus sets the CacheClusterStatus field's value.
func (*Stage) SetClientCertificateId ¶ added in v1.5.0
SetClientCertificateId sets the ClientCertificateId field's value.
func (*Stage) SetCreatedDate ¶ added in v1.5.0
SetCreatedDate sets the CreatedDate field's value.
func (*Stage) SetDeploymentId ¶ added in v1.5.0
SetDeploymentId sets the DeploymentId field's value.
func (*Stage) SetDescription ¶ added in v1.5.0
SetDescription sets the Description field's value.
func (*Stage) SetDocumentationVersion ¶ added in v1.5.13
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*Stage) SetLastUpdatedDate ¶ added in v1.5.0
SetLastUpdatedDate sets the LastUpdatedDate field's value.
func (*Stage) SetMethodSettings ¶ added in v1.5.0
func (s *Stage) SetMethodSettings(v map[string]*MethodSetting) *Stage
SetMethodSettings sets the MethodSettings field's value.
func (*Stage) SetStageName ¶ added in v1.5.0
SetStageName sets the StageName field's value.
func (*Stage) SetVariables ¶ added in v1.5.0
SetVariables sets the Variables field's value.
type StageKey ¶
type StageKey struct { // 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}.
func (*StageKey) SetRestApiId ¶ added in v1.5.0
SetRestApiId sets the RestApiId field's value.
func (*StageKey) SetStageName ¶ added in v1.5.0
SetStageName sets the StageName field's value.
type TestInvokeAuthorizerInput ¶ added in v1.1.7
type TestInvokeAuthorizerInput struct { // [Optional] A key-value map of additional context variables. AdditionalContext map[string]*string `locationName:"additionalContext" type:"map"` // Specifies a test invoke authorizer request's Authorizer ID. // // AuthorizerId is a required field AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // [Optional] The simulated request body of an incoming invocation request. Body *string `locationName:"body" type:"string"` // [Required] A key-value map of headers to simulate an incoming invocation // request. This is where the incoming authorization token, or identity source, // should be specified. Headers map[string]*string `locationName:"headers" type:"map"` // [Optional] The URI path, including query string, of the simulated invocation // request. Use this to specify path parameters and query string parameters. PathWithQueryString *string `locationName:"pathWithQueryString" type:"string"` // Specifies a test invoke authorizer request's RestApi identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // A key-value map of stage variables to simulate an invocation on a deployed // Stage. StageVariables map[string]*string `locationName:"stageVariables" type:"map"` // contains filtered or unexported fields }
Make a request to simulate the execution of an Authorizer.
func (TestInvokeAuthorizerInput) GoString ¶ added in v1.1.7
func (s TestInvokeAuthorizerInput) GoString() string
GoString returns the string representation
func (*TestInvokeAuthorizerInput) SetAdditionalContext ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetAdditionalContext(v map[string]*string) *TestInvokeAuthorizerInput
SetAdditionalContext sets the AdditionalContext field's value.
func (*TestInvokeAuthorizerInput) SetAuthorizerId ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetAuthorizerId(v string) *TestInvokeAuthorizerInput
SetAuthorizerId sets the AuthorizerId field's value.
func (*TestInvokeAuthorizerInput) SetBody ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetBody(v string) *TestInvokeAuthorizerInput
SetBody sets the Body field's value.
func (*TestInvokeAuthorizerInput) SetHeaders ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetHeaders(v map[string]*string) *TestInvokeAuthorizerInput
SetHeaders sets the Headers field's value.
func (*TestInvokeAuthorizerInput) SetPathWithQueryString ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetPathWithQueryString(v string) *TestInvokeAuthorizerInput
SetPathWithQueryString sets the PathWithQueryString field's value.
func (*TestInvokeAuthorizerInput) SetRestApiId ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetRestApiId(v string) *TestInvokeAuthorizerInput
SetRestApiId sets the RestApiId field's value.
func (*TestInvokeAuthorizerInput) SetStageVariables ¶ added in v1.5.0
func (s *TestInvokeAuthorizerInput) SetStageVariables(v map[string]*string) *TestInvokeAuthorizerInput
SetStageVariables sets the StageVariables field's value.
func (TestInvokeAuthorizerInput) String ¶ added in v1.1.7
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.7
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.7
func (s TestInvokeAuthorizerOutput) GoString() string
GoString returns the string representation
func (*TestInvokeAuthorizerOutput) SetAuthorization ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetAuthorization(v map[string][]*string) *TestInvokeAuthorizerOutput
SetAuthorization sets the Authorization field's value.
func (*TestInvokeAuthorizerOutput) SetClaims ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetClaims(v map[string]*string) *TestInvokeAuthorizerOutput
SetClaims sets the Claims field's value.
func (*TestInvokeAuthorizerOutput) SetClientStatus ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetClientStatus(v int64) *TestInvokeAuthorizerOutput
SetClientStatus sets the ClientStatus field's value.
func (*TestInvokeAuthorizerOutput) SetLatency ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetLatency(v int64) *TestInvokeAuthorizerOutput
SetLatency sets the Latency field's value.
func (*TestInvokeAuthorizerOutput) SetLog ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetLog(v string) *TestInvokeAuthorizerOutput
SetLog sets the Log field's value.
func (*TestInvokeAuthorizerOutput) SetPolicy ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetPolicy(v string) *TestInvokeAuthorizerOutput
SetPolicy sets the Policy field's value.
func (*TestInvokeAuthorizerOutput) SetPrincipalId ¶ added in v1.5.0
func (s *TestInvokeAuthorizerOutput) SetPrincipalId(v string) *TestInvokeAuthorizerOutput
SetPrincipalId sets the PrincipalId field's value.
func (TestInvokeAuthorizerOutput) String ¶ added in v1.1.7
func (s TestInvokeAuthorizerOutput) String() string
String returns the string representation
type TestInvokeMethodInput ¶
type TestInvokeMethodInput struct { // The simulated request body of an incoming invocation request. Body *string `locationName:"body" type:"string"` // A ClientCertificate identifier to use in the test invocation. API Gateway // will use the certificate when making the HTTPS request to the defined back-end // endpoint. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // A key-value map of headers to simulate an incoming invocation request. Headers map[string]*string `locationName:"headers" type:"map"` // Specifies a test invoke method request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // The URI path, including query string, of the simulated invocation request. // Use this to specify path parameters and query string parameters. PathWithQueryString *string `locationName:"pathWithQueryString" type:"string"` // Specifies a test invoke method request's resource ID. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies a test invoke method request's API identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // A key-value map of stage variables to simulate an invocation on a deployed // Stage. StageVariables map[string]*string `locationName:"stageVariables" type:"map"` // contains filtered or unexported fields }
Make a request to simulate the execution of a Method.
func (TestInvokeMethodInput) GoString ¶
func (s TestInvokeMethodInput) GoString() string
GoString returns the string representation
func (*TestInvokeMethodInput) SetBody ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetBody(v string) *TestInvokeMethodInput
SetBody sets the Body field's value.
func (*TestInvokeMethodInput) SetClientCertificateId ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetClientCertificateId(v string) *TestInvokeMethodInput
SetClientCertificateId sets the ClientCertificateId field's value.
func (*TestInvokeMethodInput) SetHeaders ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetHeaders(v map[string]*string) *TestInvokeMethodInput
SetHeaders sets the Headers field's value.
func (*TestInvokeMethodInput) SetHttpMethod ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetHttpMethod(v string) *TestInvokeMethodInput
SetHttpMethod sets the HttpMethod field's value.
func (*TestInvokeMethodInput) SetPathWithQueryString ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetPathWithQueryString(v string) *TestInvokeMethodInput
SetPathWithQueryString sets the PathWithQueryString field's value.
func (*TestInvokeMethodInput) SetResourceId ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetResourceId(v string) *TestInvokeMethodInput
SetResourceId sets the ResourceId field's value.
func (*TestInvokeMethodInput) SetRestApiId ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetRestApiId(v string) *TestInvokeMethodInput
SetRestApiId sets the RestApiId field's value.
func (*TestInvokeMethodInput) SetStageVariables ¶ added in v1.5.0
func (s *TestInvokeMethodInput) SetStageVariables(v map[string]*string) *TestInvokeMethodInput
SetStageVariables sets the StageVariables field's value.
func (TestInvokeMethodInput) String ¶
func (s TestInvokeMethodInput) String() string
String returns the string representation
func (*TestInvokeMethodInput) Validate ¶ added in v1.1.21
func (s *TestInvokeMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TestInvokeMethodOutput ¶
type TestInvokeMethodOutput struct { // The body of the HTTP response. Body *string `locationName:"body" type:"string"` // The headers of the HTTP response. Headers map[string]*string `locationName:"headers" type:"map"` // The execution latency of the test invoke request. Latency *int64 `locationName:"latency" type:"long"` // The Amazon API Gateway execution log for the test invoke request. Log *string `locationName:"log" type:"string"` // The HTTP status code. Status *int64 `locationName:"status" type:"integer"` // contains filtered or unexported fields }
Represents the response of the test invoke request in the HTTP method.
Test API using the API Gateway console (http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-test-method.html#how-to-test-method-console)
func (TestInvokeMethodOutput) GoString ¶
func (s TestInvokeMethodOutput) GoString() string
GoString returns the string representation
func (*TestInvokeMethodOutput) SetBody ¶ added in v1.5.0
func (s *TestInvokeMethodOutput) SetBody(v string) *TestInvokeMethodOutput
SetBody sets the Body field's value.
func (*TestInvokeMethodOutput) SetHeaders ¶ added in v1.5.0
func (s *TestInvokeMethodOutput) SetHeaders(v map[string]*string) *TestInvokeMethodOutput
SetHeaders sets the Headers field's value.
func (*TestInvokeMethodOutput) SetLatency ¶ added in v1.5.0
func (s *TestInvokeMethodOutput) SetLatency(v int64) *TestInvokeMethodOutput
SetLatency sets the Latency field's value.
func (*TestInvokeMethodOutput) SetLog ¶ added in v1.5.0
func (s *TestInvokeMethodOutput) SetLog(v string) *TestInvokeMethodOutput
SetLog sets the Log field's value.
func (*TestInvokeMethodOutput) SetStatus ¶ added in v1.5.0
func (s *TestInvokeMethodOutput) SetStatus(v int64) *TestInvokeMethodOutput
SetStatus sets the Status field's value.
func (TestInvokeMethodOutput) String ¶
func (s TestInvokeMethodOutput) String() string
String returns the string representation
type ThrottleSettings ¶
type ThrottleSettings struct { // The API request burst limit, the maximum rate limit over a time ranging from // one to a few seconds, depending upon whether the underlying token bucket // is at its full capacity. BurstLimit *int64 `locationName:"burstLimit" type:"integer"` // The API request steady-state rate limit. RateLimit *float64 `locationName:"rateLimit" type:"double"` // contains filtered or unexported fields }
The API request rate limits.
func (ThrottleSettings) GoString ¶
func (s ThrottleSettings) GoString() string
GoString returns the string representation
func (*ThrottleSettings) SetBurstLimit ¶ added in v1.5.0
func (s *ThrottleSettings) SetBurstLimit(v int64) *ThrottleSettings
SetBurstLimit sets the BurstLimit field's value.
func (*ThrottleSettings) SetRateLimit ¶ added in v1.5.0
func (s *ThrottleSettings) SetRateLimit(v float64) *ThrottleSettings
SetRateLimit sets the RateLimit field's value.
func (ThrottleSettings) String ¶
func (s ThrottleSettings) String() string
String returns the string representation
type UpdateAccountInput ¶
type UpdateAccountInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // contains filtered or unexported fields }
Requests Amazon API Gateway to change information about the current Account resource.
func (UpdateAccountInput) GoString ¶
func (s UpdateAccountInput) GoString() string
GoString returns the string representation
func (*UpdateAccountInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateAccountInput) SetPatchOperations(v []*PatchOperation) *UpdateAccountInput
SetPatchOperations sets the PatchOperations field's value.
func (UpdateAccountInput) String ¶
func (s UpdateAccountInput) String() string
String returns the string representation
type UpdateApiKeyInput ¶
type UpdateApiKeyInput struct { // The identifier of the ApiKey resource to be updated. // // ApiKey is a required field ApiKey *string `location:"uri" locationName:"api_Key" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // contains filtered or unexported fields }
A request to change information about an ApiKey resource.
func (UpdateApiKeyInput) GoString ¶
func (s UpdateApiKeyInput) GoString() string
GoString returns the string representation
func (*UpdateApiKeyInput) SetApiKey ¶ added in v1.5.0
func (s *UpdateApiKeyInput) SetApiKey(v string) *UpdateApiKeyInput
SetApiKey sets the ApiKey field's value.
func (*UpdateApiKeyInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateApiKeyInput) SetPatchOperations(v []*PatchOperation) *UpdateApiKeyInput
SetPatchOperations sets the PatchOperations field's value.
func (UpdateApiKeyInput) String ¶
func (s UpdateApiKeyInput) String() string
String returns the string representation
func (*UpdateApiKeyInput) Validate ¶ added in v1.1.21
func (s *UpdateApiKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateAuthorizerInput ¶ added in v1.1.2
type UpdateAuthorizerInput struct { // The identifier of the Authorizer resource. // // AuthorizerId is a required field AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The RestApi identifier for the Authorizer resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to update an existing Authorizer resource.
func (UpdateAuthorizerInput) GoString ¶ added in v1.1.2
func (s UpdateAuthorizerInput) GoString() string
GoString returns the string representation
func (*UpdateAuthorizerInput) SetAuthorizerId ¶ added in v1.5.0
func (s *UpdateAuthorizerInput) SetAuthorizerId(v string) *UpdateAuthorizerInput
SetAuthorizerId sets the AuthorizerId field's value.
func (*UpdateAuthorizerInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateAuthorizerInput) SetPatchOperations(v []*PatchOperation) *UpdateAuthorizerInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateAuthorizerInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateAuthorizerInput) SetRestApiId(v string) *UpdateAuthorizerInput
SetRestApiId sets the RestApiId field's value.
func (UpdateAuthorizerInput) String ¶ added in v1.1.2
func (s UpdateAuthorizerInput) String() string
String returns the string representation
func (*UpdateAuthorizerInput) Validate ¶ added in v1.1.21
func (s *UpdateAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateBasePathMappingInput ¶
type UpdateBasePathMappingInput struct { // The base path of the BasePathMapping resource to change. // // BasePath is a required field BasePath *string `location:"uri" locationName:"base_path" type:"string" required:"true"` // The domain name of the BasePathMapping resource to change. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // contains filtered or unexported fields }
A request to change information about the BasePathMapping resource.
func (UpdateBasePathMappingInput) GoString ¶
func (s UpdateBasePathMappingInput) GoString() string
GoString returns the string representation
func (*UpdateBasePathMappingInput) SetBasePath ¶ added in v1.5.0
func (s *UpdateBasePathMappingInput) SetBasePath(v string) *UpdateBasePathMappingInput
SetBasePath sets the BasePath field's value.
func (*UpdateBasePathMappingInput) SetDomainName ¶ added in v1.5.0
func (s *UpdateBasePathMappingInput) SetDomainName(v string) *UpdateBasePathMappingInput
SetDomainName sets the DomainName field's value.
func (*UpdateBasePathMappingInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateBasePathMappingInput) SetPatchOperations(v []*PatchOperation) *UpdateBasePathMappingInput
SetPatchOperations sets the PatchOperations field's value.
func (UpdateBasePathMappingInput) String ¶
func (s UpdateBasePathMappingInput) String() string
String returns the string representation
func (*UpdateBasePathMappingInput) Validate ¶ added in v1.1.21
func (s *UpdateBasePathMappingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateClientCertificateInput ¶
type UpdateClientCertificateInput struct { // The identifier of the ClientCertificate resource to be updated. // // ClientCertificateId is a required field ClientCertificateId *string `location:"uri" locationName:"clientcertificate_id" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // contains filtered or unexported fields }
A request to change information about an ClientCertificate resource.
func (UpdateClientCertificateInput) GoString ¶
func (s UpdateClientCertificateInput) GoString() string
GoString returns the string representation
func (*UpdateClientCertificateInput) SetClientCertificateId ¶ added in v1.5.0
func (s *UpdateClientCertificateInput) SetClientCertificateId(v string) *UpdateClientCertificateInput
SetClientCertificateId sets the ClientCertificateId field's value.
func (*UpdateClientCertificateInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateClientCertificateInput) SetPatchOperations(v []*PatchOperation) *UpdateClientCertificateInput
SetPatchOperations sets the PatchOperations field's value.
func (UpdateClientCertificateInput) String ¶
func (s UpdateClientCertificateInput) String() string
String returns the string representation
func (*UpdateClientCertificateInput) Validate ¶ added in v1.1.21
func (s *UpdateClientCertificateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDeploymentInput ¶
type UpdateDeploymentInput struct { // The replacement identifier for the Deployment resource to change information // about. // // DeploymentId is a required field DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The replacement identifier of the RestApi resource for the Deployment resource // to change information about. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to change information about a Deployment resource.
func (UpdateDeploymentInput) GoString ¶
func (s UpdateDeploymentInput) GoString() string
GoString returns the string representation
func (*UpdateDeploymentInput) SetDeploymentId ¶ added in v1.5.0
func (s *UpdateDeploymentInput) SetDeploymentId(v string) *UpdateDeploymentInput
SetDeploymentId sets the DeploymentId field's value.
func (*UpdateDeploymentInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateDeploymentInput) SetPatchOperations(v []*PatchOperation) *UpdateDeploymentInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateDeploymentInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateDeploymentInput) SetRestApiId(v string) *UpdateDeploymentInput
SetRestApiId sets the RestApiId field's value.
func (UpdateDeploymentInput) String ¶
func (s UpdateDeploymentInput) String() string
String returns the string representation
func (*UpdateDeploymentInput) Validate ¶ added in v1.1.21
func (s *UpdateDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDocumentationPartInput ¶ added in v1.5.13
type UpdateDocumentationPartInput struct { // [Required] The identifier of the to-be-updated documentation part. // // DocumentationPartId is a required field DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The identifier of an API of the to-be-updated documentation part. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Updates an existing documentation part of a given API.
func (UpdateDocumentationPartInput) GoString ¶ added in v1.5.13
func (s UpdateDocumentationPartInput) GoString() string
GoString returns the string representation
func (*UpdateDocumentationPartInput) SetDocumentationPartId ¶ added in v1.5.13
func (s *UpdateDocumentationPartInput) SetDocumentationPartId(v string) *UpdateDocumentationPartInput
SetDocumentationPartId sets the DocumentationPartId field's value.
func (*UpdateDocumentationPartInput) SetPatchOperations ¶ added in v1.5.13
func (s *UpdateDocumentationPartInput) SetPatchOperations(v []*PatchOperation) *UpdateDocumentationPartInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateDocumentationPartInput) SetRestApiId ¶ added in v1.5.13
func (s *UpdateDocumentationPartInput) SetRestApiId(v string) *UpdateDocumentationPartInput
SetRestApiId sets the RestApiId field's value.
func (UpdateDocumentationPartInput) String ¶ added in v1.5.13
func (s UpdateDocumentationPartInput) String() string
String returns the string representation
func (*UpdateDocumentationPartInput) Validate ¶ added in v1.5.13
func (s *UpdateDocumentationPartInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDocumentationVersionInput ¶ added in v1.5.13
type UpdateDocumentationVersionInput struct { // [Required] The version identifier of the to-be-updated documentation version. // // DocumentationVersion is a required field DocumentationVersion *string `location:"uri" locationName:"doc_version" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The identifier of an API of the to-be-updated documentation version. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Updates an existing documentation version of an API.
func (UpdateDocumentationVersionInput) GoString ¶ added in v1.5.13
func (s UpdateDocumentationVersionInput) GoString() string
GoString returns the string representation
func (*UpdateDocumentationVersionInput) SetDocumentationVersion ¶ added in v1.5.13
func (s *UpdateDocumentationVersionInput) SetDocumentationVersion(v string) *UpdateDocumentationVersionInput
SetDocumentationVersion sets the DocumentationVersion field's value.
func (*UpdateDocumentationVersionInput) SetPatchOperations ¶ added in v1.5.13
func (s *UpdateDocumentationVersionInput) SetPatchOperations(v []*PatchOperation) *UpdateDocumentationVersionInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateDocumentationVersionInput) SetRestApiId ¶ added in v1.5.13
func (s *UpdateDocumentationVersionInput) SetRestApiId(v string) *UpdateDocumentationVersionInput
SetRestApiId sets the RestApiId field's value.
func (UpdateDocumentationVersionInput) String ¶ added in v1.5.13
func (s UpdateDocumentationVersionInput) String() string
String returns the string representation
func (*UpdateDocumentationVersionInput) Validate ¶ added in v1.5.13
func (s *UpdateDocumentationVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDomainNameInput ¶
type UpdateDomainNameInput struct { // The name of the DomainName resource to be changed. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // contains filtered or unexported fields }
A request to change information about the DomainName resource.
func (UpdateDomainNameInput) GoString ¶
func (s UpdateDomainNameInput) GoString() string
GoString returns the string representation
func (*UpdateDomainNameInput) SetDomainName ¶ added in v1.5.0
func (s *UpdateDomainNameInput) SetDomainName(v string) *UpdateDomainNameInput
SetDomainName sets the DomainName field's value.
func (*UpdateDomainNameInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateDomainNameInput) SetPatchOperations(v []*PatchOperation) *UpdateDomainNameInput
SetPatchOperations sets the PatchOperations field's value.
func (UpdateDomainNameInput) String ¶
func (s UpdateDomainNameInput) String() string
String returns the string representation
func (*UpdateDomainNameInput) Validate ¶ added in v1.1.21
func (s *UpdateDomainNameInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateIntegrationInput ¶
type UpdateIntegrationInput struct { // Represents an update integration request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // Represents an update integration request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Represents an update integration request's API identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Represents an update integration request.
func (UpdateIntegrationInput) GoString ¶
func (s UpdateIntegrationInput) GoString() string
GoString returns the string representation
func (*UpdateIntegrationInput) SetHttpMethod ¶ added in v1.5.0
func (s *UpdateIntegrationInput) SetHttpMethod(v string) *UpdateIntegrationInput
SetHttpMethod sets the HttpMethod field's value.
func (*UpdateIntegrationInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateIntegrationInput) SetPatchOperations(v []*PatchOperation) *UpdateIntegrationInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateIntegrationInput) SetResourceId ¶ added in v1.5.0
func (s *UpdateIntegrationInput) SetResourceId(v string) *UpdateIntegrationInput
SetResourceId sets the ResourceId field's value.
func (*UpdateIntegrationInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateIntegrationInput) SetRestApiId(v string) *UpdateIntegrationInput
SetRestApiId sets the RestApiId field's value.
func (UpdateIntegrationInput) String ¶
func (s UpdateIntegrationInput) String() string
String returns the string representation
func (*UpdateIntegrationInput) Validate ¶ added in v1.1.21
func (s *UpdateIntegrationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateIntegrationResponseInput ¶
type UpdateIntegrationResponseInput struct { // Specifies an update integration response request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // Specifies an update integration response request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // Specifies an update integration response request's API identifier. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies an update integration response request's status code. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
Represents an update integration response request.
func (UpdateIntegrationResponseInput) GoString ¶
func (s UpdateIntegrationResponseInput) GoString() string
GoString returns the string representation
func (*UpdateIntegrationResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *UpdateIntegrationResponseInput) SetHttpMethod(v string) *UpdateIntegrationResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*UpdateIntegrationResponseInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateIntegrationResponseInput) SetPatchOperations(v []*PatchOperation) *UpdateIntegrationResponseInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateIntegrationResponseInput) SetResourceId ¶ added in v1.5.0
func (s *UpdateIntegrationResponseInput) SetResourceId(v string) *UpdateIntegrationResponseInput
SetResourceId sets the ResourceId field's value.
func (*UpdateIntegrationResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateIntegrationResponseInput) SetRestApiId(v string) *UpdateIntegrationResponseInput
SetRestApiId sets the RestApiId field's value.
func (*UpdateIntegrationResponseInput) SetStatusCode ¶ added in v1.5.0
func (s *UpdateIntegrationResponseInput) SetStatusCode(v string) *UpdateIntegrationResponseInput
SetStatusCode sets the StatusCode field's value.
func (UpdateIntegrationResponseInput) String ¶
func (s UpdateIntegrationResponseInput) String() string
String returns the string representation
func (*UpdateIntegrationResponseInput) Validate ¶ added in v1.1.21
func (s *UpdateIntegrationResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateMethodInput ¶
type UpdateMethodInput struct { // The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The Resource identifier for the Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the Method resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to update an existing Method resource.
func (UpdateMethodInput) GoString ¶
func (s UpdateMethodInput) GoString() string
GoString returns the string representation
func (*UpdateMethodInput) SetHttpMethod ¶ added in v1.5.0
func (s *UpdateMethodInput) SetHttpMethod(v string) *UpdateMethodInput
SetHttpMethod sets the HttpMethod field's value.
func (*UpdateMethodInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateMethodInput) SetPatchOperations(v []*PatchOperation) *UpdateMethodInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateMethodInput) SetResourceId ¶ added in v1.5.0
func (s *UpdateMethodInput) SetResourceId(v string) *UpdateMethodInput
SetResourceId sets the ResourceId field's value.
func (*UpdateMethodInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateMethodInput) SetRestApiId(v string) *UpdateMethodInput
SetRestApiId sets the RestApiId field's value.
func (UpdateMethodInput) String ¶
func (s UpdateMethodInput) String() string
String returns the string representation
func (*UpdateMethodInput) Validate ¶ added in v1.1.21
func (s *UpdateMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateMethodResponseInput ¶
type UpdateMethodResponseInput struct { // The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The Resource identifier for the MethodResponse resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the MethodResponse resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The status code for the MethodResponse resource. // // StatusCode is a required field StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` // contains filtered or unexported fields }
A request to update an existing MethodResponse resource.
func (UpdateMethodResponseInput) GoString ¶
func (s UpdateMethodResponseInput) GoString() string
GoString returns the string representation
func (*UpdateMethodResponseInput) SetHttpMethod ¶ added in v1.5.0
func (s *UpdateMethodResponseInput) SetHttpMethod(v string) *UpdateMethodResponseInput
SetHttpMethod sets the HttpMethod field's value.
func (*UpdateMethodResponseInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateMethodResponseInput) SetPatchOperations(v []*PatchOperation) *UpdateMethodResponseInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateMethodResponseInput) SetResourceId ¶ added in v1.5.0
func (s *UpdateMethodResponseInput) SetResourceId(v string) *UpdateMethodResponseInput
SetResourceId sets the ResourceId field's value.
func (*UpdateMethodResponseInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateMethodResponseInput) SetRestApiId(v string) *UpdateMethodResponseInput
SetRestApiId sets the RestApiId field's value.
func (*UpdateMethodResponseInput) SetStatusCode ¶ added in v1.5.0
func (s *UpdateMethodResponseInput) SetStatusCode(v string) *UpdateMethodResponseInput
SetStatusCode sets the StatusCode field's value.
func (UpdateMethodResponseInput) String ¶
func (s UpdateMethodResponseInput) String() string
String returns the string representation
func (*UpdateMethodResponseInput) Validate ¶ added in v1.1.21
func (s *UpdateMethodResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateModelInput ¶
type UpdateModelInput struct { // The name of the model to update. // // ModelName is a required field ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The RestApi identifier under which the model exists. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to update an existing model in an existing RestApi resource.
func (UpdateModelInput) GoString ¶
func (s UpdateModelInput) GoString() string
GoString returns the string representation
func (*UpdateModelInput) SetModelName ¶ added in v1.5.0
func (s *UpdateModelInput) SetModelName(v string) *UpdateModelInput
SetModelName sets the ModelName field's value.
func (*UpdateModelInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateModelInput) SetPatchOperations(v []*PatchOperation) *UpdateModelInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateModelInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateModelInput) SetRestApiId(v string) *UpdateModelInput
SetRestApiId sets the RestApiId field's value.
func (UpdateModelInput) String ¶
func (s UpdateModelInput) String() string
String returns the string representation
func (*UpdateModelInput) Validate ¶ added in v1.1.21
func (s *UpdateModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateResourceInput ¶
type UpdateResourceInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The identifier of the Resource resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // The RestApi identifier for the Resource resource. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to change information about a Resource resource.
func (UpdateResourceInput) GoString ¶
func (s UpdateResourceInput) GoString() string
GoString returns the string representation
func (*UpdateResourceInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateResourceInput) SetPatchOperations(v []*PatchOperation) *UpdateResourceInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateResourceInput) SetResourceId ¶ added in v1.5.0
func (s *UpdateResourceInput) SetResourceId(v string) *UpdateResourceInput
SetResourceId sets the ResourceId field's value.
func (*UpdateResourceInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateResourceInput) SetRestApiId(v string) *UpdateResourceInput
SetRestApiId sets the RestApiId field's value.
func (UpdateResourceInput) String ¶
func (s UpdateResourceInput) String() string
String returns the string representation
func (*UpdateResourceInput) Validate ¶ added in v1.1.21
func (s *UpdateResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateRestApiInput ¶
type UpdateRestApiInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The ID of the RestApi you want to update. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to update an existing RestApi resource in your collection.
func (UpdateRestApiInput) GoString ¶
func (s UpdateRestApiInput) GoString() string
GoString returns the string representation
func (*UpdateRestApiInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateRestApiInput) SetPatchOperations(v []*PatchOperation) *UpdateRestApiInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateRestApiInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateRestApiInput) SetRestApiId(v string) *UpdateRestApiInput
SetRestApiId sets the RestApiId field's value.
func (UpdateRestApiInput) String ¶
func (s UpdateRestApiInput) String() string
String returns the string representation
func (*UpdateRestApiInput) Validate ¶ added in v1.1.21
func (s *UpdateRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateStageInput ¶
type UpdateStageInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The identifier of the RestApi resource for the Stage resource to change information // about. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the Stage resource to change information about. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Requests Amazon API Gateway to change information about a Stage resource.
func (UpdateStageInput) GoString ¶
func (s UpdateStageInput) GoString() string
GoString returns the string representation
func (*UpdateStageInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateStageInput) SetPatchOperations(v []*PatchOperation) *UpdateStageInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateStageInput) SetRestApiId ¶ added in v1.5.0
func (s *UpdateStageInput) SetRestApiId(v string) *UpdateStageInput
SetRestApiId sets the RestApiId field's value.
func (*UpdateStageInput) SetStageName ¶ added in v1.5.0
func (s *UpdateStageInput) SetStageName(v string) *UpdateStageInput
SetStageName sets the StageName field's value.
func (UpdateStageInput) String ¶
func (s UpdateStageInput) String() string
String returns the string representation
func (*UpdateStageInput) Validate ¶ added in v1.1.21
func (s *UpdateStageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUsageInput ¶ added in v1.4.2
type UpdateUsageInput struct { // The identifier of the API key associated with the usage plan in which a temporary // extension is granted to the remaining quota. // // KeyId is a required field KeyId *string `location:"uri" locationName:"keyId" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The Id of the usage plan associated with the usage data. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The PATCH request to grant a temporary extension to the 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) SetKeyId ¶ added in v1.5.0
func (s *UpdateUsageInput) SetKeyId(v string) *UpdateUsageInput
SetKeyId sets the KeyId field's value.
func (*UpdateUsageInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateUsageInput) SetPatchOperations(v []*PatchOperation) *UpdateUsageInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateUsageInput) SetUsagePlanId ¶ added in v1.5.0
func (s *UpdateUsageInput) SetUsagePlanId(v string) *UpdateUsageInput
SetUsagePlanId sets the UsagePlanId field's value.
func (UpdateUsageInput) String ¶ added in v1.4.2
func (s UpdateUsageInput) String() string
String returns the string representation
func (*UpdateUsageInput) Validate ¶ added in v1.4.2
func (s *UpdateUsageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUsagePlanInput ¶ added in v1.4.2
type UpdateUsagePlanInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []*PatchOperation `locationName:"patchOperations" type:"list"` // The Id of the to-be-updated usage plan. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The PATCH request to update a usage plan of a given plan Id.
func (UpdateUsagePlanInput) GoString ¶ added in v1.4.2
func (s UpdateUsagePlanInput) GoString() string
GoString returns the string representation
func (*UpdateUsagePlanInput) SetPatchOperations ¶ added in v1.5.0
func (s *UpdateUsagePlanInput) SetPatchOperations(v []*PatchOperation) *UpdateUsagePlanInput
SetPatchOperations sets the PatchOperations field's value.
func (*UpdateUsagePlanInput) SetUsagePlanId ¶ added in v1.5.0
func (s *UpdateUsagePlanInput) SetUsagePlanId(v string) *UpdateUsagePlanInput
SetUsagePlanId sets the UsagePlanId field's value.
func (UpdateUsagePlanInput) String ¶ added in v1.4.2
func (s UpdateUsagePlanInput) String() string
String returns the string representation
func (*UpdateUsagePlanInput) Validate ¶ added in v1.4.2
func (s *UpdateUsagePlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Usage ¶ added in v1.4.2
type Usage struct { // The ending date of the usage data. EndDate *string `locationName:"endDate" type:"string"` // The usage data, as daily logs of used and remaining quotas, over the specified // time interval indexed over the API keys in a usage plan. For example, {..., // "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} // stands for an API key value and the daily log entry is of the format [used // quota, remaining quota]. Items map[string][][]*int64 `locationName:"values" type:"map"` Position *string `locationName:"position" type:"string"` // The starting date of the usage data. StartDate *string `locationName:"startDate" type:"string"` // The plan Id associated with this usage data. UsagePlanId *string `locationName:"usagePlanId" type:"string"` // contains filtered or unexported fields }
Represents the usage data of a usage plan.
Create and Use Usage Plans (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html), Manage Usage in a Usage Plan (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-usage-plans-with-console.html#api-gateway-usage-plan-manage-usage)
func (*Usage) SetEndDate ¶ added in v1.5.0
SetEndDate sets the EndDate field's value.
func (*Usage) SetPosition ¶ added in v1.5.0
SetPosition sets the Position field's value.
func (*Usage) SetStartDate ¶ added in v1.5.0
SetStartDate sets the StartDate field's value.
func (*Usage) SetUsagePlanId ¶ added in v1.5.0
SetUsagePlanId sets the UsagePlanId field's value.
type UsagePlan ¶ added in v1.4.2
type UsagePlan struct { // The associated API stages of a usage plan. ApiStages []*ApiStage `locationName:"apiStages" type:"list"` // The description of a usage plan. Description *string `locationName:"description" type:"string"` // The identifier of a UsagePlan resource. Id *string `locationName:"id" type:"string"` // The name of a usage plan. Name *string `locationName:"name" type:"string"` // The AWS Markeplace product identifier to associate with the usage plan as // a SaaS product on AWS Marketplace. ProductCode *string `locationName:"productCode" type:"string"` // The maximum number of permitted requests per a given unit time interval. Quota *QuotaSettings `locationName:"quota" type:"structure"` // The request throttle limits of a usage plan. Throttle *ThrottleSettings `locationName:"throttle" type:"structure"` // contains filtered or unexported fields }
Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.
In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.
Create and Use Usage Plans (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (*UsagePlan) SetApiStages ¶ added in v1.5.0
SetApiStages sets the ApiStages field's value.
func (*UsagePlan) SetDescription ¶ added in v1.5.0
SetDescription sets the Description field's value.
func (*UsagePlan) SetProductCode ¶ added in v1.5.13
SetProductCode sets the ProductCode field's value.
func (*UsagePlan) SetQuota ¶ added in v1.5.0
func (s *UsagePlan) SetQuota(v *QuotaSettings) *UsagePlan
SetQuota sets the Quota field's value.
func (*UsagePlan) SetThrottle ¶ added in v1.5.0
func (s *UsagePlan) SetThrottle(v *ThrottleSettings) *UsagePlan
SetThrottle sets the Throttle field's value.
type UsagePlanKey ¶ added in v1.4.2
type UsagePlanKey struct { // The Id of a usage plan key. Id *string `locationName:"id" type:"string"` // The name of a usage plan key. Name *string `locationName:"name" type:"string"` // The type of a usage plan key. Currently, the valid key type is API_KEY. Type *string `locationName:"type" type:"string"` // The value of a usage plan key. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
Represents a usage plan key to identify a plan customer.
To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.
" Create and Use Usage Plans (http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (UsagePlanKey) GoString ¶ added in v1.4.2
func (s UsagePlanKey) GoString() string
GoString returns the string representation
func (*UsagePlanKey) SetId ¶ added in v1.5.0
func (s *UsagePlanKey) SetId(v string) *UsagePlanKey
SetId sets the Id field's value.
func (*UsagePlanKey) SetName ¶ added in v1.5.0
func (s *UsagePlanKey) SetName(v string) *UsagePlanKey
SetName sets the Name field's value.
func (*UsagePlanKey) SetType ¶ added in v1.5.0
func (s *UsagePlanKey) SetType(v string) *UsagePlanKey
SetType sets the Type field's value.
func (*UsagePlanKey) SetValue ¶ added in v1.5.0
func (s *UsagePlanKey) SetValue(v string) *UsagePlanKey
SetValue sets the Value field's value.
func (UsagePlanKey) String ¶ added in v1.4.2
func (s UsagePlanKey) String() string
String returns the string representation
Directories ¶
Path | Synopsis |
---|---|
Package apigatewayiface provides an interface to enable mocking the Amazon API Gateway service client for testing your code.
|
Package apigatewayiface provides an interface to enable mocking the Amazon API Gateway service client for testing your code. |