Documentation ¶
Overview ¶
Package apigateway provides the client and types for making API requests to Amazon API Gateway.
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
See apigateway package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/apigateway/
Using the Client ¶
To use Amazon API Gateway with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon API Gateway client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/apigateway/#New
Index ¶
- Constants
- type AccessLogSettings
- type ApiKey
- type ApiKeySourceType
- type ApiKeysFormat
- type ApiStage
- type Authorizer
- type AuthorizerType
- type BasePathMapping
- type CacheClusterSize
- type CacheClusterStatus
- type CanarySettings
- type Certificate
- type Client
- func (c *Client) CreateApiKeyRequest(input *CreateApiKeyInput) CreateApiKeyRequest
- func (c *Client) CreateAuthorizerRequest(input *CreateAuthorizerInput) CreateAuthorizerRequest
- func (c *Client) CreateBasePathMappingRequest(input *CreateBasePathMappingInput) CreateBasePathMappingRequest
- func (c *Client) CreateDeploymentRequest(input *CreateDeploymentInput) CreateDeploymentRequest
- func (c *Client) CreateDocumentationPartRequest(input *CreateDocumentationPartInput) CreateDocumentationPartRequest
- func (c *Client) CreateDocumentationVersionRequest(input *CreateDocumentationVersionInput) CreateDocumentationVersionRequest
- func (c *Client) CreateDomainNameRequest(input *CreateDomainNameInput) CreateDomainNameRequest
- func (c *Client) CreateModelRequest(input *CreateModelInput) CreateModelRequest
- func (c *Client) CreateRequestValidatorRequest(input *CreateRequestValidatorInput) CreateRequestValidatorRequest
- func (c *Client) CreateResourceRequest(input *CreateResourceInput) CreateResourceRequest
- func (c *Client) CreateRestApiRequest(input *CreateRestApiInput) CreateRestApiRequest
- func (c *Client) CreateStageRequest(input *CreateStageInput) CreateStageRequest
- func (c *Client) CreateUsagePlanKeyRequest(input *CreateUsagePlanKeyInput) CreateUsagePlanKeyRequest
- func (c *Client) CreateUsagePlanRequest(input *CreateUsagePlanInput) CreateUsagePlanRequest
- func (c *Client) CreateVpcLinkRequest(input *CreateVpcLinkInput) CreateVpcLinkRequest
- func (c *Client) DeleteApiKeyRequest(input *DeleteApiKeyInput) DeleteApiKeyRequest
- func (c *Client) DeleteAuthorizerRequest(input *DeleteAuthorizerInput) DeleteAuthorizerRequest
- func (c *Client) DeleteBasePathMappingRequest(input *DeleteBasePathMappingInput) DeleteBasePathMappingRequest
- func (c *Client) DeleteClientCertificateRequest(input *DeleteClientCertificateInput) DeleteClientCertificateRequest
- func (c *Client) DeleteDeploymentRequest(input *DeleteDeploymentInput) DeleteDeploymentRequest
- func (c *Client) DeleteDocumentationPartRequest(input *DeleteDocumentationPartInput) DeleteDocumentationPartRequest
- func (c *Client) DeleteDocumentationVersionRequest(input *DeleteDocumentationVersionInput) DeleteDocumentationVersionRequest
- func (c *Client) DeleteDomainNameRequest(input *DeleteDomainNameInput) DeleteDomainNameRequest
- func (c *Client) DeleteGatewayResponseRequest(input *DeleteGatewayResponseInput) DeleteGatewayResponseRequest
- func (c *Client) DeleteIntegrationRequest(input *DeleteIntegrationInput) DeleteIntegrationRequest
- func (c *Client) DeleteIntegrationResponseRequest(input *DeleteIntegrationResponseInput) DeleteIntegrationResponseRequest
- func (c *Client) DeleteMethodRequest(input *DeleteMethodInput) DeleteMethodRequest
- func (c *Client) DeleteMethodResponseRequest(input *DeleteMethodResponseInput) DeleteMethodResponseRequest
- func (c *Client) DeleteModelRequest(input *DeleteModelInput) DeleteModelRequest
- func (c *Client) DeleteRequestValidatorRequest(input *DeleteRequestValidatorInput) DeleteRequestValidatorRequest
- func (c *Client) DeleteResourceRequest(input *DeleteResourceInput) DeleteResourceRequest
- func (c *Client) DeleteRestApiRequest(input *DeleteRestApiInput) DeleteRestApiRequest
- func (c *Client) DeleteStageRequest(input *DeleteStageInput) DeleteStageRequest
- func (c *Client) DeleteUsagePlanKeyRequest(input *DeleteUsagePlanKeyInput) DeleteUsagePlanKeyRequest
- func (c *Client) DeleteUsagePlanRequest(input *DeleteUsagePlanInput) DeleteUsagePlanRequest
- func (c *Client) DeleteVpcLinkRequest(input *DeleteVpcLinkInput) DeleteVpcLinkRequest
- func (c *Client) FlushStageAuthorizersCacheRequest(input *FlushStageAuthorizersCacheInput) FlushStageAuthorizersCacheRequest
- func (c *Client) FlushStageCacheRequest(input *FlushStageCacheInput) FlushStageCacheRequest
- func (c *Client) GenerateClientCertificateRequest(input *GenerateClientCertificateInput) GenerateClientCertificateRequest
- func (c *Client) GetAccountRequest(input *GetAccountInput) GetAccountRequest
- func (c *Client) GetApiKeyRequest(input *GetApiKeyInput) GetApiKeyRequest
- func (c *Client) GetApiKeysRequest(input *GetApiKeysInput) GetApiKeysRequest
- func (c *Client) GetAuthorizerRequest(input *GetAuthorizerInput) GetAuthorizerRequest
- func (c *Client) GetAuthorizersRequest(input *GetAuthorizersInput) GetAuthorizersRequest
- func (c *Client) GetBasePathMappingRequest(input *GetBasePathMappingInput) GetBasePathMappingRequest
- func (c *Client) GetBasePathMappingsRequest(input *GetBasePathMappingsInput) GetBasePathMappingsRequest
- func (c *Client) GetClientCertificateRequest(input *GetClientCertificateInput) GetClientCertificateRequest
- func (c *Client) GetClientCertificatesRequest(input *GetClientCertificatesInput) GetClientCertificatesRequest
- func (c *Client) GetDeploymentRequest(input *GetDeploymentInput) GetDeploymentRequest
- func (c *Client) GetDeploymentsRequest(input *GetDeploymentsInput) GetDeploymentsRequest
- func (c *Client) GetDocumentationPartRequest(input *GetDocumentationPartInput) GetDocumentationPartRequest
- func (c *Client) GetDocumentationPartsRequest(input *GetDocumentationPartsInput) GetDocumentationPartsRequest
- func (c *Client) GetDocumentationVersionRequest(input *GetDocumentationVersionInput) GetDocumentationVersionRequest
- func (c *Client) GetDocumentationVersionsRequest(input *GetDocumentationVersionsInput) GetDocumentationVersionsRequest
- func (c *Client) GetDomainNameRequest(input *GetDomainNameInput) GetDomainNameRequest
- func (c *Client) GetDomainNamesRequest(input *GetDomainNamesInput) GetDomainNamesRequest
- func (c *Client) GetExportRequest(input *GetExportInput) GetExportRequest
- func (c *Client) GetGatewayResponseRequest(input *GetGatewayResponseInput) GetGatewayResponseRequest
- func (c *Client) GetGatewayResponsesRequest(input *GetGatewayResponsesInput) GetGatewayResponsesRequest
- func (c *Client) GetIntegrationRequest(input *GetIntegrationInput) GetIntegrationRequest
- func (c *Client) GetIntegrationResponseRequest(input *GetIntegrationResponseInput) GetIntegrationResponseRequest
- func (c *Client) GetMethodRequest(input *GetMethodInput) GetMethodRequest
- func (c *Client) GetMethodResponseRequest(input *GetMethodResponseInput) GetMethodResponseRequest
- func (c *Client) GetModelRequest(input *GetModelInput) GetModelRequest
- func (c *Client) GetModelTemplateRequest(input *GetModelTemplateInput) GetModelTemplateRequest
- func (c *Client) GetModelsRequest(input *GetModelsInput) GetModelsRequest
- func (c *Client) GetRequestValidatorRequest(input *GetRequestValidatorInput) GetRequestValidatorRequest
- func (c *Client) GetRequestValidatorsRequest(input *GetRequestValidatorsInput) GetRequestValidatorsRequest
- func (c *Client) GetResourceRequest(input *GetResourceInput) GetResourceRequest
- func (c *Client) GetResourcesRequest(input *GetResourcesInput) GetResourcesRequest
- func (c *Client) GetRestApiRequest(input *GetRestApiInput) GetRestApiRequest
- func (c *Client) GetRestApisRequest(input *GetRestApisInput) GetRestApisRequest
- func (c *Client) GetSdkRequest(input *GetSdkInput) GetSdkRequest
- func (c *Client) GetSdkTypeRequest(input *GetSdkTypeInput) GetSdkTypeRequest
- func (c *Client) GetSdkTypesRequest(input *GetSdkTypesInput) GetSdkTypesRequest
- func (c *Client) GetStageRequest(input *GetStageInput) GetStageRequest
- func (c *Client) GetStagesRequest(input *GetStagesInput) GetStagesRequest
- func (c *Client) GetTagsRequest(input *GetTagsInput) GetTagsRequest
- func (c *Client) GetUsagePlanKeyRequest(input *GetUsagePlanKeyInput) GetUsagePlanKeyRequest
- func (c *Client) GetUsagePlanKeysRequest(input *GetUsagePlanKeysInput) GetUsagePlanKeysRequest
- func (c *Client) GetUsagePlanRequest(input *GetUsagePlanInput) GetUsagePlanRequest
- func (c *Client) GetUsagePlansRequest(input *GetUsagePlansInput) GetUsagePlansRequest
- func (c *Client) GetUsageRequest(input *GetUsageInput) GetUsageRequest
- func (c *Client) GetVpcLinkRequest(input *GetVpcLinkInput) GetVpcLinkRequest
- func (c *Client) GetVpcLinksRequest(input *GetVpcLinksInput) GetVpcLinksRequest
- func (c *Client) ImportApiKeysRequest(input *ImportApiKeysInput) ImportApiKeysRequest
- func (c *Client) ImportDocumentationPartsRequest(input *ImportDocumentationPartsInput) ImportDocumentationPartsRequest
- func (c *Client) ImportRestApiRequest(input *ImportRestApiInput) ImportRestApiRequest
- func (c *Client) PutGatewayResponseRequest(input *PutGatewayResponseInput) PutGatewayResponseRequest
- func (c *Client) PutIntegrationRequest(input *PutIntegrationInput) PutIntegrationRequest
- func (c *Client) PutIntegrationResponseRequest(input *PutIntegrationResponseInput) PutIntegrationResponseRequest
- func (c *Client) PutMethodRequest(input *PutMethodInput) PutMethodRequest
- func (c *Client) PutMethodResponseRequest(input *PutMethodResponseInput) PutMethodResponseRequest
- func (c *Client) PutRestApiRequest(input *PutRestApiInput) PutRestApiRequest
- func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
- func (c *Client) TestInvokeAuthorizerRequest(input *TestInvokeAuthorizerInput) TestInvokeAuthorizerRequest
- func (c *Client) TestInvokeMethodRequest(input *TestInvokeMethodInput) TestInvokeMethodRequest
- func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
- func (c *Client) UpdateAccountRequest(input *UpdateAccountInput) UpdateAccountRequest
- func (c *Client) UpdateApiKeyRequest(input *UpdateApiKeyInput) UpdateApiKeyRequest
- func (c *Client) UpdateAuthorizerRequest(input *UpdateAuthorizerInput) UpdateAuthorizerRequest
- func (c *Client) UpdateBasePathMappingRequest(input *UpdateBasePathMappingInput) UpdateBasePathMappingRequest
- func (c *Client) UpdateClientCertificateRequest(input *UpdateClientCertificateInput) UpdateClientCertificateRequest
- func (c *Client) UpdateDeploymentRequest(input *UpdateDeploymentInput) UpdateDeploymentRequest
- func (c *Client) UpdateDocumentationPartRequest(input *UpdateDocumentationPartInput) UpdateDocumentationPartRequest
- func (c *Client) UpdateDocumentationVersionRequest(input *UpdateDocumentationVersionInput) UpdateDocumentationVersionRequest
- func (c *Client) UpdateDomainNameRequest(input *UpdateDomainNameInput) UpdateDomainNameRequest
- func (c *Client) UpdateGatewayResponseRequest(input *UpdateGatewayResponseInput) UpdateGatewayResponseRequest
- func (c *Client) UpdateIntegrationRequest(input *UpdateIntegrationInput) UpdateIntegrationRequest
- func (c *Client) UpdateIntegrationResponseRequest(input *UpdateIntegrationResponseInput) UpdateIntegrationResponseRequest
- func (c *Client) UpdateMethodRequest(input *UpdateMethodInput) UpdateMethodRequest
- func (c *Client) UpdateMethodResponseRequest(input *UpdateMethodResponseInput) UpdateMethodResponseRequest
- func (c *Client) UpdateModelRequest(input *UpdateModelInput) UpdateModelRequest
- func (c *Client) UpdateRequestValidatorRequest(input *UpdateRequestValidatorInput) UpdateRequestValidatorRequest
- func (c *Client) UpdateResourceRequest(input *UpdateResourceInput) UpdateResourceRequest
- func (c *Client) UpdateRestApiRequest(input *UpdateRestApiInput) UpdateRestApiRequest
- func (c *Client) UpdateStageRequest(input *UpdateStageInput) UpdateStageRequest
- func (c *Client) UpdateUsagePlanRequest(input *UpdateUsagePlanInput) UpdateUsagePlanRequest
- func (c *Client) UpdateUsageRequest(input *UpdateUsageInput) UpdateUsageRequest
- func (c *Client) UpdateVpcLinkRequest(input *UpdateVpcLinkInput) UpdateVpcLinkRequest
- type ConnectionType
- type ContentHandlingStrategy
- type CreateApiKeyInput
- type CreateApiKeyOutput
- type CreateApiKeyRequest
- type CreateApiKeyResponse
- type CreateAuthorizerInput
- type CreateAuthorizerOutput
- type CreateAuthorizerRequest
- type CreateAuthorizerResponse
- type CreateBasePathMappingInput
- type CreateBasePathMappingOutput
- type CreateBasePathMappingRequest
- type CreateBasePathMappingResponse
- type CreateDeploymentInput
- type CreateDeploymentOutput
- type CreateDeploymentRequest
- type CreateDeploymentResponse
- type CreateDocumentationPartInput
- type CreateDocumentationPartOutput
- type CreateDocumentationPartRequest
- type CreateDocumentationPartResponse
- type CreateDocumentationVersionInput
- type CreateDocumentationVersionOutput
- type CreateDocumentationVersionRequest
- type CreateDocumentationVersionResponse
- type CreateDomainNameInput
- type CreateDomainNameOutput
- type CreateDomainNameRequest
- type CreateDomainNameResponse
- type CreateModelInput
- type CreateModelOutput
- type CreateModelRequest
- type CreateModelResponse
- type CreateRequestValidatorInput
- type CreateRequestValidatorOutput
- type CreateRequestValidatorRequest
- type CreateRequestValidatorResponse
- type CreateResourceInput
- type CreateResourceOutput
- type CreateResourceRequest
- type CreateResourceResponse
- type CreateRestApiInput
- type CreateRestApiOutput
- type CreateRestApiRequest
- type CreateRestApiResponse
- type CreateStageInput
- type CreateStageOutput
- type CreateStageRequest
- type CreateStageResponse
- type CreateUsagePlanInput
- type CreateUsagePlanKeyInput
- type CreateUsagePlanKeyOutput
- type CreateUsagePlanKeyRequest
- type CreateUsagePlanKeyResponse
- type CreateUsagePlanOutput
- type CreateUsagePlanRequest
- type CreateUsagePlanResponse
- type CreateVpcLinkInput
- type CreateVpcLinkOutput
- type CreateVpcLinkRequest
- type CreateVpcLinkResponse
- type DeleteApiKeyInput
- type DeleteApiKeyOutput
- type DeleteApiKeyRequest
- type DeleteApiKeyResponse
- type DeleteAuthorizerInput
- type DeleteAuthorizerOutput
- type DeleteAuthorizerRequest
- type DeleteAuthorizerResponse
- type DeleteBasePathMappingInput
- type DeleteBasePathMappingOutput
- type DeleteBasePathMappingRequest
- type DeleteBasePathMappingResponse
- type DeleteClientCertificateInput
- type DeleteClientCertificateOutput
- type DeleteClientCertificateRequest
- type DeleteClientCertificateResponse
- type DeleteDeploymentInput
- type DeleteDeploymentOutput
- type DeleteDeploymentRequest
- type DeleteDeploymentResponse
- type DeleteDocumentationPartInput
- type DeleteDocumentationPartOutput
- type DeleteDocumentationPartRequest
- type DeleteDocumentationPartResponse
- type DeleteDocumentationVersionInput
- type DeleteDocumentationVersionOutput
- type DeleteDocumentationVersionRequest
- type DeleteDocumentationVersionResponse
- type DeleteDomainNameInput
- type DeleteDomainNameOutput
- type DeleteDomainNameRequest
- type DeleteDomainNameResponse
- type DeleteGatewayResponseInput
- type DeleteGatewayResponseOutput
- type DeleteGatewayResponseRequest
- type DeleteGatewayResponseResponse
- type DeleteIntegrationInput
- type DeleteIntegrationOutput
- type DeleteIntegrationRequest
- type DeleteIntegrationResponse
- type DeleteIntegrationResponseInput
- type DeleteIntegrationResponseOutput
- type DeleteIntegrationResponseRequest
- type DeleteIntegrationResponseResponse
- type DeleteMethodInput
- type DeleteMethodOutput
- type DeleteMethodRequest
- type DeleteMethodResponse
- type DeleteMethodResponseInput
- type DeleteMethodResponseOutput
- type DeleteMethodResponseRequest
- type DeleteMethodResponseResponse
- type DeleteModelInput
- type DeleteModelOutput
- type DeleteModelRequest
- type DeleteModelResponse
- type DeleteRequestValidatorInput
- type DeleteRequestValidatorOutput
- type DeleteRequestValidatorRequest
- type DeleteRequestValidatorResponse
- type DeleteResourceInput
- type DeleteResourceOutput
- type DeleteResourceRequest
- type DeleteResourceResponse
- type DeleteRestApiInput
- type DeleteRestApiOutput
- type DeleteRestApiRequest
- type DeleteRestApiResponse
- type DeleteStageInput
- type DeleteStageOutput
- type DeleteStageRequest
- type DeleteStageResponse
- type DeleteUsagePlanInput
- type DeleteUsagePlanKeyInput
- type DeleteUsagePlanKeyOutput
- type DeleteUsagePlanKeyRequest
- type DeleteUsagePlanKeyResponse
- type DeleteUsagePlanOutput
- type DeleteUsagePlanRequest
- type DeleteUsagePlanResponse
- type DeleteVpcLinkInput
- type DeleteVpcLinkOutput
- type DeleteVpcLinkRequest
- type DeleteVpcLinkResponse
- type Deployment
- type DeploymentCanarySettings
- type DocumentationPart
- type DocumentationPartLocation
- type DocumentationPartType
- type DocumentationVersion
- type DomainName
- type DomainNameStatus
- type EndpointConfiguration
- type EndpointType
- type FlushStageAuthorizersCacheInput
- type FlushStageAuthorizersCacheOutput
- type FlushStageAuthorizersCacheRequest
- type FlushStageAuthorizersCacheResponse
- type FlushStageCacheInput
- type FlushStageCacheOutput
- type FlushStageCacheRequest
- type FlushStageCacheResponse
- type GatewayResponse
- type GatewayResponseType
- type GenerateClientCertificateInput
- type GenerateClientCertificateOutput
- type GenerateClientCertificateRequest
- type GenerateClientCertificateResponse
- type GetAccountInput
- type GetAccountOutput
- type GetAccountRequest
- type GetAccountResponse
- type GetApiKeyInput
- type GetApiKeyOutput
- type GetApiKeyRequest
- type GetApiKeyResponse
- type GetApiKeysInput
- type GetApiKeysOutput
- type GetApiKeysPaginator
- type GetApiKeysRequest
- type GetApiKeysResponse
- type GetAuthorizerInput
- type GetAuthorizerOutput
- type GetAuthorizerRequest
- type GetAuthorizerResponse
- type GetAuthorizersInput
- type GetAuthorizersOutput
- type GetAuthorizersRequest
- type GetAuthorizersResponse
- type GetBasePathMappingInput
- type GetBasePathMappingOutput
- type GetBasePathMappingRequest
- type GetBasePathMappingResponse
- type GetBasePathMappingsInput
- type GetBasePathMappingsOutput
- type GetBasePathMappingsPaginator
- type GetBasePathMappingsRequest
- type GetBasePathMappingsResponse
- type GetClientCertificateInput
- type GetClientCertificateOutput
- type GetClientCertificateRequest
- type GetClientCertificateResponse
- type GetClientCertificatesInput
- type GetClientCertificatesOutput
- type GetClientCertificatesPaginator
- type GetClientCertificatesRequest
- type GetClientCertificatesResponse
- type GetDeploymentInput
- type GetDeploymentOutput
- type GetDeploymentRequest
- type GetDeploymentResponse
- type GetDeploymentsInput
- type GetDeploymentsOutput
- type GetDeploymentsPaginator
- type GetDeploymentsRequest
- type GetDeploymentsResponse
- type GetDocumentationPartInput
- type GetDocumentationPartOutput
- type GetDocumentationPartRequest
- type GetDocumentationPartResponse
- type GetDocumentationPartsInput
- type GetDocumentationPartsOutput
- type GetDocumentationPartsRequest
- type GetDocumentationPartsResponse
- type GetDocumentationVersionInput
- type GetDocumentationVersionOutput
- type GetDocumentationVersionRequest
- type GetDocumentationVersionResponse
- type GetDocumentationVersionsInput
- type GetDocumentationVersionsOutput
- type GetDocumentationVersionsRequest
- type GetDocumentationVersionsResponse
- type GetDomainNameInput
- type GetDomainNameOutput
- type GetDomainNameRequest
- type GetDomainNameResponse
- type GetDomainNamesInput
- type GetDomainNamesOutput
- type GetDomainNamesPaginator
- type GetDomainNamesRequest
- type GetDomainNamesResponse
- type GetExportInput
- type GetExportOutput
- type GetExportRequest
- type GetExportResponse
- type GetGatewayResponseInput
- type GetGatewayResponseOutput
- type GetGatewayResponseRequest
- type GetGatewayResponseResponse
- type GetGatewayResponsesInput
- type GetGatewayResponsesOutput
- type GetGatewayResponsesRequest
- type GetGatewayResponsesResponse
- type GetIntegrationInput
- type GetIntegrationOutput
- type GetIntegrationRequest
- type GetIntegrationResponse
- type GetIntegrationResponseInput
- type GetIntegrationResponseOutput
- type GetIntegrationResponseRequest
- type GetIntegrationResponseResponse
- type GetMethodInput
- type GetMethodOutput
- type GetMethodRequest
- type GetMethodResponse
- type GetMethodResponseInput
- type GetMethodResponseOutput
- type GetMethodResponseRequest
- type GetMethodResponseResponse
- type GetModelInput
- type GetModelOutput
- type GetModelRequest
- type GetModelResponse
- type GetModelTemplateInput
- type GetModelTemplateOutput
- type GetModelTemplateRequest
- type GetModelTemplateResponse
- type GetModelsInput
- type GetModelsOutput
- type GetModelsPaginator
- type GetModelsRequest
- type GetModelsResponse
- type GetRequestValidatorInput
- type GetRequestValidatorOutput
- type GetRequestValidatorRequest
- type GetRequestValidatorResponse
- type GetRequestValidatorsInput
- type GetRequestValidatorsOutput
- type GetRequestValidatorsRequest
- type GetRequestValidatorsResponse
- type GetResourceInput
- type GetResourceOutput
- type GetResourceRequest
- type GetResourceResponse
- type GetResourcesInput
- type GetResourcesOutput
- type GetResourcesPaginator
- type GetResourcesRequest
- type GetResourcesResponse
- type GetRestApiInput
- type GetRestApiOutput
- type GetRestApiRequest
- type GetRestApiResponse
- type GetRestApisInput
- type GetRestApisOutput
- type GetRestApisPaginator
- type GetRestApisRequest
- type GetRestApisResponse
- type GetSdkInput
- type GetSdkOutput
- type GetSdkRequest
- type GetSdkResponse
- type GetSdkTypeInput
- type GetSdkTypeOutput
- type GetSdkTypeRequest
- type GetSdkTypeResponse
- type GetSdkTypesInput
- type GetSdkTypesOutput
- type GetSdkTypesRequest
- type GetSdkTypesResponse
- type GetStageInput
- type GetStageOutput
- type GetStageRequest
- type GetStageResponse
- type GetStagesInput
- type GetStagesOutput
- type GetStagesRequest
- type GetStagesResponse
- type GetTagsInput
- type GetTagsOutput
- type GetTagsRequest
- type GetTagsResponse
- type GetUsageInput
- type GetUsageOutput
- type GetUsagePaginator
- type GetUsagePlanInput
- type GetUsagePlanKeyInput
- type GetUsagePlanKeyOutput
- type GetUsagePlanKeyRequest
- type GetUsagePlanKeyResponse
- type GetUsagePlanKeysInput
- type GetUsagePlanKeysOutput
- type GetUsagePlanKeysPaginator
- type GetUsagePlanKeysRequest
- type GetUsagePlanKeysResponse
- type GetUsagePlanOutput
- type GetUsagePlanRequest
- type GetUsagePlanResponse
- type GetUsagePlansInput
- type GetUsagePlansOutput
- type GetUsagePlansPaginator
- type GetUsagePlansRequest
- type GetUsagePlansResponse
- type GetUsageRequest
- type GetUsageResponse
- type GetVpcLinkInput
- type GetVpcLinkOutput
- type GetVpcLinkRequest
- type GetVpcLinkResponse
- type GetVpcLinksInput
- type GetVpcLinksOutput
- type GetVpcLinksPaginator
- type GetVpcLinksRequest
- type GetVpcLinksResponse
- type ImportApiKeysInput
- type ImportApiKeysOutput
- type ImportApiKeysRequest
- type ImportApiKeysResponse
- type ImportDocumentationPartsInput
- type ImportDocumentationPartsOutput
- type ImportDocumentationPartsRequest
- type ImportDocumentationPartsResponse
- type ImportRestApiInput
- type ImportRestApiOutput
- type ImportRestApiRequest
- type ImportRestApiResponse
- type Integration
- type IntegrationResponse
- type IntegrationType
- type LocationStatusType
- type Method
- type MethodResponse
- type MethodSetting
- type MethodSnapshot
- type Model
- type Op
- type PatchOperation
- type PutGatewayResponseInput
- type PutGatewayResponseOutput
- type PutGatewayResponseRequest
- type PutGatewayResponseResponse
- type PutIntegrationInput
- type PutIntegrationOutput
- type PutIntegrationRequest
- type PutIntegrationResponse
- type PutIntegrationResponseInput
- type PutIntegrationResponseOutput
- type PutIntegrationResponseRequest
- type PutIntegrationResponseResponse
- type PutMethodInput
- type PutMethodOutput
- type PutMethodRequest
- type PutMethodResponse
- type PutMethodResponseInput
- type PutMethodResponseOutput
- type PutMethodResponseRequest
- type PutMethodResponseResponse
- type PutMode
- type PutRestApiInput
- type PutRestApiOutput
- type PutRestApiRequest
- type PutRestApiResponse
- type QuotaPeriodType
- type QuotaSettings
- type RequestValidator
- type Resource
- type RestApi
- type SdkConfigurationProperty
- type SdkType
- type SecurityPolicy
- type Stage
- type StageKey
- type TagResourceInput
- type TagResourceOutput
- type TagResourceRequest
- type TagResourceResponse
- type TestInvokeAuthorizerInput
- type TestInvokeAuthorizerOutput
- type TestInvokeAuthorizerRequest
- type TestInvokeAuthorizerResponse
- type TestInvokeMethodInput
- type TestInvokeMethodOutput
- type TestInvokeMethodRequest
- type TestInvokeMethodResponse
- type ThrottleSettings
- type TlsConfig
- type UnauthorizedCacheControlHeaderStrategy
- type UntagResourceInput
- type UntagResourceOutput
- type UntagResourceRequest
- type UntagResourceResponse
- type UpdateAccountInput
- type UpdateAccountOutput
- type UpdateAccountRequest
- type UpdateAccountResponse
- type UpdateApiKeyInput
- type UpdateApiKeyOutput
- type UpdateApiKeyRequest
- type UpdateApiKeyResponse
- type UpdateAuthorizerInput
- type UpdateAuthorizerOutput
- type UpdateAuthorizerRequest
- type UpdateAuthorizerResponse
- type UpdateBasePathMappingInput
- type UpdateBasePathMappingOutput
- type UpdateBasePathMappingRequest
- type UpdateBasePathMappingResponse
- type UpdateClientCertificateInput
- type UpdateClientCertificateOutput
- type UpdateClientCertificateRequest
- type UpdateClientCertificateResponse
- type UpdateDeploymentInput
- type UpdateDeploymentOutput
- type UpdateDeploymentRequest
- type UpdateDeploymentResponse
- type UpdateDocumentationPartInput
- type UpdateDocumentationPartOutput
- type UpdateDocumentationPartRequest
- type UpdateDocumentationPartResponse
- type UpdateDocumentationVersionInput
- type UpdateDocumentationVersionOutput
- type UpdateDocumentationVersionRequest
- type UpdateDocumentationVersionResponse
- type UpdateDomainNameInput
- type UpdateDomainNameOutput
- type UpdateDomainNameRequest
- type UpdateDomainNameResponse
- type UpdateGatewayResponseInput
- type UpdateGatewayResponseOutput
- type UpdateGatewayResponseRequest
- type UpdateGatewayResponseResponse
- type UpdateIntegrationInput
- type UpdateIntegrationOutput
- type UpdateIntegrationRequest
- type UpdateIntegrationResponse
- type UpdateIntegrationResponseInput
- type UpdateIntegrationResponseOutput
- type UpdateIntegrationResponseRequest
- type UpdateIntegrationResponseResponse
- type UpdateMethodInput
- type UpdateMethodOutput
- type UpdateMethodRequest
- type UpdateMethodResponse
- type UpdateMethodResponseInput
- type UpdateMethodResponseOutput
- type UpdateMethodResponseRequest
- type UpdateMethodResponseResponse
- type UpdateModelInput
- type UpdateModelOutput
- type UpdateModelRequest
- type UpdateModelResponse
- type UpdateRequestValidatorInput
- type UpdateRequestValidatorOutput
- type UpdateRequestValidatorRequest
- type UpdateRequestValidatorResponse
- type UpdateResourceInput
- type UpdateResourceOutput
- type UpdateResourceRequest
- type UpdateResourceResponse
- type UpdateRestApiInput
- type UpdateRestApiOutput
- type UpdateRestApiRequest
- type UpdateRestApiResponse
- type UpdateStageInput
- type UpdateStageOutput
- type UpdateStageRequest
- type UpdateStageResponse
- type UpdateUsageInput
- type UpdateUsageOutput
- type UpdateUsagePlanInput
- type UpdateUsagePlanOutput
- type UpdateUsagePlanRequest
- type UpdateUsagePlanResponse
- type UpdateUsageRequest
- type UpdateUsageResponse
- type UpdateVpcLinkInput
- type UpdateVpcLinkOutput
- type UpdateVpcLinkRequest
- type UpdateVpcLinkResponse
- type UsagePlan
- type UsagePlanKey
- type VpcLink
- type VpcLinkStatus
Constants ¶
const ( ServiceName = "Amazon API Gateway" // Service's name ServiceID = "APIGateway" // Service's identifier EndpointsID = "apigateway" // Service's Endpoint identifier )
const ( // ErrCodeBadRequestException for service response error code // "BadRequestException". // // The submitted request is not valid, for example, the input is incomplete // or incorrect. See the accompanying error message for details. ErrCodeBadRequestException = "BadRequestException" // ErrCodeConflictException for service response error code // "ConflictException". // // The request configuration has conflicts. For details, see the accompanying // error message. ErrCodeConflictException = "ConflictException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // The request exceeded the rate limit. Retry after the specified time period. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeNotFoundException for service response error code // "NotFoundException". // // The requested resource is not found. Make sure that the request URI is correct. ErrCodeNotFoundException = "NotFoundException" // "ServiceUnavailableException". // // The requested service is not available. For details see the accompanying // error message. Retry after the specified time period. ErrCodeServiceUnavailableException = "ServiceUnavailableException" // ErrCodeTooManyRequestsException for service response error code // "TooManyRequestsException". // // The request has reached its throttling limit. Retry after the specified time // period. ErrCodeTooManyRequestsException = "TooManyRequestsException" // "UnauthorizedException". // // The request is denied because the caller has insufficient permissions. ErrCodeUnauthorizedException = "UnauthorizedException" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessLogSettings ¶ added in v0.2.0
type AccessLogSettings struct { // The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis // Data Firehose delivery stream to receive access logs. If you specify a Kinesis // Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. DestinationArn *string `locationName:"destinationArn" type:"string"` // A single line format of the access logs of data, as specified by selected // $context variables (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). // The format must include at least $context.requestId. Format *string `locationName:"format" type:"string"` // contains filtered or unexported fields }
Access log settings, including the access log format and access log destination ARN.
func (AccessLogSettings) MarshalFields ¶ added in v0.3.0
func (s AccessLogSettings) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AccessLogSettings) String ¶ added in v0.2.0
func (s AccessLogSettings) String() string
String returns the string representation
type ApiKey ¶ added in v0.9.0
type ApiKey struct { // The timestamp when the API Key was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // An AWS Marketplace customer identifier , when integrating with the AWS SaaS // Marketplace. CustomerId *string `locationName:"customerId" type:"string"` // The description of the API Key. Description *string `locationName:"description" type:"string"` // Specifies whether the API Key can be used by callers. Enabled *bool `locationName:"enabled" type:"boolean"` // The identifier of the API Key. Id *string `locationName:"id" type:"string"` // The timestamp when the API Key was last updated. LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp"` // 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 collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html)
func (ApiKey) MarshalFields ¶ added in v0.9.0
func (s ApiKey) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type ApiKeySourceType ¶ added in v0.2.0
type ApiKeySourceType string
const ( ApiKeySourceTypeHeader ApiKeySourceType = "HEADER" ApiKeySourceTypeAuthorizer ApiKeySourceType = "AUTHORIZER" )
Enum values for ApiKeySourceType
func (ApiKeySourceType) MarshalValue ¶ added in v0.3.0
func (enum ApiKeySourceType) MarshalValue() (string, error)
func (ApiKeySourceType) MarshalValueBuf ¶ added in v0.3.0
func (enum ApiKeySourceType) MarshalValueBuf(b []byte) ([]byte, error)
type ApiKeysFormat ¶
type ApiKeysFormat string
const (
ApiKeysFormatCsv ApiKeysFormat = "csv"
)
Enum values for ApiKeysFormat
func (ApiKeysFormat) MarshalValue ¶ added in v0.3.0
func (enum ApiKeysFormat) MarshalValue() (string, error)
func (ApiKeysFormat) MarshalValueBuf ¶ added in v0.3.0
func (enum ApiKeysFormat) MarshalValueBuf(b []byte) ([]byte, error)
type ApiStage ¶
type ApiStage struct { // API Id of the associated API stage in a usage plan. ApiId *string `locationName:"apiId" type:"string"` // API stage name of the associated API stage in a usage plan. Stage *string `locationName:"stage" type:"string"` // Map containing method level throttling information for API stage in a usage // plan. Throttle map[string]ThrottleSettings `locationName:"throttle" type:"map"` // contains filtered or unexported fields }
API stage name of the associated API stage in a usage plan.
func (ApiStage) MarshalFields ¶ added in v0.3.0
func (s ApiStage) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type Authorizer ¶ added in v0.9.0
type Authorizer struct { // Optional customer-defined field, used in OpenAPI imports and exports without // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the required credentials as an IAM role for API Gateway to invoke // the authorizer. To specify an IAM role for API Gateway to assume, use the // role's Amazon Resource Name (ARN). To use resource-based permissions on the // Lambda function, specify null. AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"` // The TTL in seconds of cached authorizer results. If it equals 0, authorization // caching is disabled. If it is greater than 0, API Gateway will cache authorizer // responses. If this field is not set, the default value is 300. The maximum // value is 3600, or 1 hour. AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or // REQUEST authorizers, this must be a well-formed Lambda function URI, for // example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, // where {region} is the same as the region hosting the Lambda function, path // indicates that the remaining substring in the URI should be treated as the // path to the resource, including the initial /. For Lambda functions, this // is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. AuthorizerUri *string `locationName:"authorizerUri" type:"string"` // The identifier for the authorizer resource. Id *string `locationName:"id" type:"string"` // The identity source for which authorization is requested. // * For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies // the request header mapping expression for the custom header holding the // authorization token submitted by the client. For example, if the token // header name is Auth, the header mapping expression is method.request.header.Auth. // // * For the REQUEST authorizer, this is required when authorization caching // is enabled. The value is a comma-separated string of one or more mapping // expressions of the specified request parameters. For example, if an Auth // header, a Name query string parameter are defined as identity sources, // this value is method.request.header.Auth, method.request.querystring.Name. // These parameters will be used to derive the authorization caching key // and to perform runtime validation of the REQUEST authorizer by verifying // all of the identity-related request parameters are present, not null and // non-empty. Only when this is true does the authorizer invoke the authorizer // Lambda function, otherwise, it returns a 401 Unauthorized response without // calling the Lambda function. The valid value is a string of comma-separated // mapping expressions of the specified request parameters. When the authorization // caching is not enabled, this property is optional. IdentitySource *string `locationName:"identitySource" type:"string"` // A validation expression for the incoming identity token. For TOKEN authorizers, // this value is a regular expression. For COGNITO_USER_POOLS authorizers, API // Gateway will match the aud field of the incoming token from the client against // the specified regular expression. It will invoke the authorizer's Lambda // function when there is a match. Otherwise, it will return a 401 Unauthorized // response without calling the Lambda function. The validation expression does // not apply to the REQUEST authorizer. IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` // [Required] The name of the authorizer. Name *string `locationName:"name" type:"string"` // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. // Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. // For a TOKEN or REQUEST authorizer, this is not defined. ProviderARNs []string `locationName:"providerARNs" type:"list"` // The authorizer type. Valid values are TOKEN for a Lambda function using a // single authorization token submitted in a custom header, REQUEST for a Lambda // function using incoming request parameters, and COGNITO_USER_POOLS for using // an Amazon Cognito user pool. Type AuthorizerType `locationName:"type" type:"string" enum:"true"` // contains filtered or unexported fields }
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
Use Lambda Function as Authorizer (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html) Use Cognito User Pool as Authorizer (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html)
func (Authorizer) MarshalFields ¶ added in v0.9.0
func (s Authorizer) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (Authorizer) String ¶ added in v0.9.0
func (s Authorizer) String() string
String returns the string representation
type AuthorizerType ¶
type AuthorizerType string
The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
const ( AuthorizerTypeToken AuthorizerType = "TOKEN" AuthorizerTypeRequest AuthorizerType = "REQUEST" AuthorizerTypeCognitoUserPools AuthorizerType = "COGNITO_USER_POOLS" )
Enum values for AuthorizerType
func (AuthorizerType) MarshalValue ¶ added in v0.3.0
func (enum AuthorizerType) MarshalValue() (string, error)
func (AuthorizerType) MarshalValueBuf ¶ added in v0.3.0
func (enum AuthorizerType) MarshalValueBuf(b []byte) ([]byte, error)
type BasePathMapping ¶ added in v0.9.0
type BasePathMapping struct { // The base path name that callers of the API must provide as part of the URL // after the domain name. BasePath *string `locationName:"basePath" type:"string"` // The string identifier of the associated RestApi. RestApiId *string `locationName:"restApiId" type:"string"` // The name of the associated stage. Stage *string `locationName:"stage" type:"string"` // contains filtered or unexported fields }
Represents the base path that callers of the API must provide as part of the URL after the domain name.
A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.
Use Custom Domain Names (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (BasePathMapping) MarshalFields ¶ added in v0.9.0
func (s BasePathMapping) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (BasePathMapping) String ¶ added in v0.9.0
func (s BasePathMapping) String() string
String returns the string representation
type CacheClusterSize ¶
type CacheClusterSize string
Returns the size of the CacheCluster.
const ( CacheClusterSize05 CacheClusterSize = "0.5" CacheClusterSize16 CacheClusterSize = "1.6" CacheClusterSize61 CacheClusterSize = "6.1" CacheClusterSize135 CacheClusterSize = "13.5" CacheClusterSize284 CacheClusterSize = "28.4" CacheClusterSize582 CacheClusterSize = "58.2" CacheClusterSize118 CacheClusterSize = "118" CacheClusterSize237 CacheClusterSize = "237" )
Enum values for CacheClusterSize
func (CacheClusterSize) MarshalValue ¶ added in v0.3.0
func (enum CacheClusterSize) MarshalValue() (string, error)
func (CacheClusterSize) MarshalValueBuf ¶ added in v0.3.0
func (enum CacheClusterSize) MarshalValueBuf(b []byte) ([]byte, error)
type CacheClusterStatus ¶
type CacheClusterStatus string
Returns the status of the CacheCluster.
const ( CacheClusterStatusCreateInProgress CacheClusterStatus = "CREATE_IN_PROGRESS" CacheClusterStatusAvailable CacheClusterStatus = "AVAILABLE" CacheClusterStatusDeleteInProgress CacheClusterStatus = "DELETE_IN_PROGRESS" CacheClusterStatusNotAvailable CacheClusterStatus = "NOT_AVAILABLE" CacheClusterStatusFlushInProgress CacheClusterStatus = "FLUSH_IN_PROGRESS" )
Enum values for CacheClusterStatus
func (CacheClusterStatus) MarshalValue ¶ added in v0.3.0
func (enum CacheClusterStatus) MarshalValue() (string, error)
func (CacheClusterStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum CacheClusterStatus) MarshalValueBuf(b []byte) ([]byte, error)
type CanarySettings ¶ added in v0.2.0
type CanarySettings struct { // The ID of the canary deployment. DeploymentId *string `locationName:"deploymentId" type:"string"` // The percent (0-100) of traffic diverted to a canary deployment. PercentTraffic *float64 `locationName:"percentTraffic" type:"double"` // Stage variables overridden for a canary release deployment, including new // stage variables introduced in the canary. These stage variables are represented // as a string-to-string map between stage variable names and their values. StageVariableOverrides map[string]string `locationName:"stageVariableOverrides" type:"map"` // A Boolean flag to indicate whether the canary deployment uses the stage cache // or not. UseStageCache *bool `locationName:"useStageCache" type:"boolean"` // contains filtered or unexported fields }
Configuration settings of a canary deployment.
func (CanarySettings) MarshalFields ¶ added in v0.3.0
func (s CanarySettings) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CanarySettings) String ¶ added in v0.2.0
func (s CanarySettings) String() string
String returns the string representation
type Certificate ¶ added in v0.9.0
type Certificate struct { // The identifier of the client certificate. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // The timestamp when the client certificate was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The description of the client certificate. Description *string `locationName:"description" type:"string"` // The timestamp when the client certificate will expire. ExpirationDate *time.Time `locationName:"expirationDate" type:"timestamp"` // 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"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.
Use Client-Side Certificate (https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)
func (Certificate) MarshalFields ¶ added in v0.9.0
func (s Certificate) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (Certificate) String ¶ added in v0.9.0
func (s Certificate) String() string
String returns the string representation
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to Amazon API Gateway. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := apigateway.New(myConfig)
func (*Client) CreateApiKeyRequest ¶ added in v0.9.0
func (c *Client) CreateApiKeyRequest(input *CreateApiKeyInput) CreateApiKeyRequest
CreateApiKeyRequest returns a request value for making API operation for Amazon API Gateway.
Create an ApiKey resource.
AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html)
// Example sending a request using CreateApiKeyRequest. req := client.CreateApiKeyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateAuthorizerRequest ¶ added in v0.9.0
func (c *Client) CreateAuthorizerRequest(input *CreateAuthorizerInput) CreateAuthorizerRequest
CreateAuthorizerRequest returns a request value for making API operation for Amazon API Gateway.
Adds a new Authorizer resource to an existing RestApi resource.
AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html)
// Example sending a request using CreateAuthorizerRequest. req := client.CreateAuthorizerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateBasePathMappingRequest ¶ added in v0.9.0
func (c *Client) CreateBasePathMappingRequest(input *CreateBasePathMappingInput) CreateBasePathMappingRequest
CreateBasePathMappingRequest returns a request value for making API operation for Amazon API Gateway.
Creates a new BasePathMapping resource.
// Example sending a request using CreateBasePathMappingRequest. req := client.CreateBasePathMappingRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateDeploymentRequest ¶ added in v0.9.0
func (c *Client) CreateDeploymentRequest(input *CreateDeploymentInput) CreateDeploymentRequest
CreateDeploymentRequest returns a request value for making API operation for Amazon API Gateway.
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
// Example sending a request using CreateDeploymentRequest. req := client.CreateDeploymentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateDocumentationPartRequest ¶ added in v0.9.0
func (c *Client) CreateDocumentationPartRequest(input *CreateDocumentationPartInput) CreateDocumentationPartRequest
CreateDocumentationPartRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using CreateDocumentationPartRequest. req := client.CreateDocumentationPartRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateDocumentationVersionRequest ¶ added in v0.9.0
func (c *Client) CreateDocumentationVersionRequest(input *CreateDocumentationVersionInput) CreateDocumentationVersionRequest
CreateDocumentationVersionRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using CreateDocumentationVersionRequest. req := client.CreateDocumentationVersionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateDomainNameRequest ¶ added in v0.9.0
func (c *Client) CreateDomainNameRequest(input *CreateDomainNameInput) CreateDomainNameRequest
CreateDomainNameRequest returns a request value for making API operation for Amazon API Gateway.
Creates a new domain name.
// Example sending a request using CreateDomainNameRequest. req := client.CreateDomainNameRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateModelRequest ¶ added in v0.9.0
func (c *Client) CreateModelRequest(input *CreateModelInput) CreateModelRequest
CreateModelRequest returns a request value for making API operation for Amazon API Gateway.
Adds a new Model resource to an existing RestApi resource.
// Example sending a request using CreateModelRequest. req := client.CreateModelRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateRequestValidatorRequest ¶ added in v0.9.0
func (c *Client) CreateRequestValidatorRequest(input *CreateRequestValidatorInput) CreateRequestValidatorRequest
CreateRequestValidatorRequest returns a request value for making API operation for Amazon API Gateway.
Creates a ReqeustValidator of a given RestApi.
// Example sending a request using CreateRequestValidatorRequest. req := client.CreateRequestValidatorRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateResourceRequest ¶ added in v0.9.0
func (c *Client) CreateResourceRequest(input *CreateResourceInput) CreateResourceRequest
CreateResourceRequest returns a request value for making API operation for Amazon API Gateway.
Creates a Resource resource.
// Example sending a request using CreateResourceRequest. req := client.CreateResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateRestApiRequest ¶ added in v0.9.0
func (c *Client) CreateRestApiRequest(input *CreateRestApiInput) CreateRestApiRequest
CreateRestApiRequest returns a request value for making API operation for Amazon API Gateway.
Creates a new RestApi resource.
// Example sending a request using CreateRestApiRequest. req := client.CreateRestApiRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateStageRequest ¶ added in v0.9.0
func (c *Client) CreateStageRequest(input *CreateStageInput) CreateStageRequest
CreateStageRequest returns a request value for making API operation for Amazon API Gateway.
Creates a new Stage resource that references a pre-existing Deployment for the API.
// Example sending a request using CreateStageRequest. req := client.CreateStageRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateUsagePlanKeyRequest ¶ added in v0.9.0
func (c *Client) CreateUsagePlanKeyRequest(input *CreateUsagePlanKeyInput) CreateUsagePlanKeyRequest
CreateUsagePlanKeyRequest returns a request value for making API operation for Amazon API Gateway.
Creates a usage plan key for adding an existing API key to a usage plan.
// Example sending a request using CreateUsagePlanKeyRequest. req := client.CreateUsagePlanKeyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateUsagePlanRequest ¶ added in v0.9.0
func (c *Client) CreateUsagePlanRequest(input *CreateUsagePlanInput) CreateUsagePlanRequest
CreateUsagePlanRequest returns a request value for making API operation for Amazon API Gateway.
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
// Example sending a request using CreateUsagePlanRequest. req := client.CreateUsagePlanRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateVpcLinkRequest ¶ added in v0.9.0
func (c *Client) CreateVpcLinkRequest(input *CreateVpcLinkInput) CreateVpcLinkRequest
CreateVpcLinkRequest returns a request value for making API operation for Amazon API Gateway.
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
// Example sending a request using CreateVpcLinkRequest. req := client.CreateVpcLinkRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteApiKeyRequest ¶ added in v0.9.0
func (c *Client) DeleteApiKeyRequest(input *DeleteApiKeyInput) DeleteApiKeyRequest
DeleteApiKeyRequest returns a request value for making API operation for Amazon API Gateway.
Deletes the ApiKey resource.
// Example sending a request using DeleteApiKeyRequest. req := client.DeleteApiKeyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteAuthorizerRequest ¶ added in v0.9.0
func (c *Client) DeleteAuthorizerRequest(input *DeleteAuthorizerInput) DeleteAuthorizerRequest
DeleteAuthorizerRequest returns a request value for making API operation for Amazon API Gateway.
Deletes an existing Authorizer resource.
AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html)
// Example sending a request using DeleteAuthorizerRequest. req := client.DeleteAuthorizerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteBasePathMappingRequest ¶ added in v0.9.0
func (c *Client) DeleteBasePathMappingRequest(input *DeleteBasePathMappingInput) DeleteBasePathMappingRequest
DeleteBasePathMappingRequest returns a request value for making API operation for Amazon API Gateway.
Deletes the BasePathMapping resource.
// Example sending a request using DeleteBasePathMappingRequest. req := client.DeleteBasePathMappingRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteClientCertificateRequest ¶ added in v0.9.0
func (c *Client) DeleteClientCertificateRequest(input *DeleteClientCertificateInput) DeleteClientCertificateRequest
DeleteClientCertificateRequest returns a request value for making API operation for Amazon API Gateway.
Deletes the ClientCertificate resource.
// Example sending a request using DeleteClientCertificateRequest. req := client.DeleteClientCertificateRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteDeploymentRequest ¶ added in v0.9.0
func (c *Client) DeleteDeploymentRequest(input *DeleteDeploymentInput) DeleteDeploymentRequest
DeleteDeploymentRequest returns a request value for making API operation for Amazon API Gateway.
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
// Example sending a request using DeleteDeploymentRequest. req := client.DeleteDeploymentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteDocumentationPartRequest ¶ added in v0.9.0
func (c *Client) DeleteDocumentationPartRequest(input *DeleteDocumentationPartInput) DeleteDocumentationPartRequest
DeleteDocumentationPartRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using DeleteDocumentationPartRequest. req := client.DeleteDocumentationPartRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteDocumentationVersionRequest ¶ added in v0.9.0
func (c *Client) DeleteDocumentationVersionRequest(input *DeleteDocumentationVersionInput) DeleteDocumentationVersionRequest
DeleteDocumentationVersionRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using DeleteDocumentationVersionRequest. req := client.DeleteDocumentationVersionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteDomainNameRequest ¶ added in v0.9.0
func (c *Client) DeleteDomainNameRequest(input *DeleteDomainNameInput) DeleteDomainNameRequest
DeleteDomainNameRequest returns a request value for making API operation for Amazon API Gateway.
Deletes the DomainName resource.
// Example sending a request using DeleteDomainNameRequest. req := client.DeleteDomainNameRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteGatewayResponseRequest ¶ added in v0.9.0
func (c *Client) DeleteGatewayResponseRequest(input *DeleteGatewayResponseInput) DeleteGatewayResponseRequest
DeleteGatewayResponseRequest returns a request value for making API operation for Amazon API Gateway.
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
// Example sending a request using DeleteGatewayResponseRequest. req := client.DeleteGatewayResponseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteIntegrationRequest ¶ added in v0.9.0
func (c *Client) DeleteIntegrationRequest(input *DeleteIntegrationInput) DeleteIntegrationRequest
DeleteIntegrationRequest returns a request value for making API operation for Amazon API Gateway.
Represents a delete integration.
// Example sending a request using DeleteIntegrationRequest. req := client.DeleteIntegrationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteIntegrationResponseRequest ¶ added in v0.9.0
func (c *Client) DeleteIntegrationResponseRequest(input *DeleteIntegrationResponseInput) DeleteIntegrationResponseRequest
DeleteIntegrationResponseRequest returns a request value for making API operation for Amazon API Gateway.
Represents a delete integration response.
// Example sending a request using DeleteIntegrationResponseRequest. req := client.DeleteIntegrationResponseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteMethodRequest ¶ added in v0.9.0
func (c *Client) DeleteMethodRequest(input *DeleteMethodInput) DeleteMethodRequest
DeleteMethodRequest returns a request value for making API operation for Amazon API Gateway.
Deletes an existing Method resource.
// Example sending a request using DeleteMethodRequest. req := client.DeleteMethodRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteMethodResponseRequest ¶ added in v0.9.0
func (c *Client) DeleteMethodResponseRequest(input *DeleteMethodResponseInput) DeleteMethodResponseRequest
DeleteMethodResponseRequest returns a request value for making API operation for Amazon API Gateway.
Deletes an existing MethodResponse resource.
// Example sending a request using DeleteMethodResponseRequest. req := client.DeleteMethodResponseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteModelRequest ¶ added in v0.9.0
func (c *Client) DeleteModelRequest(input *DeleteModelInput) DeleteModelRequest
DeleteModelRequest returns a request value for making API operation for Amazon API Gateway.
Deletes a model.
// Example sending a request using DeleteModelRequest. req := client.DeleteModelRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteRequestValidatorRequest ¶ added in v0.9.0
func (c *Client) DeleteRequestValidatorRequest(input *DeleteRequestValidatorInput) DeleteRequestValidatorRequest
DeleteRequestValidatorRequest returns a request value for making API operation for Amazon API Gateway.
Deletes a RequestValidator of a given RestApi.
// Example sending a request using DeleteRequestValidatorRequest. req := client.DeleteRequestValidatorRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteResourceRequest ¶ added in v0.9.0
func (c *Client) DeleteResourceRequest(input *DeleteResourceInput) DeleteResourceRequest
DeleteResourceRequest returns a request value for making API operation for Amazon API Gateway.
Deletes a Resource resource.
// Example sending a request using DeleteResourceRequest. req := client.DeleteResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteRestApiRequest ¶ added in v0.9.0
func (c *Client) DeleteRestApiRequest(input *DeleteRestApiInput) DeleteRestApiRequest
DeleteRestApiRequest returns a request value for making API operation for Amazon API Gateway.
Deletes the specified API.
// Example sending a request using DeleteRestApiRequest. req := client.DeleteRestApiRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteStageRequest ¶ added in v0.9.0
func (c *Client) DeleteStageRequest(input *DeleteStageInput) DeleteStageRequest
DeleteStageRequest returns a request value for making API operation for Amazon API Gateway.
Deletes a Stage resource.
// Example sending a request using DeleteStageRequest. req := client.DeleteStageRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteUsagePlanKeyRequest ¶ added in v0.9.0
func (c *Client) DeleteUsagePlanKeyRequest(input *DeleteUsagePlanKeyInput) DeleteUsagePlanKeyRequest
DeleteUsagePlanKeyRequest returns a request value for making API operation for Amazon API Gateway.
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
// Example sending a request using DeleteUsagePlanKeyRequest. req := client.DeleteUsagePlanKeyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteUsagePlanRequest ¶ added in v0.9.0
func (c *Client) DeleteUsagePlanRequest(input *DeleteUsagePlanInput) DeleteUsagePlanRequest
DeleteUsagePlanRequest returns a request value for making API operation for Amazon API Gateway.
Deletes a usage plan of a given plan Id.
// Example sending a request using DeleteUsagePlanRequest. req := client.DeleteUsagePlanRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteVpcLinkRequest ¶ added in v0.9.0
func (c *Client) DeleteVpcLinkRequest(input *DeleteVpcLinkInput) DeleteVpcLinkRequest
DeleteVpcLinkRequest returns a request value for making API operation for Amazon API Gateway.
Deletes an existing VpcLink of a specified identifier.
// Example sending a request using DeleteVpcLinkRequest. req := client.DeleteVpcLinkRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) FlushStageAuthorizersCacheRequest ¶ added in v0.9.0
func (c *Client) FlushStageAuthorizersCacheRequest(input *FlushStageAuthorizersCacheInput) FlushStageAuthorizersCacheRequest
FlushStageAuthorizersCacheRequest returns a request value for making API operation for Amazon API Gateway.
Flushes all authorizer cache entries on a stage.
// Example sending a request using FlushStageAuthorizersCacheRequest. req := client.FlushStageAuthorizersCacheRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) FlushStageCacheRequest ¶ added in v0.9.0
func (c *Client) FlushStageCacheRequest(input *FlushStageCacheInput) FlushStageCacheRequest
FlushStageCacheRequest returns a request value for making API operation for Amazon API Gateway.
Flushes a stage's cache.
// Example sending a request using FlushStageCacheRequest. req := client.FlushStageCacheRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GenerateClientCertificateRequest ¶ added in v0.9.0
func (c *Client) GenerateClientCertificateRequest(input *GenerateClientCertificateInput) GenerateClientCertificateRequest
GenerateClientCertificateRequest returns a request value for making API operation for Amazon API Gateway.
Generates a ClientCertificate resource.
// Example sending a request using GenerateClientCertificateRequest. req := client.GenerateClientCertificateRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetAccountRequest ¶ added in v0.9.0
func (c *Client) GetAccountRequest(input *GetAccountInput) GetAccountRequest
GetAccountRequest returns a request value for making API operation for Amazon API Gateway.
Gets information about the current Account resource.
// Example sending a request using GetAccountRequest. req := client.GetAccountRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetApiKeyRequest ¶ added in v0.9.0
func (c *Client) GetApiKeyRequest(input *GetApiKeyInput) GetApiKeyRequest
GetApiKeyRequest returns a request value for making API operation for Amazon API Gateway.
Gets information about the current ApiKey resource.
// Example sending a request using GetApiKeyRequest. req := client.GetApiKeyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetApiKeysRequest ¶ added in v0.9.0
func (c *Client) GetApiKeysRequest(input *GetApiKeysInput) GetApiKeysRequest
GetApiKeysRequest returns a request value for making API operation for Amazon API Gateway.
Gets information about the current ApiKeys resource.
// Example sending a request using GetApiKeysRequest. req := client.GetApiKeysRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetAuthorizerRequest ¶ added in v0.9.0
func (c *Client) GetAuthorizerRequest(input *GetAuthorizerInput) GetAuthorizerRequest
GetAuthorizerRequest returns a request value for making API operation for Amazon API Gateway.
Describe an existing Authorizer resource.
AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html)
// Example sending a request using GetAuthorizerRequest. req := client.GetAuthorizerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetAuthorizersRequest ¶ added in v0.9.0
func (c *Client) GetAuthorizersRequest(input *GetAuthorizersInput) GetAuthorizersRequest
GetAuthorizersRequest returns a request value for making API operation for Amazon API Gateway.
Describe an existing Authorizers resource.
AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html)
// Example sending a request using GetAuthorizersRequest. req := client.GetAuthorizersRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetBasePathMappingRequest ¶ added in v0.9.0
func (c *Client) GetBasePathMappingRequest(input *GetBasePathMappingInput) GetBasePathMappingRequest
GetBasePathMappingRequest returns a request value for making API operation for Amazon API Gateway.
Describe a BasePathMapping resource.
// Example sending a request using GetBasePathMappingRequest. req := client.GetBasePathMappingRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetBasePathMappingsRequest ¶ added in v0.9.0
func (c *Client) GetBasePathMappingsRequest(input *GetBasePathMappingsInput) GetBasePathMappingsRequest
GetBasePathMappingsRequest returns a request value for making API operation for Amazon API Gateway.
Represents a collection of BasePathMapping resources.
// Example sending a request using GetBasePathMappingsRequest. req := client.GetBasePathMappingsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetClientCertificateRequest ¶ added in v0.9.0
func (c *Client) GetClientCertificateRequest(input *GetClientCertificateInput) GetClientCertificateRequest
GetClientCertificateRequest returns a request value for making API operation for Amazon API Gateway.
Gets information about the current ClientCertificate resource.
// Example sending a request using GetClientCertificateRequest. req := client.GetClientCertificateRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetClientCertificatesRequest ¶ added in v0.9.0
func (c *Client) GetClientCertificatesRequest(input *GetClientCertificatesInput) GetClientCertificatesRequest
GetClientCertificatesRequest returns a request value for making API operation for Amazon API Gateway.
Gets a collection of ClientCertificate resources.
// Example sending a request using GetClientCertificatesRequest. req := client.GetClientCertificatesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetDeploymentRequest ¶ added in v0.9.0
func (c *Client) GetDeploymentRequest(input *GetDeploymentInput) GetDeploymentRequest
GetDeploymentRequest returns a request value for making API operation for Amazon API Gateway.
Gets information about a Deployment resource.
// Example sending a request using GetDeploymentRequest. req := client.GetDeploymentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetDeploymentsRequest ¶ added in v0.9.0
func (c *Client) GetDeploymentsRequest(input *GetDeploymentsInput) GetDeploymentsRequest
GetDeploymentsRequest returns a request value for making API operation for Amazon API Gateway.
Gets information about a Deployments collection.
// Example sending a request using GetDeploymentsRequest. req := client.GetDeploymentsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetDocumentationPartRequest ¶ added in v0.9.0
func (c *Client) GetDocumentationPartRequest(input *GetDocumentationPartInput) GetDocumentationPartRequest
GetDocumentationPartRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using GetDocumentationPartRequest. req := client.GetDocumentationPartRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetDocumentationPartsRequest ¶ added in v0.9.0
func (c *Client) GetDocumentationPartsRequest(input *GetDocumentationPartsInput) GetDocumentationPartsRequest
GetDocumentationPartsRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using GetDocumentationPartsRequest. req := client.GetDocumentationPartsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetDocumentationVersionRequest ¶ added in v0.9.0
func (c *Client) GetDocumentationVersionRequest(input *GetDocumentationVersionInput) GetDocumentationVersionRequest
GetDocumentationVersionRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using GetDocumentationVersionRequest. req := client.GetDocumentationVersionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetDocumentationVersionsRequest ¶ added in v0.9.0
func (c *Client) GetDocumentationVersionsRequest(input *GetDocumentationVersionsInput) GetDocumentationVersionsRequest
GetDocumentationVersionsRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using GetDocumentationVersionsRequest. req := client.GetDocumentationVersionsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetDomainNameRequest ¶ added in v0.9.0
func (c *Client) GetDomainNameRequest(input *GetDomainNameInput) GetDomainNameRequest
GetDomainNameRequest returns a request value for making API operation for Amazon API Gateway.
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
// Example sending a request using GetDomainNameRequest. req := client.GetDomainNameRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetDomainNamesRequest ¶ added in v0.9.0
func (c *Client) GetDomainNamesRequest(input *GetDomainNamesInput) GetDomainNamesRequest
GetDomainNamesRequest returns a request value for making API operation for Amazon API Gateway.
Represents a collection of DomainName resources.
// Example sending a request using GetDomainNamesRequest. req := client.GetDomainNamesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetExportRequest ¶ added in v0.9.0
func (c *Client) GetExportRequest(input *GetExportInput) GetExportRequest
GetExportRequest returns a request value for making API operation for Amazon API Gateway.
Exports a deployed version of a RestApi in a specified format.
// Example sending a request using GetExportRequest. req := client.GetExportRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetGatewayResponseRequest ¶ added in v0.9.0
func (c *Client) GetGatewayResponseRequest(input *GetGatewayResponseInput) GetGatewayResponseRequest
GetGatewayResponseRequest returns a request value for making API operation for Amazon API Gateway.
Gets a GatewayResponse of a specified response type on the given RestApi.
// Example sending a request using GetGatewayResponseRequest. req := client.GetGatewayResponseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetGatewayResponsesRequest ¶ added in v0.9.0
func (c *Client) GetGatewayResponsesRequest(input *GetGatewayResponsesInput) GetGatewayResponsesRequest
GetGatewayResponsesRequest returns a request value for making API operation for Amazon API Gateway.
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
// Example sending a request using GetGatewayResponsesRequest. req := client.GetGatewayResponsesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetIntegrationRequest ¶ added in v0.9.0
func (c *Client) GetIntegrationRequest(input *GetIntegrationInput) GetIntegrationRequest
GetIntegrationRequest returns a request value for making API operation for Amazon API Gateway.
Get the integration settings.
// Example sending a request using GetIntegrationRequest. req := client.GetIntegrationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetIntegrationResponseRequest ¶ added in v0.9.0
func (c *Client) GetIntegrationResponseRequest(input *GetIntegrationResponseInput) GetIntegrationResponseRequest
GetIntegrationResponseRequest returns a request value for making API operation for Amazon API Gateway.
Represents a get integration response.
// Example sending a request using GetIntegrationResponseRequest. req := client.GetIntegrationResponseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetMethodRequest ¶ added in v0.9.0
func (c *Client) GetMethodRequest(input *GetMethodInput) GetMethodRequest
GetMethodRequest returns a request value for making API operation for Amazon API Gateway.
Describe an existing Method resource.
// Example sending a request using GetMethodRequest. req := client.GetMethodRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetMethodResponseRequest ¶ added in v0.9.0
func (c *Client) GetMethodResponseRequest(input *GetMethodResponseInput) GetMethodResponseRequest
GetMethodResponseRequest returns a request value for making API operation for Amazon API Gateway.
Describes a MethodResponse resource.
// Example sending a request using GetMethodResponseRequest. req := client.GetMethodResponseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetModelRequest ¶ added in v0.9.0
func (c *Client) GetModelRequest(input *GetModelInput) GetModelRequest
GetModelRequest returns a request value for making API operation for Amazon API Gateway.
Describes an existing model defined for a RestApi resource.
// Example sending a request using GetModelRequest. req := client.GetModelRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetModelTemplateRequest ¶ added in v0.9.0
func (c *Client) GetModelTemplateRequest(input *GetModelTemplateInput) GetModelTemplateRequest
GetModelTemplateRequest returns a request value for making API operation for Amazon API Gateway.
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
// Example sending a request using GetModelTemplateRequest. req := client.GetModelTemplateRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetModelsRequest ¶ added in v0.9.0
func (c *Client) GetModelsRequest(input *GetModelsInput) GetModelsRequest
GetModelsRequest returns a request value for making API operation for Amazon API Gateway.
Describes existing Models defined for a RestApi resource.
// Example sending a request using GetModelsRequest. req := client.GetModelsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetRequestValidatorRequest ¶ added in v0.9.0
func (c *Client) GetRequestValidatorRequest(input *GetRequestValidatorInput) GetRequestValidatorRequest
GetRequestValidatorRequest returns a request value for making API operation for Amazon API Gateway.
Gets a RequestValidator of a given RestApi.
// Example sending a request using GetRequestValidatorRequest. req := client.GetRequestValidatorRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetRequestValidatorsRequest ¶ added in v0.9.0
func (c *Client) GetRequestValidatorsRequest(input *GetRequestValidatorsInput) GetRequestValidatorsRequest
GetRequestValidatorsRequest returns a request value for making API operation for Amazon API Gateway.
Gets the RequestValidators collection of a given RestApi.
// Example sending a request using GetRequestValidatorsRequest. req := client.GetRequestValidatorsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetResourceRequest ¶ added in v0.9.0
func (c *Client) GetResourceRequest(input *GetResourceInput) GetResourceRequest
GetResourceRequest returns a request value for making API operation for Amazon API Gateway.
Lists information about a resource.
// Example sending a request using GetResourceRequest. req := client.GetResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetResourcesRequest ¶ added in v0.9.0
func (c *Client) GetResourcesRequest(input *GetResourcesInput) GetResourcesRequest
GetResourcesRequest returns a request value for making API operation for Amazon API Gateway.
Lists information about a collection of Resource resources.
// Example sending a request using GetResourcesRequest. req := client.GetResourcesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetRestApiRequest ¶ added in v0.9.0
func (c *Client) GetRestApiRequest(input *GetRestApiInput) GetRestApiRequest
GetRestApiRequest returns a request value for making API operation for Amazon API Gateway.
Lists the RestApi resource in the collection.
// Example sending a request using GetRestApiRequest. req := client.GetRestApiRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetRestApisRequest ¶ added in v0.9.0
func (c *Client) GetRestApisRequest(input *GetRestApisInput) GetRestApisRequest
GetRestApisRequest returns a request value for making API operation for Amazon API Gateway.
Lists the RestApis resources for your collection.
// Example sending a request using GetRestApisRequest. req := client.GetRestApisRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetSdkRequest ¶ added in v0.9.0
func (c *Client) GetSdkRequest(input *GetSdkInput) GetSdkRequest
GetSdkRequest returns a request value for making API operation for Amazon API Gateway.
Generates a client SDK for a RestApi and Stage.
// Example sending a request using GetSdkRequest. req := client.GetSdkRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetSdkTypeRequest ¶ added in v0.9.0
func (c *Client) GetSdkTypeRequest(input *GetSdkTypeInput) GetSdkTypeRequest
GetSdkTypeRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using GetSdkTypeRequest. req := client.GetSdkTypeRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetSdkTypesRequest ¶ added in v0.9.0
func (c *Client) GetSdkTypesRequest(input *GetSdkTypesInput) GetSdkTypesRequest
GetSdkTypesRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using GetSdkTypesRequest. req := client.GetSdkTypesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetStageRequest ¶ added in v0.9.0
func (c *Client) GetStageRequest(input *GetStageInput) GetStageRequest
GetStageRequest returns a request value for making API operation for Amazon API Gateway.
Gets information about a Stage resource.
// Example sending a request using GetStageRequest. req := client.GetStageRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetStagesRequest ¶ added in v0.9.0
func (c *Client) GetStagesRequest(input *GetStagesInput) GetStagesRequest
GetStagesRequest returns a request value for making API operation for Amazon API Gateway.
Gets information about one or more Stage resources.
// Example sending a request using GetStagesRequest. req := client.GetStagesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetTagsRequest ¶ added in v0.9.0
func (c *Client) GetTagsRequest(input *GetTagsInput) GetTagsRequest
GetTagsRequest returns a request value for making API operation for Amazon API Gateway.
Gets the Tags collection for a given resource.
// Example sending a request using GetTagsRequest. req := client.GetTagsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetUsagePlanKeyRequest ¶ added in v0.9.0
func (c *Client) GetUsagePlanKeyRequest(input *GetUsagePlanKeyInput) GetUsagePlanKeyRequest
GetUsagePlanKeyRequest returns a request value for making API operation for Amazon API Gateway.
Gets a usage plan key of a given key identifier.
// Example sending a request using GetUsagePlanKeyRequest. req := client.GetUsagePlanKeyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetUsagePlanKeysRequest ¶ added in v0.9.0
func (c *Client) GetUsagePlanKeysRequest(input *GetUsagePlanKeysInput) GetUsagePlanKeysRequest
GetUsagePlanKeysRequest returns a request value for making API operation for Amazon API Gateway.
Gets all the usage plan keys representing the API keys added to a specified usage plan.
// Example sending a request using GetUsagePlanKeysRequest. req := client.GetUsagePlanKeysRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetUsagePlanRequest ¶ added in v0.9.0
func (c *Client) GetUsagePlanRequest(input *GetUsagePlanInput) GetUsagePlanRequest
GetUsagePlanRequest returns a request value for making API operation for Amazon API Gateway.
Gets a usage plan of a given plan identifier.
// Example sending a request using GetUsagePlanRequest. req := client.GetUsagePlanRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetUsagePlansRequest ¶ added in v0.9.0
func (c *Client) GetUsagePlansRequest(input *GetUsagePlansInput) GetUsagePlansRequest
GetUsagePlansRequest returns a request value for making API operation for Amazon API Gateway.
Gets all the usage plans of the caller's account.
// Example sending a request using GetUsagePlansRequest. req := client.GetUsagePlansRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetUsageRequest ¶ added in v0.9.0
func (c *Client) GetUsageRequest(input *GetUsageInput) GetUsageRequest
GetUsageRequest returns a request value for making API operation for Amazon API Gateway.
Gets the usage data of a usage plan in a specified time interval.
// Example sending a request using GetUsageRequest. req := client.GetUsageRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetVpcLinkRequest ¶ added in v0.9.0
func (c *Client) GetVpcLinkRequest(input *GetVpcLinkInput) GetVpcLinkRequest
GetVpcLinkRequest returns a request value for making API operation for Amazon API Gateway.
Gets a specified VPC link under the caller's account in a region.
// Example sending a request using GetVpcLinkRequest. req := client.GetVpcLinkRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetVpcLinksRequest ¶ added in v0.9.0
func (c *Client) GetVpcLinksRequest(input *GetVpcLinksInput) GetVpcLinksRequest
GetVpcLinksRequest returns a request value for making API operation for Amazon API Gateway.
Gets the VpcLinks collection under the caller's account in a selected region.
// Example sending a request using GetVpcLinksRequest. req := client.GetVpcLinksRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) ImportApiKeysRequest ¶ added in v0.9.0
func (c *Client) ImportApiKeysRequest(input *ImportApiKeysInput) ImportApiKeysRequest
ImportApiKeysRequest returns a request value for making API operation for Amazon API Gateway.
Import API keys from an external source, such as a CSV-formatted file.
// Example sending a request using ImportApiKeysRequest. req := client.ImportApiKeysRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) ImportDocumentationPartsRequest ¶ added in v0.9.0
func (c *Client) ImportDocumentationPartsRequest(input *ImportDocumentationPartsInput) ImportDocumentationPartsRequest
ImportDocumentationPartsRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using ImportDocumentationPartsRequest. req := client.ImportDocumentationPartsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) ImportRestApiRequest ¶ added in v0.9.0
func (c *Client) ImportRestApiRequest(input *ImportRestApiInput) ImportRestApiRequest
ImportRestApiRequest returns a request value for making API operation for Amazon API Gateway.
A feature of the API Gateway control service for creating a new API from an external API definition file.
// Example sending a request using ImportRestApiRequest. req := client.ImportRestApiRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) PutGatewayResponseRequest ¶ added in v0.9.0
func (c *Client) PutGatewayResponseRequest(input *PutGatewayResponseInput) PutGatewayResponseRequest
PutGatewayResponseRequest returns a request value for making API operation for Amazon API Gateway.
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
// Example sending a request using PutGatewayResponseRequest. req := client.PutGatewayResponseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) PutIntegrationRequest ¶ added in v0.9.0
func (c *Client) PutIntegrationRequest(input *PutIntegrationInput) PutIntegrationRequest
PutIntegrationRequest returns a request value for making API operation for Amazon API Gateway.
Sets up a method's integration.
// Example sending a request using PutIntegrationRequest. req := client.PutIntegrationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) PutIntegrationResponseRequest ¶ added in v0.9.0
func (c *Client) PutIntegrationResponseRequest(input *PutIntegrationResponseInput) PutIntegrationResponseRequest
PutIntegrationResponseRequest returns a request value for making API operation for Amazon API Gateway.
Represents a put integration.
// Example sending a request using PutIntegrationResponseRequest. req := client.PutIntegrationResponseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) PutMethodRequest ¶ added in v0.9.0
func (c *Client) PutMethodRequest(input *PutMethodInput) PutMethodRequest
PutMethodRequest returns a request value for making API operation for Amazon API Gateway.
Add a method to an existing Resource resource.
// Example sending a request using PutMethodRequest. req := client.PutMethodRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) PutMethodResponseRequest ¶ added in v0.9.0
func (c *Client) PutMethodResponseRequest(input *PutMethodResponseInput) PutMethodResponseRequest
PutMethodResponseRequest returns a request value for making API operation for Amazon API Gateway.
Adds a MethodResponse to an existing Method resource.
// Example sending a request using PutMethodResponseRequest. req := client.PutMethodResponseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) PutRestApiRequest ¶ added in v0.9.0
func (c *Client) PutRestApiRequest(input *PutRestApiInput) PutRestApiRequest
PutRestApiRequest returns a request value for making API operation for Amazon API Gateway.
A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
// Example sending a request using PutRestApiRequest. req := client.PutRestApiRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) TagResourceRequest ¶ added in v0.9.0
func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
TagResourceRequest returns a request value for making API operation for Amazon API Gateway.
Adds or updates a tag on a given resource.
// Example sending a request using TagResourceRequest. req := client.TagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) TestInvokeAuthorizerRequest ¶ added in v0.9.0
func (c *Client) TestInvokeAuthorizerRequest(input *TestInvokeAuthorizerInput) TestInvokeAuthorizerRequest
TestInvokeAuthorizerRequest returns a request value for making API operation for Amazon API Gateway.
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
Use Lambda Function as Authorizer (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html) Use Cognito User Pool as Authorizer (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html)
// Example sending a request using TestInvokeAuthorizerRequest. req := client.TestInvokeAuthorizerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) TestInvokeMethodRequest ¶ added in v0.9.0
func (c *Client) TestInvokeMethodRequest(input *TestInvokeMethodInput) TestInvokeMethodRequest
TestInvokeMethodRequest returns a request value for making API operation for Amazon API Gateway.
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
// Example sending a request using TestInvokeMethodRequest. req := client.TestInvokeMethodRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UntagResourceRequest ¶ added in v0.9.0
func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
UntagResourceRequest returns a request value for making API operation for Amazon API Gateway.
Removes a tag from a given resource.
// Example sending a request using UntagResourceRequest. req := client.UntagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateAccountRequest ¶ added in v0.9.0
func (c *Client) UpdateAccountRequest(input *UpdateAccountInput) UpdateAccountRequest
UpdateAccountRequest returns a request value for making API operation for Amazon API Gateway.
Changes information about the current Account resource.
// Example sending a request using UpdateAccountRequest. req := client.UpdateAccountRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateApiKeyRequest ¶ added in v0.9.0
func (c *Client) UpdateApiKeyRequest(input *UpdateApiKeyInput) UpdateApiKeyRequest
UpdateApiKeyRequest returns a request value for making API operation for Amazon API Gateway.
Changes information about an ApiKey resource.
// Example sending a request using UpdateApiKeyRequest. req := client.UpdateApiKeyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateAuthorizerRequest ¶ added in v0.9.0
func (c *Client) UpdateAuthorizerRequest(input *UpdateAuthorizerInput) UpdateAuthorizerRequest
UpdateAuthorizerRequest returns a request value for making API operation for Amazon API Gateway.
Updates an existing Authorizer resource.
AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html)
// Example sending a request using UpdateAuthorizerRequest. req := client.UpdateAuthorizerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateBasePathMappingRequest ¶ added in v0.9.0
func (c *Client) UpdateBasePathMappingRequest(input *UpdateBasePathMappingInput) UpdateBasePathMappingRequest
UpdateBasePathMappingRequest returns a request value for making API operation for Amazon API Gateway.
Changes information about the BasePathMapping resource.
// Example sending a request using UpdateBasePathMappingRequest. req := client.UpdateBasePathMappingRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateClientCertificateRequest ¶ added in v0.9.0
func (c *Client) UpdateClientCertificateRequest(input *UpdateClientCertificateInput) UpdateClientCertificateRequest
UpdateClientCertificateRequest returns a request value for making API operation for Amazon API Gateway.
Changes information about an ClientCertificate resource.
// Example sending a request using UpdateClientCertificateRequest. req := client.UpdateClientCertificateRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateDeploymentRequest ¶ added in v0.9.0
func (c *Client) UpdateDeploymentRequest(input *UpdateDeploymentInput) UpdateDeploymentRequest
UpdateDeploymentRequest returns a request value for making API operation for Amazon API Gateway.
Changes information about a Deployment resource.
// Example sending a request using UpdateDeploymentRequest. req := client.UpdateDeploymentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateDocumentationPartRequest ¶ added in v0.9.0
func (c *Client) UpdateDocumentationPartRequest(input *UpdateDocumentationPartInput) UpdateDocumentationPartRequest
UpdateDocumentationPartRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using UpdateDocumentationPartRequest. req := client.UpdateDocumentationPartRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateDocumentationVersionRequest ¶ added in v0.9.0
func (c *Client) UpdateDocumentationVersionRequest(input *UpdateDocumentationVersionInput) UpdateDocumentationVersionRequest
UpdateDocumentationVersionRequest returns a request value for making API operation for Amazon API Gateway.
// Example sending a request using UpdateDocumentationVersionRequest. req := client.UpdateDocumentationVersionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateDomainNameRequest ¶ added in v0.9.0
func (c *Client) UpdateDomainNameRequest(input *UpdateDomainNameInput) UpdateDomainNameRequest
UpdateDomainNameRequest returns a request value for making API operation for Amazon API Gateway.
Changes information about the DomainName resource.
// Example sending a request using UpdateDomainNameRequest. req := client.UpdateDomainNameRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateGatewayResponseRequest ¶ added in v0.9.0
func (c *Client) UpdateGatewayResponseRequest(input *UpdateGatewayResponseInput) UpdateGatewayResponseRequest
UpdateGatewayResponseRequest returns a request value for making API operation for Amazon API Gateway.
Updates a GatewayResponse of a specified response type on the given RestApi.
// Example sending a request using UpdateGatewayResponseRequest. req := client.UpdateGatewayResponseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateIntegrationRequest ¶ added in v0.9.0
func (c *Client) UpdateIntegrationRequest(input *UpdateIntegrationInput) UpdateIntegrationRequest
UpdateIntegrationRequest returns a request value for making API operation for Amazon API Gateway.
Represents an update integration.
// Example sending a request using UpdateIntegrationRequest. req := client.UpdateIntegrationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateIntegrationResponseRequest ¶ added in v0.9.0
func (c *Client) UpdateIntegrationResponseRequest(input *UpdateIntegrationResponseInput) UpdateIntegrationResponseRequest
UpdateIntegrationResponseRequest returns a request value for making API operation for Amazon API Gateway.
Represents an update integration response.
// Example sending a request using UpdateIntegrationResponseRequest. req := client.UpdateIntegrationResponseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateMethodRequest ¶ added in v0.9.0
func (c *Client) UpdateMethodRequest(input *UpdateMethodInput) UpdateMethodRequest
UpdateMethodRequest returns a request value for making API operation for Amazon API Gateway.
Updates an existing Method resource.
// Example sending a request using UpdateMethodRequest. req := client.UpdateMethodRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateMethodResponseRequest ¶ added in v0.9.0
func (c *Client) UpdateMethodResponseRequest(input *UpdateMethodResponseInput) UpdateMethodResponseRequest
UpdateMethodResponseRequest returns a request value for making API operation for Amazon API Gateway.
Updates an existing MethodResponse resource.
// Example sending a request using UpdateMethodResponseRequest. req := client.UpdateMethodResponseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateModelRequest ¶ added in v0.9.0
func (c *Client) UpdateModelRequest(input *UpdateModelInput) UpdateModelRequest
UpdateModelRequest returns a request value for making API operation for Amazon API Gateway.
Changes information about a model.
// Example sending a request using UpdateModelRequest. req := client.UpdateModelRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateRequestValidatorRequest ¶ added in v0.9.0
func (c *Client) UpdateRequestValidatorRequest(input *UpdateRequestValidatorInput) UpdateRequestValidatorRequest
UpdateRequestValidatorRequest returns a request value for making API operation for Amazon API Gateway.
Updates a RequestValidator of a given RestApi.
// Example sending a request using UpdateRequestValidatorRequest. req := client.UpdateRequestValidatorRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateResourceRequest ¶ added in v0.9.0
func (c *Client) UpdateResourceRequest(input *UpdateResourceInput) UpdateResourceRequest
UpdateResourceRequest returns a request value for making API operation for Amazon API Gateway.
Changes information about a Resource resource.
// Example sending a request using UpdateResourceRequest. req := client.UpdateResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateRestApiRequest ¶ added in v0.9.0
func (c *Client) UpdateRestApiRequest(input *UpdateRestApiInput) UpdateRestApiRequest
UpdateRestApiRequest returns a request value for making API operation for Amazon API Gateway.
Changes information about the specified API.
// Example sending a request using UpdateRestApiRequest. req := client.UpdateRestApiRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateStageRequest ¶ added in v0.9.0
func (c *Client) UpdateStageRequest(input *UpdateStageInput) UpdateStageRequest
UpdateStageRequest returns a request value for making API operation for Amazon API Gateway.
Changes information about a Stage resource.
// Example sending a request using UpdateStageRequest. req := client.UpdateStageRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateUsagePlanRequest ¶ added in v0.9.0
func (c *Client) UpdateUsagePlanRequest(input *UpdateUsagePlanInput) UpdateUsagePlanRequest
UpdateUsagePlanRequest returns a request value for making API operation for Amazon API Gateway.
Updates a usage plan of a given plan Id.
// Example sending a request using UpdateUsagePlanRequest. req := client.UpdateUsagePlanRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateUsageRequest ¶ added in v0.9.0
func (c *Client) UpdateUsageRequest(input *UpdateUsageInput) UpdateUsageRequest
UpdateUsageRequest returns a request value for making API operation for Amazon API Gateway.
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
// Example sending a request using UpdateUsageRequest. req := client.UpdateUsageRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UpdateVpcLinkRequest ¶ added in v0.9.0
func (c *Client) UpdateVpcLinkRequest(input *UpdateVpcLinkInput) UpdateVpcLinkRequest
UpdateVpcLinkRequest returns a request value for making API operation for Amazon API Gateway.
Updates an existing VpcLink of a specified identifier.
// Example sending a request using UpdateVpcLinkRequest. req := client.UpdateVpcLinkRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
type ConnectionType ¶ added in v0.2.0
type ConnectionType string
const ( ConnectionTypeInternet ConnectionType = "INTERNET" ConnectionTypeVpcLink ConnectionType = "VPC_LINK" )
Enum values for ConnectionType
func (ConnectionType) MarshalValue ¶ added in v0.3.0
func (enum ConnectionType) MarshalValue() (string, error)
func (ConnectionType) MarshalValueBuf ¶ added in v0.3.0
func (enum ConnectionType) MarshalValueBuf(b []byte) ([]byte, error)
type ContentHandlingStrategy ¶
type ContentHandlingStrategy string
const ( ContentHandlingStrategyConvertToBinary ContentHandlingStrategy = "CONVERT_TO_BINARY" ContentHandlingStrategyConvertToText ContentHandlingStrategy = "CONVERT_TO_TEXT" )
Enum values for ContentHandlingStrategy
func (ContentHandlingStrategy) MarshalValue ¶ added in v0.3.0
func (enum ContentHandlingStrategy) MarshalValue() (string, error)
func (ContentHandlingStrategy) MarshalValueBuf ¶ added in v0.3.0
func (enum ContentHandlingStrategy) MarshalValueBuf(b []byte) ([]byte, error)
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. This parameter is deprecated and should not be // used. 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"` // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. // The tag key can be up to 128 characters and must not start with aws:. The // tag value can be up to 256 characters. Tags map[string]string `locationName:"tags" type:"map"` // 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) MarshalFields ¶ added in v0.3.0
func (s CreateApiKeyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateApiKeyInput) String ¶
func (s CreateApiKeyInput) String() string
String returns the string representation
type CreateApiKeyOutput ¶ added in v0.9.0
type CreateApiKeyOutput struct { // The timestamp when the API Key was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // An AWS Marketplace customer identifier , when integrating with the AWS SaaS // Marketplace. CustomerId *string `locationName:"customerId" type:"string"` // The description of the API Key. Description *string `locationName:"description" type:"string"` // Specifies whether the API Key can be used by callers. Enabled *bool `locationName:"enabled" type:"boolean"` // The identifier of the API Key. Id *string `locationName:"id" type:"string"` // The timestamp when the API Key was last updated. LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp"` // 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 collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html)
func (CreateApiKeyOutput) MarshalFields ¶ added in v0.9.0
func (s CreateApiKeyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateApiKeyOutput) String ¶ added in v0.9.0
func (s CreateApiKeyOutput) String() string
String returns the string representation
type CreateApiKeyRequest ¶
type CreateApiKeyRequest struct { *aws.Request Input *CreateApiKeyInput Copy func(*CreateApiKeyInput) CreateApiKeyRequest }
CreateApiKeyRequest is the request type for the CreateApiKey API operation.
func (CreateApiKeyRequest) Send ¶
func (r CreateApiKeyRequest) Send(ctx context.Context) (*CreateApiKeyResponse, error)
Send marshals and sends the CreateApiKey API request.
type CreateApiKeyResponse ¶ added in v0.9.0
type CreateApiKeyResponse struct { *CreateApiKeyOutput // contains filtered or unexported fields }
CreateApiKeyResponse is the response type for the CreateApiKey API operation.
func (*CreateApiKeyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateApiKeyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateApiKey request.
type CreateAuthorizerInput ¶
type CreateAuthorizerInput struct { // Optional customer-defined field, used in OpenAPI imports and exports without // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the required credentials as an IAM role for API Gateway to invoke // the authorizer. To specify an IAM role for API Gateway to assume, use the // role's Amazon Resource Name (ARN). To use resource-based permissions on the // Lambda function, specify null. AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"` // The TTL in seconds of cached authorizer results. If it equals 0, authorization // caching is disabled. If it is greater than 0, API Gateway will cache authorizer // responses. If this field is not set, the default value is 300. The maximum // value is 3600, or 1 hour. AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or // REQUEST authorizers, this must be a well-formed Lambda function URI, for // example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, // where {region} is the same as the region hosting the Lambda function, path // indicates that the remaining substring in the URI should be treated as the // path to the resource, including the initial /. For Lambda functions, this // is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. AuthorizerUri *string `locationName:"authorizerUri" type:"string"` // The identity source for which authorization is requested. // * For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies // the request header mapping expression for the custom header holding the // authorization token submitted by the client. For example, if the token // header name is Auth, the header mapping expression is method.request.header.Auth. // // * For the REQUEST authorizer, this is required when authorization caching // is enabled. The value is a comma-separated string of one or more mapping // expressions of the specified request parameters. For example, if an Auth // header, a Name query string parameter are defined as identity sources, // this value is method.request.header.Auth, method.request.querystring.Name. // These parameters will be used to derive the authorization caching key // and to perform runtime validation of the REQUEST authorizer by verifying // all of the identity-related request parameters are present, not null and // non-empty. Only when this is true does the authorizer invoke the authorizer // Lambda function, otherwise, it returns a 401 Unauthorized response without // calling the Lambda function. The valid value is a string of comma-separated // mapping expressions of the specified request parameters. When the authorization // caching is not enabled, this property is optional. IdentitySource *string `locationName:"identitySource" type:"string"` // A validation expression for the incoming identity token. For TOKEN authorizers, // this value is a regular expression. For COGNITO_USER_POOLS authorizers, API // Gateway will match the aud field of the incoming token from the client against // the specified regular expression. It will invoke the authorizer's Lambda // function when there is a match. Otherwise, it will return a 401 Unauthorized // response without calling the Lambda function. The validation expression does // not apply to the REQUEST authorizer. IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` // [Required] The name of the authorizer. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. // Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. // For a TOKEN or REQUEST authorizer, this is not defined. ProviderARNs []string `locationName:"providerARNs" type:"list"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The authorizer type. Valid values are TOKEN for a Lambda function // using a single authorization token submitted in a custom header, REQUEST // for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS // for using an Amazon Cognito user pool. // // Type is a required field Type AuthorizerType `locationName:"type" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Request to add a new Authorizer to an existing RestApi resource.
func (CreateAuthorizerInput) MarshalFields ¶ added in v0.3.0
func (s CreateAuthorizerInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateAuthorizerInput) String ¶
func (s CreateAuthorizerInput) String() string
String returns the string representation
func (*CreateAuthorizerInput) Validate ¶
func (s *CreateAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateAuthorizerOutput ¶ added in v0.9.0
type CreateAuthorizerOutput struct { // Optional customer-defined field, used in OpenAPI imports and exports without // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the required credentials as an IAM role for API Gateway to invoke // the authorizer. To specify an IAM role for API Gateway to assume, use the // role's Amazon Resource Name (ARN). To use resource-based permissions on the // Lambda function, specify null. AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"` // The TTL in seconds of cached authorizer results. If it equals 0, authorization // caching is disabled. If it is greater than 0, API Gateway will cache authorizer // responses. If this field is not set, the default value is 300. The maximum // value is 3600, or 1 hour. AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or // REQUEST authorizers, this must be a well-formed Lambda function URI, for // example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, // where {region} is the same as the region hosting the Lambda function, path // indicates that the remaining substring in the URI should be treated as the // path to the resource, including the initial /. For Lambda functions, this // is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. AuthorizerUri *string `locationName:"authorizerUri" type:"string"` // The identifier for the authorizer resource. Id *string `locationName:"id" type:"string"` // The identity source for which authorization is requested. // * For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies // the request header mapping expression for the custom header holding the // authorization token submitted by the client. For example, if the token // header name is Auth, the header mapping expression is method.request.header.Auth. // // * For the REQUEST authorizer, this is required when authorization caching // is enabled. The value is a comma-separated string of one or more mapping // expressions of the specified request parameters. For example, if an Auth // header, a Name query string parameter are defined as identity sources, // this value is method.request.header.Auth, method.request.querystring.Name. // These parameters will be used to derive the authorization caching key // and to perform runtime validation of the REQUEST authorizer by verifying // all of the identity-related request parameters are present, not null and // non-empty. Only when this is true does the authorizer invoke the authorizer // Lambda function, otherwise, it returns a 401 Unauthorized response without // calling the Lambda function. The valid value is a string of comma-separated // mapping expressions of the specified request parameters. When the authorization // caching is not enabled, this property is optional. IdentitySource *string `locationName:"identitySource" type:"string"` // A validation expression for the incoming identity token. For TOKEN authorizers, // this value is a regular expression. For COGNITO_USER_POOLS authorizers, API // Gateway will match the aud field of the incoming token from the client against // the specified regular expression. It will invoke the authorizer's Lambda // function when there is a match. Otherwise, it will return a 401 Unauthorized // response without calling the Lambda function. The validation expression does // not apply to the REQUEST authorizer. IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` // [Required] The name of the authorizer. Name *string `locationName:"name" type:"string"` // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. // Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. // For a TOKEN or REQUEST authorizer, this is not defined. ProviderARNs []string `locationName:"providerARNs" type:"list"` // The authorizer type. Valid values are TOKEN for a Lambda function using a // single authorization token submitted in a custom header, REQUEST for a Lambda // function using incoming request parameters, and COGNITO_USER_POOLS for using // an Amazon Cognito user pool. Type AuthorizerType `locationName:"type" type:"string" enum:"true"` // contains filtered or unexported fields }
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
Use Lambda Function as Authorizer (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html) Use Cognito User Pool as Authorizer (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html)
func (CreateAuthorizerOutput) MarshalFields ¶ added in v0.9.0
func (s CreateAuthorizerOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateAuthorizerOutput) String ¶ added in v0.9.0
func (s CreateAuthorizerOutput) String() string
String returns the string representation
type CreateAuthorizerRequest ¶
type CreateAuthorizerRequest struct { *aws.Request Input *CreateAuthorizerInput Copy func(*CreateAuthorizerInput) CreateAuthorizerRequest }
CreateAuthorizerRequest is the request type for the CreateAuthorizer API operation.
func (CreateAuthorizerRequest) Send ¶
func (r CreateAuthorizerRequest) Send(ctx context.Context) (*CreateAuthorizerResponse, error)
Send marshals and sends the CreateAuthorizer API request.
type CreateAuthorizerResponse ¶ added in v0.9.0
type CreateAuthorizerResponse struct { *CreateAuthorizerOutput // contains filtered or unexported fields }
CreateAuthorizerResponse is the response type for the CreateAuthorizer API operation.
func (*CreateAuthorizerResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateAuthorizerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateAuthorizer request.
type CreateBasePathMappingInput ¶
type CreateBasePathMappingInput struct { // The base path name that callers of the API must provide as part of the URL // after the domain name. This value must be unique for all of the mappings // across a single API. Specify '(none)' if you do not want callers to specify // a base path name after the domain name. BasePath *string `locationName:"basePath" type:"string"` // [Required] 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `locationName:"restApiId" type:"string" required:"true"` // The name of the API's stage that you want to use for this mapping. Specify // '(none)' if you 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 API Gateway to create a new BasePathMapping resource.
func (CreateBasePathMappingInput) MarshalFields ¶ added in v0.3.0
func (s CreateBasePathMappingInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateBasePathMappingInput) String ¶
func (s CreateBasePathMappingInput) String() string
String returns the string representation
func (*CreateBasePathMappingInput) Validate ¶
func (s *CreateBasePathMappingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateBasePathMappingOutput ¶ added in v0.9.0
type CreateBasePathMappingOutput struct { // The base path name that callers of the API must provide as part of the URL // after the domain name. BasePath *string `locationName:"basePath" type:"string"` // The string identifier of the associated RestApi. RestApiId *string `locationName:"restApiId" type:"string"` // The name of the associated stage. Stage *string `locationName:"stage" type:"string"` // contains filtered or unexported fields }
Represents the base path that callers of the API must provide as part of the URL after the domain name.
A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.
Use Custom Domain Names (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (CreateBasePathMappingOutput) MarshalFields ¶ added in v0.9.0
func (s CreateBasePathMappingOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateBasePathMappingOutput) String ¶ added in v0.9.0
func (s CreateBasePathMappingOutput) String() string
String returns the string representation
type CreateBasePathMappingRequest ¶
type CreateBasePathMappingRequest struct { *aws.Request Input *CreateBasePathMappingInput Copy func(*CreateBasePathMappingInput) CreateBasePathMappingRequest }
CreateBasePathMappingRequest is the request type for the CreateBasePathMapping API operation.
func (CreateBasePathMappingRequest) Send ¶
func (r CreateBasePathMappingRequest) Send(ctx context.Context) (*CreateBasePathMappingResponse, error)
Send marshals and sends the CreateBasePathMapping API request.
type CreateBasePathMappingResponse ¶ added in v0.9.0
type CreateBasePathMappingResponse struct { *CreateBasePathMappingOutput // contains filtered or unexported fields }
CreateBasePathMappingResponse is the response type for the CreateBasePathMapping API operation.
func (*CreateBasePathMappingResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateBasePathMappingResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateBasePathMapping request.
type CreateDeploymentInput ¶
type CreateDeploymentInput struct { // Enables a cache cluster for the Stage resource specified in the input. CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` // Specifies the cache cluster size for the Stage resource specified in the // input, if a cache cluster is enabled. CacheClusterSize CacheClusterSize `locationName:"cacheClusterSize" type:"string" enum:"true"` // The input configuration for the canary deployment when the deployment is // a canary release deployment. CanarySettings *DeploymentCanarySettings `locationName:"canarySettings" type:"structure"` // The description for the Deployment resource to create. Description *string `locationName:"description" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The 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"` // Specifies whether active tracing with X-ray is enabled for the Stage. TracingEnabled *bool `locationName:"tracingEnabled" type:"boolean"` // 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 API Gateway to create a Deployment resource.
func (CreateDeploymentInput) MarshalFields ¶ added in v0.3.0
func (s CreateDeploymentInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateDeploymentInput) String ¶
func (s CreateDeploymentInput) String() string
String returns the string representation
func (*CreateDeploymentInput) Validate ¶
func (s *CreateDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDeploymentOutput ¶ added in v0.9.0
type CreateDeploymentOutput 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"` // 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 (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html), AWS SDKs (https://aws.amazon.com/tools/)
func (CreateDeploymentOutput) MarshalFields ¶ added in v0.9.0
func (s CreateDeploymentOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateDeploymentOutput) String ¶ added in v0.9.0
func (s CreateDeploymentOutput) String() string
String returns the string representation
type CreateDeploymentRequest ¶
type CreateDeploymentRequest struct { *aws.Request Input *CreateDeploymentInput Copy func(*CreateDeploymentInput) CreateDeploymentRequest }
CreateDeploymentRequest is the request type for the CreateDeployment API operation.
func (CreateDeploymentRequest) Send ¶
func (r CreateDeploymentRequest) Send(ctx context.Context) (*CreateDeploymentResponse, error)
Send marshals and sends the CreateDeployment API request.
type CreateDeploymentResponse ¶ added in v0.9.0
type CreateDeploymentResponse struct { *CreateDeploymentOutput // contains filtered or unexported fields }
CreateDeploymentResponse is the response type for the CreateDeployment API operation.
func (*CreateDeploymentResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateDeploymentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateDeployment request.
type CreateDocumentationPartInput ¶
type CreateDocumentationPartInput struct { // [Required] The location of the targeted API entity of the to-be-created documentation // part. // // Location is a required field Location *DocumentationPartLocation `locationName:"location" type:"structure" required:"true"` // [Required] The new documentation content map of the targeted API entity. // Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value // pairs can be exported and, hence, published. // // Properties is a required field Properties *string `locationName:"properties" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Creates a new documentation part of a given API.
func (CreateDocumentationPartInput) MarshalFields ¶ added in v0.3.0
func (s CreateDocumentationPartInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateDocumentationPartInput) String ¶
func (s CreateDocumentationPartInput) String() string
String returns the string representation
func (*CreateDocumentationPartInput) Validate ¶
func (s *CreateDocumentationPartInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDocumentationPartOutput ¶ added in v0.9.0
type CreateDocumentationPartOutput struct { // The DocumentationPart identifier, generated by 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 OpenAPI-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 OpenAPI 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 OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.
Documenting an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationParts
func (CreateDocumentationPartOutput) MarshalFields ¶ added in v0.9.0
func (s CreateDocumentationPartOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateDocumentationPartOutput) String ¶ added in v0.9.0
func (s CreateDocumentationPartOutput) String() string
String returns the string representation
type CreateDocumentationPartRequest ¶
type CreateDocumentationPartRequest struct { *aws.Request Input *CreateDocumentationPartInput Copy func(*CreateDocumentationPartInput) CreateDocumentationPartRequest }
CreateDocumentationPartRequest is the request type for the CreateDocumentationPart API operation.
func (CreateDocumentationPartRequest) Send ¶
func (r CreateDocumentationPartRequest) Send(ctx context.Context) (*CreateDocumentationPartResponse, error)
Send marshals and sends the CreateDocumentationPart API request.
type CreateDocumentationPartResponse ¶ added in v0.9.0
type CreateDocumentationPartResponse struct { *CreateDocumentationPartOutput // contains filtered or unexported fields }
CreateDocumentationPartResponse is the response type for the CreateDocumentationPart API operation.
func (*CreateDocumentationPartResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateDocumentationPartResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateDocumentationPart request.
type CreateDocumentationVersionInput ¶
type CreateDocumentationVersionInput struct { // A description about the new documentation snapshot. Description *string `locationName:"description" type:"string"` // [Required] The version identifier of the new snapshot. // // DocumentationVersion is a required field DocumentationVersion *string `locationName:"documentationVersion" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The stage name to be associated with the new documentation snapshot. StageName *string `locationName:"stageName" type:"string"` // contains filtered or unexported fields }
Creates a new documentation version of a given API.
func (CreateDocumentationVersionInput) MarshalFields ¶ added in v0.3.0
func (s CreateDocumentationVersionInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateDocumentationVersionInput) String ¶
func (s CreateDocumentationVersionInput) String() string
String returns the string representation
func (*CreateDocumentationVersionInput) Validate ¶
func (s *CreateDocumentationVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDocumentationVersionOutput ¶ added in v0.9.0
type CreateDocumentationVersionOutput struct { // The date when the API documentation snapshot is created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // 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., OpenAPI) file.
Documenting an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart, DocumentationVersions
func (CreateDocumentationVersionOutput) MarshalFields ¶ added in v0.9.0
func (s CreateDocumentationVersionOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateDocumentationVersionOutput) String ¶ added in v0.9.0
func (s CreateDocumentationVersionOutput) String() string
String returns the string representation
type CreateDocumentationVersionRequest ¶
type CreateDocumentationVersionRequest struct { *aws.Request Input *CreateDocumentationVersionInput Copy func(*CreateDocumentationVersionInput) CreateDocumentationVersionRequest }
CreateDocumentationVersionRequest is the request type for the CreateDocumentationVersion API operation.
func (CreateDocumentationVersionRequest) Send ¶
func (r CreateDocumentationVersionRequest) Send(ctx context.Context) (*CreateDocumentationVersionResponse, error)
Send marshals and sends the CreateDocumentationVersion API request.
type CreateDocumentationVersionResponse ¶ added in v0.9.0
type CreateDocumentationVersionResponse struct { *CreateDocumentationVersionOutput // contains filtered or unexported fields }
CreateDocumentationVersionResponse is the response type for the CreateDocumentationVersion API operation.
func (*CreateDocumentationVersionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateDocumentationVersionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateDocumentationVersion request.
type CreateDomainNameInput ¶
type CreateDomainNameInput struct { // The reference to an AWS-managed certificate that will be used by edge-optimized // endpoint for this domain name. AWS Certificate Manager is the only supported // source. CertificateArn *string `locationName:"certificateArn" type:"string"` // [Deprecated] The body of the server certificate that will be used by edge-optimized // endpoint for this domain name provided by your certificate authority. CertificateBody *string `locationName:"certificateBody" type:"string"` // [Deprecated] The intermediate certificates and optionally the root certificate, // one after the other without any blank lines, used by an edge-optimized endpoint // for this domain name. If you include the root certificate, your certificate // chain must start with intermediate certificates and end with the root certificate. // Use the intermediate certificates that were provided by your certificate // authority. Do not include any intermediaries that are not in the chain of // trust path. CertificateChain *string `locationName:"certificateChain" type:"string"` // The user-friendly name of the certificate that will be used by edge-optimized // endpoint for this domain name. CertificateName *string `locationName:"certificateName" type:"string"` // [Deprecated] Your edge-optimized endpoint's domain name certificate's private // key. CertificatePrivateKey *string `locationName:"certificatePrivateKey" type:"string"` // [Required] The name of the DomainName resource. // // DomainName is a required field DomainName *string `locationName:"domainName" type:"string" required:"true"` // The endpoint configuration of this DomainName showing the endpoint types // of the domain name. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The reference to an AWS-managed certificate that will be used by regional // endpoint for this domain name. AWS Certificate Manager is the only supported // source. RegionalCertificateArn *string `locationName:"regionalCertificateArn" type:"string"` // The user-friendly name of the certificate that will be used by regional endpoint // for this domain name. RegionalCertificateName *string `locationName:"regionalCertificateName" type:"string"` // The Transport Layer Security (TLS) version + cipher suite for this DomainName. // The valid values are TLS_1_0 and TLS_1_2. SecurityPolicy SecurityPolicy `locationName:"securityPolicy" type:"string" enum:"true"` // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. // The tag key can be up to 128 characters and must not start with aws:. The // tag value can be up to 256 characters. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
A request to create a new domain name.
func (CreateDomainNameInput) MarshalFields ¶ added in v0.3.0
func (s CreateDomainNameInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateDomainNameInput) String ¶
func (s CreateDomainNameInput) String() string
String returns the string representation
func (*CreateDomainNameInput) Validate ¶
func (s *CreateDomainNameInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDomainNameOutput ¶ added in v0.9.0
type CreateDomainNameOutput struct { // The reference to an AWS-managed certificate that will be used by edge-optimized // endpoint for this domain name. AWS Certificate Manager is the only supported // source. CertificateArn *string `locationName:"certificateArn" type:"string"` // The name of the certificate that will be used by edge-optimized endpoint // for this domain name. CertificateName *string `locationName:"certificateName" type:"string"` // The timestamp when the certificate that was used by edge-optimized endpoint // for this domain name was uploaded. CertificateUploadDate *time.Time `locationName:"certificateUploadDate" type:"timestamp"` // The domain name of the Amazon CloudFront distribution associated with this // custom domain name for an edge-optimized endpoint. You set up this association // when adding a DNS record pointing the custom domain name to this distribution // name. For more information about CloudFront distributions, see the Amazon // CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/). DistributionDomainName *string `locationName:"distributionDomainName" type:"string"` // The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized // endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more // information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) // and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). DistributionHostedZoneId *string `locationName:"distributionHostedZoneId" type:"string"` // The custom domain name as an API host name, for example, my-api.example.com. DomainName *string `locationName:"domainName" type:"string"` // The status of the DomainName migration. The valid values are AVAILABLE and // UPDATING. If the status is UPDATING, the domain cannot be modified further // until the existing operation is complete. If it is AVAILABLE, the domain // can be updated. DomainNameStatus DomainNameStatus `locationName:"domainNameStatus" type:"string" enum:"true"` // An optional text message containing detailed information about status of // the DomainName migration. DomainNameStatusMessage *string `locationName:"domainNameStatusMessage" type:"string"` // The endpoint configuration of this DomainName showing the endpoint types // of the domain name. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The reference to an AWS-managed certificate that will be used for validating // the regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string `locationName:"regionalCertificateArn" type:"string"` // The name of the certificate that will be used for validating the regional // domain name. RegionalCertificateName *string `locationName:"regionalCertificateName" type:"string"` // The domain name associated with the regional endpoint for this custom domain // name. You set up this association by adding a DNS record that points the // custom domain name to this regional domain name. The regional domain name // is returned by API Gateway when you create a regional endpoint. RegionalDomainName *string `locationName:"regionalDomainName" type:"string"` // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. // For more information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) // and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). RegionalHostedZoneId *string `locationName:"regionalHostedZoneId" type:"string"` // The Transport Layer Security (TLS) version + cipher suite for this DomainName. // The valid values are TLS_1_0 and TLS_1_2. SecurityPolicy SecurityPolicy `locationName:"securityPolicy" type:"string" enum:"true"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
Represents a custom domain name as a user-friendly host name of an API (RestApi).
When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.
Set a Custom Host Name for an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (CreateDomainNameOutput) MarshalFields ¶ added in v0.9.0
func (s CreateDomainNameOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateDomainNameOutput) String ¶ added in v0.9.0
func (s CreateDomainNameOutput) String() string
String returns the string representation
type CreateDomainNameRequest ¶
type CreateDomainNameRequest struct { *aws.Request Input *CreateDomainNameInput Copy func(*CreateDomainNameInput) CreateDomainNameRequest }
CreateDomainNameRequest is the request type for the CreateDomainName API operation.
func (CreateDomainNameRequest) Send ¶
func (r CreateDomainNameRequest) Send(ctx context.Context) (*CreateDomainNameResponse, error)
Send marshals and sends the CreateDomainName API request.
type CreateDomainNameResponse ¶ added in v0.9.0
type CreateDomainNameResponse struct { *CreateDomainNameOutput // contains filtered or unexported fields }
CreateDomainNameResponse is the response type for the CreateDomainName API operation.
func (*CreateDomainNameResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateDomainNameResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateDomainName request.
type CreateModelInput ¶
type CreateModelInput struct { // [Required] 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"` // [Required] The name of the model. Must be alphanumeric. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // [Required] 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 4 (https://tools.ietf.org/html/draft-zyp-json-schema-04) 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) MarshalFields ¶ added in v0.3.0
func (s CreateModelInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateModelInput) String ¶
func (s CreateModelInput) String() string
String returns the string representation
func (*CreateModelInput) Validate ¶
func (s *CreateModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateModelOutput ¶ added in v0.9.0
type CreateModelOutput struct { // The content-type for the model. ContentType *string `locationName:"contentType" type:"string"` // The description of the model. Description *string `locationName:"description" type:"string"` // The identifier for the model resource. Id *string `locationName:"id" type:"string"` // The name of the model. Must be an alphanumeric string. Name *string `locationName:"name" type:"string"` // The schema for the model. For application/json models, this should be JSON // schema draft 4 (https://tools.ietf.org/html/draft-zyp-json-schema-04) 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html)
func (CreateModelOutput) MarshalFields ¶ added in v0.9.0
func (s CreateModelOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateModelOutput) String ¶ added in v0.9.0
func (s CreateModelOutput) String() string
String returns the string representation
type CreateModelRequest ¶
type CreateModelRequest struct { *aws.Request Input *CreateModelInput Copy func(*CreateModelInput) CreateModelRequest }
CreateModelRequest is the request type for the CreateModel API operation.
func (CreateModelRequest) Send ¶
func (r CreateModelRequest) Send(ctx context.Context) (*CreateModelResponse, error)
Send marshals and sends the CreateModel API request.
type CreateModelResponse ¶ added in v0.9.0
type CreateModelResponse struct { *CreateModelOutput // contains filtered or unexported fields }
CreateModelResponse is the response type for the CreateModel API operation.
func (*CreateModelResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateModelResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateModel request.
type CreateRequestValidatorInput ¶
type CreateRequestValidatorInput struct { // The name of the to-be-created RequestValidator. Name *string `locationName:"name" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // A Boolean flag to indicate whether to validate request body according to // the configured model schema for the method (true) or not (false). ValidateRequestBody *bool `locationName:"validateRequestBody" type:"boolean"` // A Boolean flag to indicate whether to validate request parameters, true, // or not false. ValidateRequestParameters *bool `locationName:"validateRequestParameters" type:"boolean"` // contains filtered or unexported fields }
Creates a RequestValidator of a given RestApi.
func (CreateRequestValidatorInput) MarshalFields ¶ added in v0.3.0
func (s CreateRequestValidatorInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateRequestValidatorInput) String ¶
func (s CreateRequestValidatorInput) String() string
String returns the string representation
func (*CreateRequestValidatorInput) Validate ¶
func (s *CreateRequestValidatorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateRequestValidatorOutput ¶ added in v0.9.0
type CreateRequestValidatorOutput struct { // The identifier of this RequestValidator. Id *string `locationName:"id" type:"string"` // The name of this RequestValidator Name *string `locationName:"name" type:"string"` // A Boolean flag to indicate whether to validate a request body according to // the configured Model schema. ValidateRequestBody *bool `locationName:"validateRequestBody" type:"boolean"` // A Boolean flag to indicate whether to validate request parameters (true) // or not (false). ValidateRequestParameters *bool `locationName:"validateRequestParameters" type:"boolean"` // contains filtered or unexported fields }
A set of validation rules for incoming Method requests.
In OpenAPI, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html) object. It the referenced using the x-amazon-apigateway-request-validator (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator) property.
Enable Basic Request Validation in API Gateway (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html)
func (CreateRequestValidatorOutput) MarshalFields ¶ added in v0.9.0
func (s CreateRequestValidatorOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateRequestValidatorOutput) String ¶ added in v0.9.0
func (s CreateRequestValidatorOutput) String() string
String returns the string representation
type CreateRequestValidatorRequest ¶
type CreateRequestValidatorRequest struct { *aws.Request Input *CreateRequestValidatorInput Copy func(*CreateRequestValidatorInput) CreateRequestValidatorRequest }
CreateRequestValidatorRequest is the request type for the CreateRequestValidator API operation.
func (CreateRequestValidatorRequest) Send ¶
func (r CreateRequestValidatorRequest) Send(ctx context.Context) (*CreateRequestValidatorResponse, error)
Send marshals and sends the CreateRequestValidator API request.
type CreateRequestValidatorResponse ¶ added in v0.9.0
type CreateRequestValidatorResponse struct { *CreateRequestValidatorOutput // contains filtered or unexported fields }
CreateRequestValidatorResponse is the response type for the CreateRequestValidator API operation.
func (*CreateRequestValidatorResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateRequestValidatorResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateRequestValidator request.
type CreateResourceInput ¶
type CreateResourceInput struct { // [Required] 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests API Gateway to create a Resource resource.
func (CreateResourceInput) MarshalFields ¶ added in v0.3.0
func (s CreateResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateResourceInput) String ¶
func (s CreateResourceInput) String() string
String returns the string representation
func (*CreateResourceInput) Validate ¶
func (s *CreateResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateResourceOutput ¶ added in v0.9.0
type CreateResourceOutput struct { // The resource's identifier. Id *string `locationName:"id" type:"string"` // The parent resource's identifier. ParentId *string `locationName:"parentId" type:"string"` // The full path for this resource. Path *string `locationName:"path" type:"string"` // The last path segment for this resource. PathPart *string `locationName:"pathPart" type:"string"` // Gets an API resource's method of a given HTTP verb. // // The resource methods are a map of methods indexed by methods' HTTP verbs // enabled on the resource. This method map is included in the 200 OK response // of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods // request. // // Example: Get the GET method of an API resource // // Request // GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: // application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z // Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", // "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", // "name": "method", "templated": true }, { "href": "https://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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (CreateResourceOutput) MarshalFields ¶ added in v0.9.0
func (s CreateResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateResourceOutput) String ¶ added in v0.9.0
func (s CreateResourceOutput) String() string
String returns the string representation
type CreateResourceRequest ¶
type CreateResourceRequest struct { *aws.Request Input *CreateResourceInput Copy func(*CreateResourceInput) CreateResourceRequest }
CreateResourceRequest is the request type for the CreateResource API operation.
func (CreateResourceRequest) Send ¶
func (r CreateResourceRequest) Send(ctx context.Context) (*CreateResourceResponse, error)
Send marshals and sends the CreateResource API request.
type CreateResourceResponse ¶ added in v0.9.0
type CreateResourceResponse struct { *CreateResourceOutput // contains filtered or unexported fields }
CreateResourceResponse is the response type for the CreateResource API operation.
func (*CreateResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateResource request.
type CreateRestApiInput ¶
type CreateRestApiInput struct { // The source of the API key for metering requests according to a usage plan. // Valid values are: // * HEADER to read the API key from the X-API-Key header of a request. // // * AUTHORIZER to read the API key from the UsageIdentifierKey from a custom // authorizer. ApiKeySource ApiKeySourceType `locationName:"apiKeySource" type:"string" enum:"true"` // The list of binary media types supported by the RestApi. By default, the // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string `locationName:"binaryMediaTypes" type:"list"` // The ID of the RestApi that you want to clone from. CloneFrom *string `locationName:"cloneFrom" type:"string"` // The description of the RestApi. Description *string `locationName:"description" type:"string"` // The endpoint configuration of this RestApi showing the endpoint types of // the API. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // A nullable integer that is used to enable compression (with non-negative // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with // a null value) on an API. When compression is enabled, compression or decompression // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int64 `locationName:"minimumCompressionSize" type:"integer"` // [Required] The name of the RestApi. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // A stringified JSON policy document that applies to this RestApi regardless // of the caller and Method configuration. Policy *string `locationName:"policy" type:"string"` // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. // The tag key can be up to 128 characters and must not start with aws:. The // tag value can be up to 256 characters. Tags map[string]string `locationName:"tags" type:"map"` // 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) MarshalFields ¶ added in v0.3.0
func (s CreateRestApiInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateRestApiInput) String ¶
func (s CreateRestApiInput) String() string
String returns the string representation
func (*CreateRestApiInput) Validate ¶
func (s *CreateRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateRestApiOutput ¶ added in v0.9.0
type CreateRestApiOutput struct { // The source of the API key for metering requests according to a usage plan. // Valid values are: // * HEADER to read the API key from the X-API-Key header of a request. // // * AUTHORIZER to read the API key from the UsageIdentifierKey from a custom // authorizer. ApiKeySource ApiKeySourceType `locationName:"apiKeySource" type:"string" enum:"true"` // The list of binary media types supported by the RestApi. By default, the // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string `locationName:"binaryMediaTypes" type:"list"` // The timestamp when the API was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The API's description. Description *string `locationName:"description" type:"string"` // The endpoint configuration of this RestApi showing the endpoint types of // the API. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The API's identifier. This identifier is unique across all of your APIs in // API Gateway. Id *string `locationName:"id" type:"string"` // A nullable integer that is used to enable compression (with non-negative // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with // a null value) on an API. When compression is enabled, compression or decompression // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int64 `locationName:"minimumCompressionSize" type:"integer"` // The API's name. Name *string `locationName:"name" type:"string"` // A stringified JSON policy document that applies to this RestApi regardless // of the caller and Method configuration. Policy *string `locationName:"policy" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (CreateRestApiOutput) MarshalFields ¶ added in v0.9.0
func (s CreateRestApiOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateRestApiOutput) String ¶ added in v0.9.0
func (s CreateRestApiOutput) String() string
String returns the string representation
type CreateRestApiRequest ¶
type CreateRestApiRequest struct { *aws.Request Input *CreateRestApiInput Copy func(*CreateRestApiInput) CreateRestApiRequest }
CreateRestApiRequest is the request type for the CreateRestApi API operation.
func (CreateRestApiRequest) Send ¶
func (r CreateRestApiRequest) Send(ctx context.Context) (*CreateRestApiResponse, error)
Send marshals and sends the CreateRestApi API request.
type CreateRestApiResponse ¶ added in v0.9.0
type CreateRestApiResponse struct { *CreateRestApiOutput // contains filtered or unexported fields }
CreateRestApiResponse is the response type for the CreateRestApi API operation.
func (*CreateRestApiResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateRestApiResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateRestApi request.
type CreateStageInput ¶
type CreateStageInput struct { // Whether cache clustering is enabled for the stage. CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` // The stage's cache cluster size. CacheClusterSize CacheClusterSize `locationName:"cacheClusterSize" type:"string" enum:"true"` // The canary deployment settings of this stage. CanarySettings *CanarySettings `locationName:"canarySettings" type:"structure"` // [Required] 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The name for the Stage resource. Stage names can only contain // alphanumeric characters, hyphens, and underscores. Maximum length is 128 // characters. // // StageName is a required field StageName *string `locationName:"stageName" type:"string" required:"true"` // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. // The tag key can be up to 128 characters and must not start with aws:. The // tag value can be up to 256 characters. Tags map[string]string `locationName:"tags" type:"map"` // Specifies whether active tracing with X-ray is enabled for the Stage. TracingEnabled *bool `locationName:"tracingEnabled" type:"boolean"` // 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 API Gateway to create a Stage resource.
func (CreateStageInput) MarshalFields ¶ added in v0.3.0
func (s CreateStageInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateStageInput) String ¶
func (s CreateStageInput) String() string
String returns the string representation
func (*CreateStageInput) Validate ¶
func (s *CreateStageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateStageOutput ¶ added in v0.9.0
type CreateStageOutput struct { // Settings for logging access in this stage. AccessLogSettings *AccessLogSettings `locationName:"accessLogSettings" type:"structure"` // Specifies whether a cache cluster is enabled for the stage. CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` // The size of the cache cluster for the stage, if enabled. CacheClusterSize CacheClusterSize `locationName:"cacheClusterSize" type:"string" enum:"true"` // The status of the cache cluster for the stage, if enabled. CacheClusterStatus CacheClusterStatus `locationName:"cacheClusterStatus" type:"string" enum:"true"` // Settings for the canary deployment in this stage. CanarySettings *CanarySettings `locationName:"canarySettings" type:"structure"` // The identifier of a client certificate for an API stage. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // The timestamp when the stage was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The identifier of the Deployment that the stage points to. DeploymentId *string `locationName:"deploymentId" type:"string"` // The stage's description. Description *string `locationName:"description" type:"string"` // The version of the associated API documentation. DocumentationVersion *string `locationName:"documentationVersion" type:"string"` // The timestamp when the stage last updated. LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp"` // 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 API Gateway. Stage names can only contain alphanumeric // characters, hyphens, and underscores. Maximum length is 128 characters. StageName *string `locationName:"stageName" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // Specifies whether active tracing with X-ray is enabled for the Stage. TracingEnabled *bool `locationName:"tracingEnabled" type:"boolean"` // 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"` // The ARN of the WebAcl associated with the Stage. WebAclArn *string `locationName:"webAclArn" type:"string"` // contains filtered or unexported fields }
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Deploy an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html)
func (CreateStageOutput) MarshalFields ¶ added in v0.9.0
func (s CreateStageOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateStageOutput) String ¶ added in v0.9.0
func (s CreateStageOutput) String() string
String returns the string representation
type CreateStageRequest ¶
type CreateStageRequest struct { *aws.Request Input *CreateStageInput Copy func(*CreateStageInput) CreateStageRequest }
CreateStageRequest is the request type for the CreateStage API operation.
func (CreateStageRequest) Send ¶
func (r CreateStageRequest) Send(ctx context.Context) (*CreateStageResponse, error)
Send marshals and sends the CreateStage API request.
type CreateStageResponse ¶ added in v0.9.0
type CreateStageResponse struct { *CreateStageOutput // contains filtered or unexported fields }
CreateStageResponse is the response type for the CreateStage API operation.
func (*CreateStageResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateStageResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateStage request.
type CreateUsagePlanInput ¶
type CreateUsagePlanInput struct { // The associated API stages of the usage plan. ApiStages []ApiStage `locationName:"apiStages" type:"list"` // The description of the usage plan. Description *string `locationName:"description" type:"string"` // [Required] 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 key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. // The tag key can be up to 128 characters and must not start with aws:. The // tag value can be up to 256 characters. Tags map[string]string `locationName:"tags" type:"map"` // 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) MarshalFields ¶ added in v0.3.0
func (s CreateUsagePlanInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateUsagePlanInput) String ¶
func (s CreateUsagePlanInput) String() string
String returns the string representation
func (*CreateUsagePlanInput) Validate ¶
func (s *CreateUsagePlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUsagePlanKeyInput ¶
type CreateUsagePlanKeyInput struct { // [Required] The identifier of a UsagePlanKey resource for a plan customer. // // KeyId is a required field KeyId *string `locationName:"keyId" type:"string" required:"true"` // [Required] The type of a UsagePlanKey resource for a plan customer. // // KeyType is a required field KeyType *string `locationName:"keyType" type:"string" required:"true"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s CreateUsagePlanKeyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateUsagePlanKeyInput) String ¶
func (s CreateUsagePlanKeyInput) String() string
String returns the string representation
func (*CreateUsagePlanKeyInput) Validate ¶
func (s *CreateUsagePlanKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUsagePlanKeyOutput ¶ added in v0.9.0
type CreateUsagePlanKeyOutput 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (CreateUsagePlanKeyOutput) MarshalFields ¶ added in v0.9.0
func (s CreateUsagePlanKeyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateUsagePlanKeyOutput) String ¶ added in v0.9.0
func (s CreateUsagePlanKeyOutput) String() string
String returns the string representation
type CreateUsagePlanKeyRequest ¶
type CreateUsagePlanKeyRequest struct { *aws.Request Input *CreateUsagePlanKeyInput Copy func(*CreateUsagePlanKeyInput) CreateUsagePlanKeyRequest }
CreateUsagePlanKeyRequest is the request type for the CreateUsagePlanKey API operation.
func (CreateUsagePlanKeyRequest) Send ¶
func (r CreateUsagePlanKeyRequest) Send(ctx context.Context) (*CreateUsagePlanKeyResponse, error)
Send marshals and sends the CreateUsagePlanKey API request.
type CreateUsagePlanKeyResponse ¶ added in v0.9.0
type CreateUsagePlanKeyResponse struct { *CreateUsagePlanKeyOutput // contains filtered or unexported fields }
CreateUsagePlanKeyResponse is the response type for the CreateUsagePlanKey API operation.
func (*CreateUsagePlanKeyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateUsagePlanKeyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateUsagePlanKey request.
type CreateUsagePlanOutput ¶ added in v0.9.0
type CreateUsagePlanOutput 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 collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (CreateUsagePlanOutput) MarshalFields ¶ added in v0.9.0
func (s CreateUsagePlanOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateUsagePlanOutput) String ¶ added in v0.9.0
func (s CreateUsagePlanOutput) String() string
String returns the string representation
type CreateUsagePlanRequest ¶
type CreateUsagePlanRequest struct { *aws.Request Input *CreateUsagePlanInput Copy func(*CreateUsagePlanInput) CreateUsagePlanRequest }
CreateUsagePlanRequest is the request type for the CreateUsagePlan API operation.
func (CreateUsagePlanRequest) Send ¶
func (r CreateUsagePlanRequest) Send(ctx context.Context) (*CreateUsagePlanResponse, error)
Send marshals and sends the CreateUsagePlan API request.
type CreateUsagePlanResponse ¶ added in v0.9.0
type CreateUsagePlanResponse struct { *CreateUsagePlanOutput // contains filtered or unexported fields }
CreateUsagePlanResponse is the response type for the CreateUsagePlan API operation.
func (*CreateUsagePlanResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateUsagePlanResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateUsagePlan request.
type CreateVpcLinkInput ¶ added in v0.2.0
type CreateVpcLinkInput struct { // The description of the VPC link. Description *string `locationName:"description" type:"string"` // [Required] The name used to label and identify the VPC link. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. // The tag key can be up to 128 characters and must not start with aws:. The // tag value can be up to 256 characters. Tags map[string]string `locationName:"tags" type:"map"` // [Required] The ARN of the network load balancer of the VPC targeted by the // VPC link. The network load balancer must be owned by the same AWS account // of the API owner. // // TargetArns is a required field TargetArns []string `locationName:"targetArns" type:"list" required:"true"` // contains filtered or unexported fields }
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
func (CreateVpcLinkInput) MarshalFields ¶ added in v0.3.0
func (s CreateVpcLinkInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateVpcLinkInput) String ¶ added in v0.2.0
func (s CreateVpcLinkInput) String() string
String returns the string representation
func (*CreateVpcLinkInput) Validate ¶ added in v0.2.0
func (s *CreateVpcLinkInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateVpcLinkOutput ¶ added in v0.9.0
type CreateVpcLinkOutput struct { // The description of the VPC link. Description *string `locationName:"description" type:"string"` // The identifier of the VpcLink. It is used in an Integration to reference // this VpcLink. Id *string `locationName:"id" type:"string"` // The name used to label and identify the VPC link. Name *string `locationName:"name" type:"string"` // The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, // or FAILED. Deploying an API will wait if the status is PENDING and will fail // if the status is DELETING. Status VpcLinkStatus `locationName:"status" type:"string" enum:"true"` // A description about the VPC link status. StatusMessage *string `locationName:"statusMessage" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // The ARN of the network load balancer of the VPC targeted by the VPC link. // The network load balancer must be owned by the same AWS account of the API // owner. TargetArns []string `locationName:"targetArns" type:"list"` // contains filtered or unexported fields }
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.
func (CreateVpcLinkOutput) MarshalFields ¶ added in v0.9.0
func (s CreateVpcLinkOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateVpcLinkOutput) String ¶ added in v0.9.0
func (s CreateVpcLinkOutput) String() string
String returns the string representation
type CreateVpcLinkRequest ¶ added in v0.2.0
type CreateVpcLinkRequest struct { *aws.Request Input *CreateVpcLinkInput Copy func(*CreateVpcLinkInput) CreateVpcLinkRequest }
CreateVpcLinkRequest is the request type for the CreateVpcLink API operation.
func (CreateVpcLinkRequest) Send ¶ added in v0.2.0
func (r CreateVpcLinkRequest) Send(ctx context.Context) (*CreateVpcLinkResponse, error)
Send marshals and sends the CreateVpcLink API request.
type CreateVpcLinkResponse ¶ added in v0.9.0
type CreateVpcLinkResponse struct { *CreateVpcLinkOutput // contains filtered or unexported fields }
CreateVpcLinkResponse is the response type for the CreateVpcLink API operation.
func (*CreateVpcLinkResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateVpcLinkResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateVpcLink request.
type DeleteApiKeyInput ¶
type DeleteApiKeyInput struct { // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s DeleteApiKeyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteApiKeyInput) String ¶
func (s DeleteApiKeyInput) String() string
String returns the string representation
func (*DeleteApiKeyInput) Validate ¶
func (s *DeleteApiKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApiKeyOutput ¶
type DeleteApiKeyOutput struct {
// contains filtered or unexported fields
}
func (DeleteApiKeyOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteApiKeyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteApiKeyOutput) String ¶
func (s DeleteApiKeyOutput) String() string
String returns the string representation
type DeleteApiKeyRequest ¶
type DeleteApiKeyRequest struct { *aws.Request Input *DeleteApiKeyInput Copy func(*DeleteApiKeyInput) DeleteApiKeyRequest }
DeleteApiKeyRequest is the request type for the DeleteApiKey API operation.
func (DeleteApiKeyRequest) Send ¶
func (r DeleteApiKeyRequest) Send(ctx context.Context) (*DeleteApiKeyResponse, error)
Send marshals and sends the DeleteApiKey API request.
type DeleteApiKeyResponse ¶ added in v0.9.0
type DeleteApiKeyResponse struct { *DeleteApiKeyOutput // contains filtered or unexported fields }
DeleteApiKeyResponse is the response type for the DeleteApiKey API operation.
func (*DeleteApiKeyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteApiKeyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteApiKey request.
type DeleteAuthorizerInput ¶
type DeleteAuthorizerInput struct { // [Required] The identifier of the Authorizer resource. // // AuthorizerId is a required field AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete an existing Authorizer resource.
func (DeleteAuthorizerInput) MarshalFields ¶ added in v0.3.0
func (s DeleteAuthorizerInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteAuthorizerInput) String ¶
func (s DeleteAuthorizerInput) String() string
String returns the string representation
func (*DeleteAuthorizerInput) Validate ¶
func (s *DeleteAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAuthorizerOutput ¶
type DeleteAuthorizerOutput struct {
// contains filtered or unexported fields
}
func (DeleteAuthorizerOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteAuthorizerOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteAuthorizerOutput) String ¶
func (s DeleteAuthorizerOutput) String() string
String returns the string representation
type DeleteAuthorizerRequest ¶
type DeleteAuthorizerRequest struct { *aws.Request Input *DeleteAuthorizerInput Copy func(*DeleteAuthorizerInput) DeleteAuthorizerRequest }
DeleteAuthorizerRequest is the request type for the DeleteAuthorizer API operation.
func (DeleteAuthorizerRequest) Send ¶
func (r DeleteAuthorizerRequest) Send(ctx context.Context) (*DeleteAuthorizerResponse, error)
Send marshals and sends the DeleteAuthorizer API request.
type DeleteAuthorizerResponse ¶ added in v0.9.0
type DeleteAuthorizerResponse struct { *DeleteAuthorizerOutput // contains filtered or unexported fields }
DeleteAuthorizerResponse is the response type for the DeleteAuthorizer API operation.
func (*DeleteAuthorizerResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteAuthorizerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteAuthorizer request.
type DeleteBasePathMappingInput ¶
type DeleteBasePathMappingInput struct { // [Required] The base path name of the BasePathMapping resource to delete. // // To specify an empty base path, set this parameter to '(none)'. // // BasePath is a required field BasePath *string `location:"uri" locationName:"base_path" type:"string" required:"true"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s DeleteBasePathMappingInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteBasePathMappingInput) String ¶
func (s DeleteBasePathMappingInput) String() string
String returns the string representation
func (*DeleteBasePathMappingInput) Validate ¶
func (s *DeleteBasePathMappingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBasePathMappingOutput ¶
type DeleteBasePathMappingOutput struct {
// contains filtered or unexported fields
}
func (DeleteBasePathMappingOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteBasePathMappingOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteBasePathMappingOutput) String ¶
func (s DeleteBasePathMappingOutput) String() string
String returns the string representation
type DeleteBasePathMappingRequest ¶
type DeleteBasePathMappingRequest struct { *aws.Request Input *DeleteBasePathMappingInput Copy func(*DeleteBasePathMappingInput) DeleteBasePathMappingRequest }
DeleteBasePathMappingRequest is the request type for the DeleteBasePathMapping API operation.
func (DeleteBasePathMappingRequest) Send ¶
func (r DeleteBasePathMappingRequest) Send(ctx context.Context) (*DeleteBasePathMappingResponse, error)
Send marshals and sends the DeleteBasePathMapping API request.
type DeleteBasePathMappingResponse ¶ added in v0.9.0
type DeleteBasePathMappingResponse struct { *DeleteBasePathMappingOutput // contains filtered or unexported fields }
DeleteBasePathMappingResponse is the response type for the DeleteBasePathMapping API operation.
func (*DeleteBasePathMappingResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteBasePathMappingResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteBasePathMapping request.
type DeleteClientCertificateInput ¶
type DeleteClientCertificateInput struct { // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s DeleteClientCertificateInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteClientCertificateInput) String ¶
func (s DeleteClientCertificateInput) String() string
String returns the string representation
func (*DeleteClientCertificateInput) Validate ¶
func (s *DeleteClientCertificateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteClientCertificateOutput ¶
type DeleteClientCertificateOutput struct {
// contains filtered or unexported fields
}
func (DeleteClientCertificateOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteClientCertificateOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteClientCertificateOutput) String ¶
func (s DeleteClientCertificateOutput) String() string
String returns the string representation
type DeleteClientCertificateRequest ¶
type DeleteClientCertificateRequest struct { *aws.Request Input *DeleteClientCertificateInput Copy func(*DeleteClientCertificateInput) DeleteClientCertificateRequest }
DeleteClientCertificateRequest is the request type for the DeleteClientCertificate API operation.
func (DeleteClientCertificateRequest) Send ¶
func (r DeleteClientCertificateRequest) Send(ctx context.Context) (*DeleteClientCertificateResponse, error)
Send marshals and sends the DeleteClientCertificate API request.
type DeleteClientCertificateResponse ¶ added in v0.9.0
type DeleteClientCertificateResponse struct { *DeleteClientCertificateOutput // contains filtered or unexported fields }
DeleteClientCertificateResponse is the response type for the DeleteClientCertificate API operation.
func (*DeleteClientCertificateResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteClientCertificateResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteClientCertificate request.
type DeleteDeploymentInput ¶
type DeleteDeploymentInput struct { // [Required] The identifier of the Deployment resource to delete. // // DeploymentId is a required field DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests API Gateway to delete a Deployment resource.
func (DeleteDeploymentInput) MarshalFields ¶ added in v0.3.0
func (s DeleteDeploymentInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteDeploymentInput) String ¶
func (s DeleteDeploymentInput) String() string
String returns the string representation
func (*DeleteDeploymentInput) Validate ¶
func (s *DeleteDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDeploymentOutput ¶
type DeleteDeploymentOutput struct {
// contains filtered or unexported fields
}
func (DeleteDeploymentOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteDeploymentOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteDeploymentOutput) String ¶
func (s DeleteDeploymentOutput) String() string
String returns the string representation
type DeleteDeploymentRequest ¶
type DeleteDeploymentRequest struct { *aws.Request Input *DeleteDeploymentInput Copy func(*DeleteDeploymentInput) DeleteDeploymentRequest }
DeleteDeploymentRequest is the request type for the DeleteDeployment API operation.
func (DeleteDeploymentRequest) Send ¶
func (r DeleteDeploymentRequest) Send(ctx context.Context) (*DeleteDeploymentResponse, error)
Send marshals and sends the DeleteDeployment API request.
type DeleteDeploymentResponse ¶ added in v0.9.0
type DeleteDeploymentResponse struct { *DeleteDeploymentOutput // contains filtered or unexported fields }
DeleteDeploymentResponse is the response type for the DeleteDeployment API operation.
func (*DeleteDeploymentResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteDeploymentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteDeployment request.
type DeleteDocumentationPartInput ¶
type DeleteDocumentationPartInput struct { // [Required] The identifier of the to-be-deleted documentation part. // // DocumentationPartId is a required field DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Deletes an existing documentation part of an API.
func (DeleteDocumentationPartInput) MarshalFields ¶ added in v0.3.0
func (s DeleteDocumentationPartInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteDocumentationPartInput) String ¶
func (s DeleteDocumentationPartInput) String() string
String returns the string representation
func (*DeleteDocumentationPartInput) Validate ¶
func (s *DeleteDocumentationPartInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDocumentationPartOutput ¶
type DeleteDocumentationPartOutput struct {
// contains filtered or unexported fields
}
func (DeleteDocumentationPartOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteDocumentationPartOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteDocumentationPartOutput) String ¶
func (s DeleteDocumentationPartOutput) String() string
String returns the string representation
type DeleteDocumentationPartRequest ¶
type DeleteDocumentationPartRequest struct { *aws.Request Input *DeleteDocumentationPartInput Copy func(*DeleteDocumentationPartInput) DeleteDocumentationPartRequest }
DeleteDocumentationPartRequest is the request type for the DeleteDocumentationPart API operation.
func (DeleteDocumentationPartRequest) Send ¶
func (r DeleteDocumentationPartRequest) Send(ctx context.Context) (*DeleteDocumentationPartResponse, error)
Send marshals and sends the DeleteDocumentationPart API request.
type DeleteDocumentationPartResponse ¶ added in v0.9.0
type DeleteDocumentationPartResponse struct { *DeleteDocumentationPartOutput // contains filtered or unexported fields }
DeleteDocumentationPartResponse is the response type for the DeleteDocumentationPart API operation.
func (*DeleteDocumentationPartResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteDocumentationPartResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteDocumentationPart request.
type DeleteDocumentationVersionInput ¶
type DeleteDocumentationVersionInput struct { // [Required] The version identifier of a to-be-deleted documentation snapshot. // // DocumentationVersion is a required field DocumentationVersion *string `location:"uri" locationName:"doc_version" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Deletes an existing documentation version of an API.
func (DeleteDocumentationVersionInput) MarshalFields ¶ added in v0.3.0
func (s DeleteDocumentationVersionInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteDocumentationVersionInput) String ¶
func (s DeleteDocumentationVersionInput) String() string
String returns the string representation
func (*DeleteDocumentationVersionInput) Validate ¶
func (s *DeleteDocumentationVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDocumentationVersionOutput ¶
type DeleteDocumentationVersionOutput struct {
// contains filtered or unexported fields
}
func (DeleteDocumentationVersionOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteDocumentationVersionOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteDocumentationVersionOutput) String ¶
func (s DeleteDocumentationVersionOutput) String() string
String returns the string representation
type DeleteDocumentationVersionRequest ¶
type DeleteDocumentationVersionRequest struct { *aws.Request Input *DeleteDocumentationVersionInput Copy func(*DeleteDocumentationVersionInput) DeleteDocumentationVersionRequest }
DeleteDocumentationVersionRequest is the request type for the DeleteDocumentationVersion API operation.
func (DeleteDocumentationVersionRequest) Send ¶
func (r DeleteDocumentationVersionRequest) Send(ctx context.Context) (*DeleteDocumentationVersionResponse, error)
Send marshals and sends the DeleteDocumentationVersion API request.
type DeleteDocumentationVersionResponse ¶ added in v0.9.0
type DeleteDocumentationVersionResponse struct { *DeleteDocumentationVersionOutput // contains filtered or unexported fields }
DeleteDocumentationVersionResponse is the response type for the DeleteDocumentationVersion API operation.
func (*DeleteDocumentationVersionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteDocumentationVersionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteDocumentationVersion request.
type DeleteDomainNameInput ¶
type DeleteDomainNameInput struct { // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s DeleteDomainNameInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteDomainNameInput) String ¶
func (s DeleteDomainNameInput) String() string
String returns the string representation
func (*DeleteDomainNameInput) Validate ¶
func (s *DeleteDomainNameInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDomainNameOutput ¶
type DeleteDomainNameOutput struct {
// contains filtered or unexported fields
}
func (DeleteDomainNameOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteDomainNameOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteDomainNameOutput) String ¶
func (s DeleteDomainNameOutput) String() string
String returns the string representation
type DeleteDomainNameRequest ¶
type DeleteDomainNameRequest struct { *aws.Request Input *DeleteDomainNameInput Copy func(*DeleteDomainNameInput) DeleteDomainNameRequest }
DeleteDomainNameRequest is the request type for the DeleteDomainName API operation.
func (DeleteDomainNameRequest) Send ¶
func (r DeleteDomainNameRequest) Send(ctx context.Context) (*DeleteDomainNameResponse, error)
Send marshals and sends the DeleteDomainName API request.
type DeleteDomainNameResponse ¶ added in v0.9.0
type DeleteDomainNameResponse struct { *DeleteDomainNameOutput // contains filtered or unexported fields }
DeleteDomainNameResponse is the response type for the DeleteDomainName API operation.
func (*DeleteDomainNameResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteDomainNameResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteDomainName request.
type DeleteGatewayResponseInput ¶
type DeleteGatewayResponseInput struct { // [Required] // The response type of the associated GatewayResponse. Valid values are // * ACCESS_DENIED // // * API_CONFIGURATION_ERROR // // * AUTHORIZER_FAILURE // // * AUTHORIZER_CONFIGURATION_ERROR // // * BAD_REQUEST_PARAMETERS // // * BAD_REQUEST_BODY // // * DEFAULT_4XX // // * DEFAULT_5XX // // * EXPIRED_TOKEN // // * INVALID_SIGNATURE // // * INTEGRATION_FAILURE // // * INTEGRATION_TIMEOUT // // * INVALID_API_KEY // // * MISSING_AUTHENTICATION_TOKEN // // * QUOTA_EXCEEDED // // * REQUEST_TOO_LARGE // // * RESOURCE_NOT_FOUND // // * THROTTLED // // * UNAUTHORIZED // // * UNSUPPORTED_MEDIA_TYPE // // ResponseType is a required field ResponseType GatewayResponseType `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
func (DeleteGatewayResponseInput) MarshalFields ¶ added in v0.3.0
func (s DeleteGatewayResponseInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteGatewayResponseInput) String ¶
func (s DeleteGatewayResponseInput) String() string
String returns the string representation
func (*DeleteGatewayResponseInput) Validate ¶
func (s *DeleteGatewayResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteGatewayResponseOutput ¶
type DeleteGatewayResponseOutput struct {
// contains filtered or unexported fields
}
func (DeleteGatewayResponseOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteGatewayResponseOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteGatewayResponseOutput) String ¶
func (s DeleteGatewayResponseOutput) String() string
String returns the string representation
type DeleteGatewayResponseRequest ¶
type DeleteGatewayResponseRequest struct { *aws.Request Input *DeleteGatewayResponseInput Copy func(*DeleteGatewayResponseInput) DeleteGatewayResponseRequest }
DeleteGatewayResponseRequest is the request type for the DeleteGatewayResponse API operation.
func (DeleteGatewayResponseRequest) Send ¶
func (r DeleteGatewayResponseRequest) Send(ctx context.Context) (*DeleteGatewayResponseResponse, error)
Send marshals and sends the DeleteGatewayResponse API request.
type DeleteGatewayResponseResponse ¶ added in v0.9.0
type DeleteGatewayResponseResponse struct { *DeleteGatewayResponseOutput // contains filtered or unexported fields }
DeleteGatewayResponseResponse is the response type for the DeleteGatewayResponse API operation.
func (*DeleteGatewayResponseResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteGatewayResponseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteGatewayResponse request.
type DeleteIntegrationInput ¶
type DeleteIntegrationInput struct { // [Required] Specifies a delete integration request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // [Required] Specifies a delete integration request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a delete integration request.
func (DeleteIntegrationInput) MarshalFields ¶ added in v0.3.0
func (s DeleteIntegrationInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteIntegrationInput) String ¶
func (s DeleteIntegrationInput) String() string
String returns the string representation
func (*DeleteIntegrationInput) Validate ¶
func (s *DeleteIntegrationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteIntegrationOutput ¶
type DeleteIntegrationOutput struct {
// contains filtered or unexported fields
}
func (DeleteIntegrationOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteIntegrationOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteIntegrationOutput) String ¶
func (s DeleteIntegrationOutput) String() string
String returns the string representation
type DeleteIntegrationRequest ¶
type DeleteIntegrationRequest struct { *aws.Request Input *DeleteIntegrationInput Copy func(*DeleteIntegrationInput) DeleteIntegrationRequest }
DeleteIntegrationRequest is the request type for the DeleteIntegration API operation.
func (DeleteIntegrationRequest) Send ¶
func (r DeleteIntegrationRequest) Send(ctx context.Context) (*DeleteIntegrationResponse, error)
Send marshals and sends the DeleteIntegration API request.
type DeleteIntegrationResponse ¶ added in v0.9.0
type DeleteIntegrationResponse struct { *DeleteIntegrationOutput // contains filtered or unexported fields }
DeleteIntegrationResponse is the response type for the DeleteIntegration API operation.
func (*DeleteIntegrationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteIntegrationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteIntegration request.
type DeleteIntegrationResponseInput ¶
type DeleteIntegrationResponseInput struct { // [Required] 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"` // [Required] 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s DeleteIntegrationResponseInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteIntegrationResponseInput) String ¶
func (s DeleteIntegrationResponseInput) String() string
String returns the string representation
func (*DeleteIntegrationResponseInput) Validate ¶
func (s *DeleteIntegrationResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteIntegrationResponseOutput ¶
type DeleteIntegrationResponseOutput struct {
// contains filtered or unexported fields
}
func (DeleteIntegrationResponseOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteIntegrationResponseOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteIntegrationResponseOutput) String ¶
func (s DeleteIntegrationResponseOutput) String() string
String returns the string representation
type DeleteIntegrationResponseRequest ¶
type DeleteIntegrationResponseRequest struct { *aws.Request Input *DeleteIntegrationResponseInput Copy func(*DeleteIntegrationResponseInput) DeleteIntegrationResponseRequest }
DeleteIntegrationResponseRequest is the request type for the DeleteIntegrationResponse API operation.
func (DeleteIntegrationResponseRequest) Send ¶
func (r DeleteIntegrationResponseRequest) Send(ctx context.Context) (*DeleteIntegrationResponseResponse, error)
Send marshals and sends the DeleteIntegrationResponse API request.
type DeleteIntegrationResponseResponse ¶ added in v0.9.0
type DeleteIntegrationResponseResponse struct { *DeleteIntegrationResponseOutput // contains filtered or unexported fields }
DeleteIntegrationResponseResponse is the response type for the DeleteIntegrationResponse API operation.
func (*DeleteIntegrationResponseResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteIntegrationResponseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteIntegrationResponse request.
type DeleteMethodInput ¶
type DeleteMethodInput struct { // [Required] The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // [Required] The Resource identifier for the Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete an existing Method resource.
func (DeleteMethodInput) MarshalFields ¶ added in v0.3.0
func (s DeleteMethodInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteMethodInput) String ¶
func (s DeleteMethodInput) String() string
String returns the string representation
func (*DeleteMethodInput) Validate ¶
func (s *DeleteMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteMethodOutput ¶
type DeleteMethodOutput struct {
// contains filtered or unexported fields
}
func (DeleteMethodOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteMethodOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteMethodOutput) String ¶
func (s DeleteMethodOutput) String() string
String returns the string representation
type DeleteMethodRequest ¶
type DeleteMethodRequest struct { *aws.Request Input *DeleteMethodInput Copy func(*DeleteMethodInput) DeleteMethodRequest }
DeleteMethodRequest is the request type for the DeleteMethod API operation.
func (DeleteMethodRequest) Send ¶
func (r DeleteMethodRequest) Send(ctx context.Context) (*DeleteMethodResponse, error)
Send marshals and sends the DeleteMethod API request.
type DeleteMethodResponse ¶ added in v0.9.0
type DeleteMethodResponse struct { *DeleteMethodOutput // contains filtered or unexported fields }
DeleteMethodResponse is the response type for the DeleteMethod API operation.
func (*DeleteMethodResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteMethodResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteMethod request.
type DeleteMethodResponseInput ¶
type DeleteMethodResponseInput struct { // [Required] The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // [Required] The Resource identifier for the MethodResponse resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s DeleteMethodResponseInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteMethodResponseInput) String ¶
func (s DeleteMethodResponseInput) String() string
String returns the string representation
func (*DeleteMethodResponseInput) Validate ¶
func (s *DeleteMethodResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteMethodResponseOutput ¶
type DeleteMethodResponseOutput struct {
// contains filtered or unexported fields
}
func (DeleteMethodResponseOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteMethodResponseOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteMethodResponseOutput) String ¶
func (s DeleteMethodResponseOutput) String() string
String returns the string representation
type DeleteMethodResponseRequest ¶
type DeleteMethodResponseRequest struct { *aws.Request Input *DeleteMethodResponseInput Copy func(*DeleteMethodResponseInput) DeleteMethodResponseRequest }
DeleteMethodResponseRequest is the request type for the DeleteMethodResponse API operation.
func (DeleteMethodResponseRequest) Send ¶
func (r DeleteMethodResponseRequest) Send(ctx context.Context) (*DeleteMethodResponseResponse, error)
Send marshals and sends the DeleteMethodResponse API request.
type DeleteMethodResponseResponse ¶ added in v0.9.0
type DeleteMethodResponseResponse struct { *DeleteMethodResponseOutput // contains filtered or unexported fields }
DeleteMethodResponseResponse is the response type for the DeleteMethodResponse API operation.
func (*DeleteMethodResponseResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteMethodResponseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteMethodResponse request.
type DeleteModelInput ¶
type DeleteModelInput struct { // [Required] The name of the model to delete. // // ModelName is a required field ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete an existing model in an existing RestApi resource.
func (DeleteModelInput) MarshalFields ¶ added in v0.3.0
func (s DeleteModelInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteModelInput) String ¶
func (s DeleteModelInput) String() string
String returns the string representation
func (*DeleteModelInput) Validate ¶
func (s *DeleteModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteModelOutput ¶
type DeleteModelOutput struct {
// contains filtered or unexported fields
}
func (DeleteModelOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteModelOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteModelOutput) String ¶
func (s DeleteModelOutput) String() string
String returns the string representation
type DeleteModelRequest ¶
type DeleteModelRequest struct { *aws.Request Input *DeleteModelInput Copy func(*DeleteModelInput) DeleteModelRequest }
DeleteModelRequest is the request type for the DeleteModel API operation.
func (DeleteModelRequest) Send ¶
func (r DeleteModelRequest) Send(ctx context.Context) (*DeleteModelResponse, error)
Send marshals and sends the DeleteModel API request.
type DeleteModelResponse ¶ added in v0.9.0
type DeleteModelResponse struct { *DeleteModelOutput // contains filtered or unexported fields }
DeleteModelResponse is the response type for the DeleteModel API operation.
func (*DeleteModelResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteModelResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteModel request.
type DeleteRequestValidatorInput ¶
type DeleteRequestValidatorInput struct { // [Required] The identifier of the RequestValidator to be deleted. // // RequestValidatorId is a required field RequestValidatorId *string `location:"uri" locationName:"requestvalidator_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Deletes a specified RequestValidator of a given RestApi.
func (DeleteRequestValidatorInput) MarshalFields ¶ added in v0.3.0
func (s DeleteRequestValidatorInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteRequestValidatorInput) String ¶
func (s DeleteRequestValidatorInput) String() string
String returns the string representation
func (*DeleteRequestValidatorInput) Validate ¶
func (s *DeleteRequestValidatorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteRequestValidatorOutput ¶
type DeleteRequestValidatorOutput struct {
// contains filtered or unexported fields
}
func (DeleteRequestValidatorOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteRequestValidatorOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteRequestValidatorOutput) String ¶
func (s DeleteRequestValidatorOutput) String() string
String returns the string representation
type DeleteRequestValidatorRequest ¶
type DeleteRequestValidatorRequest struct { *aws.Request Input *DeleteRequestValidatorInput Copy func(*DeleteRequestValidatorInput) DeleteRequestValidatorRequest }
DeleteRequestValidatorRequest is the request type for the DeleteRequestValidator API operation.
func (DeleteRequestValidatorRequest) Send ¶
func (r DeleteRequestValidatorRequest) Send(ctx context.Context) (*DeleteRequestValidatorResponse, error)
Send marshals and sends the DeleteRequestValidator API request.
type DeleteRequestValidatorResponse ¶ added in v0.9.0
type DeleteRequestValidatorResponse struct { *DeleteRequestValidatorOutput // contains filtered or unexported fields }
DeleteRequestValidatorResponse is the response type for the DeleteRequestValidator API operation.
func (*DeleteRequestValidatorResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteRequestValidatorResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteRequestValidator request.
type DeleteResourceInput ¶
type DeleteResourceInput struct { // [Required] The identifier of the Resource resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete a Resource.
func (DeleteResourceInput) MarshalFields ¶ added in v0.3.0
func (s DeleteResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteResourceInput) String ¶
func (s DeleteResourceInput) String() string
String returns the string representation
func (*DeleteResourceInput) Validate ¶
func (s *DeleteResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteResourceOutput ¶
type DeleteResourceOutput struct {
// contains filtered or unexported fields
}
func (DeleteResourceOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteResourceOutput) String ¶
func (s DeleteResourceOutput) String() string
String returns the string representation
type DeleteResourceRequest ¶
type DeleteResourceRequest struct { *aws.Request Input *DeleteResourceInput Copy func(*DeleteResourceInput) DeleteResourceRequest }
DeleteResourceRequest is the request type for the DeleteResource API operation.
func (DeleteResourceRequest) Send ¶
func (r DeleteResourceRequest) Send(ctx context.Context) (*DeleteResourceResponse, error)
Send marshals and sends the DeleteResource API request.
type DeleteResourceResponse ¶ added in v0.9.0
type DeleteResourceResponse struct { *DeleteResourceOutput // contains filtered or unexported fields }
DeleteResourceResponse is the response type for the DeleteResource API operation.
func (*DeleteResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteResource request.
type DeleteRestApiInput ¶
type DeleteRestApiInput struct { // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to delete the specified API from your collection.
func (DeleteRestApiInput) MarshalFields ¶ added in v0.3.0
func (s DeleteRestApiInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteRestApiInput) String ¶
func (s DeleteRestApiInput) String() string
String returns the string representation
func (*DeleteRestApiInput) Validate ¶
func (s *DeleteRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteRestApiOutput ¶
type DeleteRestApiOutput struct {
// contains filtered or unexported fields
}
func (DeleteRestApiOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteRestApiOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteRestApiOutput) String ¶
func (s DeleteRestApiOutput) String() string
String returns the string representation
type DeleteRestApiRequest ¶
type DeleteRestApiRequest struct { *aws.Request Input *DeleteRestApiInput Copy func(*DeleteRestApiInput) DeleteRestApiRequest }
DeleteRestApiRequest is the request type for the DeleteRestApi API operation.
func (DeleteRestApiRequest) Send ¶
func (r DeleteRestApiRequest) Send(ctx context.Context) (*DeleteRestApiResponse, error)
Send marshals and sends the DeleteRestApi API request.
type DeleteRestApiResponse ¶ added in v0.9.0
type DeleteRestApiResponse struct { *DeleteRestApiOutput // contains filtered or unexported fields }
DeleteRestApiResponse is the response type for the DeleteRestApi API operation.
func (*DeleteRestApiResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteRestApiResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteRestApi request.
type DeleteStageInput ¶
type DeleteStageInput struct { // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The 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 API Gateway to delete a Stage resource.
func (DeleteStageInput) MarshalFields ¶ added in v0.3.0
func (s DeleteStageInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteStageInput) String ¶
func (s DeleteStageInput) String() string
String returns the string representation
func (*DeleteStageInput) Validate ¶
func (s *DeleteStageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteStageOutput ¶
type DeleteStageOutput struct {
// contains filtered or unexported fields
}
func (DeleteStageOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteStageOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteStageOutput) String ¶
func (s DeleteStageOutput) String() string
String returns the string representation
type DeleteStageRequest ¶
type DeleteStageRequest struct { *aws.Request Input *DeleteStageInput Copy func(*DeleteStageInput) DeleteStageRequest }
DeleteStageRequest is the request type for the DeleteStage API operation.
func (DeleteStageRequest) Send ¶
func (r DeleteStageRequest) Send(ctx context.Context) (*DeleteStageResponse, error)
Send marshals and sends the DeleteStage API request.
type DeleteStageResponse ¶ added in v0.9.0
type DeleteStageResponse struct { *DeleteStageOutput // contains filtered or unexported fields }
DeleteStageResponse is the response type for the DeleteStage API operation.
func (*DeleteStageResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteStageResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteStage request.
type DeleteUsagePlanInput ¶
type DeleteUsagePlanInput struct { // [Required] The Id of the to-be-deleted usage plan. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The DELETE request to delete a usage plan of a given plan Id.
func (DeleteUsagePlanInput) MarshalFields ¶ added in v0.3.0
func (s DeleteUsagePlanInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteUsagePlanInput) String ¶
func (s DeleteUsagePlanInput) String() string
String returns the string representation
func (*DeleteUsagePlanInput) Validate ¶
func (s *DeleteUsagePlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUsagePlanKeyInput ¶
type DeleteUsagePlanKeyInput struct { // [Required] The Id of the UsagePlanKey resource to be deleted. // // KeyId is a required field KeyId *string `location:"uri" locationName:"keyId" type:"string" required:"true"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s DeleteUsagePlanKeyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteUsagePlanKeyInput) String ¶
func (s DeleteUsagePlanKeyInput) String() string
String returns the string representation
func (*DeleteUsagePlanKeyInput) Validate ¶
func (s *DeleteUsagePlanKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUsagePlanKeyOutput ¶
type DeleteUsagePlanKeyOutput struct {
// contains filtered or unexported fields
}
func (DeleteUsagePlanKeyOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteUsagePlanKeyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteUsagePlanKeyOutput) String ¶
func (s DeleteUsagePlanKeyOutput) String() string
String returns the string representation
type DeleteUsagePlanKeyRequest ¶
type DeleteUsagePlanKeyRequest struct { *aws.Request Input *DeleteUsagePlanKeyInput Copy func(*DeleteUsagePlanKeyInput) DeleteUsagePlanKeyRequest }
DeleteUsagePlanKeyRequest is the request type for the DeleteUsagePlanKey API operation.
func (DeleteUsagePlanKeyRequest) Send ¶
func (r DeleteUsagePlanKeyRequest) Send(ctx context.Context) (*DeleteUsagePlanKeyResponse, error)
Send marshals and sends the DeleteUsagePlanKey API request.
type DeleteUsagePlanKeyResponse ¶ added in v0.9.0
type DeleteUsagePlanKeyResponse struct { *DeleteUsagePlanKeyOutput // contains filtered or unexported fields }
DeleteUsagePlanKeyResponse is the response type for the DeleteUsagePlanKey API operation.
func (*DeleteUsagePlanKeyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteUsagePlanKeyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteUsagePlanKey request.
type DeleteUsagePlanOutput ¶
type DeleteUsagePlanOutput struct {
// contains filtered or unexported fields
}
func (DeleteUsagePlanOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteUsagePlanOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteUsagePlanOutput) String ¶
func (s DeleteUsagePlanOutput) String() string
String returns the string representation
type DeleteUsagePlanRequest ¶
type DeleteUsagePlanRequest struct { *aws.Request Input *DeleteUsagePlanInput Copy func(*DeleteUsagePlanInput) DeleteUsagePlanRequest }
DeleteUsagePlanRequest is the request type for the DeleteUsagePlan API operation.
func (DeleteUsagePlanRequest) Send ¶
func (r DeleteUsagePlanRequest) Send(ctx context.Context) (*DeleteUsagePlanResponse, error)
Send marshals and sends the DeleteUsagePlan API request.
type DeleteUsagePlanResponse ¶ added in v0.9.0
type DeleteUsagePlanResponse struct { *DeleteUsagePlanOutput // contains filtered or unexported fields }
DeleteUsagePlanResponse is the response type for the DeleteUsagePlan API operation.
func (*DeleteUsagePlanResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteUsagePlanResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteUsagePlan request.
type DeleteVpcLinkInput ¶ added in v0.2.0
type DeleteVpcLinkInput struct { // [Required] The identifier of the VpcLink. It is used in an Integration to // reference this VpcLink. // // VpcLinkId is a required field VpcLinkId *string `location:"uri" locationName:"vpclink_id" type:"string" required:"true"` // contains filtered or unexported fields }
Deletes an existing VpcLink of a specified identifier.
func (DeleteVpcLinkInput) MarshalFields ¶ added in v0.3.0
func (s DeleteVpcLinkInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteVpcLinkInput) String ¶ added in v0.2.0
func (s DeleteVpcLinkInput) String() string
String returns the string representation
func (*DeleteVpcLinkInput) Validate ¶ added in v0.2.0
func (s *DeleteVpcLinkInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteVpcLinkOutput ¶ added in v0.2.0
type DeleteVpcLinkOutput struct {
// contains filtered or unexported fields
}
func (DeleteVpcLinkOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteVpcLinkOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteVpcLinkOutput) String ¶ added in v0.2.0
func (s DeleteVpcLinkOutput) String() string
String returns the string representation
type DeleteVpcLinkRequest ¶ added in v0.2.0
type DeleteVpcLinkRequest struct { *aws.Request Input *DeleteVpcLinkInput Copy func(*DeleteVpcLinkInput) DeleteVpcLinkRequest }
DeleteVpcLinkRequest is the request type for the DeleteVpcLink API operation.
func (DeleteVpcLinkRequest) Send ¶ added in v0.2.0
func (r DeleteVpcLinkRequest) Send(ctx context.Context) (*DeleteVpcLinkResponse, error)
Send marshals and sends the DeleteVpcLink API request.
type DeleteVpcLinkResponse ¶ added in v0.9.0
type DeleteVpcLinkResponse struct { *DeleteVpcLinkOutput // contains filtered or unexported fields }
DeleteVpcLinkResponse is the response type for the DeleteVpcLink API operation.
func (*DeleteVpcLinkResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteVpcLinkResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteVpcLink request.
type Deployment ¶ added in v0.9.0
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"` // 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 (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html), AWS SDKs (https://aws.amazon.com/tools/)
func (Deployment) MarshalFields ¶ added in v0.9.0
func (s Deployment) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (Deployment) String ¶ added in v0.9.0
func (s Deployment) String() string
String returns the string representation
type DeploymentCanarySettings ¶ added in v0.2.0
type DeploymentCanarySettings struct { // The percentage (0.0-100.0) of traffic routed to the canary deployment. PercentTraffic *float64 `locationName:"percentTraffic" type:"double"` // A stage variable overrides used for the canary release deployment. They can // override existing stage variables or add new stage variables for the canary // release deployment. These stage variables are represented as a string-to-string // map between stage variable names and their values. StageVariableOverrides map[string]string `locationName:"stageVariableOverrides" type:"map"` // A Boolean flag to indicate whether the canary release deployment uses the // stage cache or not. UseStageCache *bool `locationName:"useStageCache" type:"boolean"` // contains filtered or unexported fields }
The input configuration for a canary deployment.
func (DeploymentCanarySettings) MarshalFields ¶ added in v0.3.0
func (s DeploymentCanarySettings) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeploymentCanarySettings) String ¶ added in v0.2.0
func (s DeploymentCanarySettings) String() string
String returns the string representation
type DocumentationPart ¶ added in v0.9.0
type DocumentationPart struct { // The DocumentationPart identifier, generated by 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 OpenAPI-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 OpenAPI 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 OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.
Documenting an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationParts
func (DocumentationPart) MarshalFields ¶ added in v0.9.0
func (s DocumentationPart) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DocumentationPart) String ¶ added in v0.9.0
func (s DocumentationPart) String() string
String returns the string representation
type DocumentationPartLocation ¶
type DocumentationPartLocation struct { // The HTTP verb of a method. It is a valid field for the API entity types of // METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, // RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. // When an applicable child entity inherits the content of an entity of the // same type with more general specifications of the other location attributes, // the child entity's method attribute must match that of the parent entity // exactly. Method *string `locationName:"method" type:"string"` // The name of the targeted API entity. It is a valid and required field for // the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, // REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field // for any other entity type. Name *string `locationName:"name" type:"string"` // The URL path of the target. It is a valid field for the API entity types // of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, // RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for // the root resource. When an applicable child entity inherits the content of // another entity of the same type with more general specifications of the other // location attributes, the child entity's path attribute must match that of // the parent entity as a prefix. Path *string `locationName:"path" type:"string"` // The HTTP status code of a response. It is a valid field for the API entity // types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value // is * for any status code. When an applicable child entity inherits the content // of an entity of the same type with more general specifications of the other // location attributes, the child entity's statusCode attribute must match that // of the parent entity exactly. StatusCode *string `locationName:"statusCode" type:"string"` // [Required] The type of API entity to which the documentation content applies. // Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, // QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, // and RESPONSE_BODY. Content inheritance does not apply to any entity of the // API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type. // // Type is a required field Type DocumentationPartType `locationName:"type" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Specifies the target API entity to which the documentation applies.
func (DocumentationPartLocation) MarshalFields ¶ added in v0.3.0
func (s DocumentationPartLocation) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DocumentationPartLocation) String ¶
func (s DocumentationPartLocation) String() string
String returns the string representation
func (*DocumentationPartLocation) Validate ¶
func (s *DocumentationPartLocation) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DocumentationPartType ¶
type DocumentationPartType string
const ( DocumentationPartTypeApi DocumentationPartType = "API" DocumentationPartTypeAuthorizer DocumentationPartType = "AUTHORIZER" DocumentationPartTypeModel DocumentationPartType = "MODEL" DocumentationPartTypeResource DocumentationPartType = "RESOURCE" DocumentationPartTypeMethod DocumentationPartType = "METHOD" DocumentationPartTypePathParameter DocumentationPartType = "PATH_PARAMETER" DocumentationPartTypeQueryParameter DocumentationPartType = "QUERY_PARAMETER" DocumentationPartTypeRequestHeader DocumentationPartType = "REQUEST_HEADER" DocumentationPartTypeRequestBody DocumentationPartType = "REQUEST_BODY" DocumentationPartTypeResponse DocumentationPartType = "RESPONSE" DocumentationPartTypeResponseHeader DocumentationPartType = "RESPONSE_HEADER" DocumentationPartTypeResponseBody DocumentationPartType = "RESPONSE_BODY" )
Enum values for DocumentationPartType
func (DocumentationPartType) MarshalValue ¶ added in v0.3.0
func (enum DocumentationPartType) MarshalValue() (string, error)
func (DocumentationPartType) MarshalValueBuf ¶ added in v0.3.0
func (enum DocumentationPartType) MarshalValueBuf(b []byte) ([]byte, error)
type DocumentationVersion ¶ added in v0.9.0
type DocumentationVersion struct { // The date when the API documentation snapshot is created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // 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., OpenAPI) file.
Documenting an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart, DocumentationVersions
func (DocumentationVersion) MarshalFields ¶ added in v0.9.0
func (s DocumentationVersion) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DocumentationVersion) String ¶ added in v0.9.0
func (s DocumentationVersion) String() string
String returns the string representation
type DomainName ¶ added in v0.9.0
type DomainName struct { // The reference to an AWS-managed certificate that will be used by edge-optimized // endpoint for this domain name. AWS Certificate Manager is the only supported // source. CertificateArn *string `locationName:"certificateArn" type:"string"` // The name of the certificate that will be used by edge-optimized endpoint // for this domain name. CertificateName *string `locationName:"certificateName" type:"string"` // The timestamp when the certificate that was used by edge-optimized endpoint // for this domain name was uploaded. CertificateUploadDate *time.Time `locationName:"certificateUploadDate" type:"timestamp"` // The domain name of the Amazon CloudFront distribution associated with this // custom domain name for an edge-optimized endpoint. You set up this association // when adding a DNS record pointing the custom domain name to this distribution // name. For more information about CloudFront distributions, see the Amazon // CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/). DistributionDomainName *string `locationName:"distributionDomainName" type:"string"` // The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized // endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more // information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) // and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). DistributionHostedZoneId *string `locationName:"distributionHostedZoneId" type:"string"` // The custom domain name as an API host name, for example, my-api.example.com. DomainName *string `locationName:"domainName" type:"string"` // The status of the DomainName migration. The valid values are AVAILABLE and // UPDATING. If the status is UPDATING, the domain cannot be modified further // until the existing operation is complete. If it is AVAILABLE, the domain // can be updated. DomainNameStatus DomainNameStatus `locationName:"domainNameStatus" type:"string" enum:"true"` // An optional text message containing detailed information about status of // the DomainName migration. DomainNameStatusMessage *string `locationName:"domainNameStatusMessage" type:"string"` // The endpoint configuration of this DomainName showing the endpoint types // of the domain name. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The reference to an AWS-managed certificate that will be used for validating // the regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string `locationName:"regionalCertificateArn" type:"string"` // The name of the certificate that will be used for validating the regional // domain name. RegionalCertificateName *string `locationName:"regionalCertificateName" type:"string"` // The domain name associated with the regional endpoint for this custom domain // name. You set up this association by adding a DNS record that points the // custom domain name to this regional domain name. The regional domain name // is returned by API Gateway when you create a regional endpoint. RegionalDomainName *string `locationName:"regionalDomainName" type:"string"` // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. // For more information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) // and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). RegionalHostedZoneId *string `locationName:"regionalHostedZoneId" type:"string"` // The Transport Layer Security (TLS) version + cipher suite for this DomainName. // The valid values are TLS_1_0 and TLS_1_2. SecurityPolicy SecurityPolicy `locationName:"securityPolicy" type:"string" enum:"true"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
Represents a custom domain name as a user-friendly host name of an API (RestApi).
When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.
Set a Custom Host Name for an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (DomainName) MarshalFields ¶ added in v0.9.0
func (s DomainName) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DomainName) String ¶ added in v0.9.0
func (s DomainName) String() string
String returns the string representation
type DomainNameStatus ¶ added in v0.10.0
type DomainNameStatus string
const ( DomainNameStatusAvailable DomainNameStatus = "AVAILABLE" DomainNameStatusUpdating DomainNameStatus = "UPDATING" DomainNameStatusPending DomainNameStatus = "PENDING" )
Enum values for DomainNameStatus
func (DomainNameStatus) MarshalValue ¶ added in v0.10.0
func (enum DomainNameStatus) MarshalValue() (string, error)
func (DomainNameStatus) MarshalValueBuf ¶ added in v0.10.0
func (enum DomainNameStatus) MarshalValueBuf(b []byte) ([]byte, error)
type EndpointConfiguration ¶ added in v0.2.0
type EndpointConfiguration struct { // A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). // For an edge-optimized API and its custom domain name, the endpoint type is // "EDGE". For a regional API and its custom domain name, the endpoint type // is REGIONAL. For a private API, the endpoint type is PRIVATE. Types []EndpointType `locationName:"types" type:"list"` // A list of VpcEndpointIds of an API (RestApi) against which to create Route53 // ALIASes. It is only supported for PRIVATE endpoint type. VpcEndpointIds []string `locationName:"vpcEndpointIds" type:"list"` // contains filtered or unexported fields }
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
func (EndpointConfiguration) MarshalFields ¶ added in v0.3.0
func (s EndpointConfiguration) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (EndpointConfiguration) String ¶ added in v0.2.0
func (s EndpointConfiguration) String() string
String returns the string representation
type EndpointType ¶ added in v0.2.0
type EndpointType string
The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region; and PRIVATE for private APIs.
const ( EndpointTypeRegional EndpointType = "REGIONAL" EndpointTypeEdge EndpointType = "EDGE" EndpointTypePrivate EndpointType = "PRIVATE" )
Enum values for EndpointType
func (EndpointType) MarshalValue ¶ added in v0.3.0
func (enum EndpointType) MarshalValue() (string, error)
func (EndpointType) MarshalValueBuf ¶ added in v0.3.0
func (enum EndpointType) MarshalValueBuf(b []byte) ([]byte, error)
type FlushStageAuthorizersCacheInput ¶
type FlushStageAuthorizersCacheInput struct { // The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The name of the stage to flush. // // StageName is a required field StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` // contains filtered or unexported fields }
Request to flush authorizer cache entries on a specified stage.
func (FlushStageAuthorizersCacheInput) MarshalFields ¶ added in v0.3.0
func (s FlushStageAuthorizersCacheInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (FlushStageAuthorizersCacheInput) String ¶
func (s FlushStageAuthorizersCacheInput) String() string
String returns the string representation
func (*FlushStageAuthorizersCacheInput) Validate ¶
func (s *FlushStageAuthorizersCacheInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type FlushStageAuthorizersCacheOutput ¶
type FlushStageAuthorizersCacheOutput struct {
// contains filtered or unexported fields
}
func (FlushStageAuthorizersCacheOutput) MarshalFields ¶ added in v0.3.0
func (s FlushStageAuthorizersCacheOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (FlushStageAuthorizersCacheOutput) String ¶
func (s FlushStageAuthorizersCacheOutput) String() string
String returns the string representation
type FlushStageAuthorizersCacheRequest ¶
type FlushStageAuthorizersCacheRequest struct { *aws.Request Input *FlushStageAuthorizersCacheInput Copy func(*FlushStageAuthorizersCacheInput) FlushStageAuthorizersCacheRequest }
FlushStageAuthorizersCacheRequest is the request type for the FlushStageAuthorizersCache API operation.
func (FlushStageAuthorizersCacheRequest) Send ¶
func (r FlushStageAuthorizersCacheRequest) Send(ctx context.Context) (*FlushStageAuthorizersCacheResponse, error)
Send marshals and sends the FlushStageAuthorizersCache API request.
type FlushStageAuthorizersCacheResponse ¶ added in v0.9.0
type FlushStageAuthorizersCacheResponse struct { *FlushStageAuthorizersCacheOutput // contains filtered or unexported fields }
FlushStageAuthorizersCacheResponse is the response type for the FlushStageAuthorizersCache API operation.
func (*FlushStageAuthorizersCacheResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *FlushStageAuthorizersCacheResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the FlushStageAuthorizersCache request.
type FlushStageCacheInput ¶
type FlushStageCacheInput struct { // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The 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 API Gateway to flush a stage's cache.
func (FlushStageCacheInput) MarshalFields ¶ added in v0.3.0
func (s FlushStageCacheInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (FlushStageCacheInput) String ¶
func (s FlushStageCacheInput) String() string
String returns the string representation
func (*FlushStageCacheInput) Validate ¶
func (s *FlushStageCacheInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type FlushStageCacheOutput ¶
type FlushStageCacheOutput struct {
// contains filtered or unexported fields
}
func (FlushStageCacheOutput) MarshalFields ¶ added in v0.3.0
func (s FlushStageCacheOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (FlushStageCacheOutput) String ¶
func (s FlushStageCacheOutput) String() string
String returns the string representation
type FlushStageCacheRequest ¶
type FlushStageCacheRequest struct { *aws.Request Input *FlushStageCacheInput Copy func(*FlushStageCacheInput) FlushStageCacheRequest }
FlushStageCacheRequest is the request type for the FlushStageCache API operation.
func (FlushStageCacheRequest) Send ¶
func (r FlushStageCacheRequest) Send(ctx context.Context) (*FlushStageCacheResponse, error)
Send marshals and sends the FlushStageCache API request.
type FlushStageCacheResponse ¶ added in v0.9.0
type FlushStageCacheResponse struct { *FlushStageCacheOutput // contains filtered or unexported fields }
FlushStageCacheResponse is the response type for the FlushStageCache API operation.
func (*FlushStageCacheResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *FlushStageCacheResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the FlushStageCache request.
type GatewayResponse ¶ added in v0.9.0
type GatewayResponse struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway // response (true) or not (false). A default gateway response is one generated // by API Gateway without any customization by an API developer. DefaultResponse *bool `locationName:"defaultResponse" type:"boolean"` // Response parameters (paths, query strings and headers) of the GatewayResponse // as a string-to-string map of key-value pairs. ResponseParameters map[string]string `locationName:"responseParameters" type:"map"` // Response templates of the GatewayResponse as a string-to-string map of key-value // pairs. ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"` // The response type of the associated GatewayResponse. Valid values are // * ACCESS_DENIED // // * API_CONFIGURATION_ERROR // // * AUTHORIZER_FAILURE // // * AUTHORIZER_CONFIGURATION_ERROR // // * BAD_REQUEST_PARAMETERS // // * BAD_REQUEST_BODY // // * DEFAULT_4XX // // * DEFAULT_5XX // // * EXPIRED_TOKEN // // * INVALID_SIGNATURE // // * INTEGRATION_FAILURE // // * INTEGRATION_TIMEOUT // // * INVALID_API_KEY // // * MISSING_AUTHENTICATION_TOKEN // // * QUOTA_EXCEEDED // // * REQUEST_TOO_LARGE // // * RESOURCE_NOT_FOUND // // * THROTTLED // // * UNAUTHORIZED // // * UNSUPPORTED_MEDIA_TYPE ResponseType GatewayResponseType `locationName:"responseType" type:"string" enum:"true"` // The HTTP status code for this GatewayResponse. StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway (https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html)
Example: Get a Gateway Response of a given response type
Request ¶
This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45
The response type is specified as a URL path.
Response ¶
The successful operation returns the 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{\n \"message\": $context.error.messageString,\n \"type\": \"$context.error.responseType\",\n \"stage\": \"$context.stage\",\n \"resourcePath\": \"$context.resourcePath\",\n \"stageVariables.a\": \"$stageVariables.a\",\n \"statusCode\": \"'404'\"\n}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404" }
Customize Gateway Responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html)
func (GatewayResponse) MarshalFields ¶ added in v0.9.0
func (s GatewayResponse) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GatewayResponse) String ¶ added in v0.9.0
func (s GatewayResponse) String() string
String returns the string representation
type GatewayResponseType ¶
type GatewayResponseType string
const ( GatewayResponseTypeDefault4xx GatewayResponseType = "DEFAULT_4XX" GatewayResponseTypeDefault5xx GatewayResponseType = "DEFAULT_5XX" GatewayResponseTypeResourceNotFound GatewayResponseType = "RESOURCE_NOT_FOUND" GatewayResponseTypeInvalidApiKey GatewayResponseType = "INVALID_API_KEY" GatewayResponseTypeAccessDenied GatewayResponseType = "ACCESS_DENIED" GatewayResponseTypeAuthorizerFailure GatewayResponseType = "AUTHORIZER_FAILURE" GatewayResponseTypeAuthorizerConfigurationError GatewayResponseType = "AUTHORIZER_CONFIGURATION_ERROR" GatewayResponseTypeInvalidSignature GatewayResponseType = "INVALID_SIGNATURE" GatewayResponseTypeExpiredToken GatewayResponseType = "EXPIRED_TOKEN" GatewayResponseTypeMissingAuthenticationToken GatewayResponseType = "MISSING_AUTHENTICATION_TOKEN" GatewayResponseTypeIntegrationFailure GatewayResponseType = "INTEGRATION_FAILURE" GatewayResponseTypeIntegrationTimeout GatewayResponseType = "INTEGRATION_TIMEOUT" GatewayResponseTypeApiConfigurationError GatewayResponseType = "API_CONFIGURATION_ERROR" GatewayResponseTypeUnsupportedMediaType GatewayResponseType = "UNSUPPORTED_MEDIA_TYPE" GatewayResponseTypeBadRequestParameters GatewayResponseType = "BAD_REQUEST_PARAMETERS" GatewayResponseTypeBadRequestBody GatewayResponseType = "BAD_REQUEST_BODY" GatewayResponseTypeRequestTooLarge GatewayResponseType = "REQUEST_TOO_LARGE" GatewayResponseTypeThrottled GatewayResponseType = "THROTTLED" GatewayResponseTypeQuotaExceeded GatewayResponseType = "QUOTA_EXCEEDED" )
Enum values for GatewayResponseType
func (GatewayResponseType) MarshalValue ¶ added in v0.3.0
func (enum GatewayResponseType) MarshalValue() (string, error)
func (GatewayResponseType) MarshalValueBuf ¶ added in v0.3.0
func (enum GatewayResponseType) MarshalValueBuf(b []byte) ([]byte, error)
type GenerateClientCertificateInput ¶
type GenerateClientCertificateInput struct { // The description of the ClientCertificate. Description *string `locationName:"description" type:"string"` // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. // The tag key can be up to 128 characters and must not start with aws:. The // tag value can be up to 256 characters. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
A request to generate a ClientCertificate resource.
func (GenerateClientCertificateInput) MarshalFields ¶ added in v0.3.0
func (s GenerateClientCertificateInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GenerateClientCertificateInput) String ¶
func (s GenerateClientCertificateInput) String() string
String returns the string representation
type GenerateClientCertificateOutput ¶ added in v0.9.0
type GenerateClientCertificateOutput struct { // The identifier of the client certificate. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // The timestamp when the client certificate was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The description of the client certificate. Description *string `locationName:"description" type:"string"` // The timestamp when the client certificate will expire. ExpirationDate *time.Time `locationName:"expirationDate" type:"timestamp"` // 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"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.
Use Client-Side Certificate (https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)
func (GenerateClientCertificateOutput) MarshalFields ¶ added in v0.9.0
func (s GenerateClientCertificateOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GenerateClientCertificateOutput) String ¶ added in v0.9.0
func (s GenerateClientCertificateOutput) String() string
String returns the string representation
type GenerateClientCertificateRequest ¶
type GenerateClientCertificateRequest struct { *aws.Request Input *GenerateClientCertificateInput Copy func(*GenerateClientCertificateInput) GenerateClientCertificateRequest }
GenerateClientCertificateRequest is the request type for the GenerateClientCertificate API operation.
func (GenerateClientCertificateRequest) Send ¶
func (r GenerateClientCertificateRequest) Send(ctx context.Context) (*GenerateClientCertificateResponse, error)
Send marshals and sends the GenerateClientCertificate API request.
type GenerateClientCertificateResponse ¶ added in v0.9.0
type GenerateClientCertificateResponse struct { *GenerateClientCertificateOutput // contains filtered or unexported fields }
GenerateClientCertificateResponse is the response type for the GenerateClientCertificate API operation.
func (*GenerateClientCertificateResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GenerateClientCertificateResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GenerateClientCertificate request.
type GetAccountInput ¶
type GetAccountInput struct {
// contains filtered or unexported fields
}
Requests API Gateway to get information about the current Account resource.
func (GetAccountInput) MarshalFields ¶ added in v0.3.0
func (s GetAccountInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetAccountInput) String ¶
func (s GetAccountInput) String() string
String returns the string representation
type GetAccountOutput ¶ added in v0.9.0
type GetAccountOutput 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 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 (https://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": "https://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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-limits.html) Developer Guide (https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html), AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html)
func (GetAccountOutput) MarshalFields ¶ added in v0.9.0
func (s GetAccountOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetAccountOutput) String ¶ added in v0.9.0
func (s GetAccountOutput) String() string
String returns the string representation
type GetAccountRequest ¶
type GetAccountRequest struct { *aws.Request Input *GetAccountInput Copy func(*GetAccountInput) GetAccountRequest }
GetAccountRequest is the request type for the GetAccount API operation.
func (GetAccountRequest) Send ¶
func (r GetAccountRequest) Send(ctx context.Context) (*GetAccountResponse, error)
Send marshals and sends the GetAccount API request.
type GetAccountResponse ¶ added in v0.9.0
type GetAccountResponse struct { *GetAccountOutput // contains filtered or unexported fields }
GetAccountResponse is the response type for the GetAccount API operation.
func (*GetAccountResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetAccountResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetAccount request.
type GetApiKeyInput ¶
type GetApiKeyInput struct { // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetApiKeyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetApiKeyInput) String ¶
func (s GetApiKeyInput) String() string
String returns the string representation
func (*GetApiKeyInput) Validate ¶
func (s *GetApiKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetApiKeyOutput ¶ added in v0.9.0
type GetApiKeyOutput struct { // The timestamp when the API Key was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // An AWS Marketplace customer identifier , when integrating with the AWS SaaS // Marketplace. CustomerId *string `locationName:"customerId" type:"string"` // The description of the API Key. Description *string `locationName:"description" type:"string"` // Specifies whether the API Key can be used by callers. Enabled *bool `locationName:"enabled" type:"boolean"` // The identifier of the API Key. Id *string `locationName:"id" type:"string"` // The timestamp when the API Key was last updated. LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp"` // 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 collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html)
func (GetApiKeyOutput) MarshalFields ¶ added in v0.9.0
func (s GetApiKeyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetApiKeyOutput) String ¶ added in v0.9.0
func (s GetApiKeyOutput) String() string
String returns the string representation
type GetApiKeyRequest ¶
type GetApiKeyRequest struct { *aws.Request Input *GetApiKeyInput Copy func(*GetApiKeyInput) GetApiKeyRequest }
GetApiKeyRequest is the request type for the GetApiKey API operation.
func (GetApiKeyRequest) Send ¶
func (r GetApiKeyRequest) Send(ctx context.Context) (*GetApiKeyResponse, error)
Send marshals and sends the GetApiKey API request.
type GetApiKeyResponse ¶ added in v0.9.0
type GetApiKeyResponse struct { *GetApiKeyOutput // contains filtered or unexported fields }
GetApiKeyResponse is the response type for the GetApiKey API operation.
func (*GetApiKeyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetApiKeyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetApiKey request.
type GetApiKeysInput ¶
type GetApiKeysInput struct { // The identifier of a customer in AWS Marketplace or an external system, such // as a developer portal. CustomerId *string `location:"querystring" locationName:"customerId" type:"string"` // A boolean flag to specify whether (true) or not (false) the result contains // key values. IncludeValues *bool `location:"querystring" locationName:"includeValues" type:"boolean"` // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The name of queried API keys. NameQuery *string `location:"querystring" locationName:"name" type:"string"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
A request to get information about the current ApiKeys resource.
func (GetApiKeysInput) MarshalFields ¶ added in v0.3.0
func (s GetApiKeysInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetApiKeysInput) String ¶
func (s GetApiKeysInput) String() string
String returns the string representation
type GetApiKeysOutput ¶
type GetApiKeysOutput struct { // The current page of elements from this collection. Items []ApiKey `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // A list of warning messages logged during the import of API keys when the // failOnWarnings option is set to true. Warnings []string `locationName:"warnings" type:"list"` // contains filtered or unexported fields }
Represents a collection of API keys as represented by an ApiKeys resource.
Use API Keys (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html)
func (GetApiKeysOutput) MarshalFields ¶ added in v0.3.0
func (s GetApiKeysOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetApiKeysOutput) String ¶
func (s GetApiKeysOutput) String() string
String returns the string representation
type GetApiKeysPaginator ¶ added in v0.9.0
GetApiKeysPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetApiKeysPaginator ¶ added in v0.9.0
func NewGetApiKeysPaginator(req GetApiKeysRequest) GetApiKeysPaginator
NewGetApiKeysRequestPaginator returns a paginator for GetApiKeys. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetApiKeysRequest(input) p := apigateway.NewGetApiKeysRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetApiKeysPaginator) CurrentPage ¶ added in v0.9.0
func (p *GetApiKeysPaginator) CurrentPage() *GetApiKeysOutput
type GetApiKeysRequest ¶
type GetApiKeysRequest struct { *aws.Request Input *GetApiKeysInput Copy func(*GetApiKeysInput) GetApiKeysRequest }
GetApiKeysRequest is the request type for the GetApiKeys API operation.
func (GetApiKeysRequest) Send ¶
func (r GetApiKeysRequest) Send(ctx context.Context) (*GetApiKeysResponse, error)
Send marshals and sends the GetApiKeys API request.
type GetApiKeysResponse ¶ added in v0.9.0
type GetApiKeysResponse struct { *GetApiKeysOutput // contains filtered or unexported fields }
GetApiKeysResponse is the response type for the GetApiKeys API operation.
func (*GetApiKeysResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetApiKeysResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetApiKeys request.
type GetAuthorizerInput ¶
type GetAuthorizerInput struct { // [Required] The identifier of the Authorizer resource. // // AuthorizerId is a required field AuthorizerId *string `location:"uri" locationName:"authorizer_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe an existing Authorizer resource.
func (GetAuthorizerInput) MarshalFields ¶ added in v0.3.0
func (s GetAuthorizerInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetAuthorizerInput) String ¶
func (s GetAuthorizerInput) String() string
String returns the string representation
func (*GetAuthorizerInput) Validate ¶
func (s *GetAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAuthorizerOutput ¶ added in v0.9.0
type GetAuthorizerOutput struct { // Optional customer-defined field, used in OpenAPI imports and exports without // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the required credentials as an IAM role for API Gateway to invoke // the authorizer. To specify an IAM role for API Gateway to assume, use the // role's Amazon Resource Name (ARN). To use resource-based permissions on the // Lambda function, specify null. AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"` // The TTL in seconds of cached authorizer results. If it equals 0, authorization // caching is disabled. If it is greater than 0, API Gateway will cache authorizer // responses. If this field is not set, the default value is 300. The maximum // value is 3600, or 1 hour. AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or // REQUEST authorizers, this must be a well-formed Lambda function URI, for // example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, // where {region} is the same as the region hosting the Lambda function, path // indicates that the remaining substring in the URI should be treated as the // path to the resource, including the initial /. For Lambda functions, this // is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. AuthorizerUri *string `locationName:"authorizerUri" type:"string"` // The identifier for the authorizer resource. Id *string `locationName:"id" type:"string"` // The identity source for which authorization is requested. // * For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies // the request header mapping expression for the custom header holding the // authorization token submitted by the client. For example, if the token // header name is Auth, the header mapping expression is method.request.header.Auth. // // * For the REQUEST authorizer, this is required when authorization caching // is enabled. The value is a comma-separated string of one or more mapping // expressions of the specified request parameters. For example, if an Auth // header, a Name query string parameter are defined as identity sources, // this value is method.request.header.Auth, method.request.querystring.Name. // These parameters will be used to derive the authorization caching key // and to perform runtime validation of the REQUEST authorizer by verifying // all of the identity-related request parameters are present, not null and // non-empty. Only when this is true does the authorizer invoke the authorizer // Lambda function, otherwise, it returns a 401 Unauthorized response without // calling the Lambda function. The valid value is a string of comma-separated // mapping expressions of the specified request parameters. When the authorization // caching is not enabled, this property is optional. IdentitySource *string `locationName:"identitySource" type:"string"` // A validation expression for the incoming identity token. For TOKEN authorizers, // this value is a regular expression. For COGNITO_USER_POOLS authorizers, API // Gateway will match the aud field of the incoming token from the client against // the specified regular expression. It will invoke the authorizer's Lambda // function when there is a match. Otherwise, it will return a 401 Unauthorized // response without calling the Lambda function. The validation expression does // not apply to the REQUEST authorizer. IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` // [Required] The name of the authorizer. Name *string `locationName:"name" type:"string"` // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. // Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. // For a TOKEN or REQUEST authorizer, this is not defined. ProviderARNs []string `locationName:"providerARNs" type:"list"` // The authorizer type. Valid values are TOKEN for a Lambda function using a // single authorization token submitted in a custom header, REQUEST for a Lambda // function using incoming request parameters, and COGNITO_USER_POOLS for using // an Amazon Cognito user pool. Type AuthorizerType `locationName:"type" type:"string" enum:"true"` // contains filtered or unexported fields }
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
Use Lambda Function as Authorizer (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html) Use Cognito User Pool as Authorizer (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html)
func (GetAuthorizerOutput) MarshalFields ¶ added in v0.9.0
func (s GetAuthorizerOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetAuthorizerOutput) String ¶ added in v0.9.0
func (s GetAuthorizerOutput) String() string
String returns the string representation
type GetAuthorizerRequest ¶
type GetAuthorizerRequest struct { *aws.Request Input *GetAuthorizerInput Copy func(*GetAuthorizerInput) GetAuthorizerRequest }
GetAuthorizerRequest is the request type for the GetAuthorizer API operation.
func (GetAuthorizerRequest) Send ¶
func (r GetAuthorizerRequest) Send(ctx context.Context) (*GetAuthorizerResponse, error)
Send marshals and sends the GetAuthorizer API request.
type GetAuthorizerResponse ¶ added in v0.9.0
type GetAuthorizerResponse struct { *GetAuthorizerOutput // contains filtered or unexported fields }
GetAuthorizerResponse is the response type for the GetAuthorizer API operation.
func (*GetAuthorizerResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetAuthorizerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetAuthorizer request.
type GetAuthorizersInput ¶
type GetAuthorizersInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe an existing Authorizers resource.
func (GetAuthorizersInput) MarshalFields ¶ added in v0.3.0
func (s GetAuthorizersInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetAuthorizersInput) String ¶
func (s GetAuthorizersInput) String() string
String returns the string representation
func (*GetAuthorizersInput) Validate ¶
func (s *GetAuthorizersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAuthorizersOutput ¶
type GetAuthorizersOutput struct { // The current page of elements from this collection. Items []Authorizer `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Represents a collection of Authorizer resources.
Use Lambda Function as Authorizer (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html) Use Cognito User Pool as Authorizer (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html)
func (GetAuthorizersOutput) MarshalFields ¶ added in v0.3.0
func (s GetAuthorizersOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetAuthorizersOutput) String ¶
func (s GetAuthorizersOutput) String() string
String returns the string representation
type GetAuthorizersRequest ¶
type GetAuthorizersRequest struct { *aws.Request Input *GetAuthorizersInput Copy func(*GetAuthorizersInput) GetAuthorizersRequest }
GetAuthorizersRequest is the request type for the GetAuthorizers API operation.
func (GetAuthorizersRequest) Send ¶
func (r GetAuthorizersRequest) Send(ctx context.Context) (*GetAuthorizersResponse, error)
Send marshals and sends the GetAuthorizers API request.
type GetAuthorizersResponse ¶ added in v0.9.0
type GetAuthorizersResponse struct { *GetAuthorizersOutput // contains filtered or unexported fields }
GetAuthorizersResponse is the response type for the GetAuthorizers API operation.
func (*GetAuthorizersResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetAuthorizersResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetAuthorizers request.
type GetBasePathMappingInput ¶
type GetBasePathMappingInput struct { // [Required] 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. Specify '(none)' 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"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetBasePathMappingInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetBasePathMappingInput) String ¶
func (s GetBasePathMappingInput) String() string
String returns the string representation
func (*GetBasePathMappingInput) Validate ¶
func (s *GetBasePathMappingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetBasePathMappingOutput ¶ added in v0.9.0
type GetBasePathMappingOutput struct { // The base path name that callers of the API must provide as part of the URL // after the domain name. BasePath *string `locationName:"basePath" type:"string"` // The string identifier of the associated RestApi. RestApiId *string `locationName:"restApiId" type:"string"` // The name of the associated stage. Stage *string `locationName:"stage" type:"string"` // contains filtered or unexported fields }
Represents the base path that callers of the API must provide as part of the URL after the domain name.
A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.
Use Custom Domain Names (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (GetBasePathMappingOutput) MarshalFields ¶ added in v0.9.0
func (s GetBasePathMappingOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetBasePathMappingOutput) String ¶ added in v0.9.0
func (s GetBasePathMappingOutput) String() string
String returns the string representation
type GetBasePathMappingRequest ¶
type GetBasePathMappingRequest struct { *aws.Request Input *GetBasePathMappingInput Copy func(*GetBasePathMappingInput) GetBasePathMappingRequest }
GetBasePathMappingRequest is the request type for the GetBasePathMapping API operation.
func (GetBasePathMappingRequest) Send ¶
func (r GetBasePathMappingRequest) Send(ctx context.Context) (*GetBasePathMappingResponse, error)
Send marshals and sends the GetBasePathMapping API request.
type GetBasePathMappingResponse ¶ added in v0.9.0
type GetBasePathMappingResponse struct { *GetBasePathMappingOutput // contains filtered or unexported fields }
GetBasePathMappingResponse is the response type for the GetBasePathMapping API operation.
func (*GetBasePathMappingResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetBasePathMappingResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetBasePathMapping request.
type GetBasePathMappingsInput ¶
type GetBasePathMappingsInput struct { // [Required] The domain name of a BasePathMapping resource. // // DomainName is a required field DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"` // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
A request to get information about a collection of BasePathMapping resources.
func (GetBasePathMappingsInput) MarshalFields ¶ added in v0.3.0
func (s GetBasePathMappingsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetBasePathMappingsInput) String ¶
func (s GetBasePathMappingsInput) String() string
String returns the string representation
func (*GetBasePathMappingsInput) Validate ¶
func (s *GetBasePathMappingsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetBasePathMappingsOutput ¶
type GetBasePathMappingsOutput struct { // The current page of elements from this collection. Items []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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (GetBasePathMappingsOutput) MarshalFields ¶ added in v0.3.0
func (s GetBasePathMappingsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetBasePathMappingsOutput) String ¶
func (s GetBasePathMappingsOutput) String() string
String returns the string representation
type GetBasePathMappingsPaginator ¶ added in v0.9.0
GetBasePathMappingsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetBasePathMappingsPaginator ¶ added in v0.9.0
func NewGetBasePathMappingsPaginator(req GetBasePathMappingsRequest) GetBasePathMappingsPaginator
NewGetBasePathMappingsRequestPaginator returns a paginator for GetBasePathMappings. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetBasePathMappingsRequest(input) p := apigateway.NewGetBasePathMappingsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetBasePathMappingsPaginator) CurrentPage ¶ added in v0.9.0
func (p *GetBasePathMappingsPaginator) CurrentPage() *GetBasePathMappingsOutput
type GetBasePathMappingsRequest ¶
type GetBasePathMappingsRequest struct { *aws.Request Input *GetBasePathMappingsInput Copy func(*GetBasePathMappingsInput) GetBasePathMappingsRequest }
GetBasePathMappingsRequest is the request type for the GetBasePathMappings API operation.
func (GetBasePathMappingsRequest) Send ¶
func (r GetBasePathMappingsRequest) Send(ctx context.Context) (*GetBasePathMappingsResponse, error)
Send marshals and sends the GetBasePathMappings API request.
type GetBasePathMappingsResponse ¶ added in v0.9.0
type GetBasePathMappingsResponse struct { *GetBasePathMappingsOutput // contains filtered or unexported fields }
GetBasePathMappingsResponse is the response type for the GetBasePathMappings API operation.
func (*GetBasePathMappingsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetBasePathMappingsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetBasePathMappings request.
type GetClientCertificateInput ¶
type GetClientCertificateInput struct { // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetClientCertificateInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetClientCertificateInput) String ¶
func (s GetClientCertificateInput) String() string
String returns the string representation
func (*GetClientCertificateInput) Validate ¶
func (s *GetClientCertificateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetClientCertificateOutput ¶ added in v0.9.0
type GetClientCertificateOutput struct { // The identifier of the client certificate. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // The timestamp when the client certificate was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The description of the client certificate. Description *string `locationName:"description" type:"string"` // The timestamp when the client certificate will expire. ExpirationDate *time.Time `locationName:"expirationDate" type:"timestamp"` // 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"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.
Use Client-Side Certificate (https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)
func (GetClientCertificateOutput) MarshalFields ¶ added in v0.9.0
func (s GetClientCertificateOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetClientCertificateOutput) String ¶ added in v0.9.0
func (s GetClientCertificateOutput) String() string
String returns the string representation
type GetClientCertificateRequest ¶
type GetClientCertificateRequest struct { *aws.Request Input *GetClientCertificateInput Copy func(*GetClientCertificateInput) GetClientCertificateRequest }
GetClientCertificateRequest is the request type for the GetClientCertificate API operation.
func (GetClientCertificateRequest) Send ¶
func (r GetClientCertificateRequest) Send(ctx context.Context) (*GetClientCertificateResponse, error)
Send marshals and sends the GetClientCertificate API request.
type GetClientCertificateResponse ¶ added in v0.9.0
type GetClientCertificateResponse struct { *GetClientCertificateOutput // contains filtered or unexported fields }
GetClientCertificateResponse is the response type for the GetClientCertificate API operation.
func (*GetClientCertificateResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetClientCertificateResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetClientCertificate request.
type GetClientCertificatesInput ¶
type GetClientCertificatesInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
A request to get information about a collection of ClientCertificate resources.
func (GetClientCertificatesInput) MarshalFields ¶ added in v0.3.0
func (s GetClientCertificatesInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetClientCertificatesInput) String ¶
func (s GetClientCertificatesInput) String() string
String returns the string representation
type GetClientCertificatesOutput ¶
type GetClientCertificatesOutput struct { // The current page of elements from this collection. Items []Certificate `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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)
func (GetClientCertificatesOutput) MarshalFields ¶ added in v0.3.0
func (s GetClientCertificatesOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetClientCertificatesOutput) String ¶
func (s GetClientCertificatesOutput) String() string
String returns the string representation
type GetClientCertificatesPaginator ¶ added in v0.9.0
GetClientCertificatesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetClientCertificatesPaginator ¶ added in v0.9.0
func NewGetClientCertificatesPaginator(req GetClientCertificatesRequest) GetClientCertificatesPaginator
NewGetClientCertificatesRequestPaginator returns a paginator for GetClientCertificates. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetClientCertificatesRequest(input) p := apigateway.NewGetClientCertificatesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetClientCertificatesPaginator) CurrentPage ¶ added in v0.9.0
func (p *GetClientCertificatesPaginator) CurrentPage() *GetClientCertificatesOutput
type GetClientCertificatesRequest ¶
type GetClientCertificatesRequest struct { *aws.Request Input *GetClientCertificatesInput Copy func(*GetClientCertificatesInput) GetClientCertificatesRequest }
GetClientCertificatesRequest is the request type for the GetClientCertificates API operation.
func (GetClientCertificatesRequest) Send ¶
func (r GetClientCertificatesRequest) Send(ctx context.Context) (*GetClientCertificatesResponse, error)
Send marshals and sends the GetClientCertificates API request.
type GetClientCertificatesResponse ¶ added in v0.9.0
type GetClientCertificatesResponse struct { *GetClientCertificatesOutput // contains filtered or unexported fields }
GetClientCertificatesResponse is the response type for the GetClientCertificates API operation.
func (*GetClientCertificatesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetClientCertificatesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetClientCertificates request.
type GetDeploymentInput ¶
type GetDeploymentInput struct { // [Required] The identifier of the Deployment resource to get information about. // // DeploymentId is a required field DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` // A query parameter to retrieve the specified embedded resources of the returned // Deployment resource in the response. In a REST API call, this embed parameter // value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. // The SDK and other platform-dependent libraries might use a different format // for the list. Currently, this request supports only retrieval of the embedded // API summary this way. Hence, the parameter value must be a single-valued // list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary. Embed []string `location:"querystring" locationName:"embed" type:"list"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests API Gateway to get information about a Deployment resource.
func (GetDeploymentInput) MarshalFields ¶ added in v0.3.0
func (s GetDeploymentInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDeploymentInput) String ¶
func (s GetDeploymentInput) String() string
String returns the string representation
func (*GetDeploymentInput) Validate ¶
func (s *GetDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDeploymentOutput ¶ added in v0.9.0
type GetDeploymentOutput 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"` // 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 (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html), AWS SDKs (https://aws.amazon.com/tools/)
func (GetDeploymentOutput) MarshalFields ¶ added in v0.9.0
func (s GetDeploymentOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDeploymentOutput) String ¶ added in v0.9.0
func (s GetDeploymentOutput) String() string
String returns the string representation
type GetDeploymentRequest ¶
type GetDeploymentRequest struct { *aws.Request Input *GetDeploymentInput Copy func(*GetDeploymentInput) GetDeploymentRequest }
GetDeploymentRequest is the request type for the GetDeployment API operation.
func (GetDeploymentRequest) Send ¶
func (r GetDeploymentRequest) Send(ctx context.Context) (*GetDeploymentResponse, error)
Send marshals and sends the GetDeployment API request.
type GetDeploymentResponse ¶ added in v0.9.0
type GetDeploymentResponse struct { *GetDeploymentOutput // contains filtered or unexported fields }
GetDeploymentResponse is the response type for the GetDeployment API operation.
func (*GetDeploymentResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetDeploymentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDeployment request.
type GetDeploymentsInput ¶
type GetDeploymentsInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests API Gateway to get information about a Deployments collection.
func (GetDeploymentsInput) MarshalFields ¶ added in v0.3.0
func (s GetDeploymentsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDeploymentsInput) String ¶
func (s GetDeploymentsInput) String() string
String returns the string representation
func (*GetDeploymentsInput) Validate ¶
func (s *GetDeploymentsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDeploymentsOutput ¶
type GetDeploymentsOutput struct { // The current page of elements from this collection. Items []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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html), AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html), AWS SDKs (https://aws.amazon.com/tools/)
func (GetDeploymentsOutput) MarshalFields ¶ added in v0.3.0
func (s GetDeploymentsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDeploymentsOutput) String ¶
func (s GetDeploymentsOutput) String() string
String returns the string representation
type GetDeploymentsPaginator ¶ added in v0.9.0
GetDeploymentsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetDeploymentsPaginator ¶ added in v0.9.0
func NewGetDeploymentsPaginator(req GetDeploymentsRequest) GetDeploymentsPaginator
NewGetDeploymentsRequestPaginator returns a paginator for GetDeployments. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetDeploymentsRequest(input) p := apigateway.NewGetDeploymentsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetDeploymentsPaginator) CurrentPage ¶ added in v0.9.0
func (p *GetDeploymentsPaginator) CurrentPage() *GetDeploymentsOutput
type GetDeploymentsRequest ¶
type GetDeploymentsRequest struct { *aws.Request Input *GetDeploymentsInput Copy func(*GetDeploymentsInput) GetDeploymentsRequest }
GetDeploymentsRequest is the request type for the GetDeployments API operation.
func (GetDeploymentsRequest) Send ¶
func (r GetDeploymentsRequest) Send(ctx context.Context) (*GetDeploymentsResponse, error)
Send marshals and sends the GetDeployments API request.
type GetDeploymentsResponse ¶ added in v0.9.0
type GetDeploymentsResponse struct { *GetDeploymentsOutput // contains filtered or unexported fields }
GetDeploymentsResponse is the response type for the GetDeployments API operation.
func (*GetDeploymentsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetDeploymentsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDeployments request.
type GetDocumentationPartInput ¶
type GetDocumentationPartInput struct { // [Required] The string identifier of the associated RestApi. // // DocumentationPartId is a required field DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets a specified documentation part of a given API.
func (GetDocumentationPartInput) MarshalFields ¶ added in v0.3.0
func (s GetDocumentationPartInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDocumentationPartInput) String ¶
func (s GetDocumentationPartInput) String() string
String returns the string representation
func (*GetDocumentationPartInput) Validate ¶
func (s *GetDocumentationPartInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDocumentationPartOutput ¶ added in v0.9.0
type GetDocumentationPartOutput struct { // The DocumentationPart identifier, generated by 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 OpenAPI-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 OpenAPI 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 OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.
Documenting an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationParts
func (GetDocumentationPartOutput) MarshalFields ¶ added in v0.9.0
func (s GetDocumentationPartOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDocumentationPartOutput) String ¶ added in v0.9.0
func (s GetDocumentationPartOutput) String() string
String returns the string representation
type GetDocumentationPartRequest ¶
type GetDocumentationPartRequest struct { *aws.Request Input *GetDocumentationPartInput Copy func(*GetDocumentationPartInput) GetDocumentationPartRequest }
GetDocumentationPartRequest is the request type for the GetDocumentationPart API operation.
func (GetDocumentationPartRequest) Send ¶
func (r GetDocumentationPartRequest) Send(ctx context.Context) (*GetDocumentationPartResponse, error)
Send marshals and sends the GetDocumentationPart API request.
type GetDocumentationPartResponse ¶ added in v0.9.0
type GetDocumentationPartResponse struct { *GetDocumentationPartOutput // contains filtered or unexported fields }
GetDocumentationPartResponse is the response type for the GetDocumentationPart API operation.
func (*GetDocumentationPartResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetDocumentationPartResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDocumentationPart request.
type GetDocumentationPartsInput ¶
type GetDocumentationPartsInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The status of the API documentation parts to retrieve. Valid values are DOCUMENTED // for retrieving DocumentationPart resources with content and UNDOCUMENTED // for DocumentationPart resources without content. LocationStatus LocationStatusType `location:"querystring" locationName:"locationStatus" type:"string" enum:"true"` // The name of API entities of the to-be-retrieved documentation parts. NameQuery *string `location:"querystring" locationName:"name" type:"string"` // The path of API entities of the to-be-retrieved documentation parts. Path *string `location:"querystring" locationName:"path" type:"string"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The type of API entities of the to-be-retrieved documentation parts. Type DocumentationPartType `location:"querystring" locationName:"type" type:"string" enum:"true"` // contains filtered or unexported fields }
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
func (GetDocumentationPartsInput) MarshalFields ¶ added in v0.3.0
func (s GetDocumentationPartsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDocumentationPartsInput) String ¶
func (s GetDocumentationPartsInput) String() string
String returns the string representation
func (*GetDocumentationPartsInput) Validate ¶
func (s *GetDocumentationPartsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDocumentationPartsOutput ¶
type GetDocumentationPartsOutput struct { // The current page of elements from this collection. Items []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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart
func (GetDocumentationPartsOutput) MarshalFields ¶ added in v0.3.0
func (s GetDocumentationPartsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDocumentationPartsOutput) String ¶
func (s GetDocumentationPartsOutput) String() string
String returns the string representation
type GetDocumentationPartsRequest ¶
type GetDocumentationPartsRequest struct { *aws.Request Input *GetDocumentationPartsInput Copy func(*GetDocumentationPartsInput) GetDocumentationPartsRequest }
GetDocumentationPartsRequest is the request type for the GetDocumentationParts API operation.
func (GetDocumentationPartsRequest) Send ¶
func (r GetDocumentationPartsRequest) Send(ctx context.Context) (*GetDocumentationPartsResponse, error)
Send marshals and sends the GetDocumentationParts API request.
type GetDocumentationPartsResponse ¶ added in v0.9.0
type GetDocumentationPartsResponse struct { *GetDocumentationPartsOutput // contains filtered or unexported fields }
GetDocumentationPartsResponse is the response type for the GetDocumentationParts API operation.
func (*GetDocumentationPartsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetDocumentationPartsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDocumentationParts request.
type GetDocumentationVersionInput ¶
type GetDocumentationVersionInput struct { // [Required] The version identifier of the to-be-retrieved documentation snapshot. // // DocumentationVersion is a required field DocumentationVersion *string `location:"uri" locationName:"doc_version" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets a documentation snapshot of an API.
func (GetDocumentationVersionInput) MarshalFields ¶ added in v0.3.0
func (s GetDocumentationVersionInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDocumentationVersionInput) String ¶
func (s GetDocumentationVersionInput) String() string
String returns the string representation
func (*GetDocumentationVersionInput) Validate ¶
func (s *GetDocumentationVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDocumentationVersionOutput ¶ added in v0.9.0
type GetDocumentationVersionOutput struct { // The date when the API documentation snapshot is created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // 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., OpenAPI) file.
Documenting an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart, DocumentationVersions
func (GetDocumentationVersionOutput) MarshalFields ¶ added in v0.9.0
func (s GetDocumentationVersionOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDocumentationVersionOutput) String ¶ added in v0.9.0
func (s GetDocumentationVersionOutput) String() string
String returns the string representation
type GetDocumentationVersionRequest ¶
type GetDocumentationVersionRequest struct { *aws.Request Input *GetDocumentationVersionInput Copy func(*GetDocumentationVersionInput) GetDocumentationVersionRequest }
GetDocumentationVersionRequest is the request type for the GetDocumentationVersion API operation.
func (GetDocumentationVersionRequest) Send ¶
func (r GetDocumentationVersionRequest) Send(ctx context.Context) (*GetDocumentationVersionResponse, error)
Send marshals and sends the GetDocumentationVersion API request.
type GetDocumentationVersionResponse ¶ added in v0.9.0
type GetDocumentationVersionResponse struct { *GetDocumentationVersionOutput // contains filtered or unexported fields }
GetDocumentationVersionResponse is the response type for the GetDocumentationVersion API operation.
func (*GetDocumentationVersionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetDocumentationVersionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDocumentationVersion request.
type GetDocumentationVersionsInput ¶
type GetDocumentationVersionsInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets the documentation versions of an API.
func (GetDocumentationVersionsInput) MarshalFields ¶ added in v0.3.0
func (s GetDocumentationVersionsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDocumentationVersionsInput) String ¶
func (s GetDocumentationVersionsInput) String() string
String returns the string representation
func (*GetDocumentationVersionsInput) Validate ¶
func (s *GetDocumentationVersionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDocumentationVersionsOutput ¶
type GetDocumentationVersionsOutput struct { // The current page of elements from this collection. Items []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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart, DocumentationVersion
func (GetDocumentationVersionsOutput) MarshalFields ¶ added in v0.3.0
func (s GetDocumentationVersionsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDocumentationVersionsOutput) String ¶
func (s GetDocumentationVersionsOutput) String() string
String returns the string representation
type GetDocumentationVersionsRequest ¶
type GetDocumentationVersionsRequest struct { *aws.Request Input *GetDocumentationVersionsInput Copy func(*GetDocumentationVersionsInput) GetDocumentationVersionsRequest }
GetDocumentationVersionsRequest is the request type for the GetDocumentationVersions API operation.
func (GetDocumentationVersionsRequest) Send ¶
func (r GetDocumentationVersionsRequest) Send(ctx context.Context) (*GetDocumentationVersionsResponse, error)
Send marshals and sends the GetDocumentationVersions API request.
type GetDocumentationVersionsResponse ¶ added in v0.9.0
type GetDocumentationVersionsResponse struct { *GetDocumentationVersionsOutput // contains filtered or unexported fields }
GetDocumentationVersionsResponse is the response type for the GetDocumentationVersions API operation.
func (*GetDocumentationVersionsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetDocumentationVersionsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDocumentationVersions request.
type GetDomainNameInput ¶
type GetDomainNameInput struct { // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetDomainNameInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDomainNameInput) String ¶
func (s GetDomainNameInput) String() string
String returns the string representation
func (*GetDomainNameInput) Validate ¶
func (s *GetDomainNameInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDomainNameOutput ¶ added in v0.9.0
type GetDomainNameOutput struct { // The reference to an AWS-managed certificate that will be used by edge-optimized // endpoint for this domain name. AWS Certificate Manager is the only supported // source. CertificateArn *string `locationName:"certificateArn" type:"string"` // The name of the certificate that will be used by edge-optimized endpoint // for this domain name. CertificateName *string `locationName:"certificateName" type:"string"` // The timestamp when the certificate that was used by edge-optimized endpoint // for this domain name was uploaded. CertificateUploadDate *time.Time `locationName:"certificateUploadDate" type:"timestamp"` // The domain name of the Amazon CloudFront distribution associated with this // custom domain name for an edge-optimized endpoint. You set up this association // when adding a DNS record pointing the custom domain name to this distribution // name. For more information about CloudFront distributions, see the Amazon // CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/). DistributionDomainName *string `locationName:"distributionDomainName" type:"string"` // The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized // endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more // information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) // and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). DistributionHostedZoneId *string `locationName:"distributionHostedZoneId" type:"string"` // The custom domain name as an API host name, for example, my-api.example.com. DomainName *string `locationName:"domainName" type:"string"` // The status of the DomainName migration. The valid values are AVAILABLE and // UPDATING. If the status is UPDATING, the domain cannot be modified further // until the existing operation is complete. If it is AVAILABLE, the domain // can be updated. DomainNameStatus DomainNameStatus `locationName:"domainNameStatus" type:"string" enum:"true"` // An optional text message containing detailed information about status of // the DomainName migration. DomainNameStatusMessage *string `locationName:"domainNameStatusMessage" type:"string"` // The endpoint configuration of this DomainName showing the endpoint types // of the domain name. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The reference to an AWS-managed certificate that will be used for validating // the regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string `locationName:"regionalCertificateArn" type:"string"` // The name of the certificate that will be used for validating the regional // domain name. RegionalCertificateName *string `locationName:"regionalCertificateName" type:"string"` // The domain name associated with the regional endpoint for this custom domain // name. You set up this association by adding a DNS record that points the // custom domain name to this regional domain name. The regional domain name // is returned by API Gateway when you create a regional endpoint. RegionalDomainName *string `locationName:"regionalDomainName" type:"string"` // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. // For more information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) // and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). RegionalHostedZoneId *string `locationName:"regionalHostedZoneId" type:"string"` // The Transport Layer Security (TLS) version + cipher suite for this DomainName. // The valid values are TLS_1_0 and TLS_1_2. SecurityPolicy SecurityPolicy `locationName:"securityPolicy" type:"string" enum:"true"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
Represents a custom domain name as a user-friendly host name of an API (RestApi).
When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.
Set a Custom Host Name for an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (GetDomainNameOutput) MarshalFields ¶ added in v0.9.0
func (s GetDomainNameOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDomainNameOutput) String ¶ added in v0.9.0
func (s GetDomainNameOutput) String() string
String returns the string representation
type GetDomainNameRequest ¶
type GetDomainNameRequest struct { *aws.Request Input *GetDomainNameInput Copy func(*GetDomainNameInput) GetDomainNameRequest }
GetDomainNameRequest is the request type for the GetDomainName API operation.
func (GetDomainNameRequest) Send ¶
func (r GetDomainNameRequest) Send(ctx context.Context) (*GetDomainNameResponse, error)
Send marshals and sends the GetDomainName API request.
type GetDomainNameResponse ¶ added in v0.9.0
type GetDomainNameResponse struct { *GetDomainNameOutput // contains filtered or unexported fields }
GetDomainNameResponse is the response type for the GetDomainName API operation.
func (*GetDomainNameResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetDomainNameResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDomainName request.
type GetDomainNamesInput ¶
type GetDomainNamesInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
Request to describe a collection of DomainName resources.
func (GetDomainNamesInput) MarshalFields ¶ added in v0.3.0
func (s GetDomainNamesInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDomainNamesInput) String ¶
func (s GetDomainNamesInput) String() string
String returns the string representation
type GetDomainNamesOutput ¶
type GetDomainNamesOutput struct { // The current page of elements from this collection. Items []DomainName `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Represents a collection of DomainName resources.
Use Client-Side Certificate (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (GetDomainNamesOutput) MarshalFields ¶ added in v0.3.0
func (s GetDomainNamesOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDomainNamesOutput) String ¶
func (s GetDomainNamesOutput) String() string
String returns the string representation
type GetDomainNamesPaginator ¶ added in v0.9.0
GetDomainNamesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetDomainNamesPaginator ¶ added in v0.9.0
func NewGetDomainNamesPaginator(req GetDomainNamesRequest) GetDomainNamesPaginator
NewGetDomainNamesRequestPaginator returns a paginator for GetDomainNames. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetDomainNamesRequest(input) p := apigateway.NewGetDomainNamesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetDomainNamesPaginator) CurrentPage ¶ added in v0.9.0
func (p *GetDomainNamesPaginator) CurrentPage() *GetDomainNamesOutput
type GetDomainNamesRequest ¶
type GetDomainNamesRequest struct { *aws.Request Input *GetDomainNamesInput Copy func(*GetDomainNamesInput) GetDomainNamesRequest }
GetDomainNamesRequest is the request type for the GetDomainNames API operation.
func (GetDomainNamesRequest) Send ¶
func (r GetDomainNamesRequest) Send(ctx context.Context) (*GetDomainNamesResponse, error)
Send marshals and sends the GetDomainNames API request.
type GetDomainNamesResponse ¶ added in v0.9.0
type GetDomainNamesResponse struct { *GetDomainNamesOutput // contains filtered or unexported fields }
GetDomainNamesResponse is the response type for the GetDomainNames API operation.
func (*GetDomainNamesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetDomainNamesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDomainNames request.
type GetExportInput ¶
type GetExportInput struct { // The content-type of the export, for example application/json. Currently application/json // and application/yaml are supported for exportType ofoas30 and swagger. This // should be specified in the Accept header for direct API requests. Accepts *string `location:"header" locationName:"Accept" type:"string"` // [Required] The type of export. Acceptable values are 'oas30' for OpenAPI // 3.0.x and 'swagger' for Swagger/OpenAPI 2.0. // // 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 exportType oas30 and swagger, // any combination of the following parameters are supported: extensions='integrations' // or extensions='apigateway' will export the API with x-amazon-apigateway-integration // extensions. 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The 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) MarshalFields ¶ added in v0.3.0
func (s GetExportInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetExportInput) String ¶
func (s GetExportInput) String() string
String returns the string representation
func (*GetExportInput) Validate ¶
func (s *GetExportInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetExportOutput ¶
type GetExportOutput struct { // The binary blob response to GetExport, which contains the export. Body []byte `locationName:"body" type:"blob"` // The content-disposition header value in the HTTP response. ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"` // The content-type header value in the HTTP response. This will correspond // to a valid 'accept' type in the request. ContentType *string `location:"header" locationName:"Content-Type" type:"string"` // contains filtered or unexported fields }
The binary blob response to GetExport, which contains the generated SDK.
func (GetExportOutput) MarshalFields ¶ added in v0.3.0
func (s GetExportOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetExportOutput) String ¶
func (s GetExportOutput) String() string
String returns the string representation
type GetExportRequest ¶
type GetExportRequest struct { *aws.Request Input *GetExportInput Copy func(*GetExportInput) GetExportRequest }
GetExportRequest is the request type for the GetExport API operation.
func (GetExportRequest) Send ¶
func (r GetExportRequest) Send(ctx context.Context) (*GetExportResponse, error)
Send marshals and sends the GetExport API request.
type GetExportResponse ¶ added in v0.9.0
type GetExportResponse struct { *GetExportOutput // contains filtered or unexported fields }
GetExportResponse is the response type for the GetExport API operation.
func (*GetExportResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetExportResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetExport request.
type GetGatewayResponseInput ¶
type GetGatewayResponseInput struct { // [Required] // The response type of the associated GatewayResponse. Valid values are // * ACCESS_DENIED // // * API_CONFIGURATION_ERROR // // * AUTHORIZER_FAILURE // // * AUTHORIZER_CONFIGURATION_ERROR // // * BAD_REQUEST_PARAMETERS // // * BAD_REQUEST_BODY // // * DEFAULT_4XX // // * DEFAULT_5XX // // * EXPIRED_TOKEN // // * INVALID_SIGNATURE // // * INTEGRATION_FAILURE // // * INTEGRATION_TIMEOUT // // * INVALID_API_KEY // // * MISSING_AUTHENTICATION_TOKEN // // * QUOTA_EXCEEDED // // * REQUEST_TOO_LARGE // // * RESOURCE_NOT_FOUND // // * THROTTLED // // * UNAUTHORIZED // // * UNSUPPORTED_MEDIA_TYPE // // ResponseType is a required field ResponseType GatewayResponseType `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets a GatewayResponse of a specified response type on the given RestApi.
func (GetGatewayResponseInput) MarshalFields ¶ added in v0.3.0
func (s GetGatewayResponseInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetGatewayResponseInput) String ¶
func (s GetGatewayResponseInput) String() string
String returns the string representation
func (*GetGatewayResponseInput) Validate ¶
func (s *GetGatewayResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetGatewayResponseOutput ¶ added in v0.9.0
type GetGatewayResponseOutput struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway // response (true) or not (false). A default gateway response is one generated // by API Gateway without any customization by an API developer. DefaultResponse *bool `locationName:"defaultResponse" type:"boolean"` // Response parameters (paths, query strings and headers) of the GatewayResponse // as a string-to-string map of key-value pairs. ResponseParameters map[string]string `locationName:"responseParameters" type:"map"` // Response templates of the GatewayResponse as a string-to-string map of key-value // pairs. ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"` // The response type of the associated GatewayResponse. Valid values are // * ACCESS_DENIED // // * API_CONFIGURATION_ERROR // // * AUTHORIZER_FAILURE // // * AUTHORIZER_CONFIGURATION_ERROR // // * BAD_REQUEST_PARAMETERS // // * BAD_REQUEST_BODY // // * DEFAULT_4XX // // * DEFAULT_5XX // // * EXPIRED_TOKEN // // * INVALID_SIGNATURE // // * INTEGRATION_FAILURE // // * INTEGRATION_TIMEOUT // // * INVALID_API_KEY // // * MISSING_AUTHENTICATION_TOKEN // // * QUOTA_EXCEEDED // // * REQUEST_TOO_LARGE // // * RESOURCE_NOT_FOUND // // * THROTTLED // // * UNAUTHORIZED // // * UNSUPPORTED_MEDIA_TYPE ResponseType GatewayResponseType `locationName:"responseType" type:"string" enum:"true"` // The HTTP status code for this GatewayResponse. StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway (https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html)
Example: Get a Gateway Response of a given response type
Request ¶
This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45
The response type is specified as a URL path.
Response ¶
The successful operation returns the 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{\n \"message\": $context.error.messageString,\n \"type\": \"$context.error.responseType\",\n \"stage\": \"$context.stage\",\n \"resourcePath\": \"$context.resourcePath\",\n \"stageVariables.a\": \"$stageVariables.a\",\n \"statusCode\": \"'404'\"\n}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404" }
Customize Gateway Responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html)
func (GetGatewayResponseOutput) MarshalFields ¶ added in v0.9.0
func (s GetGatewayResponseOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetGatewayResponseOutput) String ¶ added in v0.9.0
func (s GetGatewayResponseOutput) String() string
String returns the string representation
type GetGatewayResponseRequest ¶
type GetGatewayResponseRequest struct { *aws.Request Input *GetGatewayResponseInput Copy func(*GetGatewayResponseInput) GetGatewayResponseRequest }
GetGatewayResponseRequest is the request type for the GetGatewayResponse API operation.
func (GetGatewayResponseRequest) Send ¶
func (r GetGatewayResponseRequest) Send(ctx context.Context) (*GetGatewayResponseResponse, error)
Send marshals and sends the GetGatewayResponse API request.
type GetGatewayResponseResponse ¶ added in v0.9.0
type GetGatewayResponseResponse struct { *GetGatewayResponseOutput // contains filtered or unexported fields }
GetGatewayResponseResponse is the response type for the GetGatewayResponse API operation.
func (*GetGatewayResponseResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetGatewayResponseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetGatewayResponse request.
type GetGatewayResponsesInput ¶
type GetGatewayResponsesInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. The GatewayResponses collection does not support // pagination and the limit does not apply here. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. The GatewayResponse // collection does not support pagination and the position does not apply here. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
func (GetGatewayResponsesInput) MarshalFields ¶ added in v0.3.0
func (s GetGatewayResponsesInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetGatewayResponsesInput) String ¶
func (s GetGatewayResponsesInput) String() string
String returns the string representation
func (*GetGatewayResponsesInput) Validate ¶
func (s *GetGatewayResponsesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetGatewayResponsesOutput ¶
type GetGatewayResponsesOutput struct { // Returns the entire collection, because of no pagination support. Items []GatewayResponse `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.
For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway (https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html)
Example: Get the collection of gateway responses of an API
Request ¶
This example request shows how to retrieve the GatewayResponses collection from an API.
GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515
Response ¶
The successful operation returns the 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "first": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "gatewayresponse:by-type": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "item": [ { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" }, { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" }, { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } ] }, "_embedded": { "item": [ { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "INTEGRATION_FAILURE", "statusCode": "504" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "RESOURCE_NOT_FOUND", "statusCode": "404" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "REQUEST_TOO_LARGE", "statusCode": "413" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "THROTTLED", "statusCode": "429" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "UNSUPPORTED_MEDIA_TYPE", "statusCode": "415" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "AUTHORIZER_CONFIGURATION_ERROR", "statusCode": "500" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "DEFAULT_5XX" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "DEFAULT_4XX" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "BAD_REQUEST_PARAMETERS", "statusCode": "400" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "BAD_REQUEST_BODY", "statusCode": "400" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "EXPIRED_TOKEN", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "ACCESS_DENIED", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "INVALID_API_KEY", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "UNAUTHORIZED", "statusCode": "401" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "API_CONFIGURATION_ERROR", "statusCode": "500" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "QUOTA_EXCEEDED", "statusCode": "429" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "INTEGRATION_TIMEOUT", "statusCode": "504" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "INVALID_SIGNATURE", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{\"message\":$context.error.messageString}" }, "responseType": "AUTHORIZER_FAILURE", "statusCode": "500" } ] } }
Customize Gateway Responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html)
func (GetGatewayResponsesOutput) MarshalFields ¶ added in v0.3.0
func (s GetGatewayResponsesOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetGatewayResponsesOutput) String ¶
func (s GetGatewayResponsesOutput) String() string
String returns the string representation
type GetGatewayResponsesRequest ¶
type GetGatewayResponsesRequest struct { *aws.Request Input *GetGatewayResponsesInput Copy func(*GetGatewayResponsesInput) GetGatewayResponsesRequest }
GetGatewayResponsesRequest is the request type for the GetGatewayResponses API operation.
func (GetGatewayResponsesRequest) Send ¶
func (r GetGatewayResponsesRequest) Send(ctx context.Context) (*GetGatewayResponsesResponse, error)
Send marshals and sends the GetGatewayResponses API request.
type GetGatewayResponsesResponse ¶ added in v0.9.0
type GetGatewayResponsesResponse struct { *GetGatewayResponsesOutput // contains filtered or unexported fields }
GetGatewayResponsesResponse is the response type for the GetGatewayResponses API operation.
func (*GetGatewayResponsesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetGatewayResponsesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetGatewayResponses request.
type GetIntegrationInput ¶
type GetIntegrationInput struct { // [Required] Specifies a get integration request's HTTP method. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // [Required] Specifies a get integration request's resource identifier // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a request to get the integration configuration.
func (GetIntegrationInput) MarshalFields ¶ added in v0.3.0
func (s GetIntegrationInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetIntegrationInput) String ¶
func (s GetIntegrationInput) String() string
String returns the string representation
func (*GetIntegrationInput) Validate ¶
func (s *GetIntegrationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetIntegrationOutput ¶ added in v0.9.0
type GetIntegrationOutput struct { // A list of request parameters whose values API Gateway caches. To be valid // values for cacheKeyParameters, these parameters must also be specified for // Method requestParameters. CacheKeyParameters []string `locationName:"cacheKeyParameters" type:"list"` // Specifies a group of related cached parameters. By default, API Gateway uses // the resource ID as the cacheNamespace. You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string `locationName:"cacheNamespace" type:"string"` // The (id (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) // of the VpcLink used for the integration when connectionType=VPC_LINK and // undefined, otherwise. ConnectionId *string `locationName:"connectionId" type:"string"` // The type of the network connection to the integration endpoint. The valid // value is INTERNET for connections through the public routable internet or // VPC_LINK for private connections between API Gateway and a network load balancer // in a VPC. The default value is INTERNET. ConnectionType ConnectionType `locationName:"connectionType" type:"string" enum:"true"` // 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 passthroughBehavior is configured to support payload pass-through. ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"` // Specifies the credentials required for the integration, if any. For AWS integrations, // three options are available. To specify an IAM Role for API Gateway to assume, // use the role's Amazon Resource Name (ARN). To require that the caller's identity // be passed through from the request, specify the string arn:aws:iam::\*:user/\*. // To use resource-based permissions on supported AWS services, specify null. Credentials *string `locationName:"credentials" type:"string"` // Specifies the integration's HTTP method type. HttpMethod *string `locationName:"httpMethod" type:"string"` // Specifies the integration's responses. // // Example: Get integration responses of a method // // Request // GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 // HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns 200 OK status and a payload as follows: // { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", // "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" // }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" // } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" // }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream // in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" // }, "statusCode": "200" } // // Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) IntegrationResponses map[string]IntegrationResponse `locationName:"integrationResponses" type:"map"` // Specifies how the method request body of an unmapped content type will be // passed through the integration request to the back end without transformation. // A content type is unmapped if no mapping template is defined in the integration // or the content type does not match any of the mapped content types, as specified // in requestTemplates. The valid value is one of the following: // // * WHEN_NO_MATCH: passes the method request body through the integration // request to the back end without transformation when the method request // content type does not match any content type associated with the mapping // templates defined in the integration request. // // * WHEN_NO_TEMPLATES: passes the method request body through the integration // request to the back end without transformation when no mapping template // is defined in the integration request. If a template is defined when this // option is selected, the method request of an unmapped content-type will // be rejected with an HTTP 415 Unsupported Media Type response. // // * NEVER: rejects the method request with an HTTP 415 Unsupported Media // Type response when either the method request content type does not match // any content type associated with the mapping templates defined in the // integration request or no mapping template is defined in the integration // request. PassthroughBehavior *string `locationName:"passthroughBehavior" type:"string"` // A key-value map specifying request parameters that are passed from the method // request to the back end. The key is an integration request parameter name // and the associated value is a method request parameter value or static value // that must be enclosed within single quotes and pre-encoded as required by // the back end. The method request parameter value must match the pattern of // method.request.{location}.{name}, where location is querystring, path, or // header and name must be a valid and unique method request parameter name. RequestParameters map[string]string `locationName:"requestParameters" type:"map"` // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the // value. RequestTemplates map[string]string `locationName:"requestTemplates" type:"map"` // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 // milliseconds or 29 seconds. TimeoutInMillis *int64 `locationName:"timeoutInMillis" type:"integer"` // Specifies the TLS configuration for an integration. TlsConfig *TlsConfig `locationName:"tlsConfig" type:"structure"` // Specifies an API method integration type. The valid value is one of the following: // // * AWS: for integrating the API method request with an AWS service action, // including the Lambda function-invoking action. With the Lambda function-invoking // action, this is referred to as the Lambda custom integration. With any // other AWS service action, this is known as AWS integration. // // * AWS_PROXY: for integrating the API method request with the Lambda function-invoking // action with the client request passed through as-is. This integration // is also referred to as the Lambda proxy integration. // // * HTTP: for integrating the API method request with an HTTP endpoint, // including a private HTTP endpoint within a VPC. This integration is also // referred to as the HTTP custom integration. // // * HTTP_PROXY: for integrating the API method request with an HTTP endpoint, // including a private HTTP endpoint within a VPC, with the client request // passed through as-is. This is also referred to as the HTTP proxy integration. // // * MOCK: for integrating the API method request with API Gateway as a "loop-back" // endpoint without invoking any backend. // // For the HTTP and HTTP proxy integrations, each integration can specify a // protocol (http/https), port and path. Standard 80 and 443 ports are supported // as well as custom ports above 1024. An HTTP or HTTP proxy integration with // a connectionType of VPC_LINK is referred to as a private integration and // uses a VpcLink to connect API Gateway to a network load balancer of a VPC. Type IntegrationType `locationName:"type" type:"string" enum:"true"` // Specifies Uniform Resource Identifier (URI) of the integration endpoint. // // * For HTTP or HTTP_PROXY 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 either standard integration, where connectionType is not VPC_LINK, // or private integration, where connectionType is VPC_LINK. For a private // HTTP integration, the URI is not used for routing. // // * For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. // Here, {Region} is the API Gateway region (e.g., us-east-1); {service} // is the name of the integrated AWS service (e.g., s3); and {subdomain} // is a designated subdomain supported by certain AWS service for fast host-name // lookup. action can be used for an AWS service action-based API, using // an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} // refers to a supported action {name} plus any required input parameters. // Alternatively, path can be used for an AWS service path-based API. The // ensuing service_api refers to the path to an AWS service resource, including // the region of the integrated AWS service, if applicable. For example, // for integration with the S3 API of GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html), // the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} // or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (GetIntegrationOutput) MarshalFields ¶ added in v0.9.0
func (s GetIntegrationOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetIntegrationOutput) String ¶ added in v0.9.0
func (s GetIntegrationOutput) String() string
String returns the string representation
type GetIntegrationRequest ¶
type GetIntegrationRequest struct { *aws.Request Input *GetIntegrationInput Copy func(*GetIntegrationInput) GetIntegrationRequest }
GetIntegrationRequest is the request type for the GetIntegration API operation.
func (GetIntegrationRequest) Send ¶
func (r GetIntegrationRequest) Send(ctx context.Context) (*GetIntegrationResponse, error)
Send marshals and sends the GetIntegration API request.
type GetIntegrationResponse ¶ added in v0.9.0
type GetIntegrationResponse struct { *GetIntegrationOutput // contains filtered or unexported fields }
GetIntegrationResponse is the response type for the GetIntegration API operation.
func (*GetIntegrationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetIntegrationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetIntegration request.
type GetIntegrationResponseInput ¶
type GetIntegrationResponseInput struct { // [Required] 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"` // [Required] 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetIntegrationResponseInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetIntegrationResponseInput) String ¶
func (s GetIntegrationResponseInput) String() string
String returns the string representation
func (*GetIntegrationResponseInput) Validate ¶
func (s *GetIntegrationResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetIntegrationResponseOutput ¶ added in v0.9.0
type GetIntegrationResponseOutput struct { // Specifies how to handle response payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: // // * CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded // string to the corresponding binary blob. // // * CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. // // If this property is not defined, the response payload will be passed through // from the integration response to the method response without modification. ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"` // A key-value map specifying response parameters that are passed to the method // response from the back end. The key is a method response header parameter // name and the mapped value is an integration response header value, a static // value enclosed within a pair of single quotes, or a JSON expression from // the integration response body. The mapping key must match the pattern of // method.response.header.{name}, where name is a valid and unique header name. // The mapped non-static value must match the pattern of integration.response.header.{name} // or integration.response.body.{JSON-expression}, where name is a valid and // unique response header name and JSON-expression is a valid JSON expression // without the $ prefix. ResponseParameters map[string]string `locationName:"responseParameters" type:"map"` // Specifies the templates used to transform the integration response body. // Response templates are represented as a key/value map, with a content-type // as the key and a template as the value. ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"` // Specifies the regular expression (regex) pattern used to choose an integration // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you // could use the .+ regex to match error response. However, make sure that the // error response does not contain any newline (\n) character in such cases. // If the back end is an AWS Lambda function, the AWS Lambda function error // header is matched. For all other HTTP and AWS back ends, the HTTP status // code is matched. SelectionPattern *string `locationName:"selectionPattern" type:"string"` // Specifies the status code that is used to map the integration response to // an existing MethodResponse. StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (GetIntegrationResponseOutput) MarshalFields ¶ added in v0.9.0
func (s GetIntegrationResponseOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetIntegrationResponseOutput) String ¶ added in v0.9.0
func (s GetIntegrationResponseOutput) String() string
String returns the string representation
type GetIntegrationResponseRequest ¶
type GetIntegrationResponseRequest struct { *aws.Request Input *GetIntegrationResponseInput Copy func(*GetIntegrationResponseInput) GetIntegrationResponseRequest }
GetIntegrationResponseRequest is the request type for the GetIntegrationResponse API operation.
func (GetIntegrationResponseRequest) Send ¶
func (r GetIntegrationResponseRequest) Send(ctx context.Context) (*GetIntegrationResponseResponse, error)
Send marshals and sends the GetIntegrationResponse API request.
type GetIntegrationResponseResponse ¶ added in v0.9.0
type GetIntegrationResponseResponse struct { *GetIntegrationResponseOutput // contains filtered or unexported fields }
GetIntegrationResponseResponse is the response type for the GetIntegrationResponse API operation.
func (*GetIntegrationResponseResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetIntegrationResponseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetIntegrationResponse request.
type GetMethodInput ¶
type GetMethodInput struct { // [Required] Specifies the method request's HTTP method type. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // [Required] The Resource identifier for the Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to describe an existing Method resource.
func (GetMethodInput) MarshalFields ¶ added in v0.3.0
func (s GetMethodInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetMethodInput) String ¶
func (s GetMethodInput) String() string
String returns the string representation
func (*GetMethodInput) Validate ¶
func (s *GetMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetMethodOutput ¶ added in v0.9.0
type GetMethodOutput struct { // A boolean flag specifying whether a valid ApiKey is required to invoke this // method. ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"` // A list of authorization scopes configured on the method. The scopes are used // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. // The authorization works by matching the method scopes against the scopes // parsed from the access token in the incoming request. The method invocation // is authorized if any method scopes matches a claimed scope in the access // token. Otherwise, the invocation is not authorized. When the method scope // is configured, the client must provide an access token instead of an identity // token for authorization purposes. AuthorizationScopes []string `locationName:"authorizationScopes" type:"list"` // The method's authorization type. Valid values are NONE for open access, AWS_IAM // for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS // for using a Cognito user pool. AuthorizationType *string `locationName:"authorizationType" type:"string"` // The identifier of an Authorizer to use on this method. The authorizationType // must be CUSTOM. AuthorizerId *string `locationName:"authorizerId" type:"string"` // The method's HTTP verb. HttpMethod *string `locationName:"httpMethod" type:"string"` // Gets the method's integration responsible for passing the client-submitted // request to the back end and performing necessary transformations to make // the request compliant with the back end. // // Example: // // Request // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns a 200 OK status code and a payload similar // to the following: // { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", // "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true } ], "self": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": // { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" // }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", // "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" // }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", // "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", // "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": // "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": // "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", // \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", // "_embedded": { "integration:responses": { "_links": { "self": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", // "name": "200", "title": "200" }, "integrationresponse:delete": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" // }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" // } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", // "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": // "integration.response.body.a" }, "responseTemplates": { "application/json": // "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op // => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n // \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } // } } // // AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html) MethodIntegration *Integration `locationName:"methodIntegration" type:"structure"` // Gets a method response associated with a given HTTP status code. // // The collection of method responses are encapsulated in a key-value map, where // the key is a response's HTTP status code and the value is a MethodResponse // resource that specifies the response returned to the caller from the back // end through the integration response. // // Example: Get a 200 OK response of a GET method // // Request // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns a 200 OK status code and a payload similar // to the following: // { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", // "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", // "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" // }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" // } }, "responseModels": { "application/json": "Empty" }, "responseParameters": // { "method.response.header.operator": false, "method.response.header.operand_2": // false, "method.response.header.operand_1": false }, "statusCode": "200" // } // // AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) 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 the PetStore // 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 API Gateway. A key is a method request parameter name // matching the pattern of method.request.{location}.{name}, where location // is querystring, path, or header and name is a valid and unique parameter // name. The value associated with the key is a Boolean flag indicating whether // the parameter is required (true) or optional (false). The method request // parameter names defined here are available in Integration to be mapped to // integration request parameters or templates. RequestParameters map[string]bool `locationName:"requestParameters" type:"map"` // The identifier of a RequestValidator for request validation. RequestValidatorId *string `locationName:"requestValidatorId" type:"string"` // contains filtered or unexported fields }
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
Example: Retrive the GET method on a specified resource
Request ¶
The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri).
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://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() (https://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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html)
func (GetMethodOutput) MarshalFields ¶ added in v0.9.0
func (s GetMethodOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetMethodOutput) String ¶ added in v0.9.0
func (s GetMethodOutput) String() string
String returns the string representation
type GetMethodRequest ¶
type GetMethodRequest struct { *aws.Request Input *GetMethodInput Copy func(*GetMethodInput) GetMethodRequest }
GetMethodRequest is the request type for the GetMethod API operation.
func (GetMethodRequest) Send ¶
func (r GetMethodRequest) Send(ctx context.Context) (*GetMethodResponse, error)
Send marshals and sends the GetMethod API request.
type GetMethodResponse ¶ added in v0.9.0
type GetMethodResponse struct { *GetMethodOutput // contains filtered or unexported fields }
GetMethodResponse is the response type for the GetMethod API operation.
func (*GetMethodResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetMethodResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetMethod request.
type GetMethodResponseInput ¶
type GetMethodResponseInput struct { // [Required] The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // [Required] The Resource identifier for the MethodResponse resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetMethodResponseInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetMethodResponseInput) String ¶
func (s GetMethodResponseInput) String() string
String returns the string representation
func (*GetMethodResponseInput) Validate ¶
func (s *GetMethodResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetMethodResponseOutput ¶ added in v0.9.0
type GetMethodResponseOutput 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 // 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. 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": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" }
Method, IntegrationResponse, Integration Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (GetMethodResponseOutput) MarshalFields ¶ added in v0.9.0
func (s GetMethodResponseOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetMethodResponseOutput) String ¶ added in v0.9.0
func (s GetMethodResponseOutput) String() string
String returns the string representation
type GetMethodResponseRequest ¶
type GetMethodResponseRequest struct { *aws.Request Input *GetMethodResponseInput Copy func(*GetMethodResponseInput) GetMethodResponseRequest }
GetMethodResponseRequest is the request type for the GetMethodResponse API operation.
func (GetMethodResponseRequest) Send ¶
func (r GetMethodResponseRequest) Send(ctx context.Context) (*GetMethodResponseResponse, error)
Send marshals and sends the GetMethodResponse API request.
type GetMethodResponseResponse ¶ added in v0.9.0
type GetMethodResponseResponse struct { *GetMethodResponseOutput // contains filtered or unexported fields }
GetMethodResponseResponse is the response type for the GetMethodResponse API operation.
func (*GetMethodResponseResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetMethodResponseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetMethodResponse request.
type GetModelInput ¶
type GetModelInput struct { // A query parameter of a Boolean value to resolve (true) all external model // references and returns a flattened model schema or not (false) The default // is false. Flatten *bool `location:"querystring" locationName:"flatten" type:"boolean"` // [Required] The name of the model as an identifier. // // ModelName is a required field ModelName *string `location:"uri" locationName:"model_name" type:"string" required:"true"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetModelInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetModelInput) String ¶
func (s GetModelInput) String() string
String returns the string representation
func (*GetModelInput) Validate ¶
func (s *GetModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetModelOutput ¶ added in v0.9.0
type GetModelOutput struct { // The content-type for the model. ContentType *string `locationName:"contentType" type:"string"` // The description of the model. Description *string `locationName:"description" type:"string"` // The identifier for the model resource. Id *string `locationName:"id" type:"string"` // The name of the model. Must be an alphanumeric string. Name *string `locationName:"name" type:"string"` // The schema for the model. For application/json models, this should be JSON // schema draft 4 (https://tools.ietf.org/html/draft-zyp-json-schema-04) 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html)
func (GetModelOutput) MarshalFields ¶ added in v0.9.0
func (s GetModelOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetModelOutput) String ¶ added in v0.9.0
func (s GetModelOutput) String() string
String returns the string representation
type GetModelRequest ¶
type GetModelRequest struct { *aws.Request Input *GetModelInput Copy func(*GetModelInput) GetModelRequest }
GetModelRequest is the request type for the GetModel API operation.
func (GetModelRequest) Send ¶
func (r GetModelRequest) Send(ctx context.Context) (*GetModelResponse, error)
Send marshals and sends the GetModel API request.
type GetModelResponse ¶ added in v0.9.0
type GetModelResponse struct { *GetModelOutput // contains filtered or unexported fields }
GetModelResponse is the response type for the GetModel API operation.
func (*GetModelResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetModelResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetModel request.
type GetModelTemplateInput ¶
type GetModelTemplateInput struct { // [Required] 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to generate a sample mapping template used to transform the payload.
func (GetModelTemplateInput) MarshalFields ¶ added in v0.3.0
func (s GetModelTemplateInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetModelTemplateInput) String ¶
func (s GetModelTemplateInput) String() string
String returns the string representation
func (*GetModelTemplateInput) Validate ¶
func (s *GetModelTemplateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetModelTemplateOutput ¶
type GetModelTemplateOutput struct { // The Apache Velocity Template Language (VTL) (https://velocity.apache.org/engine/devel/vtl-reference.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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html#models-mappings-mappings)
func (GetModelTemplateOutput) MarshalFields ¶ added in v0.3.0
func (s GetModelTemplateOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetModelTemplateOutput) String ¶
func (s GetModelTemplateOutput) String() string
String returns the string representation
type GetModelTemplateRequest ¶
type GetModelTemplateRequest struct { *aws.Request Input *GetModelTemplateInput Copy func(*GetModelTemplateInput) GetModelTemplateRequest }
GetModelTemplateRequest is the request type for the GetModelTemplate API operation.
func (GetModelTemplateRequest) Send ¶
func (r GetModelTemplateRequest) Send(ctx context.Context) (*GetModelTemplateResponse, error)
Send marshals and sends the GetModelTemplate API request.
type GetModelTemplateResponse ¶ added in v0.9.0
type GetModelTemplateResponse struct { *GetModelTemplateOutput // contains filtered or unexported fields }
GetModelTemplateResponse is the response type for the GetModelTemplate API operation.
func (*GetModelTemplateResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetModelTemplateResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetModelTemplate request.
type GetModelsInput ¶
type GetModelsInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to list existing Models defined for a RestApi resource.
func (GetModelsInput) MarshalFields ¶ added in v0.3.0
func (s GetModelsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetModelsInput) String ¶
func (s GetModelsInput) String() string
String returns the string representation
func (*GetModelsInput) Validate ¶
func (s *GetModelsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetModelsOutput ¶
type GetModelsOutput struct { // The current page of elements from this collection. Items []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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html)
func (GetModelsOutput) MarshalFields ¶ added in v0.3.0
func (s GetModelsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetModelsOutput) String ¶
func (s GetModelsOutput) String() string
String returns the string representation
type GetModelsPaginator ¶ added in v0.9.0
GetModelsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetModelsPaginator ¶ added in v0.9.0
func NewGetModelsPaginator(req GetModelsRequest) GetModelsPaginator
NewGetModelsRequestPaginator returns a paginator for GetModels. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetModelsRequest(input) p := apigateway.NewGetModelsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetModelsPaginator) CurrentPage ¶ added in v0.9.0
func (p *GetModelsPaginator) CurrentPage() *GetModelsOutput
type GetModelsRequest ¶
type GetModelsRequest struct { *aws.Request Input *GetModelsInput Copy func(*GetModelsInput) GetModelsRequest }
GetModelsRequest is the request type for the GetModels API operation.
func (GetModelsRequest) Send ¶
func (r GetModelsRequest) Send(ctx context.Context) (*GetModelsResponse, error)
Send marshals and sends the GetModels API request.
type GetModelsResponse ¶ added in v0.9.0
type GetModelsResponse struct { *GetModelsOutput // contains filtered or unexported fields }
GetModelsResponse is the response type for the GetModels API operation.
func (*GetModelsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetModelsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetModels request.
type GetRequestValidatorInput ¶
type GetRequestValidatorInput struct { // [Required] The identifier of the RequestValidator to be retrieved. // // RequestValidatorId is a required field RequestValidatorId *string `location:"uri" locationName:"requestvalidator_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets a RequestValidator of a given RestApi.
func (GetRequestValidatorInput) MarshalFields ¶ added in v0.3.0
func (s GetRequestValidatorInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetRequestValidatorInput) String ¶
func (s GetRequestValidatorInput) String() string
String returns the string representation
func (*GetRequestValidatorInput) Validate ¶
func (s *GetRequestValidatorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRequestValidatorOutput ¶ added in v0.9.0
type GetRequestValidatorOutput struct { // The identifier of this RequestValidator. Id *string `locationName:"id" type:"string"` // The name of this RequestValidator Name *string `locationName:"name" type:"string"` // A Boolean flag to indicate whether to validate a request body according to // the configured Model schema. ValidateRequestBody *bool `locationName:"validateRequestBody" type:"boolean"` // A Boolean flag to indicate whether to validate request parameters (true) // or not (false). ValidateRequestParameters *bool `locationName:"validateRequestParameters" type:"boolean"` // contains filtered or unexported fields }
A set of validation rules for incoming Method requests.
In OpenAPI, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html) object. It the referenced using the x-amazon-apigateway-request-validator (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator) property.
Enable Basic Request Validation in API Gateway (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html)
func (GetRequestValidatorOutput) MarshalFields ¶ added in v0.9.0
func (s GetRequestValidatorOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetRequestValidatorOutput) String ¶ added in v0.9.0
func (s GetRequestValidatorOutput) String() string
String returns the string representation
type GetRequestValidatorRequest ¶
type GetRequestValidatorRequest struct { *aws.Request Input *GetRequestValidatorInput Copy func(*GetRequestValidatorInput) GetRequestValidatorRequest }
GetRequestValidatorRequest is the request type for the GetRequestValidator API operation.
func (GetRequestValidatorRequest) Send ¶
func (r GetRequestValidatorRequest) Send(ctx context.Context) (*GetRequestValidatorResponse, error)
Send marshals and sends the GetRequestValidator API request.
type GetRequestValidatorResponse ¶ added in v0.9.0
type GetRequestValidatorResponse struct { *GetRequestValidatorOutput // contains filtered or unexported fields }
GetRequestValidatorResponse is the response type for the GetRequestValidator API operation.
func (*GetRequestValidatorResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetRequestValidatorResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetRequestValidator request.
type GetRequestValidatorsInput ¶
type GetRequestValidatorsInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets the RequestValidators collection of a given RestApi.
func (GetRequestValidatorsInput) MarshalFields ¶ added in v0.3.0
func (s GetRequestValidatorsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetRequestValidatorsInput) String ¶
func (s GetRequestValidatorsInput) String() string
String returns the string representation
func (*GetRequestValidatorsInput) Validate ¶
func (s *GetRequestValidatorsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRequestValidatorsOutput ¶
type GetRequestValidatorsOutput struct { // The current page of elements from this collection. Items []RequestValidator `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
A collection of RequestValidator resources of a given RestApi.
In OpenAPI, the RequestValidators of an API is defined by the x-amazon-apigateway-request-validators (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.html) extension.
Enable Basic Request Validation in API Gateway (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html)
func (GetRequestValidatorsOutput) MarshalFields ¶ added in v0.3.0
func (s GetRequestValidatorsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetRequestValidatorsOutput) String ¶
func (s GetRequestValidatorsOutput) String() string
String returns the string representation
type GetRequestValidatorsRequest ¶
type GetRequestValidatorsRequest struct { *aws.Request Input *GetRequestValidatorsInput Copy func(*GetRequestValidatorsInput) GetRequestValidatorsRequest }
GetRequestValidatorsRequest is the request type for the GetRequestValidators API operation.
func (GetRequestValidatorsRequest) Send ¶
func (r GetRequestValidatorsRequest) Send(ctx context.Context) (*GetRequestValidatorsResponse, error)
Send marshals and sends the GetRequestValidators API request.
type GetRequestValidatorsResponse ¶ added in v0.9.0
type GetRequestValidatorsResponse struct { *GetRequestValidatorsOutput // contains filtered or unexported fields }
GetRequestValidatorsResponse is the response type for the GetRequestValidators API operation.
func (*GetRequestValidatorsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetRequestValidatorsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetRequestValidators request.
type GetResourceInput ¶
type GetResourceInput struct { // A query parameter to retrieve the specified resources embedded in the returned // Resource representation in the response. This embed parameter value is a // list of comma-separated strings. Currently, the request supports only retrieval // of the embedded Method resources this way. The query parameter value must // be a single-valued list and contain the "methods" string. For example, GET // /restapis/{restapi_id}/resources/{resource_id}?embed=methods. Embed []string `location:"querystring" locationName:"embed" type:"list"` // [Required] The identifier for the Resource resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to list information about a resource.
func (GetResourceInput) MarshalFields ¶ added in v0.3.0
func (s GetResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetResourceInput) String ¶
func (s GetResourceInput) String() string
String returns the string representation
func (*GetResourceInput) Validate ¶
func (s *GetResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetResourceOutput ¶ added in v0.9.0
type GetResourceOutput struct { // The resource's identifier. Id *string `locationName:"id" type:"string"` // The parent resource's identifier. ParentId *string `locationName:"parentId" type:"string"` // The full path for this resource. Path *string `locationName:"path" type:"string"` // The last path segment for this resource. PathPart *string `locationName:"pathPart" type:"string"` // Gets an API resource's method of a given HTTP verb. // // The resource methods are a map of methods indexed by methods' HTTP verbs // enabled on the resource. This method map is included in the 200 OK response // of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods // request. // // Example: Get the GET method of an API resource // // Request // GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: // application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z // Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", // "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", // "name": "method", "templated": true }, { "href": "https://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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (GetResourceOutput) MarshalFields ¶ added in v0.9.0
func (s GetResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetResourceOutput) String ¶ added in v0.9.0
func (s GetResourceOutput) String() string
String returns the string representation
type GetResourceRequest ¶
type GetResourceRequest struct { *aws.Request Input *GetResourceInput Copy func(*GetResourceInput) GetResourceRequest }
GetResourceRequest is the request type for the GetResource API operation.
func (GetResourceRequest) Send ¶
func (r GetResourceRequest) Send(ctx context.Context) (*GetResourceResponse, error)
Send marshals and sends the GetResource API request.
type GetResourceResponse ¶ added in v0.9.0
type GetResourceResponse struct { *GetResourceOutput // contains filtered or unexported fields }
GetResourceResponse is the response type for the GetResource API operation.
func (*GetResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetResource request.
type GetResourcesInput ¶
type GetResourcesInput struct { // A query parameter used to retrieve the specified resources embedded in the // returned Resources resource in the response. This embed parameter value is // a list of comma-separated strings. Currently, the request supports only retrieval // of the embedded Method resources this way. The query parameter value must // be a single-valued list and contain the "methods" string. For example, GET // /restapis/{restapi_id}/resources?embed=methods. Embed []string `location:"querystring" locationName:"embed" type:"list"` // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to list information about a collection of resources.
func (GetResourcesInput) MarshalFields ¶ added in v0.3.0
func (s GetResourcesInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetResourcesInput) String ¶
func (s GetResourcesInput) String() string
String returns the string representation
func (*GetResourcesInput) Validate ¶
func (s *GetResourcesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetResourcesOutput ¶
type GetResourcesOutput struct { // The current page of elements from this collection. Items []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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (GetResourcesOutput) MarshalFields ¶ added in v0.3.0
func (s GetResourcesOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetResourcesOutput) String ¶
func (s GetResourcesOutput) String() string
String returns the string representation
type GetResourcesPaginator ¶ added in v0.9.0
GetResourcesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetResourcesPaginator ¶ added in v0.9.0
func NewGetResourcesPaginator(req GetResourcesRequest) GetResourcesPaginator
NewGetResourcesRequestPaginator returns a paginator for GetResources. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetResourcesRequest(input) p := apigateway.NewGetResourcesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetResourcesPaginator) CurrentPage ¶ added in v0.9.0
func (p *GetResourcesPaginator) CurrentPage() *GetResourcesOutput
type GetResourcesRequest ¶
type GetResourcesRequest struct { *aws.Request Input *GetResourcesInput Copy func(*GetResourcesInput) GetResourcesRequest }
GetResourcesRequest is the request type for the GetResources API operation.
func (GetResourcesRequest) Send ¶
func (r GetResourcesRequest) Send(ctx context.Context) (*GetResourcesResponse, error)
Send marshals and sends the GetResources API request.
type GetResourcesResponse ¶ added in v0.9.0
type GetResourcesResponse struct { *GetResourcesOutput // contains filtered or unexported fields }
GetResourcesResponse is the response type for the GetResources API operation.
func (*GetResourcesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetResourcesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetResources request.
type GetRestApiInput ¶
type GetRestApiInput struct { // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
The GET request to list an existing RestApi defined for your collection.
func (GetRestApiInput) MarshalFields ¶ added in v0.3.0
func (s GetRestApiInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetRestApiInput) String ¶
func (s GetRestApiInput) String() string
String returns the string representation
func (*GetRestApiInput) Validate ¶
func (s *GetRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRestApiOutput ¶ added in v0.9.0
type GetRestApiOutput struct { // The source of the API key for metering requests according to a usage plan. // Valid values are: // * HEADER to read the API key from the X-API-Key header of a request. // // * AUTHORIZER to read the API key from the UsageIdentifierKey from a custom // authorizer. ApiKeySource ApiKeySourceType `locationName:"apiKeySource" type:"string" enum:"true"` // The list of binary media types supported by the RestApi. By default, the // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string `locationName:"binaryMediaTypes" type:"list"` // The timestamp when the API was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The API's description. Description *string `locationName:"description" type:"string"` // The endpoint configuration of this RestApi showing the endpoint types of // the API. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The API's identifier. This identifier is unique across all of your APIs in // API Gateway. Id *string `locationName:"id" type:"string"` // A nullable integer that is used to enable compression (with non-negative // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with // a null value) on an API. When compression is enabled, compression or decompression // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int64 `locationName:"minimumCompressionSize" type:"integer"` // The API's name. Name *string `locationName:"name" type:"string"` // A stringified JSON policy document that applies to this RestApi regardless // of the caller and Method configuration. Policy *string `locationName:"policy" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (GetRestApiOutput) MarshalFields ¶ added in v0.9.0
func (s GetRestApiOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetRestApiOutput) String ¶ added in v0.9.0
func (s GetRestApiOutput) String() string
String returns the string representation
type GetRestApiRequest ¶
type GetRestApiRequest struct { *aws.Request Input *GetRestApiInput Copy func(*GetRestApiInput) GetRestApiRequest }
GetRestApiRequest is the request type for the GetRestApi API operation.
func (GetRestApiRequest) Send ¶
func (r GetRestApiRequest) Send(ctx context.Context) (*GetRestApiResponse, error)
Send marshals and sends the GetRestApi API request.
type GetRestApiResponse ¶ added in v0.9.0
type GetRestApiResponse struct { *GetRestApiOutput // contains filtered or unexported fields }
GetRestApiResponse is the response type for the GetRestApi API operation.
func (*GetRestApiResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetRestApiResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetRestApi request.
type GetRestApisInput ¶
type GetRestApisInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
The GET request to list existing RestApis defined for your collection.
func (GetRestApisInput) MarshalFields ¶ added in v0.3.0
func (s GetRestApisInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetRestApisInput) String ¶
func (s GetRestApisInput) String() string
String returns the string representation
type GetRestApisOutput ¶
type GetRestApisOutput struct { // The current page of elements from this collection. Items []RestApi `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.
Create an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (GetRestApisOutput) MarshalFields ¶ added in v0.3.0
func (s GetRestApisOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetRestApisOutput) String ¶
func (s GetRestApisOutput) String() string
String returns the string representation
type GetRestApisPaginator ¶ added in v0.9.0
GetRestApisPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetRestApisPaginator ¶ added in v0.9.0
func NewGetRestApisPaginator(req GetRestApisRequest) GetRestApisPaginator
NewGetRestApisRequestPaginator returns a paginator for GetRestApis. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetRestApisRequest(input) p := apigateway.NewGetRestApisRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetRestApisPaginator) CurrentPage ¶ added in v0.9.0
func (p *GetRestApisPaginator) CurrentPage() *GetRestApisOutput
type GetRestApisRequest ¶
type GetRestApisRequest struct { *aws.Request Input *GetRestApisInput Copy func(*GetRestApisInput) GetRestApisRequest }
GetRestApisRequest is the request type for the GetRestApis API operation.
func (GetRestApisRequest) Send ¶
func (r GetRestApisRequest) Send(ctx context.Context) (*GetRestApisResponse, error)
Send marshals and sends the GetRestApis API request.
type GetRestApisResponse ¶ added in v0.9.0
type GetRestApisResponse struct { *GetRestApisOutput // contains filtered or unexported fields }
GetRestApisResponse is the response type for the GetRestApis API operation.
func (*GetRestApisResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetRestApisResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetRestApis request.
type GetSdkInput ¶
type GetSdkInput struct { // A string-to-string key-value map of query parameters sdkType-dependent properties // of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix // is required. For sdkType of android, parameters named groupId, artifactId, // artifactVersion, and invokerPackage are required. For sdkType of java, parameters // named serviceName and javaPackageName are required. Parameters map[string]string `location:"querystring" locationName:"parameters" type:"map"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The language for the generated SDK. Currently java, javascript, // android, objectivec (for iOS), swift (for iOS), and ruby are supported. // // SdkType is a required field SdkType *string `location:"uri" locationName:"sdk_type" type:"string" required:"true"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetSdkInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetSdkInput) String ¶
func (s GetSdkInput) String() string
String returns the string representation
func (*GetSdkInput) Validate ¶
func (s *GetSdkInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSdkOutput ¶
type GetSdkOutput struct { // The binary blob response to GetSdk, which contains the generated SDK. Body []byte `locationName:"body" type:"blob"` // The content-disposition header value in the HTTP response. ContentDisposition *string `location:"header" locationName:"Content-Disposition" type:"string"` // The content-type header value in the HTTP response. ContentType *string `location:"header" locationName:"Content-Type" type:"string"` // contains filtered or unexported fields }
The binary blob response to GetSdk, which contains the generated SDK.
func (GetSdkOutput) MarshalFields ¶ added in v0.3.0
func (s GetSdkOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetSdkOutput) String ¶
func (s GetSdkOutput) String() string
String returns the string representation
type GetSdkRequest ¶
type GetSdkRequest struct { *aws.Request Input *GetSdkInput Copy func(*GetSdkInput) GetSdkRequest }
GetSdkRequest is the request type for the GetSdk API operation.
func (GetSdkRequest) Send ¶
func (r GetSdkRequest) Send(ctx context.Context) (*GetSdkResponse, error)
Send marshals and sends the GetSdk API request.
type GetSdkResponse ¶ added in v0.9.0
type GetSdkResponse struct { *GetSdkOutput // contains filtered or unexported fields }
GetSdkResponse is the response type for the GetSdk API operation.
func (*GetSdkResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetSdkResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetSdk request.
type GetSdkTypeInput ¶
type GetSdkTypeInput struct { // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetSdkTypeInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetSdkTypeInput) String ¶
func (s GetSdkTypeInput) String() string
String returns the string representation
func (*GetSdkTypeInput) Validate ¶
func (s *GetSdkTypeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSdkTypeOutput ¶
type GetSdkTypeOutput struct { // A list of configuration properties of an SdkType. ConfigurationProperties []SdkConfigurationProperty `locationName:"configurationProperties" type:"list"` // The description of an SdkType. Description *string `locationName:"description" type:"string"` // The user-friendly name of an SdkType instance. FriendlyName *string `locationName:"friendlyName" type:"string"` // The identifier of an SdkType instance. Id *string `locationName:"id" type:"string"` // contains filtered or unexported fields }
A type of SDK that API Gateway can generate.
func (GetSdkTypeOutput) MarshalFields ¶ added in v0.3.0
func (s GetSdkTypeOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetSdkTypeOutput) String ¶
func (s GetSdkTypeOutput) String() string
String returns the string representation
type GetSdkTypeRequest ¶
type GetSdkTypeRequest struct { *aws.Request Input *GetSdkTypeInput Copy func(*GetSdkTypeInput) GetSdkTypeRequest }
GetSdkTypeRequest is the request type for the GetSdkType API operation.
func (GetSdkTypeRequest) Send ¶
func (r GetSdkTypeRequest) Send(ctx context.Context) (*GetSdkTypeResponse, error)
Send marshals and sends the GetSdkType API request.
type GetSdkTypeResponse ¶ added in v0.9.0
type GetSdkTypeResponse struct { *GetSdkTypeOutput // contains filtered or unexported fields }
GetSdkTypeResponse is the response type for the GetSdkType API operation.
func (*GetSdkTypeResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetSdkTypeResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetSdkType request.
type GetSdkTypesInput ¶
type GetSdkTypesInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
Get the SdkTypes collection.
func (GetSdkTypesInput) MarshalFields ¶ added in v0.3.0
func (s GetSdkTypesInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetSdkTypesInput) String ¶
func (s GetSdkTypesInput) String() string
String returns the string representation
type GetSdkTypesOutput ¶
type GetSdkTypesOutput struct { // The current page of elements from this collection. Items []SdkType `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
The collection of SdkType instances.
func (GetSdkTypesOutput) MarshalFields ¶ added in v0.3.0
func (s GetSdkTypesOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetSdkTypesOutput) String ¶
func (s GetSdkTypesOutput) String() string
String returns the string representation
type GetSdkTypesRequest ¶
type GetSdkTypesRequest struct { *aws.Request Input *GetSdkTypesInput Copy func(*GetSdkTypesInput) GetSdkTypesRequest }
GetSdkTypesRequest is the request type for the GetSdkTypes API operation.
func (GetSdkTypesRequest) Send ¶
func (r GetSdkTypesRequest) Send(ctx context.Context) (*GetSdkTypesResponse, error)
Send marshals and sends the GetSdkTypes API request.
type GetSdkTypesResponse ¶ added in v0.9.0
type GetSdkTypesResponse struct { *GetSdkTypesOutput // contains filtered or unexported fields }
GetSdkTypesResponse is the response type for the GetSdkTypes API operation.
func (*GetSdkTypesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetSdkTypesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetSdkTypes request.
type GetStageInput ¶
type GetStageInput struct { // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The 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 API Gateway to get information about a Stage resource.
func (GetStageInput) MarshalFields ¶ added in v0.3.0
func (s GetStageInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetStageInput) String ¶
func (s GetStageInput) String() string
String returns the string representation
func (*GetStageInput) Validate ¶
func (s *GetStageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetStageOutput ¶ added in v0.9.0
type GetStageOutput struct { // Settings for logging access in this stage. AccessLogSettings *AccessLogSettings `locationName:"accessLogSettings" type:"structure"` // Specifies whether a cache cluster is enabled for the stage. CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` // The size of the cache cluster for the stage, if enabled. CacheClusterSize CacheClusterSize `locationName:"cacheClusterSize" type:"string" enum:"true"` // The status of the cache cluster for the stage, if enabled. CacheClusterStatus CacheClusterStatus `locationName:"cacheClusterStatus" type:"string" enum:"true"` // Settings for the canary deployment in this stage. CanarySettings *CanarySettings `locationName:"canarySettings" type:"structure"` // The identifier of a client certificate for an API stage. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // The timestamp when the stage was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The identifier of the Deployment that the stage points to. DeploymentId *string `locationName:"deploymentId" type:"string"` // The stage's description. Description *string `locationName:"description" type:"string"` // The version of the associated API documentation. DocumentationVersion *string `locationName:"documentationVersion" type:"string"` // The timestamp when the stage last updated. LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp"` // 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 API Gateway. Stage names can only contain alphanumeric // characters, hyphens, and underscores. Maximum length is 128 characters. StageName *string `locationName:"stageName" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // Specifies whether active tracing with X-ray is enabled for the Stage. TracingEnabled *bool `locationName:"tracingEnabled" type:"boolean"` // 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"` // The ARN of the WebAcl associated with the Stage. WebAclArn *string `locationName:"webAclArn" type:"string"` // contains filtered or unexported fields }
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Deploy an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html)
func (GetStageOutput) MarshalFields ¶ added in v0.9.0
func (s GetStageOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetStageOutput) String ¶ added in v0.9.0
func (s GetStageOutput) String() string
String returns the string representation
type GetStageRequest ¶
type GetStageRequest struct { *aws.Request Input *GetStageInput Copy func(*GetStageInput) GetStageRequest }
GetStageRequest is the request type for the GetStage API operation.
func (GetStageRequest) Send ¶
func (r GetStageRequest) Send(ctx context.Context) (*GetStageResponse, error)
Send marshals and sends the GetStage API request.
type GetStageResponse ¶ added in v0.9.0
type GetStageResponse struct { *GetStageOutput // contains filtered or unexported fields }
GetStageResponse is the response type for the GetStage API operation.
func (*GetStageResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetStageResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetStage request.
type GetStagesInput ¶
type GetStagesInput struct { // The stages' deployment identifiers. DeploymentId *string `location:"querystring" locationName:"deploymentId" type:"string"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests API Gateway to get information about one or more Stage resources.
func (GetStagesInput) MarshalFields ¶ added in v0.3.0
func (s GetStagesInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetStagesInput) String ¶
func (s GetStagesInput) String() string
String returns the string representation
func (*GetStagesInput) Validate ¶
func (s *GetStagesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetStagesOutput ¶
type GetStagesOutput struct { // The current page of elements from this collection. Item []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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/stages.html)
func (GetStagesOutput) MarshalFields ¶ added in v0.3.0
func (s GetStagesOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetStagesOutput) String ¶
func (s GetStagesOutput) String() string
String returns the string representation
type GetStagesRequest ¶
type GetStagesRequest struct { *aws.Request Input *GetStagesInput Copy func(*GetStagesInput) GetStagesRequest }
GetStagesRequest is the request type for the GetStages API operation.
func (GetStagesRequest) Send ¶
func (r GetStagesRequest) Send(ctx context.Context) (*GetStagesResponse, error)
Send marshals and sends the GetStages API request.
type GetStagesResponse ¶ added in v0.9.0
type GetStagesResponse struct { *GetStagesOutput // contains filtered or unexported fields }
GetStagesResponse is the response type for the GetStages API operation.
func (*GetStagesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetStagesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetStages request.
type GetTagsInput ¶ added in v0.2.0
type GetTagsInput struct { // (Not currently supported) The maximum number of returned results per page. // The default value is 25 and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // (Not currently supported) The current pagination position in the paged result // set. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] The ARN of a resource that can be tagged. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resource_arn" type:"string" required:"true"` // contains filtered or unexported fields }
Gets the Tags collection for a given resource.
func (GetTagsInput) MarshalFields ¶ added in v0.3.0
func (s GetTagsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetTagsInput) String ¶ added in v0.2.0
func (s GetTagsInput) String() string
String returns the string representation
func (*GetTagsInput) Validate ¶ added in v0.2.0
func (s *GetTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetTagsOutput ¶ added in v0.2.0
type GetTagsOutput struct { // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
The collection of tags. Each tag element is associated with a given resource.
func (GetTagsOutput) MarshalFields ¶ added in v0.3.0
func (s GetTagsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetTagsOutput) String ¶ added in v0.2.0
func (s GetTagsOutput) String() string
String returns the string representation
type GetTagsRequest ¶ added in v0.2.0
type GetTagsRequest struct { *aws.Request Input *GetTagsInput Copy func(*GetTagsInput) GetTagsRequest }
GetTagsRequest is the request type for the GetTags API operation.
func (GetTagsRequest) Send ¶ added in v0.2.0
func (r GetTagsRequest) Send(ctx context.Context) (*GetTagsResponse, error)
Send marshals and sends the GetTags API request.
type GetTagsResponse ¶ added in v0.9.0
type GetTagsResponse struct { *GetTagsOutput // contains filtered or unexported fields }
GetTagsResponse is the response type for the GetTags API operation.
func (*GetTagsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetTagsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetTags request.
type GetUsageInput ¶
type GetUsageInput struct { // [Required] The ending date (e.g., 2016-12-31) of the usage data. // // EndDate is a required field EndDate *string `location:"querystring" locationName:"endDate" type:"string" required:"true"` // The Id of the API key associated with the resultant usage data. KeyId *string `location:"querystring" locationName:"keyId" type:"string"` // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] 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"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetUsageInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetUsageInput) String ¶
func (s GetUsageInput) String() string
String returns the string representation
func (*GetUsageInput) Validate ¶
func (s *GetUsageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUsageOutput ¶ added in v0.9.0
type GetUsageOutput 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html), Manage Usage in a Usage Plan (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-usage-plans-with-console.html#api-gateway-usage-plan-manage-usage)
func (GetUsageOutput) MarshalFields ¶ added in v0.9.0
func (s GetUsageOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetUsageOutput) String ¶ added in v0.9.0
func (s GetUsageOutput) String() string
String returns the string representation
type GetUsagePaginator ¶ added in v0.9.0
GetUsagePaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetUsagePaginator ¶ added in v0.9.0
func NewGetUsagePaginator(req GetUsageRequest) GetUsagePaginator
NewGetUsageRequestPaginator returns a paginator for GetUsage. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetUsageRequest(input) p := apigateway.NewGetUsageRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetUsagePaginator) CurrentPage ¶ added in v0.9.0
func (p *GetUsagePaginator) CurrentPage() *GetUsageOutput
type GetUsagePlanInput ¶
type GetUsagePlanInput struct { // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetUsagePlanInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetUsagePlanInput) String ¶
func (s GetUsagePlanInput) String() string
String returns the string representation
func (*GetUsagePlanInput) Validate ¶
func (s *GetUsagePlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUsagePlanKeyInput ¶
type GetUsagePlanKeyInput struct { // [Required] 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"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetUsagePlanKeyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetUsagePlanKeyInput) String ¶
func (s GetUsagePlanKeyInput) String() string
String returns the string representation
func (*GetUsagePlanKeyInput) Validate ¶
func (s *GetUsagePlanKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUsagePlanKeyOutput ¶
type GetUsagePlanKeyOutput struct { // The Id of a usage plan key. Id *string `locationName:"id" type:"string"` // The name of a usage plan key. Name *string `locationName:"name" type:"string"` // The type of a usage plan key. Currently, the valid key type is API_KEY. Type *string `locationName:"type" type:"string"` // The value of a usage plan key. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
Represents a usage plan key to identify a plan customer.
To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.
" Create and Use Usage Plans (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (GetUsagePlanKeyOutput) MarshalFields ¶ added in v0.3.0
func (s GetUsagePlanKeyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetUsagePlanKeyOutput) String ¶
func (s GetUsagePlanKeyOutput) String() string
String returns the string representation
type GetUsagePlanKeyRequest ¶
type GetUsagePlanKeyRequest struct { *aws.Request Input *GetUsagePlanKeyInput Copy func(*GetUsagePlanKeyInput) GetUsagePlanKeyRequest }
GetUsagePlanKeyRequest is the request type for the GetUsagePlanKey API operation.
func (GetUsagePlanKeyRequest) Send ¶
func (r GetUsagePlanKeyRequest) Send(ctx context.Context) (*GetUsagePlanKeyResponse, error)
Send marshals and sends the GetUsagePlanKey API request.
type GetUsagePlanKeyResponse ¶ added in v0.9.0
type GetUsagePlanKeyResponse struct { *GetUsagePlanKeyOutput // contains filtered or unexported fields }
GetUsagePlanKeyResponse is the response type for the GetUsagePlanKey API operation.
func (*GetUsagePlanKeyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetUsagePlanKeyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetUsagePlanKey request.
type GetUsagePlanKeysInput ¶
type GetUsagePlanKeysInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // A query parameter specifying the name of the to-be-returned usage plan keys. NameQuery *string `location:"querystring" locationName:"name" type:"string"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s GetUsagePlanKeysInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetUsagePlanKeysInput) String ¶
func (s GetUsagePlanKeysInput) String() string
String returns the string representation
func (*GetUsagePlanKeysInput) Validate ¶
func (s *GetUsagePlanKeysInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUsagePlanKeysOutput ¶
type GetUsagePlanKeysOutput struct { // The current page of elements from this collection. Items []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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (GetUsagePlanKeysOutput) MarshalFields ¶ added in v0.3.0
func (s GetUsagePlanKeysOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetUsagePlanKeysOutput) String ¶
func (s GetUsagePlanKeysOutput) String() string
String returns the string representation
type GetUsagePlanKeysPaginator ¶ added in v0.9.0
GetUsagePlanKeysPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetUsagePlanKeysPaginator ¶ added in v0.9.0
func NewGetUsagePlanKeysPaginator(req GetUsagePlanKeysRequest) GetUsagePlanKeysPaginator
NewGetUsagePlanKeysRequestPaginator returns a paginator for GetUsagePlanKeys. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetUsagePlanKeysRequest(input) p := apigateway.NewGetUsagePlanKeysRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetUsagePlanKeysPaginator) CurrentPage ¶ added in v0.9.0
func (p *GetUsagePlanKeysPaginator) CurrentPage() *GetUsagePlanKeysOutput
type GetUsagePlanKeysRequest ¶
type GetUsagePlanKeysRequest struct { *aws.Request Input *GetUsagePlanKeysInput Copy func(*GetUsagePlanKeysInput) GetUsagePlanKeysRequest }
GetUsagePlanKeysRequest is the request type for the GetUsagePlanKeys API operation.
func (GetUsagePlanKeysRequest) Send ¶
func (r GetUsagePlanKeysRequest) Send(ctx context.Context) (*GetUsagePlanKeysResponse, error)
Send marshals and sends the GetUsagePlanKeys API request.
type GetUsagePlanKeysResponse ¶ added in v0.9.0
type GetUsagePlanKeysResponse struct { *GetUsagePlanKeysOutput // contains filtered or unexported fields }
GetUsagePlanKeysResponse is the response type for the GetUsagePlanKeys API operation.
func (*GetUsagePlanKeysResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetUsagePlanKeysResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetUsagePlanKeys request.
type GetUsagePlanOutput ¶ added in v0.9.0
type GetUsagePlanOutput 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 collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (GetUsagePlanOutput) MarshalFields ¶ added in v0.9.0
func (s GetUsagePlanOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetUsagePlanOutput) String ¶ added in v0.9.0
func (s GetUsagePlanOutput) String() string
String returns the string representation
type GetUsagePlanRequest ¶
type GetUsagePlanRequest struct { *aws.Request Input *GetUsagePlanInput Copy func(*GetUsagePlanInput) GetUsagePlanRequest }
GetUsagePlanRequest is the request type for the GetUsagePlan API operation.
func (GetUsagePlanRequest) Send ¶
func (r GetUsagePlanRequest) Send(ctx context.Context) (*GetUsagePlanResponse, error)
Send marshals and sends the GetUsagePlan API request.
type GetUsagePlanResponse ¶ added in v0.9.0
type GetUsagePlanResponse struct { *GetUsagePlanOutput // contains filtered or unexported fields }
GetUsagePlanResponse is the response type for the GetUsagePlan API operation.
func (*GetUsagePlanResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetUsagePlanResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetUsagePlan request.
type GetUsagePlansInput ¶
type GetUsagePlansInput struct { // The identifier of the API key associated with the usage plans. KeyId *string `location:"querystring" locationName:"keyId" type:"string"` // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
The GET request to get all the usage plans of the caller's account.
func (GetUsagePlansInput) MarshalFields ¶ added in v0.3.0
func (s GetUsagePlansInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetUsagePlansInput) String ¶
func (s GetUsagePlansInput) String() string
String returns the string representation
type GetUsagePlansOutput ¶
type GetUsagePlansOutput struct { // The current page of elements from this collection. Items []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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (GetUsagePlansOutput) MarshalFields ¶ added in v0.3.0
func (s GetUsagePlansOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetUsagePlansOutput) String ¶
func (s GetUsagePlansOutput) String() string
String returns the string representation
type GetUsagePlansPaginator ¶ added in v0.9.0
GetUsagePlansPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetUsagePlansPaginator ¶ added in v0.9.0
func NewGetUsagePlansPaginator(req GetUsagePlansRequest) GetUsagePlansPaginator
NewGetUsagePlansRequestPaginator returns a paginator for GetUsagePlans. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetUsagePlansRequest(input) p := apigateway.NewGetUsagePlansRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetUsagePlansPaginator) CurrentPage ¶ added in v0.9.0
func (p *GetUsagePlansPaginator) CurrentPage() *GetUsagePlansOutput
type GetUsagePlansRequest ¶
type GetUsagePlansRequest struct { *aws.Request Input *GetUsagePlansInput Copy func(*GetUsagePlansInput) GetUsagePlansRequest }
GetUsagePlansRequest is the request type for the GetUsagePlans API operation.
func (GetUsagePlansRequest) Send ¶
func (r GetUsagePlansRequest) Send(ctx context.Context) (*GetUsagePlansResponse, error)
Send marshals and sends the GetUsagePlans API request.
type GetUsagePlansResponse ¶ added in v0.9.0
type GetUsagePlansResponse struct { *GetUsagePlansOutput // contains filtered or unexported fields }
GetUsagePlansResponse is the response type for the GetUsagePlans API operation.
func (*GetUsagePlansResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetUsagePlansResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetUsagePlans request.
type GetUsageRequest ¶
type GetUsageRequest struct { *aws.Request Input *GetUsageInput Copy func(*GetUsageInput) GetUsageRequest }
GetUsageRequest is the request type for the GetUsage API operation.
func (GetUsageRequest) Send ¶
func (r GetUsageRequest) Send(ctx context.Context) (*GetUsageResponse, error)
Send marshals and sends the GetUsage API request.
type GetUsageResponse ¶ added in v0.9.0
type GetUsageResponse struct { *GetUsageOutput // contains filtered or unexported fields }
GetUsageResponse is the response type for the GetUsage API operation.
func (*GetUsageResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetUsageResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetUsage request.
type GetVpcLinkInput ¶ added in v0.2.0
type GetVpcLinkInput struct { // [Required] The identifier of the VpcLink. It is used in an Integration to // reference this VpcLink. // // VpcLinkId is a required field VpcLinkId *string `location:"uri" locationName:"vpclink_id" type:"string" required:"true"` // contains filtered or unexported fields }
Gets a specified VPC link under the caller's account in a region.
func (GetVpcLinkInput) MarshalFields ¶ added in v0.3.0
func (s GetVpcLinkInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetVpcLinkInput) String ¶ added in v0.2.0
func (s GetVpcLinkInput) String() string
String returns the string representation
func (*GetVpcLinkInput) Validate ¶ added in v0.2.0
func (s *GetVpcLinkInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetVpcLinkOutput ¶ added in v0.9.0
type GetVpcLinkOutput struct { // The description of the VPC link. Description *string `locationName:"description" type:"string"` // The identifier of the VpcLink. It is used in an Integration to reference // this VpcLink. Id *string `locationName:"id" type:"string"` // The name used to label and identify the VPC link. Name *string `locationName:"name" type:"string"` // The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, // or FAILED. Deploying an API will wait if the status is PENDING and will fail // if the status is DELETING. Status VpcLinkStatus `locationName:"status" type:"string" enum:"true"` // A description about the VPC link status. StatusMessage *string `locationName:"statusMessage" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // The ARN of the network load balancer of the VPC targeted by the VPC link. // The network load balancer must be owned by the same AWS account of the API // owner. TargetArns []string `locationName:"targetArns" type:"list"` // contains filtered or unexported fields }
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.
func (GetVpcLinkOutput) MarshalFields ¶ added in v0.9.0
func (s GetVpcLinkOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetVpcLinkOutput) String ¶ added in v0.9.0
func (s GetVpcLinkOutput) String() string
String returns the string representation
type GetVpcLinkRequest ¶ added in v0.2.0
type GetVpcLinkRequest struct { *aws.Request Input *GetVpcLinkInput Copy func(*GetVpcLinkInput) GetVpcLinkRequest }
GetVpcLinkRequest is the request type for the GetVpcLink API operation.
func (GetVpcLinkRequest) Send ¶ added in v0.2.0
func (r GetVpcLinkRequest) Send(ctx context.Context) (*GetVpcLinkResponse, error)
Send marshals and sends the GetVpcLink API request.
type GetVpcLinkResponse ¶ added in v0.9.0
type GetVpcLinkResponse struct { *GetVpcLinkOutput // contains filtered or unexported fields }
GetVpcLinkResponse is the response type for the GetVpcLink API operation.
func (*GetVpcLinkResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetVpcLinkResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetVpcLink request.
type GetVpcLinksInput ¶ added in v0.2.0
type GetVpcLinksInput struct { // The maximum number of returned results per page. The default value is 25 // and the maximum value is 500. Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` // The current pagination position in the paged result set. Position *string `location:"querystring" locationName:"position" type:"string"` // contains filtered or unexported fields }
Gets the VpcLinks collection under the caller's account in a selected region.
func (GetVpcLinksInput) MarshalFields ¶ added in v0.3.0
func (s GetVpcLinksInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetVpcLinksInput) String ¶ added in v0.2.0
func (s GetVpcLinksInput) String() string
String returns the string representation
type GetVpcLinksOutput ¶ added in v0.2.0
type GetVpcLinksOutput struct { // The current page of elements from this collection. Items []VpcLink `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` // contains filtered or unexported fields }
The collection of VPC links under the caller's account in a region.
Getting Started with Private Integrations (https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-with-private-integration.html), Set up Private Integrations (https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-private-integration.html)
func (GetVpcLinksOutput) MarshalFields ¶ added in v0.3.0
func (s GetVpcLinksOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetVpcLinksOutput) String ¶ added in v0.2.0
func (s GetVpcLinksOutput) String() string
String returns the string representation
type GetVpcLinksPaginator ¶ added in v0.9.0
GetVpcLinksPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetVpcLinksPaginator ¶ added in v0.9.0
func NewGetVpcLinksPaginator(req GetVpcLinksRequest) GetVpcLinksPaginator
NewGetVpcLinksRequestPaginator returns a paginator for GetVpcLinks. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetVpcLinksRequest(input) p := apigateway.NewGetVpcLinksRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetVpcLinksPaginator) CurrentPage ¶ added in v0.9.0
func (p *GetVpcLinksPaginator) CurrentPage() *GetVpcLinksOutput
type GetVpcLinksRequest ¶ added in v0.2.0
type GetVpcLinksRequest struct { *aws.Request Input *GetVpcLinksInput Copy func(*GetVpcLinksInput) GetVpcLinksRequest }
GetVpcLinksRequest is the request type for the GetVpcLinks API operation.
func (GetVpcLinksRequest) Send ¶ added in v0.2.0
func (r GetVpcLinksRequest) Send(ctx context.Context) (*GetVpcLinksResponse, error)
Send marshals and sends the GetVpcLinks API request.
type GetVpcLinksResponse ¶ added in v0.9.0
type GetVpcLinksResponse struct { *GetVpcLinksOutput // contains filtered or unexported fields }
GetVpcLinksResponse is the response type for the GetVpcLinks API operation.
func (*GetVpcLinksResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetVpcLinksResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetVpcLinks request.
type ImportApiKeysInput ¶
type ImportApiKeysInput struct { // The payload of the POST request to import API keys. For the payload format, // see API Key File Format (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html). // // Body is a required field Body []byte `locationName:"body" type:"blob" required:"true"` // A query parameter to indicate whether to rollback ApiKey importation (true) // or not (false) when error is encountered. FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` // A query parameter to specify the input format to imported API keys. Currently, // only the csv format is supported. // // Format is a required field Format ApiKeysFormat `location:"querystring" locationName:"format" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
The POST request to import API keys from an external source, such as a CSV-formatted file.
func (ImportApiKeysInput) MarshalFields ¶ added in v0.3.0
func (s ImportApiKeysInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ImportApiKeysInput) String ¶
func (s ImportApiKeysInput) String() string
String returns the string representation
func (*ImportApiKeysInput) Validate ¶
func (s *ImportApiKeysInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportApiKeysOutput ¶
type ImportApiKeysOutput struct { // A list of all the ApiKey identifiers. Ids []string `locationName:"ids" type:"list"` // A list of warning messages. Warnings []string `locationName:"warnings" type:"list"` // contains filtered or unexported fields }
The identifier of an ApiKey used in a UsagePlan.
func (ImportApiKeysOutput) MarshalFields ¶ added in v0.3.0
func (s ImportApiKeysOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ImportApiKeysOutput) String ¶
func (s ImportApiKeysOutput) String() string
String returns the string representation
type ImportApiKeysRequest ¶
type ImportApiKeysRequest struct { *aws.Request Input *ImportApiKeysInput Copy func(*ImportApiKeysInput) ImportApiKeysRequest }
ImportApiKeysRequest is the request type for the ImportApiKeys API operation.
func (ImportApiKeysRequest) Send ¶
func (r ImportApiKeysRequest) Send(ctx context.Context) (*ImportApiKeysResponse, error)
Send marshals and sends the ImportApiKeys API request.
type ImportApiKeysResponse ¶ added in v0.9.0
type ImportApiKeysResponse struct { *ImportApiKeysOutput // contains filtered or unexported fields }
ImportApiKeysResponse is the response type for the ImportApiKeys API operation.
func (*ImportApiKeysResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ImportApiKeysResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ImportApiKeys request.
type ImportDocumentationPartsInput ¶
type ImportDocumentationPartsInput struct { // [Required] Raw byte array representing the to-be-imported documentation parts. // To import from an OpenAPI file, this is a JSON object. // // Body is a required field Body []byte `locationName:"body" type:"blob" required:"true"` // A query parameter to specify whether to rollback the documentation importation // (true) or not (false) when a warning is encountered. The default value is // false. FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` // A query parameter to indicate whether to overwrite (OVERWRITE) any existing // DocumentationParts definition or to merge (MERGE) the new definition into // the existing one. The default value is MERGE. Mode PutMode `location:"querystring" locationName:"mode" type:"string" enum:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Import documentation parts from an external (e.g., OpenAPI) definition file.
func (ImportDocumentationPartsInput) MarshalFields ¶ added in v0.3.0
func (s ImportDocumentationPartsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ImportDocumentationPartsInput) String ¶
func (s ImportDocumentationPartsInput) String() string
String returns the string representation
func (*ImportDocumentationPartsInput) Validate ¶
func (s *ImportDocumentationPartsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportDocumentationPartsOutput ¶
type ImportDocumentationPartsOutput struct { // A list of the returned documentation part identifiers. Ids []string `locationName:"ids" type:"list"` // A list of warning messages reported during import of documentation parts. Warnings []string `locationName:"warnings" type:"list"` // contains filtered or unexported fields }
A collection of the imported DocumentationPart identifiers.
This is used to return the result when documentation parts in an external (e.g., OpenAPI) file are imported into API Gateway
Documenting an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), documentationpart:import (https://docs.aws.amazon.com/apigateway/api-reference/link-relation/documentationpart-import/), DocumentationPart
func (ImportDocumentationPartsOutput) MarshalFields ¶ added in v0.3.0
func (s ImportDocumentationPartsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ImportDocumentationPartsOutput) String ¶
func (s ImportDocumentationPartsOutput) String() string
String returns the string representation
type ImportDocumentationPartsRequest ¶
type ImportDocumentationPartsRequest struct { *aws.Request Input *ImportDocumentationPartsInput Copy func(*ImportDocumentationPartsInput) ImportDocumentationPartsRequest }
ImportDocumentationPartsRequest is the request type for the ImportDocumentationParts API operation.
func (ImportDocumentationPartsRequest) Send ¶
func (r ImportDocumentationPartsRequest) Send(ctx context.Context) (*ImportDocumentationPartsResponse, error)
Send marshals and sends the ImportDocumentationParts API request.
type ImportDocumentationPartsResponse ¶ added in v0.9.0
type ImportDocumentationPartsResponse struct { *ImportDocumentationPartsOutput // contains filtered or unexported fields }
ImportDocumentationPartsResponse is the response type for the ImportDocumentationParts API operation.
func (*ImportDocumentationPartsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ImportDocumentationPartsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ImportDocumentationParts request.
type ImportRestApiInput ¶
type ImportRestApiInput struct { // [Required] The POST request body containing external API definitions. Currently, // only OpenAPI definition JSON/YAML files are supported. The maximum size of // the API definition file is 6MB. // // Body is a required field Body []byte `locationName:"body" type:"blob" required:"true"` // A query parameter to indicate whether to rollback the API creation (true) // or not (false) when a warning is encountered. The default value is false. FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` // A key-value map of context-specific query string parameters specifying the // behavior of different API importing operations. The following shows operation-specific // parameters and their supported values. // // To exclude DocumentationParts from the import, set parameters as ignore=documentation. // // To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, // endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. // The default endpoint type is EDGE. // // To handle imported basepath, set parameters as basepath=ignore, basepath=prepend // or basepath=split. // // For example, the AWS CLI command to exclude documentation from the imported // API is: // // aws apigateway import-rest-api --parameters ignore=documentation --body // 'file:///path/to/imported-api-body.json' // // The AWS CLI command to set the regional endpoint on the imported API is: // // aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL // --body 'file:///path/to/imported-api-body.json' Parameters map[string]string `location:"querystring" locationName:"parameters" type:"map"` // contains filtered or unexported fields }
A POST request to import an API to API Gateway using an input of an API definition file.
func (ImportRestApiInput) MarshalFields ¶ added in v0.3.0
func (s ImportRestApiInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ImportRestApiInput) String ¶
func (s ImportRestApiInput) String() string
String returns the string representation
func (*ImportRestApiInput) Validate ¶
func (s *ImportRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportRestApiOutput ¶ added in v0.9.0
type ImportRestApiOutput struct { // The source of the API key for metering requests according to a usage plan. // Valid values are: // * HEADER to read the API key from the X-API-Key header of a request. // // * AUTHORIZER to read the API key from the UsageIdentifierKey from a custom // authorizer. ApiKeySource ApiKeySourceType `locationName:"apiKeySource" type:"string" enum:"true"` // The list of binary media types supported by the RestApi. By default, the // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string `locationName:"binaryMediaTypes" type:"list"` // The timestamp when the API was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The API's description. Description *string `locationName:"description" type:"string"` // The endpoint configuration of this RestApi showing the endpoint types of // the API. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The API's identifier. This identifier is unique across all of your APIs in // API Gateway. Id *string `locationName:"id" type:"string"` // A nullable integer that is used to enable compression (with non-negative // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with // a null value) on an API. When compression is enabled, compression or decompression // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int64 `locationName:"minimumCompressionSize" type:"integer"` // The API's name. Name *string `locationName:"name" type:"string"` // A stringified JSON policy document that applies to this RestApi regardless // of the caller and Method configuration. Policy *string `locationName:"policy" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (ImportRestApiOutput) MarshalFields ¶ added in v0.9.0
func (s ImportRestApiOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ImportRestApiOutput) String ¶ added in v0.9.0
func (s ImportRestApiOutput) String() string
String returns the string representation
type ImportRestApiRequest ¶
type ImportRestApiRequest struct { *aws.Request Input *ImportRestApiInput Copy func(*ImportRestApiInput) ImportRestApiRequest }
ImportRestApiRequest is the request type for the ImportRestApi API operation.
func (ImportRestApiRequest) Send ¶
func (r ImportRestApiRequest) Send(ctx context.Context) (*ImportRestApiResponse, error)
Send marshals and sends the ImportRestApi API request.
type ImportRestApiResponse ¶ added in v0.9.0
type ImportRestApiResponse struct { *ImportRestApiOutput // contains filtered or unexported fields }
ImportRestApiResponse is the response type for the ImportRestApi API operation.
func (*ImportRestApiResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ImportRestApiResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ImportRestApi request.
type Integration ¶ added in v0.9.0
type Integration struct { // A list of request parameters whose values API Gateway caches. To be valid // values for cacheKeyParameters, these parameters must also be specified for // Method requestParameters. CacheKeyParameters []string `locationName:"cacheKeyParameters" type:"list"` // Specifies a group of related cached parameters. By default, API Gateway uses // the resource ID as the cacheNamespace. You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string `locationName:"cacheNamespace" type:"string"` // The (id (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) // of the VpcLink used for the integration when connectionType=VPC_LINK and // undefined, otherwise. ConnectionId *string `locationName:"connectionId" type:"string"` // The type of the network connection to the integration endpoint. The valid // value is INTERNET for connections through the public routable internet or // VPC_LINK for private connections between API Gateway and a network load balancer // in a VPC. The default value is INTERNET. ConnectionType ConnectionType `locationName:"connectionType" type:"string" enum:"true"` // 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 passthroughBehavior is configured to support payload pass-through. ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"` // Specifies the credentials required for the integration, if any. For AWS integrations, // three options are available. To specify an IAM Role for API Gateway to assume, // use the role's Amazon Resource Name (ARN). To require that the caller's identity // be passed through from the request, specify the string arn:aws:iam::\*:user/\*. // To use resource-based permissions on supported AWS services, specify null. Credentials *string `locationName:"credentials" type:"string"` // Specifies the integration's HTTP method type. HttpMethod *string `locationName:"httpMethod" type:"string"` // Specifies the integration's responses. // // Example: Get integration responses of a method // // Request // GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 // HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns 200 OK status and a payload as follows: // { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", // "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" // }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" // } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" // }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream // in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" // }, "statusCode": "200" } // // Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) IntegrationResponses map[string]IntegrationResponse `locationName:"integrationResponses" type:"map"` // Specifies how the method request body of an unmapped content type will be // passed through the integration request to the back end without transformation. // A content type is unmapped if no mapping template is defined in the integration // or the content type does not match any of the mapped content types, as specified // in requestTemplates. The valid value is one of the following: // // * WHEN_NO_MATCH: passes the method request body through the integration // request to the back end without transformation when the method request // content type does not match any content type associated with the mapping // templates defined in the integration request. // // * WHEN_NO_TEMPLATES: passes the method request body through the integration // request to the back end without transformation when no mapping template // is defined in the integration request. If a template is defined when this // option is selected, the method request of an unmapped content-type will // be rejected with an HTTP 415 Unsupported Media Type response. // // * NEVER: rejects the method request with an HTTP 415 Unsupported Media // Type response when either the method request content type does not match // any content type associated with the mapping templates defined in the // integration request or no mapping template is defined in the integration // request. PassthroughBehavior *string `locationName:"passthroughBehavior" type:"string"` // A key-value map specifying request parameters that are passed from the method // request to the back end. The key is an integration request parameter name // and the associated value is a method request parameter value or static value // that must be enclosed within single quotes and pre-encoded as required by // the back end. The method request parameter value must match the pattern of // method.request.{location}.{name}, where location is querystring, path, or // header and name must be a valid and unique method request parameter name. RequestParameters map[string]string `locationName:"requestParameters" type:"map"` // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the // value. RequestTemplates map[string]string `locationName:"requestTemplates" type:"map"` // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 // milliseconds or 29 seconds. TimeoutInMillis *int64 `locationName:"timeoutInMillis" type:"integer"` // Specifies the TLS configuration for an integration. TlsConfig *TlsConfig `locationName:"tlsConfig" type:"structure"` // Specifies an API method integration type. The valid value is one of the following: // // * AWS: for integrating the API method request with an AWS service action, // including the Lambda function-invoking action. With the Lambda function-invoking // action, this is referred to as the Lambda custom integration. With any // other AWS service action, this is known as AWS integration. // // * AWS_PROXY: for integrating the API method request with the Lambda function-invoking // action with the client request passed through as-is. This integration // is also referred to as the Lambda proxy integration. // // * HTTP: for integrating the API method request with an HTTP endpoint, // including a private HTTP endpoint within a VPC. This integration is also // referred to as the HTTP custom integration. // // * HTTP_PROXY: for integrating the API method request with an HTTP endpoint, // including a private HTTP endpoint within a VPC, with the client request // passed through as-is. This is also referred to as the HTTP proxy integration. // // * MOCK: for integrating the API method request with API Gateway as a "loop-back" // endpoint without invoking any backend. // // For the HTTP and HTTP proxy integrations, each integration can specify a // protocol (http/https), port and path. Standard 80 and 443 ports are supported // as well as custom ports above 1024. An HTTP or HTTP proxy integration with // a connectionType of VPC_LINK is referred to as a private integration and // uses a VpcLink to connect API Gateway to a network load balancer of a VPC. Type IntegrationType `locationName:"type" type:"string" enum:"true"` // Specifies Uniform Resource Identifier (URI) of the integration endpoint. // // * For HTTP or HTTP_PROXY 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 either standard integration, where connectionType is not VPC_LINK, // or private integration, where connectionType is VPC_LINK. For a private // HTTP integration, the URI is not used for routing. // // * For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. // Here, {Region} is the API Gateway region (e.g., us-east-1); {service} // is the name of the integrated AWS service (e.g., s3); and {subdomain} // is a designated subdomain supported by certain AWS service for fast host-name // lookup. action can be used for an AWS service action-based API, using // an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} // refers to a supported action {name} plus any required input parameters. // Alternatively, path can be used for an AWS service path-based API. The // ensuing service_api refers to the path to an AWS service resource, including // the region of the integrated AWS service, if applicable. For example, // for integration with the S3 API of GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html), // the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} // or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (Integration) MarshalFields ¶ added in v0.9.0
func (s Integration) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (Integration) String ¶ added in v0.9.0
func (s Integration) String() string
String returns the string representation
type IntegrationResponse ¶ added in v0.9.0
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 ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"` // A key-value map specifying response parameters that are passed to the method // response from the back end. The key is a method response header parameter // name and the mapped value is an integration response header value, a static // value enclosed within a pair of single quotes, or a JSON expression from // the integration response body. The mapping key must match the pattern of // method.response.header.{name}, where name is a valid and unique header name. // The mapped non-static value must match the pattern of integration.response.header.{name} // or integration.response.body.{JSON-expression}, where name is a valid and // unique response header name and JSON-expression is a valid JSON expression // without the $ prefix. ResponseParameters map[string]string `locationName:"responseParameters" type:"map"` // Specifies the templates used to transform the integration response body. // Response templates are represented as a key/value map, with a content-type // as the key and a template as the value. ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"` // Specifies the regular expression (regex) pattern used to choose an integration // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you // could use the .+ regex to match error response. However, make sure that the // error response does not contain any newline (\n) character in such cases. // If the back end is an AWS Lambda function, the AWS Lambda function error // header is matched. For all other HTTP and AWS back ends, the HTTP status // code is matched. SelectionPattern *string `locationName:"selectionPattern" type:"string"` // Specifies the status code that is used to map the integration response to // an existing MethodResponse. StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (IntegrationResponse) MarshalFields ¶ added in v0.9.0
func (s IntegrationResponse) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (IntegrationResponse) String ¶ added in v0.9.0
func (s IntegrationResponse) String() string
String returns the string representation
type IntegrationType ¶
type IntegrationType string
The integration type. The valid value is HTTP for integrating an API method with an HTTP backend; AWS with any AWS service endpoints; MOCK for testing without actually invoking the backend; HTTP_PROXY for integrating with the HTTP proxy integration; AWS_PROXY for integrating with the Lambda proxy integration.
const ( IntegrationTypeHttp IntegrationType = "HTTP" IntegrationTypeAws IntegrationType = "AWS" IntegrationTypeMock IntegrationType = "MOCK" IntegrationTypeHttpProxy IntegrationType = "HTTP_PROXY" IntegrationTypeAwsProxy IntegrationType = "AWS_PROXY" )
Enum values for IntegrationType
func (IntegrationType) MarshalValue ¶ added in v0.3.0
func (enum IntegrationType) MarshalValue() (string, error)
func (IntegrationType) MarshalValueBuf ¶ added in v0.3.0
func (enum IntegrationType) MarshalValueBuf(b []byte) ([]byte, error)
type LocationStatusType ¶ added in v0.2.0
type LocationStatusType string
const ( LocationStatusTypeDocumented LocationStatusType = "DOCUMENTED" LocationStatusTypeUndocumented LocationStatusType = "UNDOCUMENTED" )
Enum values for LocationStatusType
func (LocationStatusType) MarshalValue ¶ added in v0.3.0
func (enum LocationStatusType) MarshalValue() (string, error)
func (LocationStatusType) MarshalValueBuf ¶ added in v0.3.0
func (enum LocationStatusType) MarshalValueBuf(b []byte) ([]byte, error)
type Method ¶ added in v0.9.0
type Method struct { // A boolean flag specifying whether a valid ApiKey is required to invoke this // method. ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"` // A list of authorization scopes configured on the method. The scopes are used // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. // The authorization works by matching the method scopes against the scopes // parsed from the access token in the incoming request. The method invocation // is authorized if any method scopes matches a claimed scope in the access // token. Otherwise, the invocation is not authorized. When the method scope // is configured, the client must provide an access token instead of an identity // token for authorization purposes. AuthorizationScopes []string `locationName:"authorizationScopes" type:"list"` // The method's authorization type. Valid values are NONE for open access, AWS_IAM // for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS // for using a Cognito user pool. AuthorizationType *string `locationName:"authorizationType" type:"string"` // The identifier of an Authorizer to use on this method. The authorizationType // must be CUSTOM. AuthorizerId *string `locationName:"authorizerId" type:"string"` // The method's HTTP verb. HttpMethod *string `locationName:"httpMethod" type:"string"` // Gets the method's integration responsible for passing the client-submitted // request to the back end and performing necessary transformations to make // the request compliant with the back end. // // Example: // // Request // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns a 200 OK status code and a payload similar // to the following: // { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", // "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true } ], "self": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": // { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" // }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", // "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" // }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", // "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", // "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": // "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": // "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", // \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", // "_embedded": { "integration:responses": { "_links": { "self": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", // "name": "200", "title": "200" }, "integrationresponse:delete": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" // }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" // } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", // "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": // "integration.response.body.a" }, "responseTemplates": { "application/json": // "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op // => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n // \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } // } } // // AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html) MethodIntegration *Integration `locationName:"methodIntegration" type:"structure"` // Gets a method response associated with a given HTTP status code. // // The collection of method responses are encapsulated in a key-value map, where // the key is a response's HTTP status code and the value is a MethodResponse // resource that specifies the response returned to the caller from the back // end through the integration response. // // Example: Get a 200 OK response of a GET method // // Request // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns a 200 OK status code and a payload similar // to the following: // { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", // "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", // "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" // }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" // } }, "responseModels": { "application/json": "Empty" }, "responseParameters": // { "method.response.header.operator": false, "method.response.header.operand_2": // false, "method.response.header.operand_1": false }, "statusCode": "200" // } // // AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) 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 the PetStore // 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 API Gateway. A key is a method request parameter name // matching the pattern of method.request.{location}.{name}, where location // is querystring, path, or header and name is a valid and unique parameter // name. The value associated with the key is a Boolean flag indicating whether // the parameter is required (true) or optional (false). The method request // parameter names defined here are available in Integration to be mapped to // integration request parameters or templates. RequestParameters map[string]bool `locationName:"requestParameters" type:"map"` // The identifier of a RequestValidator for request validation. RequestValidatorId *string `locationName:"requestValidatorId" type:"string"` // contains filtered or unexported fields }
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
Example: Retrive the GET method on a specified resource
Request ¶
The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri).
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://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() (https://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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html)
func (Method) MarshalFields ¶ added in v0.9.0
func (s Method) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type MethodResponse ¶ added in v0.9.0
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 // 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. 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": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" }
Method, IntegrationResponse, Integration Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (MethodResponse) MarshalFields ¶ added in v0.9.0
func (s MethodResponse) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (MethodResponse) String ¶ added in v0.9.0
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 affects // 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 affects 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. Choose ERROR to write // only error-level entries to CloudWatch Logs, or choose INFO to include all // ERROR events as well as extra informational events. 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 UnauthorizedCacheControlHeaderStrategy `locationName:"unauthorizedCacheControlHeaderStrategy" type:"string" enum:"true"` // contains filtered or unexported fields }
Specifies the method setting properties.
func (MethodSetting) MarshalFields ¶ added in v0.3.0
func (s MethodSetting) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (MethodSetting) String ¶
func (s MethodSetting) String() string
String returns the string representation
type MethodSnapshot ¶
type MethodSnapshot struct { // Specifies whether the method requires a valid ApiKey. ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"` // The method's authorization type. Valid values are NONE for open access, AWS_IAM // for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS // for using a Cognito user pool. AuthorizationType *string `locationName:"authorizationType" type:"string"` // contains filtered or unexported fields }
Represents a summary of a Method resource, given a particular date and time.
func (MethodSnapshot) MarshalFields ¶ added in v0.3.0
func (s MethodSnapshot) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (MethodSnapshot) String ¶
func (s MethodSnapshot) String() string
String returns the string representation
type Model ¶ added in v0.9.0
type Model struct { // The content-type for the model. ContentType *string `locationName:"contentType" type:"string"` // The description of the model. Description *string `locationName:"description" type:"string"` // The identifier for the model resource. Id *string `locationName:"id" type:"string"` // The name of the model. Must be an alphanumeric string. Name *string `locationName:"name" type:"string"` // The schema for the model. For application/json models, this should be JSON // schema draft 4 (https://tools.ietf.org/html/draft-zyp-json-schema-04) 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html)
func (Model) MarshalFields ¶ added in v0.9.0
func (s Model) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type Op ¶
type Op string
const ( OpAdd Op = "add" OpRemove Op = "remove" OpReplace Op = "replace" OpMove Op = "move" OpCopy Op = "copy" OpTest Op = "test" )
Enum values for Op
func (Op) MarshalValue ¶ added in v0.3.0
type PatchOperation ¶
type PatchOperation struct { // The copy update operation's source as identified by a JSON-Pointer value // referencing the location within the targeted resource to copy the value from. // For example, to promote a canary deployment, you copy the canary deployment // ID to the affiliated deployment ID by calling a PATCH request on a Stage // resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId". From *string `locationName:"from" type:"string"` // An update operation to be performed with this PATCH request. The valid value // can be add, remove, replace or copy. Not all valid operations are supported // for a given resource. Support of the operations depends on specific operational // contexts. Attempts to apply an unsupported operation on a resource will return // an error message. Op Op `locationName:"op" type:"string" enum:"true"` // The op operation's target, as identified by a JSON Pointer (https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08) // value that references a location within the targeted resource. For example, // if the target resource has an updateable property of {"name":"value"}, the // path for this property is /name. If the name property value is a JSON object // (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name // property will be /name/child~1name. Any slash ("/") character appearing in // path names must be escaped with "~1", as shown in the example above. Each // op operation can have only one path associated with it. Path *string `locationName:"path" type:"string"` // The new target value of the update operation. It is applicable for the add // or replace operation. When using AWS CLI to update a property of a JSON value, // enclose the JSON object with a pair of single quotes in a Linux shell, e.g., // '{"a": ...}'. In a Windows shell, see Using JSON for Parameters (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.
func (PatchOperation) MarshalFields ¶ added in v0.3.0
func (s PatchOperation) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PatchOperation) String ¶
func (s PatchOperation) String() string
String returns the string representation
type PutGatewayResponseInput ¶
type PutGatewayResponseInput struct { // Response parameters (paths, query strings and headers) of the GatewayResponse // as a string-to-string map of key-value pairs. ResponseParameters map[string]string `locationName:"responseParameters" type:"map"` // Response templates of the GatewayResponse as a string-to-string map of key-value // pairs. ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"` // [Required] // The response type of the associated GatewayResponse. Valid values are // * ACCESS_DENIED // // * API_CONFIGURATION_ERROR // // * AUTHORIZER_FAILURE // // * AUTHORIZER_CONFIGURATION_ERROR // // * BAD_REQUEST_PARAMETERS // // * BAD_REQUEST_BODY // // * DEFAULT_4XX // // * DEFAULT_5XX // // * EXPIRED_TOKEN // // * INVALID_SIGNATURE // // * INTEGRATION_FAILURE // // * INTEGRATION_TIMEOUT // // * INVALID_API_KEY // // * MISSING_AUTHENTICATION_TOKEN // // * QUOTA_EXCEEDED // // * REQUEST_TOO_LARGE // // * RESOURCE_NOT_FOUND // // * THROTTLED // // * UNAUTHORIZED // // * UNSUPPORTED_MEDIA_TYPE // // ResponseType is a required field ResponseType GatewayResponseType `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // The HTTP status code of the GatewayResponse. StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
func (PutGatewayResponseInput) MarshalFields ¶ added in v0.3.0
func (s PutGatewayResponseInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutGatewayResponseInput) String ¶
func (s PutGatewayResponseInput) String() string
String returns the string representation
func (*PutGatewayResponseInput) Validate ¶
func (s *PutGatewayResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutGatewayResponseOutput ¶ added in v0.9.0
type PutGatewayResponseOutput struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway // response (true) or not (false). A default gateway response is one generated // by API Gateway without any customization by an API developer. DefaultResponse *bool `locationName:"defaultResponse" type:"boolean"` // Response parameters (paths, query strings and headers) of the GatewayResponse // as a string-to-string map of key-value pairs. ResponseParameters map[string]string `locationName:"responseParameters" type:"map"` // Response templates of the GatewayResponse as a string-to-string map of key-value // pairs. ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"` // The response type of the associated GatewayResponse. Valid values are // * ACCESS_DENIED // // * API_CONFIGURATION_ERROR // // * AUTHORIZER_FAILURE // // * AUTHORIZER_CONFIGURATION_ERROR // // * BAD_REQUEST_PARAMETERS // // * BAD_REQUEST_BODY // // * DEFAULT_4XX // // * DEFAULT_5XX // // * EXPIRED_TOKEN // // * INVALID_SIGNATURE // // * INTEGRATION_FAILURE // // * INTEGRATION_TIMEOUT // // * INVALID_API_KEY // // * MISSING_AUTHENTICATION_TOKEN // // * QUOTA_EXCEEDED // // * REQUEST_TOO_LARGE // // * RESOURCE_NOT_FOUND // // * THROTTLED // // * UNAUTHORIZED // // * UNSUPPORTED_MEDIA_TYPE ResponseType GatewayResponseType `locationName:"responseType" type:"string" enum:"true"` // The HTTP status code for this GatewayResponse. StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway (https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html)
Example: Get a Gateway Response of a given response type
Request ¶
This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45
The response type is specified as a URL path.
Response ¶
The successful operation returns the 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{\n \"message\": $context.error.messageString,\n \"type\": \"$context.error.responseType\",\n \"stage\": \"$context.stage\",\n \"resourcePath\": \"$context.resourcePath\",\n \"stageVariables.a\": \"$stageVariables.a\",\n \"statusCode\": \"'404'\"\n}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404" }
Customize Gateway Responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html)
func (PutGatewayResponseOutput) MarshalFields ¶ added in v0.9.0
func (s PutGatewayResponseOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutGatewayResponseOutput) String ¶ added in v0.9.0
func (s PutGatewayResponseOutput) String() string
String returns the string representation
type PutGatewayResponseRequest ¶
type PutGatewayResponseRequest struct { *aws.Request Input *PutGatewayResponseInput Copy func(*PutGatewayResponseInput) PutGatewayResponseRequest }
PutGatewayResponseRequest is the request type for the PutGatewayResponse API operation.
func (PutGatewayResponseRequest) Send ¶
func (r PutGatewayResponseRequest) Send(ctx context.Context) (*PutGatewayResponseResponse, error)
Send marshals and sends the PutGatewayResponse API request.
type PutGatewayResponseResponse ¶ added in v0.9.0
type PutGatewayResponseResponse struct { *PutGatewayResponseOutput // contains filtered or unexported fields }
PutGatewayResponseResponse is the response type for the PutGatewayResponse API operation.
func (*PutGatewayResponseResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutGatewayResponseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutGatewayResponse request.
type PutIntegrationInput ¶
type PutIntegrationInput struct { // A list of request parameters whose values API Gateway caches. To be valid // values for cacheKeyParameters, these parameters must also be specified for // Method requestParameters. CacheKeyParameters []string `locationName:"cacheKeyParameters" type:"list"` // Specifies a group of related cached parameters. By default, API Gateway uses // the resource ID as the cacheNamespace. You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string `locationName:"cacheNamespace" type:"string"` // The (id (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) // of the VpcLink used for the integration when connectionType=VPC_LINK and // undefined, otherwise. ConnectionId *string `locationName:"connectionId" type:"string"` // The type of the network connection to the integration endpoint. The valid // value is INTERNET for connections through the public routable internet or // VPC_LINK for private connections between API Gateway and a network load balancer // in a VPC. The default value is INTERNET. ConnectionType ConnectionType `locationName:"connectionType" type:"string" enum:"true"` // 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 passthroughBehavior is configured to support payload pass-through. ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"` // Specifies whether credentials are required for a put integration. Credentials *string `locationName:"credentials" type:"string"` // [Required] 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"` // [Required] Specifies a put integration request's resource ID. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 // milliseconds or 29 seconds. TimeoutInMillis *int64 `locationName:"timeoutInMillis" type:"integer"` TlsConfig *TlsConfig `locationName:"tlsConfig" type:"structure"` // [Required] Specifies a put integration input's type. // // Type is a required field Type IntegrationType `locationName:"type" type:"string" required:"true" enum:"true"` // Specifies Uniform Resource Identifier (URI) of the integration endpoint. // // * For HTTP or HTTP_PROXY 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 either standard integration, where connectionType is not VPC_LINK, // or private integration, where connectionType is VPC_LINK. For a private // HTTP integration, the URI is not used for routing. // // * For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. // Here, {Region} is the API Gateway region (e.g., us-east-1); {service} // is the name of the integrated AWS service (e.g., s3); and {subdomain} // is a designated subdomain supported by certain AWS service for fast host-name // lookup. action can be used for an AWS service action-based API, using // an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} // refers to a supported action {name} plus any required input parameters. // Alternatively, path can be used for an AWS service path-based API. The // ensuing service_api refers to the path to an AWS service resource, including // the region of the integrated AWS service, if applicable. For example, // for integration with the S3 API of GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html), // the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} // or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} Uri *string `locationName:"uri" type:"string"` // contains filtered or unexported fields }
Sets up a method's integration.
func (PutIntegrationInput) MarshalFields ¶ added in v0.3.0
func (s PutIntegrationInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutIntegrationInput) String ¶
func (s PutIntegrationInput) String() string
String returns the string representation
func (*PutIntegrationInput) Validate ¶
func (s *PutIntegrationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutIntegrationOutput ¶ added in v0.9.0
type PutIntegrationOutput struct { // A list of request parameters whose values API Gateway caches. To be valid // values for cacheKeyParameters, these parameters must also be specified for // Method requestParameters. CacheKeyParameters []string `locationName:"cacheKeyParameters" type:"list"` // Specifies a group of related cached parameters. By default, API Gateway uses // the resource ID as the cacheNamespace. You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string `locationName:"cacheNamespace" type:"string"` // The (id (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) // of the VpcLink used for the integration when connectionType=VPC_LINK and // undefined, otherwise. ConnectionId *string `locationName:"connectionId" type:"string"` // The type of the network connection to the integration endpoint. The valid // value is INTERNET for connections through the public routable internet or // VPC_LINK for private connections between API Gateway and a network load balancer // in a VPC. The default value is INTERNET. ConnectionType ConnectionType `locationName:"connectionType" type:"string" enum:"true"` // 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 passthroughBehavior is configured to support payload pass-through. ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"` // Specifies the credentials required for the integration, if any. For AWS integrations, // three options are available. To specify an IAM Role for API Gateway to assume, // use the role's Amazon Resource Name (ARN). To require that the caller's identity // be passed through from the request, specify the string arn:aws:iam::\*:user/\*. // To use resource-based permissions on supported AWS services, specify null. Credentials *string `locationName:"credentials" type:"string"` // Specifies the integration's HTTP method type. HttpMethod *string `locationName:"httpMethod" type:"string"` // Specifies the integration's responses. // // Example: Get integration responses of a method // // Request // GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 // HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns 200 OK status and a payload as follows: // { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", // "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" // }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" // } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" // }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream // in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" // }, "statusCode": "200" } // // Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) IntegrationResponses map[string]IntegrationResponse `locationName:"integrationResponses" type:"map"` // Specifies how the method request body of an unmapped content type will be // passed through the integration request to the back end without transformation. // A content type is unmapped if no mapping template is defined in the integration // or the content type does not match any of the mapped content types, as specified // in requestTemplates. The valid value is one of the following: // // * WHEN_NO_MATCH: passes the method request body through the integration // request to the back end without transformation when the method request // content type does not match any content type associated with the mapping // templates defined in the integration request. // // * WHEN_NO_TEMPLATES: passes the method request body through the integration // request to the back end without transformation when no mapping template // is defined in the integration request. If a template is defined when this // option is selected, the method request of an unmapped content-type will // be rejected with an HTTP 415 Unsupported Media Type response. // // * NEVER: rejects the method request with an HTTP 415 Unsupported Media // Type response when either the method request content type does not match // any content type associated with the mapping templates defined in the // integration request or no mapping template is defined in the integration // request. PassthroughBehavior *string `locationName:"passthroughBehavior" type:"string"` // A key-value map specifying request parameters that are passed from the method // request to the back end. The key is an integration request parameter name // and the associated value is a method request parameter value or static value // that must be enclosed within single quotes and pre-encoded as required by // the back end. The method request parameter value must match the pattern of // method.request.{location}.{name}, where location is querystring, path, or // header and name must be a valid and unique method request parameter name. RequestParameters map[string]string `locationName:"requestParameters" type:"map"` // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the // value. RequestTemplates map[string]string `locationName:"requestTemplates" type:"map"` // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 // milliseconds or 29 seconds. TimeoutInMillis *int64 `locationName:"timeoutInMillis" type:"integer"` // Specifies the TLS configuration for an integration. TlsConfig *TlsConfig `locationName:"tlsConfig" type:"structure"` // Specifies an API method integration type. The valid value is one of the following: // // * AWS: for integrating the API method request with an AWS service action, // including the Lambda function-invoking action. With the Lambda function-invoking // action, this is referred to as the Lambda custom integration. With any // other AWS service action, this is known as AWS integration. // // * AWS_PROXY: for integrating the API method request with the Lambda function-invoking // action with the client request passed through as-is. This integration // is also referred to as the Lambda proxy integration. // // * HTTP: for integrating the API method request with an HTTP endpoint, // including a private HTTP endpoint within a VPC. This integration is also // referred to as the HTTP custom integration. // // * HTTP_PROXY: for integrating the API method request with an HTTP endpoint, // including a private HTTP endpoint within a VPC, with the client request // passed through as-is. This is also referred to as the HTTP proxy integration. // // * MOCK: for integrating the API method request with API Gateway as a "loop-back" // endpoint without invoking any backend. // // For the HTTP and HTTP proxy integrations, each integration can specify a // protocol (http/https), port and path. Standard 80 and 443 ports are supported // as well as custom ports above 1024. An HTTP or HTTP proxy integration with // a connectionType of VPC_LINK is referred to as a private integration and // uses a VpcLink to connect API Gateway to a network load balancer of a VPC. Type IntegrationType `locationName:"type" type:"string" enum:"true"` // Specifies Uniform Resource Identifier (URI) of the integration endpoint. // // * For HTTP or HTTP_PROXY 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 either standard integration, where connectionType is not VPC_LINK, // or private integration, where connectionType is VPC_LINK. For a private // HTTP integration, the URI is not used for routing. // // * For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. // Here, {Region} is the API Gateway region (e.g., us-east-1); {service} // is the name of the integrated AWS service (e.g., s3); and {subdomain} // is a designated subdomain supported by certain AWS service for fast host-name // lookup. action can be used for an AWS service action-based API, using // an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} // refers to a supported action {name} plus any required input parameters. // Alternatively, path can be used for an AWS service path-based API. The // ensuing service_api refers to the path to an AWS service resource, including // the region of the integrated AWS service, if applicable. For example, // for integration with the S3 API of GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html), // the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} // or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (PutIntegrationOutput) MarshalFields ¶ added in v0.9.0
func (s PutIntegrationOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutIntegrationOutput) String ¶ added in v0.9.0
func (s PutIntegrationOutput) String() string
String returns the string representation
type PutIntegrationRequest ¶
type PutIntegrationRequest struct { *aws.Request Input *PutIntegrationInput Copy func(*PutIntegrationInput) PutIntegrationRequest }
PutIntegrationRequest is the request type for the PutIntegration API operation.
func (PutIntegrationRequest) Send ¶
func (r PutIntegrationRequest) Send(ctx context.Context) (*PutIntegrationResponse, error)
Send marshals and sends the PutIntegration API request.
type PutIntegrationResponse ¶ added in v0.9.0
type PutIntegrationResponse struct { *PutIntegrationOutput // contains filtered or unexported fields }
PutIntegrationResponse is the response type for the PutIntegration API operation.
func (*PutIntegrationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutIntegrationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutIntegration request.
type PutIntegrationResponseInput ¶
type PutIntegrationResponseInput struct { // Specifies how to handle response payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: // // * CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded // string to the corresponding binary blob. // // * CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. // // If this property is not defined, the response payload will be passed through // from the integration response to the method response without modification. ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"` // [Required] 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"` // [Required] 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // Specifies the selection pattern of a put integration response. SelectionPattern *string `locationName:"selectionPattern" type:"string"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s PutIntegrationResponseInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutIntegrationResponseInput) String ¶
func (s PutIntegrationResponseInput) String() string
String returns the string representation
func (*PutIntegrationResponseInput) Validate ¶
func (s *PutIntegrationResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutIntegrationResponseOutput ¶ added in v0.9.0
type PutIntegrationResponseOutput struct { // Specifies how to handle response payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: // // * CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded // string to the corresponding binary blob. // // * CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. // // If this property is not defined, the response payload will be passed through // from the integration response to the method response without modification. ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"` // A key-value map specifying response parameters that are passed to the method // response from the back end. The key is a method response header parameter // name and the mapped value is an integration response header value, a static // value enclosed within a pair of single quotes, or a JSON expression from // the integration response body. The mapping key must match the pattern of // method.response.header.{name}, where name is a valid and unique header name. // The mapped non-static value must match the pattern of integration.response.header.{name} // or integration.response.body.{JSON-expression}, where name is a valid and // unique response header name and JSON-expression is a valid JSON expression // without the $ prefix. ResponseParameters map[string]string `locationName:"responseParameters" type:"map"` // Specifies the templates used to transform the integration response body. // Response templates are represented as a key/value map, with a content-type // as the key and a template as the value. ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"` // Specifies the regular expression (regex) pattern used to choose an integration // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you // could use the .+ regex to match error response. However, make sure that the // error response does not contain any newline (\n) character in such cases. // If the back end is an AWS Lambda function, the AWS Lambda function error // header is matched. For all other HTTP and AWS back ends, the HTTP status // code is matched. SelectionPattern *string `locationName:"selectionPattern" type:"string"` // Specifies the status code that is used to map the integration response to // an existing MethodResponse. StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (PutIntegrationResponseOutput) MarshalFields ¶ added in v0.9.0
func (s PutIntegrationResponseOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutIntegrationResponseOutput) String ¶ added in v0.9.0
func (s PutIntegrationResponseOutput) String() string
String returns the string representation
type PutIntegrationResponseRequest ¶
type PutIntegrationResponseRequest struct { *aws.Request Input *PutIntegrationResponseInput Copy func(*PutIntegrationResponseInput) PutIntegrationResponseRequest }
PutIntegrationResponseRequest is the request type for the PutIntegrationResponse API operation.
func (PutIntegrationResponseRequest) Send ¶
func (r PutIntegrationResponseRequest) Send(ctx context.Context) (*PutIntegrationResponseResponse, error)
Send marshals and sends the PutIntegrationResponse API request.
type PutIntegrationResponseResponse ¶ added in v0.9.0
type PutIntegrationResponseResponse struct { *PutIntegrationResponseOutput // contains filtered or unexported fields }
PutIntegrationResponseResponse is the response type for the PutIntegrationResponse API operation.
func (*PutIntegrationResponseResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutIntegrationResponseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutIntegrationResponse request.
type PutMethodInput ¶
type PutMethodInput struct { // Specifies whether the method required a valid ApiKey. ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"` // A list of authorization scopes configured on the method. The scopes are used // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. // The authorization works by matching the method scopes against the scopes // parsed from the access token in the incoming request. The method invocation // is authorized if any method scopes matches a claimed scope in the access // token. Otherwise, the invocation is not authorized. When the method scope // is configured, the client must provide an access token instead of an identity // token for authorization purposes. AuthorizationScopes []string `locationName:"authorizationScopes" type:"list"` // [Required] The method's authorization type. Valid values are NONE for open // access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom // authorizer, or COGNITO_USER_POOLS for using a Cognito user pool. // // AuthorizationType is a required field AuthorizationType *string `locationName:"authorizationType" type:"string" required:"true"` // Specifies the identifier of an Authorizer to use on this Method, if the type // is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by // API Gateway when you created the authorizer. AuthorizerId *string `locationName:"authorizerId" type:"string"` // [Required] 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 the PetStore // 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 API Gateway. A key defines a method request parameter // name matching the pattern of method.request.{location}.{name}, where location // is querystring, path, or header and name is a valid and unique parameter // name. The value associated with the key is a Boolean flag indicating whether // the parameter is required (true) or optional (false). The method request // parameter names defined here are available in Integration to be mapped to // integration request parameters or body-mapping templates. RequestParameters map[string]bool `locationName:"requestParameters" type:"map"` // The identifier of a RequestValidator for validating the method request. RequestValidatorId *string `locationName:"requestValidatorId" type:"string"` // [Required] The Resource identifier for the new Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to add a method to an existing Resource resource.
func (PutMethodInput) MarshalFields ¶ added in v0.3.0
func (s PutMethodInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutMethodInput) String ¶
func (s PutMethodInput) String() string
String returns the string representation
func (*PutMethodInput) Validate ¶
func (s *PutMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutMethodOutput ¶ added in v0.9.0
type PutMethodOutput struct { // A boolean flag specifying whether a valid ApiKey is required to invoke this // method. ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"` // A list of authorization scopes configured on the method. The scopes are used // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. // The authorization works by matching the method scopes against the scopes // parsed from the access token in the incoming request. The method invocation // is authorized if any method scopes matches a claimed scope in the access // token. Otherwise, the invocation is not authorized. When the method scope // is configured, the client must provide an access token instead of an identity // token for authorization purposes. AuthorizationScopes []string `locationName:"authorizationScopes" type:"list"` // The method's authorization type. Valid values are NONE for open access, AWS_IAM // for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS // for using a Cognito user pool. AuthorizationType *string `locationName:"authorizationType" type:"string"` // The identifier of an Authorizer to use on this method. The authorizationType // must be CUSTOM. AuthorizerId *string `locationName:"authorizerId" type:"string"` // The method's HTTP verb. HttpMethod *string `locationName:"httpMethod" type:"string"` // Gets the method's integration responsible for passing the client-submitted // request to the back end and performing necessary transformations to make // the request compliant with the back end. // // Example: // // Request // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns a 200 OK status code and a payload similar // to the following: // { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", // "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true } ], "self": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": // { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" // }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", // "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" // }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", // "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", // "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": // "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": // "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", // \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", // "_embedded": { "integration:responses": { "_links": { "self": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", // "name": "200", "title": "200" }, "integrationresponse:delete": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" // }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" // } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", // "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": // "integration.response.body.a" }, "responseTemplates": { "application/json": // "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op // => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n // \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } // } } // // AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html) MethodIntegration *Integration `locationName:"methodIntegration" type:"structure"` // Gets a method response associated with a given HTTP status code. // // The collection of method responses are encapsulated in a key-value map, where // the key is a response's HTTP status code and the value is a MethodResponse // resource that specifies the response returned to the caller from the back // end through the integration response. // // Example: Get a 200 OK response of a GET method // // Request // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns a 200 OK status code and a payload similar // to the following: // { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", // "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", // "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" // }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" // } }, "responseModels": { "application/json": "Empty" }, "responseParameters": // { "method.response.header.operator": false, "method.response.header.operand_2": // false, "method.response.header.operand_1": false }, "statusCode": "200" // } // // AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) 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 the PetStore // 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 API Gateway. A key is a method request parameter name // matching the pattern of method.request.{location}.{name}, where location // is querystring, path, or header and name is a valid and unique parameter // name. The value associated with the key is a Boolean flag indicating whether // the parameter is required (true) or optional (false). The method request // parameter names defined here are available in Integration to be mapped to // integration request parameters or templates. RequestParameters map[string]bool `locationName:"requestParameters" type:"map"` // The identifier of a RequestValidator for request validation. RequestValidatorId *string `locationName:"requestValidatorId" type:"string"` // contains filtered or unexported fields }
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
Example: Retrive the GET method on a specified resource
Request ¶
The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri).
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://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() (https://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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html)
func (PutMethodOutput) MarshalFields ¶ added in v0.9.0
func (s PutMethodOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutMethodOutput) String ¶ added in v0.9.0
func (s PutMethodOutput) String() string
String returns the string representation
type PutMethodRequest ¶
type PutMethodRequest struct { *aws.Request Input *PutMethodInput Copy func(*PutMethodInput) PutMethodRequest }
PutMethodRequest is the request type for the PutMethod API operation.
func (PutMethodRequest) Send ¶
func (r PutMethodRequest) Send(ctx context.Context) (*PutMethodResponse, error)
Send marshals and sends the PutMethod API request.
type PutMethodResponse ¶ added in v0.9.0
type PutMethodResponse struct { *PutMethodOutput // contains filtered or unexported fields }
PutMethodResponse is the response type for the PutMethod API operation.
func (*PutMethodResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutMethodResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutMethod request.
type PutMethodResponseInput ¶
type PutMethodResponseInput struct { // [Required] The HTTP verb of the Method resource. // // HttpMethod is a required field HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` // [Required] 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 // 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The 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) MarshalFields ¶ added in v0.3.0
func (s PutMethodResponseInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutMethodResponseInput) String ¶
func (s PutMethodResponseInput) String() string
String returns the string representation
func (*PutMethodResponseInput) Validate ¶
func (s *PutMethodResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutMethodResponseOutput ¶ added in v0.9.0
type PutMethodResponseOutput 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 // 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. 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": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" }
Method, IntegrationResponse, Integration Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (PutMethodResponseOutput) MarshalFields ¶ added in v0.9.0
func (s PutMethodResponseOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutMethodResponseOutput) String ¶ added in v0.9.0
func (s PutMethodResponseOutput) String() string
String returns the string representation
type PutMethodResponseRequest ¶
type PutMethodResponseRequest struct { *aws.Request Input *PutMethodResponseInput Copy func(*PutMethodResponseInput) PutMethodResponseRequest }
PutMethodResponseRequest is the request type for the PutMethodResponse API operation.
func (PutMethodResponseRequest) Send ¶
func (r PutMethodResponseRequest) Send(ctx context.Context) (*PutMethodResponseResponse, error)
Send marshals and sends the PutMethodResponse API request.
type PutMethodResponseResponse ¶ added in v0.9.0
type PutMethodResponseResponse struct { *PutMethodResponseOutput // contains filtered or unexported fields }
PutMethodResponseResponse is the response type for the PutMethodResponse API operation.
func (*PutMethodResponseResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutMethodResponseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutMethodResponse request.
type PutMode ¶
type PutMode string
Enum values for PutMode
func (PutMode) MarshalValue ¶ added in v0.3.0
type PutRestApiInput ¶
type PutRestApiInput struct { // [Required] The PUT request body containing external API definitions. Currently, // only OpenAPI definition JSON/YAML files are supported. The maximum size of // the API definition file is 6MB. // // Body is a required field Body []byte `locationName:"body" type:"blob" required:"true"` // A query parameter to indicate whether to rollback the API update (true) or // not (false) when a warning is encountered. The default value is false. FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` // The mode query parameter to specify the update mode. Valid values are "merge" // and "overwrite". By default, the update mode is "merge". Mode PutMode `location:"querystring" locationName:"mode" type:"string" enum:"true"` // Custom header parameters as part of the request. For example, to exclude // DocumentationParts from an imported API, set ignore=documentation as a parameters // value, as in the AWS CLI command of aws apigateway import-rest-api --parameters // ignore=documentation --body 'file:///path/to/imported-api-body.json'. Parameters map[string]string `location:"querystring" locationName:"parameters" type:"map"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
A PUT request to update an existing API, with external API definitions specified as the request body.
func (PutRestApiInput) MarshalFields ¶ added in v0.3.0
func (s PutRestApiInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutRestApiInput) String ¶
func (s PutRestApiInput) String() string
String returns the string representation
func (*PutRestApiInput) Validate ¶
func (s *PutRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutRestApiOutput ¶ added in v0.9.0
type PutRestApiOutput struct { // The source of the API key for metering requests according to a usage plan. // Valid values are: // * HEADER to read the API key from the X-API-Key header of a request. // // * AUTHORIZER to read the API key from the UsageIdentifierKey from a custom // authorizer. ApiKeySource ApiKeySourceType `locationName:"apiKeySource" type:"string" enum:"true"` // The list of binary media types supported by the RestApi. By default, the // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string `locationName:"binaryMediaTypes" type:"list"` // The timestamp when the API was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The API's description. Description *string `locationName:"description" type:"string"` // The endpoint configuration of this RestApi showing the endpoint types of // the API. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The API's identifier. This identifier is unique across all of your APIs in // API Gateway. Id *string `locationName:"id" type:"string"` // A nullable integer that is used to enable compression (with non-negative // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with // a null value) on an API. When compression is enabled, compression or decompression // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int64 `locationName:"minimumCompressionSize" type:"integer"` // The API's name. Name *string `locationName:"name" type:"string"` // A stringified JSON policy document that applies to this RestApi regardless // of the caller and Method configuration. Policy *string `locationName:"policy" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (PutRestApiOutput) MarshalFields ¶ added in v0.9.0
func (s PutRestApiOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutRestApiOutput) String ¶ added in v0.9.0
func (s PutRestApiOutput) String() string
String returns the string representation
type PutRestApiRequest ¶
type PutRestApiRequest struct { *aws.Request Input *PutRestApiInput Copy func(*PutRestApiInput) PutRestApiRequest }
PutRestApiRequest is the request type for the PutRestApi API operation.
func (PutRestApiRequest) Send ¶
func (r PutRestApiRequest) Send(ctx context.Context) (*PutRestApiResponse, error)
Send marshals and sends the PutRestApi API request.
type PutRestApiResponse ¶ added in v0.9.0
type PutRestApiResponse struct { *PutRestApiOutput // contains filtered or unexported fields }
PutRestApiResponse is the response type for the PutRestApi API operation.
func (*PutRestApiResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutRestApiResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutRestApi request.
type QuotaPeriodType ¶
type QuotaPeriodType string
const ( QuotaPeriodTypeDay QuotaPeriodType = "DAY" QuotaPeriodTypeWeek QuotaPeriodType = "WEEK" QuotaPeriodTypeMonth QuotaPeriodType = "MONTH" )
Enum values for QuotaPeriodType
func (QuotaPeriodType) MarshalValue ¶ added in v0.3.0
func (enum QuotaPeriodType) MarshalValue() (string, error)
func (QuotaPeriodType) MarshalValueBuf ¶ added in v0.3.0
func (enum QuotaPeriodType) MarshalValueBuf(b []byte) ([]byte, error)
type QuotaSettings ¶
type QuotaSettings struct { // The maximum number of requests that can be made in a given time period. Limit *int64 `locationName:"limit" type:"integer"` // The number of requests subtracted from the given limit in the initial time // period. Offset *int64 `locationName:"offset" type:"integer"` // The time period in which the limit applies. Valid values are "DAY", "WEEK" // or "MONTH". Period QuotaPeriodType `locationName:"period" type:"string" enum:"true"` // contains filtered or unexported fields }
Quotas configured for a usage plan.
func (QuotaSettings) MarshalFields ¶ added in v0.3.0
func (s QuotaSettings) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (QuotaSettings) String ¶
func (s QuotaSettings) String() string
String returns the string representation
type RequestValidator ¶ added in v0.9.0
type RequestValidator struct { // The identifier of this RequestValidator. Id *string `locationName:"id" type:"string"` // The name of this RequestValidator Name *string `locationName:"name" type:"string"` // A Boolean flag to indicate whether to validate a request body according to // the configured Model schema. ValidateRequestBody *bool `locationName:"validateRequestBody" type:"boolean"` // A Boolean flag to indicate whether to validate request parameters (true) // or not (false). ValidateRequestParameters *bool `locationName:"validateRequestParameters" type:"boolean"` // contains filtered or unexported fields }
A set of validation rules for incoming Method requests.
In OpenAPI, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html) object. It the referenced using the x-amazon-apigateway-request-validator (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator) property.
Enable Basic Request Validation in API Gateway (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html)
func (RequestValidator) MarshalFields ¶ added in v0.9.0
func (s RequestValidator) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (RequestValidator) String ¶ added in v0.9.0
func (s RequestValidator) String() string
String returns the string representation
type Resource ¶ added in v0.9.0
type Resource struct { // The resource's identifier. Id *string `locationName:"id" type:"string"` // The parent resource's identifier. ParentId *string `locationName:"parentId" type:"string"` // The full path for this resource. Path *string `locationName:"path" type:"string"` // The last path segment for this resource. PathPart *string `locationName:"pathPart" type:"string"` // Gets an API resource's method of a given HTTP verb. // // The resource methods are a map of methods indexed by methods' HTTP verbs // enabled on the resource. This method map is included in the 200 OK response // of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods // request. // // Example: Get the GET method of an API resource // // Request // GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: // application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z // Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", // "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", // "name": "method", "templated": true }, { "href": "https://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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (Resource) MarshalFields ¶ added in v0.9.0
func (s Resource) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type RestApi ¶ added in v0.9.0
type RestApi struct { // The source of the API key for metering requests according to a usage plan. // Valid values are: // * HEADER to read the API key from the X-API-Key header of a request. // // * AUTHORIZER to read the API key from the UsageIdentifierKey from a custom // authorizer. ApiKeySource ApiKeySourceType `locationName:"apiKeySource" type:"string" enum:"true"` // The list of binary media types supported by the RestApi. By default, the // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string `locationName:"binaryMediaTypes" type:"list"` // The timestamp when the API was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The API's description. Description *string `locationName:"description" type:"string"` // The endpoint configuration of this RestApi showing the endpoint types of // the API. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The API's identifier. This identifier is unique across all of your APIs in // API Gateway. Id *string `locationName:"id" type:"string"` // A nullable integer that is used to enable compression (with non-negative // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with // a null value) on an API. When compression is enabled, compression or decompression // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int64 `locationName:"minimumCompressionSize" type:"integer"` // The API's name. Name *string `locationName:"name" type:"string"` // A stringified JSON policy document that applies to this RestApi regardless // of the caller and Method configuration. Policy *string `locationName:"policy" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (RestApi) MarshalFields ¶ added in v0.9.0
func (s RestApi) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type SdkConfigurationProperty ¶
type SdkConfigurationProperty struct { // The default value of an SdkType configuration property. DefaultValue *string `locationName:"defaultValue" type:"string"` // The description of an SdkType configuration property. Description *string `locationName:"description" type:"string"` // The user-friendly name of an SdkType configuration property. FriendlyName *string `locationName:"friendlyName" type:"string"` // The name of a an SdkType configuration property. Name *string `locationName:"name" type:"string"` // A boolean flag of an SdkType configuration property to indicate if the associated // SDK configuration property is required (true) or not (false). Required *bool `locationName:"required" type:"boolean"` // contains filtered or unexported fields }
A configuration property of an SDK type.
func (SdkConfigurationProperty) MarshalFields ¶ added in v0.3.0
func (s SdkConfigurationProperty) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SdkConfigurationProperty) String ¶
func (s SdkConfigurationProperty) String() string
String returns the string representation
type SdkType ¶ added in v0.9.0
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) MarshalFields ¶ added in v0.9.0
func (s SdkType) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type SecurityPolicy ¶ added in v0.10.0
type SecurityPolicy string
const ( SecurityPolicyTls10 SecurityPolicy = "TLS_1_0" SecurityPolicyTls12 SecurityPolicy = "TLS_1_2" )
Enum values for SecurityPolicy
func (SecurityPolicy) MarshalValue ¶ added in v0.10.0
func (enum SecurityPolicy) MarshalValue() (string, error)
func (SecurityPolicy) MarshalValueBuf ¶ added in v0.10.0
func (enum SecurityPolicy) MarshalValueBuf(b []byte) ([]byte, error)
type Stage ¶ added in v0.9.0
type Stage struct { // Settings for logging access in this stage. AccessLogSettings *AccessLogSettings `locationName:"accessLogSettings" type:"structure"` // Specifies whether a cache cluster is enabled for the stage. CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` // The size of the cache cluster for the stage, if enabled. CacheClusterSize CacheClusterSize `locationName:"cacheClusterSize" type:"string" enum:"true"` // The status of the cache cluster for the stage, if enabled. CacheClusterStatus CacheClusterStatus `locationName:"cacheClusterStatus" type:"string" enum:"true"` // Settings for the canary deployment in this stage. CanarySettings *CanarySettings `locationName:"canarySettings" type:"structure"` // The identifier of a client certificate for an API stage. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // The timestamp when the stage was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The identifier of the Deployment that the stage points to. DeploymentId *string `locationName:"deploymentId" type:"string"` // The stage's description. Description *string `locationName:"description" type:"string"` // The version of the associated API documentation. DocumentationVersion *string `locationName:"documentationVersion" type:"string"` // The timestamp when the stage last updated. LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp"` // 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 API Gateway. Stage names can only contain alphanumeric // characters, hyphens, and underscores. Maximum length is 128 characters. StageName *string `locationName:"stageName" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // Specifies whether active tracing with X-ray is enabled for the Stage. TracingEnabled *bool `locationName:"tracingEnabled" type:"boolean"` // 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"` // The ARN of the WebAcl associated with the Stage. WebAclArn *string `locationName:"webAclArn" type:"string"` // contains filtered or unexported fields }
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Deploy an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html)
func (Stage) MarshalFields ¶ added in v0.9.0
func (s Stage) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type StageKey ¶
type StageKey struct { // The string identifier of the associated RestApi. RestApiId *string `locationName:"restApiId" type:"string"` // The stage name associated with the stage key. StageName *string `locationName:"stageName" type:"string"` // contains filtered or unexported fields }
A reference to a unique stage identified in the format {restApiId}/{stage}.
func (StageKey) MarshalFields ¶ added in v0.3.0
func (s StageKey) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type TagResourceInput ¶ added in v0.2.0
type TagResourceInput struct { // [Required] The ARN of a resource that can be tagged. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resource_arn" type:"string" required:"true"` // [Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. // The tag key can be up to 128 characters and must not start with aws:. The // tag value can be up to 256 characters. // // Tags is a required field Tags map[string]string `locationName:"tags" type:"map" required:"true"` // contains filtered or unexported fields }
Adds or updates a tag on a given resource.
func (TagResourceInput) MarshalFields ¶ added in v0.3.0
func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TagResourceInput) String ¶ added in v0.2.0
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶ added in v0.2.0
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶ added in v0.2.0
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) MarshalFields ¶ added in v0.3.0
func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TagResourceOutput) String ¶ added in v0.2.0
func (s TagResourceOutput) String() string
String returns the string representation
type TagResourceRequest ¶ added in v0.2.0
type TagResourceRequest struct { *aws.Request Input *TagResourceInput Copy func(*TagResourceInput) TagResourceRequest }
TagResourceRequest is the request type for the TagResource API operation.
func (TagResourceRequest) Send ¶ added in v0.2.0
func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)
Send marshals and sends the TagResource API request.
type TagResourceResponse ¶ added in v0.9.0
type TagResourceResponse struct { *TagResourceOutput // contains filtered or unexported fields }
TagResourceResponse is the response type for the TagResource API operation.
func (*TagResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TagResource request.
type TestInvokeAuthorizerInput ¶
type TestInvokeAuthorizerInput struct { // [Optional] A key-value map of additional context variables. AdditionalContext map[string]string `locationName:"additionalContext" type:"map"` // [Required] 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 headers as a map from string to list of values to simulate // an incoming invocation request. This is where the incoming authorization // token, or identity source, may be specified. MultiValueHeaders map[string][]string `locationName:"multiValueHeaders" 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // A key-value map of stage variables to simulate an invocation on a deployed // Stage. StageVariables map[string]string `locationName:"stageVariables" type:"map"` // contains filtered or unexported fields }
Make a request to simulate the execution of an Authorizer.
func (TestInvokeAuthorizerInput) MarshalFields ¶ added in v0.3.0
func (s TestInvokeAuthorizerInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TestInvokeAuthorizerInput) String ¶
func (s TestInvokeAuthorizerInput) String() string
String returns the string representation
func (*TestInvokeAuthorizerInput) Validate ¶
func (s *TestInvokeAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TestInvokeAuthorizerOutput ¶
type TestInvokeAuthorizerOutput struct { Authorization map[string][]string `locationName:"authorization" type:"map"` // The open identity claims (https://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 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) MarshalFields ¶ added in v0.3.0
func (s TestInvokeAuthorizerOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TestInvokeAuthorizerOutput) String ¶
func (s TestInvokeAuthorizerOutput) String() string
String returns the string representation
type TestInvokeAuthorizerRequest ¶
type TestInvokeAuthorizerRequest struct { *aws.Request Input *TestInvokeAuthorizerInput Copy func(*TestInvokeAuthorizerInput) TestInvokeAuthorizerRequest }
TestInvokeAuthorizerRequest is the request type for the TestInvokeAuthorizer API operation.
func (TestInvokeAuthorizerRequest) Send ¶
func (r TestInvokeAuthorizerRequest) Send(ctx context.Context) (*TestInvokeAuthorizerResponse, error)
Send marshals and sends the TestInvokeAuthorizer API request.
type TestInvokeAuthorizerResponse ¶ added in v0.9.0
type TestInvokeAuthorizerResponse struct { *TestInvokeAuthorizerOutput // contains filtered or unexported fields }
TestInvokeAuthorizerResponse is the response type for the TestInvokeAuthorizer API operation.
func (*TestInvokeAuthorizerResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *TestInvokeAuthorizerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TestInvokeAuthorizer request.
type TestInvokeMethodInput ¶
type TestInvokeMethodInput struct { // The simulated request body of an incoming invocation request. Body *string `locationName:"body" type:"string"` // A ClientCertificate identifier to use in the test invocation. API Gateway // will use the certificate when making the HTTPS request to the defined back-end // endpoint. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // A key-value map of headers to simulate an incoming invocation request. Headers map[string]string `locationName:"headers" type:"map"` // [Required] 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 headers as a map from string to list of values to simulate an incoming // invocation request. MultiValueHeaders map[string][]string `locationName:"multiValueHeaders" type:"map"` // 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"` // [Required] 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // A key-value map of stage variables to simulate an invocation on a deployed // Stage. StageVariables map[string]string `locationName:"stageVariables" type:"map"` // contains filtered or unexported fields }
Make a request to simulate the execution of a Method.
func (TestInvokeMethodInput) MarshalFields ¶ added in v0.3.0
func (s TestInvokeMethodInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TestInvokeMethodInput) String ¶
func (s TestInvokeMethodInput) String() string
String returns the string representation
func (*TestInvokeMethodInput) Validate ¶
func (s *TestInvokeMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TestInvokeMethodOutput ¶
type TestInvokeMethodOutput struct { // The body of the HTTP response. Body *string `locationName:"body" type:"string"` // The headers of the HTTP response. Headers map[string]string `locationName:"headers" type:"map"` // The execution latency of the test invoke request. Latency *int64 `locationName:"latency" type:"long"` // The API Gateway execution log for the test invoke request. Log *string `locationName:"log" type:"string"` // The headers of the HTTP response as a map from string to list of values. MultiValueHeaders map[string][]string `locationName:"multiValueHeaders" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-test-method.html#how-to-test-method-console)
func (TestInvokeMethodOutput) MarshalFields ¶ added in v0.3.0
func (s TestInvokeMethodOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TestInvokeMethodOutput) String ¶
func (s TestInvokeMethodOutput) String() string
String returns the string representation
type TestInvokeMethodRequest ¶
type TestInvokeMethodRequest struct { *aws.Request Input *TestInvokeMethodInput Copy func(*TestInvokeMethodInput) TestInvokeMethodRequest }
TestInvokeMethodRequest is the request type for the TestInvokeMethod API operation.
func (TestInvokeMethodRequest) Send ¶
func (r TestInvokeMethodRequest) Send(ctx context.Context) (*TestInvokeMethodResponse, error)
Send marshals and sends the TestInvokeMethod API request.
type TestInvokeMethodResponse ¶ added in v0.9.0
type TestInvokeMethodResponse struct { *TestInvokeMethodOutput // contains filtered or unexported fields }
TestInvokeMethodResponse is the response type for the TestInvokeMethod API operation.
func (*TestInvokeMethodResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *TestInvokeMethodResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TestInvokeMethod request.
type ThrottleSettings ¶
type ThrottleSettings struct { // The API request burst limit, the maximum rate limit over a time ranging from // one to a few seconds, depending upon whether the underlying token bucket // is at its full capacity. BurstLimit *int64 `locationName:"burstLimit" type:"integer"` // The API request steady-state rate limit. RateLimit *float64 `locationName:"rateLimit" type:"double"` // contains filtered or unexported fields }
The API request rate limits.
func (ThrottleSettings) MarshalFields ¶ added in v0.3.0
func (s ThrottleSettings) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ThrottleSettings) String ¶
func (s ThrottleSettings) String() string
String returns the string representation
type TlsConfig ¶ added in v0.24.0
type TlsConfig struct { // Specifies whether or not API Gateway skips verification that the certificate // for an integration endpoint is issued by a supported certificate authority // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-supported-certificate-authorities-for-http-endpoints.html). // This isn’t recommended, but it enables you to use certificates that are // signed by private certificate authorities, or certificates that are self-signed. // If enabled, API Gateway still performs basic certificate validation, which // includes checking the certificate's expiration date, hostname, and presence // of a root certificate authority. Supported only for HTTP and HTTP_PROXY integrations. InsecureSkipVerification *bool `locationName:"insecureSkipVerification" type:"boolean"` // contains filtered or unexported fields }
func (TlsConfig) MarshalFields ¶ added in v0.24.0
func (s TlsConfig) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type UnauthorizedCacheControlHeaderStrategy ¶
type UnauthorizedCacheControlHeaderStrategy string
const ()
Enum values for UnauthorizedCacheControlHeaderStrategy
func (UnauthorizedCacheControlHeaderStrategy) MarshalValue ¶ added in v0.3.0
func (enum UnauthorizedCacheControlHeaderStrategy) MarshalValue() (string, error)
func (UnauthorizedCacheControlHeaderStrategy) MarshalValueBuf ¶ added in v0.3.0
func (enum UnauthorizedCacheControlHeaderStrategy) MarshalValueBuf(b []byte) ([]byte, error)
type UntagResourceInput ¶ added in v0.2.0
type UntagResourceInput struct { // [Required] The ARN of a resource that can be tagged. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resource_arn" type:"string" required:"true"` // [Required] The Tag keys to delete. // // TagKeys is a required field TagKeys []string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` // contains filtered or unexported fields }
Removes a tag from a given resource.
func (UntagResourceInput) MarshalFields ¶ added in v0.3.0
func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UntagResourceInput) String ¶ added in v0.2.0
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶ added in v0.2.0
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶ added in v0.2.0
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) MarshalFields ¶ added in v0.3.0
func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UntagResourceOutput) String ¶ added in v0.2.0
func (s UntagResourceOutput) String() string
String returns the string representation
type UntagResourceRequest ¶ added in v0.2.0
type UntagResourceRequest struct { *aws.Request Input *UntagResourceInput Copy func(*UntagResourceInput) UntagResourceRequest }
UntagResourceRequest is the request type for the UntagResource API operation.
func (UntagResourceRequest) Send ¶ added in v0.2.0
func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)
Send marshals and sends the UntagResource API request.
type UntagResourceResponse ¶ added in v0.9.0
type UntagResourceResponse struct { *UntagResourceOutput // contains filtered or unexported fields }
UntagResourceResponse is the response type for the UntagResource API operation.
func (*UntagResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UntagResource request.
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 API Gateway to change information about the current Account resource.
func (UpdateAccountInput) MarshalFields ¶ added in v0.3.0
func (s UpdateAccountInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateAccountInput) String ¶
func (s UpdateAccountInput) String() string
String returns the string representation
type UpdateAccountOutput ¶
type UpdateAccountOutput struct { // The version of the API keys used for the account. ApiKeyVersion *string `locationName:"apiKeyVersion" type:"string"` // The ARN of an Amazon CloudWatch role for the current Account. CloudwatchRoleArn *string `locationName:"cloudwatchRoleArn" type:"string"` // A list of features supported for the account. When usage plans are enabled, // the features list will include an entry of "UsagePlans". Features []string `locationName:"features" type:"list"` // Specifies the API request limits configured for the current Account. ThrottleSettings *ThrottleSettings `locationName:"throttleSettings" type:"structure"` // contains filtered or unexported fields }
Represents an AWS account that is associated with 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 (https://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": "https://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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-limits.html) Developer Guide (https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html), AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html)
func (UpdateAccountOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateAccountOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateAccountOutput) String ¶
func (s UpdateAccountOutput) String() string
String returns the string representation
type UpdateAccountRequest ¶
type UpdateAccountRequest struct { *aws.Request Input *UpdateAccountInput Copy func(*UpdateAccountInput) UpdateAccountRequest }
UpdateAccountRequest is the request type for the UpdateAccount API operation.
func (UpdateAccountRequest) Send ¶
func (r UpdateAccountRequest) Send(ctx context.Context) (*UpdateAccountResponse, error)
Send marshals and sends the UpdateAccount API request.
type UpdateAccountResponse ¶ added in v0.9.0
type UpdateAccountResponse struct { *UpdateAccountOutput // contains filtered or unexported fields }
UpdateAccountResponse is the response type for the UpdateAccount API operation.
func (*UpdateAccountResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateAccountResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateAccount request.
type UpdateApiKeyInput ¶
type UpdateApiKeyInput struct { // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s UpdateApiKeyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateApiKeyInput) String ¶
func (s UpdateApiKeyInput) String() string
String returns the string representation
func (*UpdateApiKeyInput) Validate ¶
func (s *UpdateApiKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateApiKeyOutput ¶
type UpdateApiKeyOutput struct { // The timestamp when the API Key was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // An AWS Marketplace customer identifier , when integrating with the AWS SaaS // Marketplace. CustomerId *string `locationName:"customerId" type:"string"` // The description of the API Key. Description *string `locationName:"description" type:"string"` // Specifies whether the API Key can be used by callers. Enabled *bool `locationName:"enabled" type:"boolean"` // The identifier of the API Key. Id *string `locationName:"id" type:"string"` // The timestamp when the API Key was last updated. LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp"` // 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 collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html)
func (UpdateApiKeyOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateApiKeyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateApiKeyOutput) String ¶
func (s UpdateApiKeyOutput) String() string
String returns the string representation
type UpdateApiKeyRequest ¶
type UpdateApiKeyRequest struct { *aws.Request Input *UpdateApiKeyInput Copy func(*UpdateApiKeyInput) UpdateApiKeyRequest }
UpdateApiKeyRequest is the request type for the UpdateApiKey API operation.
func (UpdateApiKeyRequest) Send ¶
func (r UpdateApiKeyRequest) Send(ctx context.Context) (*UpdateApiKeyResponse, error)
Send marshals and sends the UpdateApiKey API request.
type UpdateApiKeyResponse ¶ added in v0.9.0
type UpdateApiKeyResponse struct { *UpdateApiKeyOutput // contains filtered or unexported fields }
UpdateApiKeyResponse is the response type for the UpdateApiKey API operation.
func (*UpdateApiKeyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateApiKeyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateApiKey request.
type UpdateAuthorizerInput ¶
type UpdateAuthorizerInput struct { // [Required] 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to update an existing Authorizer resource.
func (UpdateAuthorizerInput) MarshalFields ¶ added in v0.3.0
func (s UpdateAuthorizerInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateAuthorizerInput) String ¶
func (s UpdateAuthorizerInput) String() string
String returns the string representation
func (*UpdateAuthorizerInput) Validate ¶
func (s *UpdateAuthorizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateAuthorizerOutput ¶
type UpdateAuthorizerOutput struct { // Optional customer-defined field, used in OpenAPI imports and exports without // functional impact. AuthType *string `locationName:"authType" type:"string"` // Specifies the required credentials as an IAM role for API Gateway to invoke // the authorizer. To specify an IAM role for API Gateway to assume, use the // role's Amazon Resource Name (ARN). To use resource-based permissions on the // Lambda function, specify null. AuthorizerCredentials *string `locationName:"authorizerCredentials" type:"string"` // The TTL in seconds of cached authorizer results. If it equals 0, authorization // caching is disabled. If it is greater than 0, API Gateway will cache authorizer // responses. If this field is not set, the default value is 300. The maximum // value is 3600, or 1 hour. AuthorizerResultTtlInSeconds *int64 `locationName:"authorizerResultTtlInSeconds" type:"integer"` // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or // REQUEST authorizers, this must be a well-formed Lambda function URI, for // example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, // where {region} is the same as the region hosting the Lambda function, path // indicates that the remaining substring in the URI should be treated as the // path to the resource, including the initial /. For Lambda functions, this // is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. AuthorizerUri *string `locationName:"authorizerUri" type:"string"` // The identifier for the authorizer resource. Id *string `locationName:"id" type:"string"` // The identity source for which authorization is requested. // * For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies // the request header mapping expression for the custom header holding the // authorization token submitted by the client. For example, if the token // header name is Auth, the header mapping expression is method.request.header.Auth. // // * For the REQUEST authorizer, this is required when authorization caching // is enabled. The value is a comma-separated string of one or more mapping // expressions of the specified request parameters. For example, if an Auth // header, a Name query string parameter are defined as identity sources, // this value is method.request.header.Auth, method.request.querystring.Name. // These parameters will be used to derive the authorization caching key // and to perform runtime validation of the REQUEST authorizer by verifying // all of the identity-related request parameters are present, not null and // non-empty. Only when this is true does the authorizer invoke the authorizer // Lambda function, otherwise, it returns a 401 Unauthorized response without // calling the Lambda function. The valid value is a string of comma-separated // mapping expressions of the specified request parameters. When the authorization // caching is not enabled, this property is optional. IdentitySource *string `locationName:"identitySource" type:"string"` // A validation expression for the incoming identity token. For TOKEN authorizers, // this value is a regular expression. For COGNITO_USER_POOLS authorizers, API // Gateway will match the aud field of the incoming token from the client against // the specified regular expression. It will invoke the authorizer's Lambda // function when there is a match. Otherwise, it will return a 401 Unauthorized // response without calling the Lambda function. The validation expression does // not apply to the REQUEST authorizer. IdentityValidationExpression *string `locationName:"identityValidationExpression" type:"string"` // [Required] The name of the authorizer. Name *string `locationName:"name" type:"string"` // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. // Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. // For a TOKEN or REQUEST authorizer, this is not defined. ProviderARNs []string `locationName:"providerARNs" type:"list"` // The authorizer type. Valid values are TOKEN for a Lambda function using a // single authorization token submitted in a custom header, REQUEST for a Lambda // function using incoming request parameters, and COGNITO_USER_POOLS for using // an Amazon Cognito user pool. Type AuthorizerType `locationName:"type" type:"string" enum:"true"` // contains filtered or unexported fields }
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
Use Lambda Function as Authorizer (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html) Use Cognito User Pool as Authorizer (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html)
func (UpdateAuthorizerOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateAuthorizerOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateAuthorizerOutput) String ¶
func (s UpdateAuthorizerOutput) String() string
String returns the string representation
type UpdateAuthorizerRequest ¶
type UpdateAuthorizerRequest struct { *aws.Request Input *UpdateAuthorizerInput Copy func(*UpdateAuthorizerInput) UpdateAuthorizerRequest }
UpdateAuthorizerRequest is the request type for the UpdateAuthorizer API operation.
func (UpdateAuthorizerRequest) Send ¶
func (r UpdateAuthorizerRequest) Send(ctx context.Context) (*UpdateAuthorizerResponse, error)
Send marshals and sends the UpdateAuthorizer API request.
type UpdateAuthorizerResponse ¶ added in v0.9.0
type UpdateAuthorizerResponse struct { *UpdateAuthorizerOutput // contains filtered or unexported fields }
UpdateAuthorizerResponse is the response type for the UpdateAuthorizer API operation.
func (*UpdateAuthorizerResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateAuthorizerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateAuthorizer request.
type UpdateBasePathMappingInput ¶
type UpdateBasePathMappingInput struct { // [Required] The base path of the BasePathMapping resource to change. // // To specify an empty base path, set this parameter to '(none)'. // // BasePath is a required field BasePath *string `location:"uri" locationName:"base_path" type:"string" required:"true"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s UpdateBasePathMappingInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateBasePathMappingInput) String ¶
func (s UpdateBasePathMappingInput) String() string
String returns the string representation
func (*UpdateBasePathMappingInput) Validate ¶
func (s *UpdateBasePathMappingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateBasePathMappingOutput ¶
type UpdateBasePathMappingOutput struct { // The base path name that callers of the API must provide as part of the URL // after the domain name. BasePath *string `locationName:"basePath" type:"string"` // The string identifier of the associated RestApi. RestApiId *string `locationName:"restApiId" type:"string"` // The name of the associated stage. Stage *string `locationName:"stage" type:"string"` // contains filtered or unexported fields }
Represents the base path that callers of the API must provide as part of the URL after the domain name.
A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.
Use Custom Domain Names (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (UpdateBasePathMappingOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateBasePathMappingOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateBasePathMappingOutput) String ¶
func (s UpdateBasePathMappingOutput) String() string
String returns the string representation
type UpdateBasePathMappingRequest ¶
type UpdateBasePathMappingRequest struct { *aws.Request Input *UpdateBasePathMappingInput Copy func(*UpdateBasePathMappingInput) UpdateBasePathMappingRequest }
UpdateBasePathMappingRequest is the request type for the UpdateBasePathMapping API operation.
func (UpdateBasePathMappingRequest) Send ¶
func (r UpdateBasePathMappingRequest) Send(ctx context.Context) (*UpdateBasePathMappingResponse, error)
Send marshals and sends the UpdateBasePathMapping API request.
type UpdateBasePathMappingResponse ¶ added in v0.9.0
type UpdateBasePathMappingResponse struct { *UpdateBasePathMappingOutput // contains filtered or unexported fields }
UpdateBasePathMappingResponse is the response type for the UpdateBasePathMapping API operation.
func (*UpdateBasePathMappingResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateBasePathMappingResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateBasePathMapping request.
type UpdateClientCertificateInput ¶
type UpdateClientCertificateInput struct { // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s UpdateClientCertificateInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateClientCertificateInput) String ¶
func (s UpdateClientCertificateInput) String() string
String returns the string representation
func (*UpdateClientCertificateInput) Validate ¶
func (s *UpdateClientCertificateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateClientCertificateOutput ¶
type UpdateClientCertificateOutput struct { // The identifier of the client certificate. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // The timestamp when the client certificate was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The description of the client certificate. Description *string `locationName:"description" type:"string"` // The timestamp when the client certificate will expire. ExpirationDate *time.Time `locationName:"expirationDate" type:"timestamp"` // 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"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.
Use Client-Side Certificate (https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)
func (UpdateClientCertificateOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateClientCertificateOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateClientCertificateOutput) String ¶
func (s UpdateClientCertificateOutput) String() string
String returns the string representation
type UpdateClientCertificateRequest ¶
type UpdateClientCertificateRequest struct { *aws.Request Input *UpdateClientCertificateInput Copy func(*UpdateClientCertificateInput) UpdateClientCertificateRequest }
UpdateClientCertificateRequest is the request type for the UpdateClientCertificate API operation.
func (UpdateClientCertificateRequest) Send ¶
func (r UpdateClientCertificateRequest) Send(ctx context.Context) (*UpdateClientCertificateResponse, error)
Send marshals and sends the UpdateClientCertificate API request.
type UpdateClientCertificateResponse ¶ added in v0.9.0
type UpdateClientCertificateResponse struct { *UpdateClientCertificateOutput // contains filtered or unexported fields }
UpdateClientCertificateResponse is the response type for the UpdateClientCertificate API operation.
func (*UpdateClientCertificateResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateClientCertificateResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateClientCertificate request.
type UpdateDeploymentInput ¶
type UpdateDeploymentInput struct { // The replacement identifier for the Deployment resource to change information // about. // // DeploymentId is a required field DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Requests API Gateway to change information about a Deployment resource.
func (UpdateDeploymentInput) MarshalFields ¶ added in v0.3.0
func (s UpdateDeploymentInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateDeploymentInput) String ¶
func (s UpdateDeploymentInput) String() string
String returns the string representation
func (*UpdateDeploymentInput) Validate ¶
func (s *UpdateDeploymentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDeploymentOutput ¶
type UpdateDeploymentOutput struct { // A summary of the RestApi at the date and time that the deployment resource // was created. ApiSummary map[string]map[string]MethodSnapshot `locationName:"apiSummary" type:"map"` // The date and time that the deployment resource was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // 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 (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html), AWS SDKs (https://aws.amazon.com/tools/)
func (UpdateDeploymentOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateDeploymentOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateDeploymentOutput) String ¶
func (s UpdateDeploymentOutput) String() string
String returns the string representation
type UpdateDeploymentRequest ¶
type UpdateDeploymentRequest struct { *aws.Request Input *UpdateDeploymentInput Copy func(*UpdateDeploymentInput) UpdateDeploymentRequest }
UpdateDeploymentRequest is the request type for the UpdateDeployment API operation.
func (UpdateDeploymentRequest) Send ¶
func (r UpdateDeploymentRequest) Send(ctx context.Context) (*UpdateDeploymentResponse, error)
Send marshals and sends the UpdateDeployment API request.
type UpdateDeploymentResponse ¶ added in v0.9.0
type UpdateDeploymentResponse struct { *UpdateDeploymentOutput // contains filtered or unexported fields }
UpdateDeploymentResponse is the response type for the UpdateDeployment API operation.
func (*UpdateDeploymentResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateDeploymentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateDeployment request.
type UpdateDocumentationPartInput ¶
type UpdateDocumentationPartInput struct { // [Required] The identifier of the to-be-updated documentation part. // // DocumentationPartId is a required field DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Updates an existing documentation part of a given API.
func (UpdateDocumentationPartInput) MarshalFields ¶ added in v0.3.0
func (s UpdateDocumentationPartInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateDocumentationPartInput) String ¶
func (s UpdateDocumentationPartInput) String() string
String returns the string representation
func (*UpdateDocumentationPartInput) Validate ¶
func (s *UpdateDocumentationPartInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDocumentationPartOutput ¶
type UpdateDocumentationPartOutput struct { // The DocumentationPart identifier, generated by 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 OpenAPI-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 OpenAPI 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 OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.
Documenting an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationParts
func (UpdateDocumentationPartOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateDocumentationPartOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateDocumentationPartOutput) String ¶
func (s UpdateDocumentationPartOutput) String() string
String returns the string representation
type UpdateDocumentationPartRequest ¶
type UpdateDocumentationPartRequest struct { *aws.Request Input *UpdateDocumentationPartInput Copy func(*UpdateDocumentationPartInput) UpdateDocumentationPartRequest }
UpdateDocumentationPartRequest is the request type for the UpdateDocumentationPart API operation.
func (UpdateDocumentationPartRequest) Send ¶
func (r UpdateDocumentationPartRequest) Send(ctx context.Context) (*UpdateDocumentationPartResponse, error)
Send marshals and sends the UpdateDocumentationPart API request.
type UpdateDocumentationPartResponse ¶ added in v0.9.0
type UpdateDocumentationPartResponse struct { *UpdateDocumentationPartOutput // contains filtered or unexported fields }
UpdateDocumentationPartResponse is the response type for the UpdateDocumentationPart API operation.
func (*UpdateDocumentationPartResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateDocumentationPartResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateDocumentationPart request.
type UpdateDocumentationVersionInput ¶
type UpdateDocumentationVersionInput struct { // [Required] The version identifier of the to-be-updated documentation version. // // DocumentationVersion is a required field DocumentationVersion *string `location:"uri" locationName:"doc_version" type:"string" required:"true"` // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The string identifier of the associated RestApi.. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Updates an existing documentation version of an API.
func (UpdateDocumentationVersionInput) MarshalFields ¶ added in v0.3.0
func (s UpdateDocumentationVersionInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateDocumentationVersionInput) String ¶
func (s UpdateDocumentationVersionInput) String() string
String returns the string representation
func (*UpdateDocumentationVersionInput) Validate ¶
func (s *UpdateDocumentationVersionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDocumentationVersionOutput ¶
type UpdateDocumentationVersionOutput struct { // The date when the API documentation snapshot is created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // 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., OpenAPI) file.
Documenting an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart, DocumentationVersions
func (UpdateDocumentationVersionOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateDocumentationVersionOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateDocumentationVersionOutput) String ¶
func (s UpdateDocumentationVersionOutput) String() string
String returns the string representation
type UpdateDocumentationVersionRequest ¶
type UpdateDocumentationVersionRequest struct { *aws.Request Input *UpdateDocumentationVersionInput Copy func(*UpdateDocumentationVersionInput) UpdateDocumentationVersionRequest }
UpdateDocumentationVersionRequest is the request type for the UpdateDocumentationVersion API operation.
func (UpdateDocumentationVersionRequest) Send ¶
func (r UpdateDocumentationVersionRequest) Send(ctx context.Context) (*UpdateDocumentationVersionResponse, error)
Send marshals and sends the UpdateDocumentationVersion API request.
type UpdateDocumentationVersionResponse ¶ added in v0.9.0
type UpdateDocumentationVersionResponse struct { *UpdateDocumentationVersionOutput // contains filtered or unexported fields }
UpdateDocumentationVersionResponse is the response type for the UpdateDocumentationVersion API operation.
func (*UpdateDocumentationVersionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateDocumentationVersionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateDocumentationVersion request.
type UpdateDomainNameInput ¶
type UpdateDomainNameInput struct { // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s UpdateDomainNameInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateDomainNameInput) String ¶
func (s UpdateDomainNameInput) String() string
String returns the string representation
func (*UpdateDomainNameInput) Validate ¶
func (s *UpdateDomainNameInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDomainNameOutput ¶
type UpdateDomainNameOutput struct { // The reference to an AWS-managed certificate that will be used by edge-optimized // endpoint for this domain name. AWS Certificate Manager is the only supported // source. CertificateArn *string `locationName:"certificateArn" type:"string"` // The name of the certificate that will be used by edge-optimized endpoint // for this domain name. CertificateName *string `locationName:"certificateName" type:"string"` // The timestamp when the certificate that was used by edge-optimized endpoint // for this domain name was uploaded. CertificateUploadDate *time.Time `locationName:"certificateUploadDate" type:"timestamp"` // The domain name of the Amazon CloudFront distribution associated with this // custom domain name for an edge-optimized endpoint. You set up this association // when adding a DNS record pointing the custom domain name to this distribution // name. For more information about CloudFront distributions, see the Amazon // CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/). DistributionDomainName *string `locationName:"distributionDomainName" type:"string"` // The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized // endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more // information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) // and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). DistributionHostedZoneId *string `locationName:"distributionHostedZoneId" type:"string"` // The custom domain name as an API host name, for example, my-api.example.com. DomainName *string `locationName:"domainName" type:"string"` // The status of the DomainName migration. The valid values are AVAILABLE and // UPDATING. If the status is UPDATING, the domain cannot be modified further // until the existing operation is complete. If it is AVAILABLE, the domain // can be updated. DomainNameStatus DomainNameStatus `locationName:"domainNameStatus" type:"string" enum:"true"` // An optional text message containing detailed information about status of // the DomainName migration. DomainNameStatusMessage *string `locationName:"domainNameStatusMessage" type:"string"` // The endpoint configuration of this DomainName showing the endpoint types // of the domain name. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The reference to an AWS-managed certificate that will be used for validating // the regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string `locationName:"regionalCertificateArn" type:"string"` // The name of the certificate that will be used for validating the regional // domain name. RegionalCertificateName *string `locationName:"regionalCertificateName" type:"string"` // The domain name associated with the regional endpoint for this custom domain // name. You set up this association by adding a DNS record that points the // custom domain name to this regional domain name. The regional domain name // is returned by API Gateway when you create a regional endpoint. RegionalDomainName *string `locationName:"regionalDomainName" type:"string"` // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. // For more information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) // and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). RegionalHostedZoneId *string `locationName:"regionalHostedZoneId" type:"string"` // The Transport Layer Security (TLS) version + cipher suite for this DomainName. // The valid values are TLS_1_0 and TLS_1_2. SecurityPolicy SecurityPolicy `locationName:"securityPolicy" type:"string" enum:"true"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
Represents a custom domain name as a user-friendly host name of an API (RestApi).
When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.
Set a Custom Host Name for an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
func (UpdateDomainNameOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateDomainNameOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateDomainNameOutput) String ¶
func (s UpdateDomainNameOutput) String() string
String returns the string representation
type UpdateDomainNameRequest ¶
type UpdateDomainNameRequest struct { *aws.Request Input *UpdateDomainNameInput Copy func(*UpdateDomainNameInput) UpdateDomainNameRequest }
UpdateDomainNameRequest is the request type for the UpdateDomainName API operation.
func (UpdateDomainNameRequest) Send ¶
func (r UpdateDomainNameRequest) Send(ctx context.Context) (*UpdateDomainNameResponse, error)
Send marshals and sends the UpdateDomainName API request.
type UpdateDomainNameResponse ¶ added in v0.9.0
type UpdateDomainNameResponse struct { *UpdateDomainNameOutput // contains filtered or unexported fields }
UpdateDomainNameResponse is the response type for the UpdateDomainName API operation.
func (*UpdateDomainNameResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateDomainNameResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateDomainName request.
type UpdateGatewayResponseInput ¶
type UpdateGatewayResponseInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"` // [Required] // The response type of the associated GatewayResponse. Valid values are // * ACCESS_DENIED // // * API_CONFIGURATION_ERROR // // * AUTHORIZER_FAILURE // // * AUTHORIZER_CONFIGURATION_ERROR // // * BAD_REQUEST_PARAMETERS // // * BAD_REQUEST_BODY // // * DEFAULT_4XX // // * DEFAULT_5XX // // * EXPIRED_TOKEN // // * INVALID_SIGNATURE // // * INTEGRATION_FAILURE // // * INTEGRATION_TIMEOUT // // * INVALID_API_KEY // // * MISSING_AUTHENTICATION_TOKEN // // * QUOTA_EXCEEDED // // * REQUEST_TOO_LARGE // // * RESOURCE_NOT_FOUND // // * THROTTLED // // * UNAUTHORIZED // // * UNSUPPORTED_MEDIA_TYPE // // ResponseType is a required field ResponseType GatewayResponseType `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Updates a GatewayResponse of a specified response type on the given RestApi.
func (UpdateGatewayResponseInput) MarshalFields ¶ added in v0.3.0
func (s UpdateGatewayResponseInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateGatewayResponseInput) String ¶
func (s UpdateGatewayResponseInput) String() string
String returns the string representation
func (*UpdateGatewayResponseInput) Validate ¶
func (s *UpdateGatewayResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateGatewayResponseOutput ¶
type UpdateGatewayResponseOutput struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway // response (true) or not (false). A default gateway response is one generated // by API Gateway without any customization by an API developer. DefaultResponse *bool `locationName:"defaultResponse" type:"boolean"` // Response parameters (paths, query strings and headers) of the GatewayResponse // as a string-to-string map of key-value pairs. ResponseParameters map[string]string `locationName:"responseParameters" type:"map"` // Response templates of the GatewayResponse as a string-to-string map of key-value // pairs. ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"` // The response type of the associated GatewayResponse. Valid values are // * ACCESS_DENIED // // * API_CONFIGURATION_ERROR // // * AUTHORIZER_FAILURE // // * AUTHORIZER_CONFIGURATION_ERROR // // * BAD_REQUEST_PARAMETERS // // * BAD_REQUEST_BODY // // * DEFAULT_4XX // // * DEFAULT_5XX // // * EXPIRED_TOKEN // // * INVALID_SIGNATURE // // * INTEGRATION_FAILURE // // * INTEGRATION_TIMEOUT // // * INVALID_API_KEY // // * MISSING_AUTHENTICATION_TOKEN // // * QUOTA_EXCEEDED // // * REQUEST_TOO_LARGE // // * RESOURCE_NOT_FOUND // // * THROTTLED // // * UNAUTHORIZED // // * UNSUPPORTED_MEDIA_TYPE ResponseType GatewayResponseType `locationName:"responseType" type:"string" enum:"true"` // The HTTP status code for this GatewayResponse. StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway (https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html)
Example: Get a Gateway Response of a given response type
Request ¶
This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45
The response type is specified as a URL path.
Response ¶
The successful operation returns the 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{\n \"message\": $context.error.messageString,\n \"type\": \"$context.error.responseType\",\n \"stage\": \"$context.stage\",\n \"resourcePath\": \"$context.resourcePath\",\n \"stageVariables.a\": \"$stageVariables.a\",\n \"statusCode\": \"'404'\"\n}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404" }
Customize Gateway Responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html)
func (UpdateGatewayResponseOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateGatewayResponseOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateGatewayResponseOutput) String ¶
func (s UpdateGatewayResponseOutput) String() string
String returns the string representation
type UpdateGatewayResponseRequest ¶
type UpdateGatewayResponseRequest struct { *aws.Request Input *UpdateGatewayResponseInput Copy func(*UpdateGatewayResponseInput) UpdateGatewayResponseRequest }
UpdateGatewayResponseRequest is the request type for the UpdateGatewayResponse API operation.
func (UpdateGatewayResponseRequest) Send ¶
func (r UpdateGatewayResponseRequest) Send(ctx context.Context) (*UpdateGatewayResponseResponse, error)
Send marshals and sends the UpdateGatewayResponse API request.
type UpdateGatewayResponseResponse ¶ added in v0.9.0
type UpdateGatewayResponseResponse struct { *UpdateGatewayResponseOutput // contains filtered or unexported fields }
UpdateGatewayResponseResponse is the response type for the UpdateGatewayResponse API operation.
func (*UpdateGatewayResponseResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateGatewayResponseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateGatewayResponse request.
type UpdateIntegrationInput ¶
type UpdateIntegrationInput struct { // [Required] 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"` // [Required] Represents an update integration request's resource identifier. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Represents an update integration request.
func (UpdateIntegrationInput) MarshalFields ¶ added in v0.3.0
func (s UpdateIntegrationInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateIntegrationInput) String ¶
func (s UpdateIntegrationInput) String() string
String returns the string representation
func (*UpdateIntegrationInput) Validate ¶
func (s *UpdateIntegrationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateIntegrationOutput ¶
type UpdateIntegrationOutput struct { // A list of request parameters whose values API Gateway caches. To be valid // values for cacheKeyParameters, these parameters must also be specified for // Method requestParameters. CacheKeyParameters []string `locationName:"cacheKeyParameters" type:"list"` // Specifies a group of related cached parameters. By default, API Gateway uses // the resource ID as the cacheNamespace. You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string `locationName:"cacheNamespace" type:"string"` // The (id (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) // of the VpcLink used for the integration when connectionType=VPC_LINK and // undefined, otherwise. ConnectionId *string `locationName:"connectionId" type:"string"` // The type of the network connection to the integration endpoint. The valid // value is INTERNET for connections through the public routable internet or // VPC_LINK for private connections between API Gateway and a network load balancer // in a VPC. The default value is INTERNET. ConnectionType ConnectionType `locationName:"connectionType" type:"string" enum:"true"` // 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 passthroughBehavior is configured to support payload pass-through. ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"` // Specifies the credentials required for the integration, if any. For AWS integrations, // three options are available. To specify an IAM Role for API Gateway to assume, // use the role's Amazon Resource Name (ARN). To require that the caller's identity // be passed through from the request, specify the string arn:aws:iam::\*:user/\*. // To use resource-based permissions on supported AWS services, specify null. Credentials *string `locationName:"credentials" type:"string"` // Specifies the integration's HTTP method type. HttpMethod *string `locationName:"httpMethod" type:"string"` // Specifies the integration's responses. // // Example: Get integration responses of a method // // Request // GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 // HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns 200 OK status and a payload as follows: // { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", // "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" // }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" // } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" // }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream // in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" // }, "statusCode": "200" } // // Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) IntegrationResponses map[string]IntegrationResponse `locationName:"integrationResponses" type:"map"` // Specifies how the method request body of an unmapped content type will be // passed through the integration request to the back end without transformation. // A content type is unmapped if no mapping template is defined in the integration // or the content type does not match any of the mapped content types, as specified // in requestTemplates. The valid value is one of the following: // // * WHEN_NO_MATCH: passes the method request body through the integration // request to the back end without transformation when the method request // content type does not match any content type associated with the mapping // templates defined in the integration request. // // * WHEN_NO_TEMPLATES: passes the method request body through the integration // request to the back end without transformation when no mapping template // is defined in the integration request. If a template is defined when this // option is selected, the method request of an unmapped content-type will // be rejected with an HTTP 415 Unsupported Media Type response. // // * NEVER: rejects the method request with an HTTP 415 Unsupported Media // Type response when either the method request content type does not match // any content type associated with the mapping templates defined in the // integration request or no mapping template is defined in the integration // request. PassthroughBehavior *string `locationName:"passthroughBehavior" type:"string"` // A key-value map specifying request parameters that are passed from the method // request to the back end. The key is an integration request parameter name // and the associated value is a method request parameter value or static value // that must be enclosed within single quotes and pre-encoded as required by // the back end. The method request parameter value must match the pattern of // method.request.{location}.{name}, where location is querystring, path, or // header and name must be a valid and unique method request parameter name. RequestParameters map[string]string `locationName:"requestParameters" type:"map"` // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the // value. RequestTemplates map[string]string `locationName:"requestTemplates" type:"map"` // Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 // milliseconds or 29 seconds. TimeoutInMillis *int64 `locationName:"timeoutInMillis" type:"integer"` // Specifies the TLS configuration for an integration. TlsConfig *TlsConfig `locationName:"tlsConfig" type:"structure"` // Specifies an API method integration type. The valid value is one of the following: // // * AWS: for integrating the API method request with an AWS service action, // including the Lambda function-invoking action. With the Lambda function-invoking // action, this is referred to as the Lambda custom integration. With any // other AWS service action, this is known as AWS integration. // // * AWS_PROXY: for integrating the API method request with the Lambda function-invoking // action with the client request passed through as-is. This integration // is also referred to as the Lambda proxy integration. // // * HTTP: for integrating the API method request with an HTTP endpoint, // including a private HTTP endpoint within a VPC. This integration is also // referred to as the HTTP custom integration. // // * HTTP_PROXY: for integrating the API method request with an HTTP endpoint, // including a private HTTP endpoint within a VPC, with the client request // passed through as-is. This is also referred to as the HTTP proxy integration. // // * MOCK: for integrating the API method request with API Gateway as a "loop-back" // endpoint without invoking any backend. // // For the HTTP and HTTP proxy integrations, each integration can specify a // protocol (http/https), port and path. Standard 80 and 443 ports are supported // as well as custom ports above 1024. An HTTP or HTTP proxy integration with // a connectionType of VPC_LINK is referred to as a private integration and // uses a VpcLink to connect API Gateway to a network load balancer of a VPC. Type IntegrationType `locationName:"type" type:"string" enum:"true"` // Specifies Uniform Resource Identifier (URI) of the integration endpoint. // // * For HTTP or HTTP_PROXY 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 either standard integration, where connectionType is not VPC_LINK, // or private integration, where connectionType is VPC_LINK. For a private // HTTP integration, the URI is not used for routing. // // * For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. // Here, {Region} is the API Gateway region (e.g., us-east-1); {service} // is the name of the integrated AWS service (e.g., s3); and {subdomain} // is a designated subdomain supported by certain AWS service for fast host-name // lookup. action can be used for an AWS service action-based API, using // an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} // refers to a supported action {name} plus any required input parameters. // Alternatively, path can be used for an AWS service path-based API. The // ensuing service_api refers to the path to an AWS service resource, including // the region of the integrated AWS service, if applicable. For example, // for integration with the S3 API of GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html), // the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} // or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (UpdateIntegrationOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateIntegrationOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateIntegrationOutput) String ¶
func (s UpdateIntegrationOutput) String() string
String returns the string representation
type UpdateIntegrationRequest ¶
type UpdateIntegrationRequest struct { *aws.Request Input *UpdateIntegrationInput Copy func(*UpdateIntegrationInput) UpdateIntegrationRequest }
UpdateIntegrationRequest is the request type for the UpdateIntegration API operation.
func (UpdateIntegrationRequest) Send ¶
func (r UpdateIntegrationRequest) Send(ctx context.Context) (*UpdateIntegrationResponse, error)
Send marshals and sends the UpdateIntegration API request.
type UpdateIntegrationResponse ¶ added in v0.9.0
type UpdateIntegrationResponse struct { *UpdateIntegrationOutput // contains filtered or unexported fields }
UpdateIntegrationResponse is the response type for the UpdateIntegration API operation.
func (*UpdateIntegrationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateIntegrationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateIntegration request.
type UpdateIntegrationResponseInput ¶
type UpdateIntegrationResponseInput struct { // [Required] 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"` // [Required] 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s UpdateIntegrationResponseInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateIntegrationResponseInput) String ¶
func (s UpdateIntegrationResponseInput) String() string
String returns the string representation
func (*UpdateIntegrationResponseInput) Validate ¶
func (s *UpdateIntegrationResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateIntegrationResponseOutput ¶
type UpdateIntegrationResponseOutput struct { // Specifies how to handle response payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: // // * CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded // string to the corresponding binary blob. // // * CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. // // If this property is not defined, the response payload will be passed through // from the integration response to the method response without modification. ContentHandling ContentHandlingStrategy `locationName:"contentHandling" type:"string" enum:"true"` // A key-value map specifying response parameters that are passed to the method // response from the back end. The key is a method response header parameter // name and the mapped value is an integration response header value, a static // value enclosed within a pair of single quotes, or a JSON expression from // the integration response body. The mapping key must match the pattern of // method.response.header.{name}, where name is a valid and unique header name. // The mapped non-static value must match the pattern of integration.response.header.{name} // or integration.response.body.{JSON-expression}, where name is a valid and // unique response header name and JSON-expression is a valid JSON expression // without the $ prefix. ResponseParameters map[string]string `locationName:"responseParameters" type:"map"` // Specifies the templates used to transform the integration response body. // Response templates are represented as a key/value map, with a content-type // as the key and a template as the value. ResponseTemplates map[string]string `locationName:"responseTemplates" type:"map"` // Specifies the regular expression (regex) pattern used to choose an integration // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you // could use the .+ regex to match error response. However, make sure that the // error response does not contain any newline (\n) character in such cases. // If the back end is an AWS Lambda function, the AWS Lambda function error // header is matched. For all other HTTP and AWS back ends, the HTTP status // code is matched. SelectionPattern *string `locationName:"selectionPattern" type:"string"` // Specifies the status code that is used to map the integration response to // an existing MethodResponse. StatusCode *string `locationName:"statusCode" type:"string"` // contains filtered or unexported fields }
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (UpdateIntegrationResponseOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateIntegrationResponseOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateIntegrationResponseOutput) String ¶
func (s UpdateIntegrationResponseOutput) String() string
String returns the string representation
type UpdateIntegrationResponseRequest ¶
type UpdateIntegrationResponseRequest struct { *aws.Request Input *UpdateIntegrationResponseInput Copy func(*UpdateIntegrationResponseInput) UpdateIntegrationResponseRequest }
UpdateIntegrationResponseRequest is the request type for the UpdateIntegrationResponse API operation.
func (UpdateIntegrationResponseRequest) Send ¶
func (r UpdateIntegrationResponseRequest) Send(ctx context.Context) (*UpdateIntegrationResponseResponse, error)
Send marshals and sends the UpdateIntegrationResponse API request.
type UpdateIntegrationResponseResponse ¶ added in v0.9.0
type UpdateIntegrationResponseResponse struct { *UpdateIntegrationResponseOutput // contains filtered or unexported fields }
UpdateIntegrationResponseResponse is the response type for the UpdateIntegrationResponse API operation.
func (*UpdateIntegrationResponseResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateIntegrationResponseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateIntegrationResponse request.
type UpdateMethodInput ¶
type UpdateMethodInput struct { // [Required] 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"` // [Required] The Resource identifier for the Method resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to update an existing Method resource.
func (UpdateMethodInput) MarshalFields ¶ added in v0.3.0
func (s UpdateMethodInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateMethodInput) String ¶
func (s UpdateMethodInput) String() string
String returns the string representation
func (*UpdateMethodInput) Validate ¶
func (s *UpdateMethodInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateMethodOutput ¶
type UpdateMethodOutput struct { // A boolean flag specifying whether a valid ApiKey is required to invoke this // method. ApiKeyRequired *bool `locationName:"apiKeyRequired" type:"boolean"` // A list of authorization scopes configured on the method. The scopes are used // with a COGNITO_USER_POOLS authorizer to authorize the method invocation. // The authorization works by matching the method scopes against the scopes // parsed from the access token in the incoming request. The method invocation // is authorized if any method scopes matches a claimed scope in the access // token. Otherwise, the invocation is not authorized. When the method scope // is configured, the client must provide an access token instead of an identity // token for authorization purposes. AuthorizationScopes []string `locationName:"authorizationScopes" type:"list"` // The method's authorization type. Valid values are NONE for open access, AWS_IAM // for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS // for using a Cognito user pool. AuthorizationType *string `locationName:"authorizationType" type:"string"` // The identifier of an Authorizer to use on this method. The authorizationType // must be CUSTOM. AuthorizerId *string `locationName:"authorizerId" type:"string"` // The method's HTTP verb. HttpMethod *string `locationName:"httpMethod" type:"string"` // Gets the method's integration responsible for passing the client-submitted // request to the back end and performing necessary transformations to make // the request compliant with the back end. // // Example: // // Request // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns a 200 OK status code and a payload similar // to the following: // { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", // "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true } ], "self": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": // { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" // }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", // "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" // }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", // "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", // "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": // "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": // "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", // \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", // "_embedded": { "integration:responses": { "_links": { "self": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", // "name": "200", "title": "200" }, "integrationresponse:delete": { "href": // "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" // }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" // } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", // "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": // "integration.response.body.a" }, "responseTemplates": { "application/json": // "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op // => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n // \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } // } } // // AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html) MethodIntegration *Integration `locationName:"methodIntegration" type:"structure"` // Gets a method response associated with a given HTTP status code. // // The collection of method responses are encapsulated in a key-value map, where // the key is a response's HTTP status code and the value is a MethodResponse // resource that specifies the response returned to the caller from the back // end through the integration response. // // Example: Get a 200 OK response of a GET method // // Request // GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 // Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com // Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 // Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // // The successful response returns a 200 OK status code and a payload similar // to the following: // { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", // "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", // "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" // }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" // } }, "responseModels": { "application/json": "Empty" }, "responseParameters": // { "method.response.header.operator": false, "method.response.header.operand_2": // false, "method.response.header.operand_1": false }, "statusCode": "200" // } // // AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html) 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 the PetStore // 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 API Gateway. A key is a method request parameter name // matching the pattern of method.request.{location}.{name}, where location // is querystring, path, or header and name is a valid and unique parameter // name. The value associated with the key is a Boolean flag indicating whether // the parameter is required (true) or optional (false). The method request // parameter names defined here are available in Integration to be mapped to // integration request parameters or templates. RequestParameters map[string]bool `locationName:"requestParameters" type:"map"` // The identifier of a RequestValidator for request validation. RequestValidatorId *string `locationName:"requestValidatorId" type:"string"` // contains filtered or unexported fields }
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
Example: Retrive the GET method on a specified resource
Request ¶
The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri).
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://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() (https://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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html)
func (UpdateMethodOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateMethodOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateMethodOutput) String ¶
func (s UpdateMethodOutput) String() string
String returns the string representation
type UpdateMethodRequest ¶
type UpdateMethodRequest struct { *aws.Request Input *UpdateMethodInput Copy func(*UpdateMethodInput) UpdateMethodRequest }
UpdateMethodRequest is the request type for the UpdateMethod API operation.
func (UpdateMethodRequest) Send ¶
func (r UpdateMethodRequest) Send(ctx context.Context) (*UpdateMethodResponse, error)
Send marshals and sends the UpdateMethod API request.
type UpdateMethodResponse ¶ added in v0.9.0
type UpdateMethodResponse struct { *UpdateMethodOutput // contains filtered or unexported fields }
UpdateMethodResponse is the response type for the UpdateMethod API operation.
func (*UpdateMethodResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateMethodResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateMethod request.
type UpdateMethodResponseInput ¶
type UpdateMethodResponseInput struct { // [Required] 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"` // [Required] The Resource identifier for the MethodResponse resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s UpdateMethodResponseInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateMethodResponseInput) String ¶
func (s UpdateMethodResponseInput) String() string
String returns the string representation
func (*UpdateMethodResponseInput) Validate ¶
func (s *UpdateMethodResponseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateMethodResponseOutput ¶
type UpdateMethodResponseOutput struct { // Specifies the Model resources used for the response's content-type. Response // models are represented as a key/value map, with a content-type as the key // and a Model name as the value. ResponseModels map[string]string `locationName:"responseModels" type:"map"` // A key-value map specifying required or optional response parameters that // 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. 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": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" }
Method, IntegrationResponse, Integration Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (UpdateMethodResponseOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateMethodResponseOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateMethodResponseOutput) String ¶
func (s UpdateMethodResponseOutput) String() string
String returns the string representation
type UpdateMethodResponseRequest ¶
type UpdateMethodResponseRequest struct { *aws.Request Input *UpdateMethodResponseInput Copy func(*UpdateMethodResponseInput) UpdateMethodResponseRequest }
UpdateMethodResponseRequest is the request type for the UpdateMethodResponse API operation.
func (UpdateMethodResponseRequest) Send ¶
func (r UpdateMethodResponseRequest) Send(ctx context.Context) (*UpdateMethodResponseResponse, error)
Send marshals and sends the UpdateMethodResponse API request.
type UpdateMethodResponseResponse ¶ added in v0.9.0
type UpdateMethodResponseResponse struct { *UpdateMethodResponseOutput // contains filtered or unexported fields }
UpdateMethodResponseResponse is the response type for the UpdateMethodResponse API operation.
func (*UpdateMethodResponseResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateMethodResponseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateMethodResponse request.
type UpdateModelInput ¶
type UpdateModelInput struct { // [Required] 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"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to update an existing model in an existing RestApi resource.
func (UpdateModelInput) MarshalFields ¶ added in v0.3.0
func (s UpdateModelInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateModelInput) String ¶
func (s UpdateModelInput) String() string
String returns the string representation
func (*UpdateModelInput) Validate ¶
func (s *UpdateModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateModelOutput ¶
type UpdateModelOutput struct { // The content-type for the model. ContentType *string `locationName:"contentType" type:"string"` // The description of the model. Description *string `locationName:"description" type:"string"` // The identifier for the model resource. Id *string `locationName:"id" type:"string"` // The name of the model. Must be an alphanumeric string. Name *string `locationName:"name" type:"string"` // The schema for the model. For application/json models, this should be JSON // schema draft 4 (https://tools.ietf.org/html/draft-zyp-json-schema-04) 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html)
func (UpdateModelOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateModelOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateModelOutput) String ¶
func (s UpdateModelOutput) String() string
String returns the string representation
type UpdateModelRequest ¶
type UpdateModelRequest struct { *aws.Request Input *UpdateModelInput Copy func(*UpdateModelInput) UpdateModelRequest }
UpdateModelRequest is the request type for the UpdateModel API operation.
func (UpdateModelRequest) Send ¶
func (r UpdateModelRequest) Send(ctx context.Context) (*UpdateModelResponse, error)
Send marshals and sends the UpdateModel API request.
type UpdateModelResponse ¶ added in v0.9.0
type UpdateModelResponse struct { *UpdateModelOutput // contains filtered or unexported fields }
UpdateModelResponse is the response type for the UpdateModel API operation.
func (*UpdateModelResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateModelResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateModel request.
type UpdateRequestValidatorInput ¶
type UpdateRequestValidatorInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The identifier of RequestValidator to be updated. // // RequestValidatorId is a required field RequestValidatorId *string `location:"uri" locationName:"requestvalidator_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Updates a RequestValidator of a given RestApi.
func (UpdateRequestValidatorInput) MarshalFields ¶ added in v0.3.0
func (s UpdateRequestValidatorInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateRequestValidatorInput) String ¶
func (s UpdateRequestValidatorInput) String() string
String returns the string representation
func (*UpdateRequestValidatorInput) Validate ¶
func (s *UpdateRequestValidatorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateRequestValidatorOutput ¶
type UpdateRequestValidatorOutput struct { // The identifier of this RequestValidator. Id *string `locationName:"id" type:"string"` // The name of this RequestValidator Name *string `locationName:"name" type:"string"` // A Boolean flag to indicate whether to validate a request body according to // the configured Model schema. ValidateRequestBody *bool `locationName:"validateRequestBody" type:"boolean"` // A Boolean flag to indicate whether to validate request parameters (true) // or not (false). ValidateRequestParameters *bool `locationName:"validateRequestParameters" type:"boolean"` // contains filtered or unexported fields }
A set of validation rules for incoming Method requests.
In OpenAPI, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html) object. It the referenced using the x-amazon-apigateway-request-validator (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator) property.
Enable Basic Request Validation in API Gateway (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html)
func (UpdateRequestValidatorOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateRequestValidatorOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateRequestValidatorOutput) String ¶
func (s UpdateRequestValidatorOutput) String() string
String returns the string representation
type UpdateRequestValidatorRequest ¶
type UpdateRequestValidatorRequest struct { *aws.Request Input *UpdateRequestValidatorInput Copy func(*UpdateRequestValidatorInput) UpdateRequestValidatorRequest }
UpdateRequestValidatorRequest is the request type for the UpdateRequestValidator API operation.
func (UpdateRequestValidatorRequest) Send ¶
func (r UpdateRequestValidatorRequest) Send(ctx context.Context) (*UpdateRequestValidatorResponse, error)
Send marshals and sends the UpdateRequestValidator API request.
type UpdateRequestValidatorResponse ¶ added in v0.9.0
type UpdateRequestValidatorResponse struct { *UpdateRequestValidatorOutput // contains filtered or unexported fields }
UpdateRequestValidatorResponse is the response type for the UpdateRequestValidator API operation.
func (*UpdateRequestValidatorResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateRequestValidatorResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateRequestValidator request.
type UpdateResourceInput ¶
type UpdateResourceInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The identifier of the Resource resource. // // ResourceId is a required field ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to change information about a Resource resource.
func (UpdateResourceInput) MarshalFields ¶ added in v0.3.0
func (s UpdateResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateResourceInput) String ¶
func (s UpdateResourceInput) String() string
String returns the string representation
func (*UpdateResourceInput) Validate ¶
func (s *UpdateResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateResourceOutput ¶
type UpdateResourceOutput struct { // The resource's identifier. Id *string `locationName:"id" type:"string"` // The parent resource's identifier. ParentId *string `locationName:"parentId" type:"string"` // The full path for this resource. Path *string `locationName:"path" type:"string"` // The last path segment for this resource. PathPart *string `locationName:"pathPart" type:"string"` // Gets an API resource's method of a given HTTP verb. // // The resource methods are a map of methods indexed by methods' HTTP verbs // enabled on the resource. This method map is included in the 200 OK response // of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods // request. // // Example: Get the GET method of an API resource // // Request // GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: // application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z // Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, // SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} // Response // { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", // "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", // "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", // "name": "method", "templated": true }, { "href": "https://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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (UpdateResourceOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateResourceOutput) String ¶
func (s UpdateResourceOutput) String() string
String returns the string representation
type UpdateResourceRequest ¶
type UpdateResourceRequest struct { *aws.Request Input *UpdateResourceInput Copy func(*UpdateResourceInput) UpdateResourceRequest }
UpdateResourceRequest is the request type for the UpdateResource API operation.
func (UpdateResourceRequest) Send ¶
func (r UpdateResourceRequest) Send(ctx context.Context) (*UpdateResourceResponse, error)
Send marshals and sends the UpdateResource API request.
type UpdateResourceResponse ¶ added in v0.9.0
type UpdateResourceResponse struct { *UpdateResourceOutput // contains filtered or unexported fields }
UpdateResourceResponse is the response type for the UpdateResource API operation.
func (*UpdateResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateResource request.
type UpdateRestApiInput ¶
type UpdateRestApiInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // contains filtered or unexported fields }
Request to update an existing RestApi resource in your collection.
func (UpdateRestApiInput) MarshalFields ¶ added in v0.3.0
func (s UpdateRestApiInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateRestApiInput) String ¶
func (s UpdateRestApiInput) String() string
String returns the string representation
func (*UpdateRestApiInput) Validate ¶
func (s *UpdateRestApiInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateRestApiOutput ¶
type UpdateRestApiOutput struct { // The source of the API key for metering requests according to a usage plan. // Valid values are: // * HEADER to read the API key from the X-API-Key header of a request. // // * AUTHORIZER to read the API key from the UsageIdentifierKey from a custom // authorizer. ApiKeySource ApiKeySourceType `locationName:"apiKeySource" type:"string" enum:"true"` // The list of binary media types supported by the RestApi. By default, the // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string `locationName:"binaryMediaTypes" type:"list"` // The timestamp when the API was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The API's description. Description *string `locationName:"description" type:"string"` // The endpoint configuration of this RestApi showing the endpoint types of // the API. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` // The API's identifier. This identifier is unique across all of your APIs in // API Gateway. Id *string `locationName:"id" type:"string"` // A nullable integer that is used to enable compression (with non-negative // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with // a null value) on an API. When compression is enabled, compression or decompression // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int64 `locationName:"minimumCompressionSize" type:"integer"` // The API's name. Name *string `locationName:"name" type:"string"` // A stringified JSON policy document that applies to this RestApi regardless // of the caller and Method configuration. Policy *string `locationName:"policy" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)
func (UpdateRestApiOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateRestApiOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateRestApiOutput) String ¶
func (s UpdateRestApiOutput) String() string
String returns the string representation
type UpdateRestApiRequest ¶
type UpdateRestApiRequest struct { *aws.Request Input *UpdateRestApiInput Copy func(*UpdateRestApiInput) UpdateRestApiRequest }
UpdateRestApiRequest is the request type for the UpdateRestApi API operation.
func (UpdateRestApiRequest) Send ¶
func (r UpdateRestApiRequest) Send(ctx context.Context) (*UpdateRestApiResponse, error)
Send marshals and sends the UpdateRestApi API request.
type UpdateRestApiResponse ¶ added in v0.9.0
type UpdateRestApiResponse struct { *UpdateRestApiOutput // contains filtered or unexported fields }
UpdateRestApiResponse is the response type for the UpdateRestApi API operation.
func (*UpdateRestApiResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateRestApiResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateRestApi request.
type UpdateStageInput ¶
type UpdateStageInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The string identifier of the associated RestApi. // // RestApiId is a required field RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` // [Required] The 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 API Gateway to change information about a Stage resource.
func (UpdateStageInput) MarshalFields ¶ added in v0.3.0
func (s UpdateStageInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateStageInput) String ¶
func (s UpdateStageInput) String() string
String returns the string representation
func (*UpdateStageInput) Validate ¶
func (s *UpdateStageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateStageOutput ¶
type UpdateStageOutput struct { // Settings for logging access in this stage. AccessLogSettings *AccessLogSettings `locationName:"accessLogSettings" type:"structure"` // Specifies whether a cache cluster is enabled for the stage. CacheClusterEnabled *bool `locationName:"cacheClusterEnabled" type:"boolean"` // The size of the cache cluster for the stage, if enabled. CacheClusterSize CacheClusterSize `locationName:"cacheClusterSize" type:"string" enum:"true"` // The status of the cache cluster for the stage, if enabled. CacheClusterStatus CacheClusterStatus `locationName:"cacheClusterStatus" type:"string" enum:"true"` // Settings for the canary deployment in this stage. CanarySettings *CanarySettings `locationName:"canarySettings" type:"structure"` // The identifier of a client certificate for an API stage. ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` // The timestamp when the stage was created. CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` // The identifier of the Deployment that the stage points to. DeploymentId *string `locationName:"deploymentId" type:"string"` // The stage's description. Description *string `locationName:"description" type:"string"` // The version of the associated API documentation. DocumentationVersion *string `locationName:"documentationVersion" type:"string"` // The timestamp when the stage last updated. LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp"` // 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 API Gateway. Stage names can only contain alphanumeric // characters, hyphens, and underscores. Maximum length is 128 characters. StageName *string `locationName:"stageName" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // Specifies whether active tracing with X-ray is enabled for the Stage. TracingEnabled *bool `locationName:"tracingEnabled" type:"boolean"` // 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"` // The ARN of the WebAcl associated with the Stage. WebAclArn *string `locationName:"webAclArn" type:"string"` // contains filtered or unexported fields }
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Deploy an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html)
func (UpdateStageOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateStageOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateStageOutput) String ¶
func (s UpdateStageOutput) String() string
String returns the string representation
type UpdateStageRequest ¶
type UpdateStageRequest struct { *aws.Request Input *UpdateStageInput Copy func(*UpdateStageInput) UpdateStageRequest }
UpdateStageRequest is the request type for the UpdateStage API operation.
func (UpdateStageRequest) Send ¶
func (r UpdateStageRequest) Send(ctx context.Context) (*UpdateStageResponse, error)
Send marshals and sends the UpdateStage API request.
type UpdateStageResponse ¶ added in v0.9.0
type UpdateStageResponse struct { *UpdateStageOutput // contains filtered or unexported fields }
UpdateStageResponse is the response type for the UpdateStage API operation.
func (*UpdateStageResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateStageResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateStage request.
type UpdateUsageInput ¶
type UpdateUsageInput struct { // [Required] 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"` // [Required] The Id of the usage plan associated with the usage data. // // UsagePlanId is a required field UsagePlanId *string `location:"uri" locationName:"usageplanId" type:"string" required:"true"` // contains filtered or unexported fields }
The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.
func (UpdateUsageInput) MarshalFields ¶ added in v0.3.0
func (s UpdateUsageInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateUsageInput) String ¶
func (s UpdateUsageInput) String() string
String returns the string representation
func (*UpdateUsageInput) Validate ¶
func (s *UpdateUsageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUsageOutput ¶
type UpdateUsageOutput struct { // The ending date of the usage data. EndDate *string `locationName:"endDate" type:"string"` // The usage data, as daily logs of used and remaining quotas, over the specified // time interval indexed over the API keys in a usage plan. For example, {..., // "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} // stands for an API key value and the daily log entry is of the format [used // quota, remaining quota]. Items map[string][][]int64 `locationName:"values" type:"map"` Position *string `locationName:"position" type:"string"` // The starting date of the usage data. StartDate *string `locationName:"startDate" type:"string"` // The plan Id associated with this usage data. UsagePlanId *string `locationName:"usagePlanId" type:"string"` // contains filtered or unexported fields }
Represents the usage data of a usage plan.
Create and Use Usage Plans (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html), Manage Usage in a Usage Plan (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-usage-plans-with-console.html#api-gateway-usage-plan-manage-usage)
func (UpdateUsageOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateUsageOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateUsageOutput) String ¶
func (s UpdateUsageOutput) String() string
String returns the string representation
type UpdateUsagePlanInput ¶
type UpdateUsagePlanInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"` // [Required] 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) MarshalFields ¶ added in v0.3.0
func (s UpdateUsagePlanInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateUsagePlanInput) String ¶
func (s UpdateUsagePlanInput) String() string
String returns the string representation
func (*UpdateUsagePlanInput) Validate ¶
func (s *UpdateUsagePlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUsagePlanOutput ¶
type UpdateUsagePlanOutput struct { // The associated API stages of a usage plan. ApiStages []ApiStage `locationName:"apiStages" type:"list"` // The description of a usage plan. Description *string `locationName:"description" type:"string"` // The identifier of a UsagePlan resource. Id *string `locationName:"id" type:"string"` // The name of a usage plan. Name *string `locationName:"name" type:"string"` // The AWS Markeplace product identifier to associate with the usage plan as // a SaaS product on AWS Marketplace. ProductCode *string `locationName:"productCode" type:"string"` // The maximum number of permitted requests per a given unit time interval. Quota *QuotaSettings `locationName:"quota" type:"structure"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (UpdateUsagePlanOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateUsagePlanOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateUsagePlanOutput) String ¶
func (s UpdateUsagePlanOutput) String() string
String returns the string representation
type UpdateUsagePlanRequest ¶
type UpdateUsagePlanRequest struct { *aws.Request Input *UpdateUsagePlanInput Copy func(*UpdateUsagePlanInput) UpdateUsagePlanRequest }
UpdateUsagePlanRequest is the request type for the UpdateUsagePlan API operation.
func (UpdateUsagePlanRequest) Send ¶
func (r UpdateUsagePlanRequest) Send(ctx context.Context) (*UpdateUsagePlanResponse, error)
Send marshals and sends the UpdateUsagePlan API request.
type UpdateUsagePlanResponse ¶ added in v0.9.0
type UpdateUsagePlanResponse struct { *UpdateUsagePlanOutput // contains filtered or unexported fields }
UpdateUsagePlanResponse is the response type for the UpdateUsagePlan API operation.
func (*UpdateUsagePlanResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateUsagePlanResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateUsagePlan request.
type UpdateUsageRequest ¶
type UpdateUsageRequest struct { *aws.Request Input *UpdateUsageInput Copy func(*UpdateUsageInput) UpdateUsageRequest }
UpdateUsageRequest is the request type for the UpdateUsage API operation.
func (UpdateUsageRequest) Send ¶
func (r UpdateUsageRequest) Send(ctx context.Context) (*UpdateUsageResponse, error)
Send marshals and sends the UpdateUsage API request.
type UpdateUsageResponse ¶ added in v0.9.0
type UpdateUsageResponse struct { *UpdateUsageOutput // contains filtered or unexported fields }
UpdateUsageResponse is the response type for the UpdateUsage API operation.
func (*UpdateUsageResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateUsageResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateUsage request.
type UpdateVpcLinkInput ¶ added in v0.2.0
type UpdateVpcLinkInput struct { // A list of update operations to be applied to the specified resource and in // the order specified in this list. PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"` // [Required] The identifier of the VpcLink. It is used in an Integration to // reference this VpcLink. // // VpcLinkId is a required field VpcLinkId *string `location:"uri" locationName:"vpclink_id" type:"string" required:"true"` // contains filtered or unexported fields }
Updates an existing VpcLink of a specified identifier.
func (UpdateVpcLinkInput) MarshalFields ¶ added in v0.3.0
func (s UpdateVpcLinkInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateVpcLinkInput) String ¶ added in v0.2.0
func (s UpdateVpcLinkInput) String() string
String returns the string representation
func (*UpdateVpcLinkInput) Validate ¶ added in v0.2.0
func (s *UpdateVpcLinkInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateVpcLinkOutput ¶ added in v0.2.0
type UpdateVpcLinkOutput struct { // The description of the VPC link. Description *string `locationName:"description" type:"string"` // The identifier of the VpcLink. It is used in an Integration to reference // this VpcLink. Id *string `locationName:"id" type:"string"` // The name used to label and identify the VPC link. Name *string `locationName:"name" type:"string"` // The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, // or FAILED. Deploying an API will wait if the status is PENDING and will fail // if the status is DELETING. Status VpcLinkStatus `locationName:"status" type:"string" enum:"true"` // A description about the VPC link status. StatusMessage *string `locationName:"statusMessage" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // The ARN of the network load balancer of the VPC targeted by the VPC link. // The network load balancer must be owned by the same AWS account of the API // owner. TargetArns []string `locationName:"targetArns" type:"list"` // contains filtered or unexported fields }
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.
func (UpdateVpcLinkOutput) MarshalFields ¶ added in v0.3.0
func (s UpdateVpcLinkOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateVpcLinkOutput) String ¶ added in v0.2.0
func (s UpdateVpcLinkOutput) String() string
String returns the string representation
type UpdateVpcLinkRequest ¶ added in v0.2.0
type UpdateVpcLinkRequest struct { *aws.Request Input *UpdateVpcLinkInput Copy func(*UpdateVpcLinkInput) UpdateVpcLinkRequest }
UpdateVpcLinkRequest is the request type for the UpdateVpcLink API operation.
func (UpdateVpcLinkRequest) Send ¶ added in v0.2.0
func (r UpdateVpcLinkRequest) Send(ctx context.Context) (*UpdateVpcLinkResponse, error)
Send marshals and sends the UpdateVpcLink API request.
type UpdateVpcLinkResponse ¶ added in v0.9.0
type UpdateVpcLinkResponse struct { *UpdateVpcLinkOutput // contains filtered or unexported fields }
UpdateVpcLinkResponse is the response type for the UpdateVpcLink API operation.
func (*UpdateVpcLinkResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateVpcLinkResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateVpcLink request.
type UsagePlan ¶ added in v0.9.0
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 collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (UsagePlan) MarshalFields ¶ added in v0.9.0
func (s UsagePlan) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type UsagePlanKey ¶ added in v0.9.0
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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
func (UsagePlanKey) MarshalFields ¶ added in v0.9.0
func (s UsagePlanKey) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UsagePlanKey) String ¶ added in v0.9.0
func (s UsagePlanKey) String() string
String returns the string representation
type VpcLink ¶ added in v0.9.0
type VpcLink struct { // The description of the VPC link. Description *string `locationName:"description" type:"string"` // The identifier of the VpcLink. It is used in an Integration to reference // this VpcLink. Id *string `locationName:"id" type:"string"` // The name used to label and identify the VPC link. Name *string `locationName:"name" type:"string"` // The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, // or FAILED. Deploying an API will wait if the status is PENDING and will fail // if the status is DELETING. Status VpcLinkStatus `locationName:"status" type:"string" enum:"true"` // A description about the VPC link status. StatusMessage *string `locationName:"statusMessage" type:"string"` // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string `locationName:"tags" type:"map"` // The ARN of the network load balancer of the VPC targeted by the VPC link. // The network load balancer must be owned by the same AWS account of the API // owner. TargetArns []string `locationName:"targetArns" type:"list"` // contains filtered or unexported fields }
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.
func (VpcLink) MarshalFields ¶ added in v0.9.0
func (s VpcLink) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type VpcLinkStatus ¶ added in v0.2.0
type VpcLinkStatus string
const ( VpcLinkStatusAvailable VpcLinkStatus = "AVAILABLE" VpcLinkStatusPending VpcLinkStatus = "PENDING" VpcLinkStatusDeleting VpcLinkStatus = "DELETING" VpcLinkStatusFailed VpcLinkStatus = "FAILED" )
Enum values for VpcLinkStatus
func (VpcLinkStatus) MarshalValue ¶ added in v0.3.0
func (enum VpcLinkStatus) MarshalValue() (string, error)
func (VpcLinkStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum VpcLinkStatus) MarshalValueBuf(b []byte) ([]byte, error)
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_CreateApiKey.go
- api_op_CreateAuthorizer.go
- api_op_CreateBasePathMapping.go
- api_op_CreateDeployment.go
- api_op_CreateDocumentationPart.go
- api_op_CreateDocumentationVersion.go
- api_op_CreateDomainName.go
- api_op_CreateModel.go
- api_op_CreateRequestValidator.go
- api_op_CreateResource.go
- api_op_CreateRestApi.go
- api_op_CreateStage.go
- api_op_CreateUsagePlan.go
- api_op_CreateUsagePlanKey.go
- api_op_CreateVpcLink.go
- api_op_DeleteApiKey.go
- api_op_DeleteAuthorizer.go
- api_op_DeleteBasePathMapping.go
- api_op_DeleteClientCertificate.go
- api_op_DeleteDeployment.go
- api_op_DeleteDocumentationPart.go
- api_op_DeleteDocumentationVersion.go
- api_op_DeleteDomainName.go
- api_op_DeleteGatewayResponse.go
- api_op_DeleteIntegration.go
- api_op_DeleteIntegrationResponse.go
- api_op_DeleteMethod.go
- api_op_DeleteMethodResponse.go
- api_op_DeleteModel.go
- api_op_DeleteRequestValidator.go
- api_op_DeleteResource.go
- api_op_DeleteRestApi.go
- api_op_DeleteStage.go
- api_op_DeleteUsagePlan.go
- api_op_DeleteUsagePlanKey.go
- api_op_DeleteVpcLink.go
- api_op_FlushStageAuthorizersCache.go
- api_op_FlushStageCache.go
- api_op_GenerateClientCertificate.go
- api_op_GetAccount.go
- api_op_GetApiKey.go
- api_op_GetApiKeys.go
- api_op_GetAuthorizer.go
- api_op_GetAuthorizers.go
- api_op_GetBasePathMapping.go
- api_op_GetBasePathMappings.go
- api_op_GetClientCertificate.go
- api_op_GetClientCertificates.go
- api_op_GetDeployment.go
- api_op_GetDeployments.go
- api_op_GetDocumentationPart.go
- api_op_GetDocumentationParts.go
- api_op_GetDocumentationVersion.go
- api_op_GetDocumentationVersions.go
- api_op_GetDomainName.go
- api_op_GetDomainNames.go
- api_op_GetExport.go
- api_op_GetGatewayResponse.go
- api_op_GetGatewayResponses.go
- api_op_GetIntegration.go
- api_op_GetIntegrationResponse.go
- api_op_GetMethod.go
- api_op_GetMethodResponse.go
- api_op_GetModel.go
- api_op_GetModelTemplate.go
- api_op_GetModels.go
- api_op_GetRequestValidator.go
- api_op_GetRequestValidators.go
- api_op_GetResource.go
- api_op_GetResources.go
- api_op_GetRestApi.go
- api_op_GetRestApis.go
- api_op_GetSdk.go
- api_op_GetSdkType.go
- api_op_GetSdkTypes.go
- api_op_GetStage.go
- api_op_GetStages.go
- api_op_GetTags.go
- api_op_GetUsage.go
- api_op_GetUsagePlan.go
- api_op_GetUsagePlanKey.go
- api_op_GetUsagePlanKeys.go
- api_op_GetUsagePlans.go
- api_op_GetVpcLink.go
- api_op_GetVpcLinks.go
- api_op_ImportApiKeys.go
- api_op_ImportDocumentationParts.go
- api_op_ImportRestApi.go
- api_op_PutGatewayResponse.go
- api_op_PutIntegration.go
- api_op_PutIntegrationResponse.go
- api_op_PutMethod.go
- api_op_PutMethodResponse.go
- api_op_PutRestApi.go
- api_op_TagResource.go
- api_op_TestInvokeAuthorizer.go
- api_op_TestInvokeMethod.go
- api_op_UntagResource.go
- api_op_UpdateAccount.go
- api_op_UpdateApiKey.go
- api_op_UpdateAuthorizer.go
- api_op_UpdateBasePathMapping.go
- api_op_UpdateClientCertificate.go
- api_op_UpdateDeployment.go
- api_op_UpdateDocumentationPart.go
- api_op_UpdateDocumentationVersion.go
- api_op_UpdateDomainName.go
- api_op_UpdateGatewayResponse.go
- api_op_UpdateIntegration.go
- api_op_UpdateIntegrationResponse.go
- api_op_UpdateMethod.go
- api_op_UpdateMethodResponse.go
- api_op_UpdateModel.go
- api_op_UpdateRequestValidator.go
- api_op_UpdateResource.go
- api_op_UpdateRestApi.go
- api_op_UpdateStage.go
- api_op_UpdateUsage.go
- api_op_UpdateUsagePlan.go
- api_op_UpdateVpcLink.go
- api_types.go
- customization.go
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. |