From 1e6e6e3b0a7546eb186909641d19729e77013c00 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Wed, 25 May 2022 18:13:16 +0000 Subject: [PATCH] Regenerated Clients --- .../08765fb0ccff45dd9878bc096857646e.json | 8 + .../2477e8e4997d49e6a63c405fe91a61f0.json | 8 + .../71a18f4173e3448193b49d160f5ce0d1.json | 8 + .../953910cf7b26448d91fa2edf47f5d42a.json | 8 + .../968b5011cc444325b267df3b6214882e.json | 8 + .../b68b34be2e754b5faeb3a3b69edc3764.json | 8 + .../dd2ac5637a6043eaba62e86196e0eab6.json | 8 + .../ef89c8b747944999bff250980fdea235.json | 8 + service/apigateway/api_op_CreateApiKey.go | 6 +- service/apigateway/api_op_CreateAuthorizer.go | 39 +- .../api_op_CreateBasePathMapping.go | 9 +- service/apigateway/api_op_CreateDeployment.go | 10 +- .../api_op_CreateDocumentationPart.go | 25 +- .../api_op_CreateDocumentationVersion.go | 11 +- service/apigateway/api_op_CreateDomainName.go | 41 +- service/apigateway/api_op_CreateModel.go | 26 +- .../api_op_CreateRequestValidator.go | 13 +- service/apigateway/api_op_CreateResource.go | 87 +-- service/apigateway/api_op_CreateRestApi.go | 27 +- service/apigateway/api_op_CreateStage.go | 12 +- service/apigateway/api_op_CreateUsagePlan.go | 13 +- .../apigateway/api_op_CreateUsagePlanKey.go | 13 +- service/apigateway/api_op_CreateVpcLink.go | 15 +- service/apigateway/api_op_DeleteApiKey.go | 2 +- service/apigateway/api_op_DeleteAuthorizer.go | 7 +- .../api_op_DeleteBasePathMapping.go | 6 +- .../api_op_DeleteClientCertificate.go | 2 +- service/apigateway/api_op_DeleteDeployment.go | 4 +- .../api_op_DeleteDocumentationPart.go | 5 +- .../api_op_DeleteDocumentationVersion.go | 5 +- service/apigateway/api_op_DeleteDomainName.go | 2 +- .../api_op_DeleteGatewayResponse.go | 4 +- .../apigateway/api_op_DeleteIntegration.go | 6 +- .../api_op_DeleteIntegrationResponse.go | 9 +- service/apigateway/api_op_DeleteMethod.go | 6 +- .../apigateway/api_op_DeleteMethodResponse.go | 8 +- service/apigateway/api_op_DeleteModel.go | 4 +- .../api_op_DeleteRequestValidator.go | 4 +- service/apigateway/api_op_DeleteResource.go | 4 +- service/apigateway/api_op_DeleteRestApi.go | 2 +- service/apigateway/api_op_DeleteStage.go | 4 +- service/apigateway/api_op_DeleteUsagePlan.go | 2 +- .../apigateway/api_op_DeleteUsagePlanKey.go | 6 +- service/apigateway/api_op_DeleteVpcLink.go | 4 +- service/apigateway/api_op_FlushStageCache.go | 4 +- .../api_op_GenerateClientCertificate.go | 6 +- service/apigateway/api_op_GetAccount.go | 47 +- service/apigateway/api_op_GetApiKey.go | 5 +- service/apigateway/api_op_GetApiKeys.go | 4 +- service/apigateway/api_op_GetAuthorizer.go | 23 +- service/apigateway/api_op_GetAuthorizers.go | 11 +- .../apigateway/api_op_GetBasePathMapping.go | 15 +- .../apigateway/api_op_GetBasePathMappings.go | 5 +- .../apigateway/api_op_GetClientCertificate.go | 8 +- .../api_op_GetClientCertificates.go | 4 +- service/apigateway/api_op_GetDeployment.go | 12 +- service/apigateway/api_op_GetDeployments.go | 10 +- .../apigateway/api_op_GetDocumentationPart.go | 18 +- .../api_op_GetDocumentationParts.go | 7 +- .../api_op_GetDocumentationVersion.go | 11 +- .../api_op_GetDocumentationVersions.go | 9 +- service/apigateway/api_op_GetDomainName.go | 35 +- service/apigateway/api_op_GetDomainNames.go | 3 +- service/apigateway/api_op_GetExport.go | 8 +- .../apigateway/api_op_GetGatewayResponse.go | 49 +- .../apigateway/api_op_GetGatewayResponses.go | 214 +---- service/apigateway/api_op_GetIntegration.go | 166 +--- .../api_op_GetIntegrationResponse.go | 26 +- service/apigateway/api_op_GetMethod.go | 170 +--- .../apigateway/api_op_GetMethodResponse.go | 36 +- service/apigateway/api_op_GetModel.go | 22 +- service/apigateway/api_op_GetModelTemplate.go | 12 +- service/apigateway/api_op_GetModels.go | 6 +- .../apigateway/api_op_GetRequestValidator.go | 13 +- .../apigateway/api_op_GetRequestValidators.go | 9 +- service/apigateway/api_op_GetResource.go | 87 +-- service/apigateway/api_op_GetResources.go | 5 +- service/apigateway/api_op_GetRestApi.go | 15 +- service/apigateway/api_op_GetRestApis.go | 4 +- service/apigateway/api_op_GetSdk.go | 8 +- service/apigateway/api_op_GetSdkType.go | 3 +- service/apigateway/api_op_GetSdkTypes.go | 1 + service/apigateway/api_op_GetStage.go | 7 +- service/apigateway/api_op_GetStages.go | 4 +- service/apigateway/api_op_GetTags.go | 2 +- service/apigateway/api_op_GetUsage.go | 11 +- service/apigateway/api_op_GetUsagePlan.go | 13 +- service/apigateway/api_op_GetUsagePlanKey.go | 14 +- service/apigateway/api_op_GetUsagePlanKeys.go | 9 +- service/apigateway/api_op_GetUsagePlans.go | 4 +- service/apigateway/api_op_GetVpcLink.go | 12 +- service/apigateway/api_op_GetVpcLinks.go | 6 +- service/apigateway/api_op_ImportApiKeys.go | 3 +- .../api_op_ImportDocumentationParts.go | 15 +- service/apigateway/api_op_ImportRestApi.go | 27 +- .../apigateway/api_op_PutGatewayResponse.go | 49 +- service/apigateway/api_op_PutIntegration.go | 243 ++---- .../api_op_PutIntegrationResponse.go | 43 +- service/apigateway/api_op_PutMethod.go | 176 +---- .../apigateway/api_op_PutMethodResponse.go | 36 +- service/apigateway/api_op_PutRestApi.go | 21 +- service/apigateway/api_op_TagResource.go | 8 +- .../apigateway/api_op_TestInvokeAuthorizer.go | 38 +- service/apigateway/api_op_TestInvokeMethod.go | 16 +- service/apigateway/api_op_UntagResource.go | 4 +- service/apigateway/api_op_UpdateAccount.go | 51 +- service/apigateway/api_op_UpdateApiKey.go | 9 +- service/apigateway/api_op_UpdateAuthorizer.go | 27 +- .../api_op_UpdateBasePathMapping.go | 15 +- .../api_op_UpdateClientCertificate.go | 12 +- service/apigateway/api_op_UpdateDeployment.go | 14 +- .../api_op_UpdateDocumentationPart.go | 22 +- .../api_op_UpdateDocumentationVersion.go | 15 +- service/apigateway/api_op_UpdateDomainName.go | 39 +- .../api_op_UpdateGatewayResponse.go | 53 +- .../apigateway/api_op_UpdateIntegration.go | 170 ++-- .../api_op_UpdateIntegrationResponse.go | 31 +- service/apigateway/api_op_UpdateMethod.go | 174 +---- .../apigateway/api_op_UpdateMethodResponse.go | 40 +- service/apigateway/api_op_UpdateModel.go | 26 +- .../api_op_UpdateRequestValidator.go | 17 +- service/apigateway/api_op_UpdateResource.go | 91 +-- service/apigateway/api_op_UpdateRestApi.go | 19 +- service/apigateway/api_op_UpdateStage.go | 11 +- service/apigateway/api_op_UpdateUsage.go | 15 +- service/apigateway/api_op_UpdateUsagePlan.go | 17 +- service/apigateway/api_op_UpdateVpcLink.go | 16 +- service/apigateway/types/types.go | 734 +++--------------- .../apprunner/api_op_CreateVpcConnector.go | 3 +- service/apprunner/types/types.go | 2 +- service/cloudformation/api_op_ActivateType.go | 4 +- .../cloudformation/api_op_CreateChangeSet.go | 6 +- .../cloudformation/api_op_CreateStackSet.go | 6 +- .../cloudformation/api_op_DeleteStackSet.go | 4 +- .../api_op_DescribePublisher.go | 2 +- ...pi_op_DescribeStackDriftDetectionStatus.go | 2 +- .../api_op_DescribeStackResourceDrifts.go | 4 +- service/cloudformation/api_op_DescribeType.go | 39 +- .../api_op_DetectStackSetDrift.go | 4 +- .../api_op_ImportStacksToStackSet.go | 2 +- .../api_op_ListStackInstances.go | 6 +- .../api_op_ListStackSetOperationResults.go | 2 +- .../api_op_ListTypeRegistrations.go | 4 +- service/cloudformation/api_op_ListTypes.go | 18 +- service/cloudformation/api_op_PublishType.go | 6 +- .../api_op_RegisterPublisher.go | 4 +- service/cloudformation/api_op_RegisterType.go | 29 +- service/cloudformation/api_op_UpdateStack.go | 6 +- .../cloudformation/api_op_UpdateStackSet.go | 4 +- service/cloudformation/deserializers.go | 26 + service/cloudformation/types/errors.go | 4 +- service/cloudformation/types/types.go | 45 +- service/fsx/api_op_UpdateFileSystem.go | 3 + service/fsx/deserializers.go | 86 ++ service/fsx/serializers.go | 44 ++ service/fsx/types/types.go | 61 +- .../lookoutmetrics/api_op_UpdateMetricSet.go | 2 +- service/lookoutmetrics/deserializers.go | 135 ++++ service/lookoutmetrics/serializers.go | 63 ++ service/lookoutmetrics/types/types.go | 56 +- service/lookoutmetrics/validators.go | 37 + service/sagemaker/api_op_CreateAutoMLJob.go | 12 +- .../sagemaker/api_op_CreateEndpointConfig.go | 2 +- .../sagemaker/api_op_CreateModelPackage.go | 6 +- .../sagemaker/api_op_CreateTransformJob.go | 22 +- service/sagemaker/api_op_DescribeEndpoint.go | 2 +- .../api_op_DescribeEndpointConfig.go | 2 +- service/sagemaker/deserializers.go | 45 ++ service/sagemaker/serializers.go | 19 + service/sagemaker/types/types.go | 92 ++- .../api_op_PutResourcePolicy.go | 3 +- service/sso/internal/endpoints/endpoints.go | 3 + service/voiceid/deserializers.go | 32 + service/voiceid/types/enums.go | 2 + service/voiceid/types/types.go | 8 + 175 files changed, 1644 insertions(+), 3302 deletions(-) create mode 100644 .changelog/08765fb0ccff45dd9878bc096857646e.json create mode 100644 .changelog/2477e8e4997d49e6a63c405fe91a61f0.json create mode 100644 .changelog/71a18f4173e3448193b49d160f5ce0d1.json create mode 100644 .changelog/953910cf7b26448d91fa2edf47f5d42a.json create mode 100644 .changelog/968b5011cc444325b267df3b6214882e.json create mode 100644 .changelog/b68b34be2e754b5faeb3a3b69edc3764.json create mode 100644 .changelog/dd2ac5637a6043eaba62e86196e0eab6.json create mode 100644 .changelog/ef89c8b747944999bff250980fdea235.json diff --git a/.changelog/08765fb0ccff45dd9878bc096857646e.json b/.changelog/08765fb0ccff45dd9878bc096857646e.json new file mode 100644 index 00000000000..4fd3cee5c7a --- /dev/null +++ b/.changelog/08765fb0ccff45dd9878bc096857646e.json @@ -0,0 +1,8 @@ +{ + "id": "08765fb0-ccff-45dd-9878-bc096857646e", + "type": "feature", + "description": "VoiceID will now automatically expire Speakers if they haven't been accessed for Enrollment, Re-enrollment or Successful Auth for three years. The Speaker APIs now return a \"LastAccessedAt\" time for Speakers, and the EvaluateSession API returns \"SPEAKER_EXPIRED\" Auth Decision for EXPIRED Speakers.", + "modules": [ + "service/voiceid" + ] +} \ No newline at end of file diff --git a/.changelog/2477e8e4997d49e6a63c405fe91a61f0.json b/.changelog/2477e8e4997d49e6a63c405fe91a61f0.json new file mode 100644 index 00000000000..97aa13e6522 --- /dev/null +++ b/.changelog/2477e8e4997d49e6a63c405fe91a61f0.json @@ -0,0 +1,8 @@ +{ + "id": "2477e8e4-997d-49e6-a63c-405fe91a61f0", + "type": "documentation", + "description": "Documentation updates for Amazon API Gateway", + "modules": [ + "service/apigateway" + ] +} \ No newline at end of file diff --git a/.changelog/71a18f4173e3448193b49d160f5ce0d1.json b/.changelog/71a18f4173e3448193b49d160f5ce0d1.json new file mode 100644 index 00000000000..1b3bc2eeb38 --- /dev/null +++ b/.changelog/71a18f4173e3448193b49d160f5ce0d1.json @@ -0,0 +1,8 @@ +{ + "id": "71a18f41-73e3-4481-93b4-9d160f5ce0d1", + "type": "documentation", + "description": "Documentation updates for Secrets Manager", + "modules": [ + "service/secretsmanager" + ] +} \ No newline at end of file diff --git a/.changelog/953910cf7b26448d91fa2edf47f5d42a.json b/.changelog/953910cf7b26448d91fa2edf47f5d42a.json new file mode 100644 index 00000000000..8ee8792d85a --- /dev/null +++ b/.changelog/953910cf7b26448d91fa2edf47f5d42a.json @@ -0,0 +1,8 @@ +{ + "id": "953910cf-7b26-448d-91fa-2edf47f5d42a", + "type": "feature", + "description": "Add a new parameter statusReason to DescribeStackSetOperation output for additional details", + "modules": [ + "service/cloudformation" + ] +} \ No newline at end of file diff --git a/.changelog/968b5011cc444325b267df3b6214882e.json b/.changelog/968b5011cc444325b267df3b6214882e.json new file mode 100644 index 00000000000..ee244b05c0e --- /dev/null +++ b/.changelog/968b5011cc444325b267df3b6214882e.json @@ -0,0 +1,8 @@ +{ + "id": "968b5011-cc44-4325-b267-df3b6214882e", + "type": "feature", + "description": "This release adds root squash support to FSx for Lustre to restrict root level access from clients by mapping root users to a less-privileged user/group with limited permissions.", + "modules": [ + "service/fsx" + ] +} \ No newline at end of file diff --git a/.changelog/b68b34be2e754b5faeb3a3b69edc3764.json b/.changelog/b68b34be2e754b5faeb3a3b69edc3764.json new file mode 100644 index 00000000000..affec990b4a --- /dev/null +++ b/.changelog/b68b34be2e754b5faeb3a3b69edc3764.json @@ -0,0 +1,8 @@ +{ + "id": "b68b34be-2e75-4b5f-aeb3-a3b69edc3764", + "type": "feature", + "description": "Adding AthenaSourceConfig for MetricSet APIs to support Athena as a data source.", + "modules": [ + "service/lookoutmetrics" + ] +} \ No newline at end of file diff --git a/.changelog/dd2ac5637a6043eaba62e86196e0eab6.json b/.changelog/dd2ac5637a6043eaba62e86196e0eab6.json new file mode 100644 index 00000000000..f7bf7f08e6a --- /dev/null +++ b/.changelog/dd2ac5637a6043eaba62e86196e0eab6.json @@ -0,0 +1,8 @@ +{ + "id": "dd2ac563-7a60-43ea-ba62-e86196e0eab6", + "type": "documentation", + "description": "Documentation-only update added for CodeConfiguration.", + "modules": [ + "service/apprunner" + ] +} \ No newline at end of file diff --git a/.changelog/ef89c8b747944999bff250980fdea235.json b/.changelog/ef89c8b747944999bff250980fdea235.json new file mode 100644 index 00000000000..ceaf1f7b78b --- /dev/null +++ b/.changelog/ef89c8b747944999bff250980fdea235.json @@ -0,0 +1,8 @@ +{ + "id": "ef89c8b7-4794-4999-bff2-50980fdea235", + "type": "feature", + "description": "Amazon SageMaker Autopilot adds support for manually selecting features from the input dataset using the CreateAutoMLJob API.", + "modules": [ + "service/sagemaker" + ] +} \ No newline at end of file diff --git a/service/apigateway/api_op_CreateApiKey.go b/service/apigateway/api_op_CreateApiKey.go index 37f1be9536c..f332623f9fa 100644 --- a/service/apigateway/api_op_CreateApiKey.go +++ b/service/apigateway/api_op_CreateApiKey.go @@ -12,8 +12,7 @@ import ( "time" ) -// Create an ApiKey resource. AWS CLI -// (https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html) +// Create an ApiKey resource. func (c *Client) CreateApiKey(ctx context.Context, params *CreateApiKeyInput, optFns ...func(*Options)) (*CreateApiKeyOutput, error) { if params == nil { params = &CreateApiKeyInput{} @@ -66,8 +65,7 @@ type CreateApiKeyInput struct { // 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) +// stage. type CreateApiKeyOutput struct { // The timestamp when the API Key was created. diff --git a/service/apigateway/api_op_CreateAuthorizer.go b/service/apigateway/api_op_CreateAuthorizer.go index 7e83901df39..4657610fb62 100644 --- a/service/apigateway/api_op_CreateAuthorizer.go +++ b/service/apigateway/api_op_CreateAuthorizer.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a new Authorizer resource to an existing RestApi resource. AWS CLI -// (https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html) +// Adds a new Authorizer resource to an existing RestApi resource. func (c *Client) CreateAuthorizer(ctx context.Context, params *CreateAuthorizerInput, optFns ...func(*Options)) (*CreateAuthorizerOutput, error) { if params == nil { params = &CreateAuthorizerInput{} @@ -31,20 +30,20 @@ func (c *Client) CreateAuthorizer(ctx context.Context, params *CreateAuthorizerI // Request to add a new Authorizer to an existing RestApi resource. type CreateAuthorizerInput struct { - // [Required] The name of the authorizer. + // The name of the authorizer. // // This member is required. Name *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [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. + // 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. // // This member is required. Type types.AuthorizerType @@ -77,15 +76,11 @@ type CreateAuthorizerInput struct { // /2015-03-31/functions/[FunctionARN]/invocations. AuthorizerUri *string - // The identity source for which authorization is requested. - // - // * For a TOKEN or + // 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 + // 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 @@ -120,11 +115,7 @@ type CreateAuthorizerInput struct { } // 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) +// Gateway will activate the authorizer when a client calls the method. type CreateAuthorizerOutput struct { // Optional customer-defined field, used in OpenAPI imports and exports without @@ -158,15 +149,11 @@ type CreateAuthorizerOutput struct { // The identifier for the authorizer resource. Id *string - // The identity source for which authorization is requested. - // - // * For a TOKEN or + // 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 + // 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 @@ -191,7 +178,7 @@ type CreateAuthorizerOutput struct { // apply to the REQUEST authorizer. IdentityValidationExpression *string - // [Required] The name of the authorizer. + // The name of the authorizer. Name *string // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS diff --git a/service/apigateway/api_op_CreateBasePathMapping.go b/service/apigateway/api_op_CreateBasePathMapping.go index bd8b8857590..107f4ffab3d 100644 --- a/service/apigateway/api_op_CreateBasePathMapping.go +++ b/service/apigateway/api_op_CreateBasePathMapping.go @@ -29,12 +29,12 @@ func (c *Client) CreateBasePathMapping(ctx context.Context, params *CreateBasePa // Requests API Gateway to create a new BasePathMapping resource. type CreateBasePathMappingInput struct { - // [Required] The domain name of the BasePathMapping resource to create. + // The domain name of the BasePathMapping resource to create. // // This member is required. DomainName *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -54,10 +54,7 @@ type CreateBasePathMappingInput struct { } // 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) +// after the domain name. type CreateBasePathMappingOutput struct { // The base path name that callers of the API must provide as part of the URL after diff --git a/service/apigateway/api_op_CreateDeployment.go b/service/apigateway/api_op_CreateDeployment.go index 7930f14a572..13721072827 100644 --- a/service/apigateway/api_op_CreateDeployment.go +++ b/service/apigateway/api_op_CreateDeployment.go @@ -32,7 +32,7 @@ func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentI // Requests API Gateway to create a Deployment resource. type CreateDeploymentInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -70,13 +70,7 @@ type CreateDeploymentInput struct { // 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/) +// over the Internet. type CreateDeploymentOutput struct { // A summary of the RestApi at the date and time that the deployment resource was diff --git a/service/apigateway/api_op_CreateDocumentationPart.go b/service/apigateway/api_op_CreateDocumentationPart.go index 578fc497e71..cdc2c22f3e2 100644 --- a/service/apigateway/api_op_CreateDocumentationPart.go +++ b/service/apigateway/api_op_CreateDocumentationPart.go @@ -11,6 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) +// Creates a documentation part. func (c *Client) CreateDocumentationPart(ctx context.Context, params *CreateDocumentationPartInput, optFns ...func(*Options)) (*CreateDocumentationPartOutput, error) { if params == nil { params = &CreateDocumentationPartInput{} @@ -29,20 +30,19 @@ func (c *Client) CreateDocumentationPart(ctx context.Context, params *CreateDocu // Creates a new documentation part of a given API. type CreateDocumentationPartInput struct { - // [Required] The location of the targeted API entity of the to-be-created - // documentation part. + // The location of the targeted API entity of the to-be-created documentation part. // // This member is required. Location *types.DocumentationPartLocation - // [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. + // 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. // // This member is required. Properties *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -50,18 +50,7 @@ type CreateDocumentationPartInput struct { noSmithyDocumentSerde } -// 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 +// A documentation part for a targeted API entity. type CreateDocumentationPartOutput struct { // The DocumentationPart identifier, generated by API Gateway when the diff --git a/service/apigateway/api_op_CreateDocumentationVersion.go b/service/apigateway/api_op_CreateDocumentationVersion.go index 3441d47c2d0..b2e085c4e28 100644 --- a/service/apigateway/api_op_CreateDocumentationVersion.go +++ b/service/apigateway/api_op_CreateDocumentationVersion.go @@ -11,6 +11,7 @@ import ( "time" ) +// Creates a documentation version func (c *Client) CreateDocumentationVersion(ctx context.Context, params *CreateDocumentationVersionInput, optFns ...func(*Options)) (*CreateDocumentationVersionOutput, error) { if params == nil { params = &CreateDocumentationVersionInput{} @@ -29,12 +30,12 @@ func (c *Client) CreateDocumentationVersion(ctx context.Context, params *CreateD // Creates a new documentation version of a given API. type CreateDocumentationVersionInput struct { - // [Required] The version identifier of the new snapshot. + // The version identifier of the new snapshot. // // This member is required. DocumentationVersion *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -48,11 +49,7 @@ type CreateDocumentationVersionInput struct { noSmithyDocumentSerde } -// 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 +// A snapshot of the documentation of an API. type CreateDocumentationVersionOutput struct { // The date when the API documentation snapshot is created. diff --git a/service/apigateway/api_op_CreateDomainName.go b/service/apigateway/api_op_CreateDomainName.go index 905643f316b..83956f452f8 100644 --- a/service/apigateway/api_op_CreateDomainName.go +++ b/service/apigateway/api_op_CreateDomainName.go @@ -31,7 +31,7 @@ func (c *Client) CreateDomainName(ctx context.Context, params *CreateDomainNameI // A request to create a new domain name. type CreateDomainNameInput struct { - // [Required] The name of the DomainName resource. + // The name of the DomainName resource. // // This member is required. DomainName *string @@ -67,9 +67,9 @@ type CreateDomainNameInput struct { // domain name. EndpointConfiguration *types.EndpointConfiguration - // If specified, API Gateway performs two-way authentication between the client and - // the server. Clients must present a trusted certificate to access your custom - // domain name. + // The mutual TLS authentication configuration for a custom domain name. If + // specified, API Gateway performs two-way authentication between the client and + // the server. Clients must present a trusted certificate to access your API. MutualTlsAuthentication *types.MutualTlsAuthenticationInput // The ARN of the public certificate issued by ACM to validate ownership of your @@ -99,16 +99,7 @@ type CreateDomainNameInput struct { } // 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) +// (RestApi). type CreateDomainNameOutput struct { // The reference to an AWS-managed certificate that will be used by edge-optimized @@ -128,24 +119,22 @@ type CreateDomainNameOutput struct { // 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/). + // CloudFront documentation. DistributionDomainName *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). + // information, see Set up a Regional Custom Domain Name and AWS Regions and + // Endpoints for API Gateway. DistributionHostedZoneId *string // The custom domain name as an API host name, for example, my-api.example.com. DomainName *string - // The status of the DomainName migration. The valid values are AVAILABLE, - // UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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. + // 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 types.DomainNameStatus // An optional text message containing detailed information about status of the @@ -181,10 +170,8 @@ type CreateDomainNameOutput struct { RegionalDomainName *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). + // more information, see Set up a Regional Custom Domain Name and AWS Regions and + // Endpoints for API Gateway. RegionalHostedZoneId *string // The Transport Layer Security (TLS) version + cipher suite for this DomainName. diff --git a/service/apigateway/api_op_CreateModel.go b/service/apigateway/api_op_CreateModel.go index 11ccf665067..5f397463dec 100644 --- a/service/apigateway/api_op_CreateModel.go +++ b/service/apigateway/api_op_CreateModel.go @@ -29,17 +29,17 @@ func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optF // Request to add a new Model to an existing RestApi resource. type CreateModelInput struct { - // [Required] The content-type for the model. + // The content-type for the model. // // This member is required. ContentType *string - // [Required] The name of the model. Must be alphanumeric. + // The name of the model. Must be alphanumeric. // // This member is required. Name *string - // [Required] The RestApi identifier under which the Model will be created. + // The RestApi identifier under which the Model will be created. // // This member is required. RestApiId *string @@ -48,20 +48,13 @@ type CreateModelInput struct { Description *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. + // schema draft 4 model. Schema *string noSmithyDocumentSerde } -// 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) +// Represents the data structure of a method's request or response payload. type CreateModelOutput struct { // The content-type for the model. @@ -77,11 +70,10 @@ type CreateModelOutput struct { Name *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 draft 4 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 // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_CreateRequestValidator.go b/service/apigateway/api_op_CreateRequestValidator.go index 8eee9b33d5e..8eae98907ee 100644 --- a/service/apigateway/api_op_CreateRequestValidator.go +++ b/service/apigateway/api_op_CreateRequestValidator.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a ReqeustValidator of a given RestApi. +// Creates a RequestValidator of a given RestApi. func (c *Client) CreateRequestValidator(ctx context.Context, params *CreateRequestValidatorInput, optFns ...func(*Options)) (*CreateRequestValidatorOutput, error) { if params == nil { params = &CreateRequestValidatorInput{} @@ -29,7 +29,7 @@ func (c *Client) CreateRequestValidator(ctx context.Context, params *CreateReque // Creates a RequestValidator of a given RestApi. type CreateRequestValidatorInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -48,14 +48,7 @@ type CreateRequestValidatorInput struct { noSmithyDocumentSerde } -// 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) +// A set of validation rules for incoming Method requests. type CreateRequestValidatorOutput struct { // The identifier of this RequestValidator. diff --git a/service/apigateway/api_op_CreateResource.go b/service/apigateway/api_op_CreateResource.go index bcb96d970ef..c8e8a1211bd 100644 --- a/service/apigateway/api_op_CreateResource.go +++ b/service/apigateway/api_op_CreateResource.go @@ -30,7 +30,7 @@ func (c *Client) CreateResource(ctx context.Context, params *CreateResourceInput // Requests API Gateway to create a Resource resource. type CreateResourceInput struct { - // [Required] The parent resource's identifier. + // The parent resource's identifier. // // This member is required. ParentId *string @@ -40,7 +40,7 @@ type CreateResourceInput struct { // This member is required. PathPart *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -48,8 +48,7 @@ type CreateResourceInput struct { noSmithyDocumentSerde } -// Represents an API resource. Create an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +// Represents an API resource. type CreateResourceOutput struct { // The resource's identifier. @@ -64,85 +63,7 @@ type CreateResourceOutput struct { // The last path segment for this resource. PathPart *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. + // Gets an API resource's method of a given HTTP verb. ResourceMethods map[string]types.Method // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_CreateRestApi.go b/service/apigateway/api_op_CreateRestApi.go index dc6a942eebe..40dd5b4274c 100644 --- a/service/apigateway/api_op_CreateRestApi.go +++ b/service/apigateway/api_op_CreateRestApi.go @@ -31,19 +31,15 @@ func (c *Client) CreateRestApi(ctx context.Context, params *CreateRestApiInput, // The POST Request to add a new RestApi resource to your collection. type CreateRestApiInput struct { - // [Required] The name of the RestApi. + // The name of the RestApi. // // This member is required. Name *string // 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. + // 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 types.ApiKeySourceType // The list of binary media types supported by the RestApi. By default, the RestApi @@ -60,7 +56,7 @@ type CreateRestApiInput struct { // endpoint. By default, clients can invoke your API with the default // https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that // clients use a custom domain name to invoke your API, disable the default - // endpoint. + // endpoint DisableExecuteApiEndpoint bool // The endpoint configuration of this RestApi showing the endpoint types of the @@ -89,18 +85,13 @@ type CreateRestApiInput struct { noSmithyDocumentSerde } -// Represents a REST API. Create an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +// Represents a REST API. 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. + // 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 types.ApiKeySourceType // The list of binary media types supported by the RestApi. By default, the RestApi diff --git a/service/apigateway/api_op_CreateStage.go b/service/apigateway/api_op_CreateStage.go index d59d05f499a..07664adca19 100644 --- a/service/apigateway/api_op_CreateStage.go +++ b/service/apigateway/api_op_CreateStage.go @@ -32,19 +32,18 @@ func (c *Client) CreateStage(ctx context.Context, params *CreateStageInput, optF // Requests API Gateway to create a Stage resource. type CreateStageInput struct { - // [Required] The identifier of the Deployment resource for the Stage resource. + // The identifier of the Deployment resource for the Stage resource. // // This member is required. DeploymentId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] The name for the Stage resource. Stage names can only contain - // alphanumeric characters, hyphens, and underscores. Maximum length is 128 - // characters. + // The name for the Stage resource. Stage names can only contain alphanumeric + // characters, hyphens, and underscores. Maximum length is 128 characters. // // This member is required. StageName *string @@ -81,8 +80,7 @@ type CreateStageInput struct { } // 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) +// callable by users. type CreateStageOutput struct { // Settings for logging access in this stage. diff --git a/service/apigateway/api_op_CreateUsagePlan.go b/service/apigateway/api_op_CreateUsagePlan.go index 9b6927a20cc..5709e68e93c 100644 --- a/service/apigateway/api_op_CreateUsagePlan.go +++ b/service/apigateway/api_op_CreateUsagePlan.go @@ -33,7 +33,7 @@ func (c *Client) CreateUsagePlan(ctx context.Context, params *CreateUsagePlanInp // payload. type CreateUsagePlanInput struct { - // [Required] The name of the usage plan. + // The name of the usage plan. // // This member is required. Name *string @@ -61,14 +61,11 @@ type CreateUsagePlanInput struct { // Represents a usage plan used to specify who can assess associated API stages. // Optionally, target request rate and quota limits can be set. In some cases // clients can exceed the targets that you set. Don’t rely on usage plans to -// control costs. Consider using AWS Budgets +// control costs. Consider using Amazon Web Services Budgets // (https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) -// to monitor costs and AWS WAF +// to monitor costs and WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to -// manage API requests. 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) +// manage API requests. type CreateUsagePlanOutput struct { // The associated API stages of a usage plan. @@ -93,7 +90,7 @@ type CreateUsagePlanOutput struct { // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string - // Map containing method level throttling information for API stage in a usage + // A map containing method level throttling information for API stage in a usage // plan. Throttle *types.ThrottleSettings diff --git a/service/apigateway/api_op_CreateUsagePlanKey.go b/service/apigateway/api_op_CreateUsagePlanKey.go index 36b6e6b971d..3b9c6bbc806 100644 --- a/service/apigateway/api_op_CreateUsagePlanKey.go +++ b/service/apigateway/api_op_CreateUsagePlanKey.go @@ -30,18 +30,18 @@ func (c *Client) CreateUsagePlanKey(ctx context.Context, params *CreateUsagePlan // usage plan. type CreateUsagePlanKeyInput struct { - // [Required] The identifier of a UsagePlanKey resource for a plan customer. + // The identifier of a UsagePlanKey resource for a plan customer. // // This member is required. KeyId *string - // [Required] The type of a UsagePlanKey resource for a plan customer. + // The type of a UsagePlanKey resource for a plan customer. // // This member is required. KeyType *string - // [Required] The Id of the UsagePlan resource representing the usage plan - // containing the to-be-created UsagePlanKey resource representing a plan customer. + // The Id of the UsagePlan resource representing the usage plan containing the + // to-be-created UsagePlanKey resource representing a plan customer. // // This member is required. UsagePlanId *string @@ -49,10 +49,7 @@ type CreateUsagePlanKeyInput struct { noSmithyDocumentSerde } -// 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) +// Represents a usage plan key to identify a plan customer. type CreateUsagePlanKeyOutput struct { // The Id of a usage plan key. diff --git a/service/apigateway/api_op_CreateVpcLink.go b/service/apigateway/api_op_CreateVpcLink.go index 09253ba7cf3..45dd09c5a49 100644 --- a/service/apigateway/api_op_CreateVpcLink.go +++ b/service/apigateway/api_op_CreateVpcLink.go @@ -36,14 +36,13 @@ func (c *Client) CreateVpcLink(ctx context.Context, params *CreateVpcLinkInput, // services. type CreateVpcLinkInput struct { - // [Required] The name used to label and identify the VPC link. + // The name used to label and identify the VPC link. // // This member is required. Name *string - // [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. + // 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. // // This member is required. TargetArns []string @@ -60,13 +59,7 @@ type CreateVpcLinkInput struct { } // 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. +// Private Cloud (VPC). type CreateVpcLinkOutput struct { // The description of the VPC link. diff --git a/service/apigateway/api_op_DeleteApiKey.go b/service/apigateway/api_op_DeleteApiKey.go index 4776773fbb8..58852b23dfd 100644 --- a/service/apigateway/api_op_DeleteApiKey.go +++ b/service/apigateway/api_op_DeleteApiKey.go @@ -29,7 +29,7 @@ func (c *Client) DeleteApiKey(ctx context.Context, params *DeleteApiKeyInput, op // A request to delete the ApiKey resource. type DeleteApiKeyInput struct { - // [Required] The identifier of the ApiKey resource to be deleted. + // The identifier of the ApiKey resource to be deleted. // // This member is required. ApiKey *string diff --git a/service/apigateway/api_op_DeleteAuthorizer.go b/service/apigateway/api_op_DeleteAuthorizer.go index 589c07ac7df..0feaf35bf80 100644 --- a/service/apigateway/api_op_DeleteAuthorizer.go +++ b/service/apigateway/api_op_DeleteAuthorizer.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing Authorizer resource. AWS CLI -// (https://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html) +// Deletes an existing Authorizer resource. func (c *Client) DeleteAuthorizer(ctx context.Context, params *DeleteAuthorizerInput, optFns ...func(*Options)) (*DeleteAuthorizerOutput, error) { if params == nil { params = &DeleteAuthorizerInput{} @@ -30,12 +29,12 @@ func (c *Client) DeleteAuthorizer(ctx context.Context, params *DeleteAuthorizerI // Request to delete an existing Authorizer resource. type DeleteAuthorizerInput struct { - // [Required] The identifier of the Authorizer resource. + // The identifier of the Authorizer resource. // // This member is required. AuthorizerId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string diff --git a/service/apigateway/api_op_DeleteBasePathMapping.go b/service/apigateway/api_op_DeleteBasePathMapping.go index bc137b43948..f2b940fd75c 100644 --- a/service/apigateway/api_op_DeleteBasePathMapping.go +++ b/service/apigateway/api_op_DeleteBasePathMapping.go @@ -29,13 +29,13 @@ func (c *Client) DeleteBasePathMapping(ctx context.Context, params *DeleteBasePa // A request to delete the BasePathMapping resource. 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)'. + // The base path name of the BasePathMapping resource to delete. To specify an + // empty base path, set this parameter to '(none)'. // // This member is required. BasePath *string - // [Required] The domain name of the BasePathMapping resource to delete. + // The domain name of the BasePathMapping resource to delete. // // This member is required. DomainName *string diff --git a/service/apigateway/api_op_DeleteClientCertificate.go b/service/apigateway/api_op_DeleteClientCertificate.go index 1dc17fd866b..5127d5a4c1e 100644 --- a/service/apigateway/api_op_DeleteClientCertificate.go +++ b/service/apigateway/api_op_DeleteClientCertificate.go @@ -29,7 +29,7 @@ func (c *Client) DeleteClientCertificate(ctx context.Context, params *DeleteClie // A request to delete the ClientCertificate resource. type DeleteClientCertificateInput struct { - // [Required] The identifier of the ClientCertificate resource to be deleted. + // The identifier of the ClientCertificate resource to be deleted. // // This member is required. ClientCertificateId *string diff --git a/service/apigateway/api_op_DeleteDeployment.go b/service/apigateway/api_op_DeleteDeployment.go index 6403902896d..19af9c4fa33 100644 --- a/service/apigateway/api_op_DeleteDeployment.go +++ b/service/apigateway/api_op_DeleteDeployment.go @@ -30,12 +30,12 @@ func (c *Client) DeleteDeployment(ctx context.Context, params *DeleteDeploymentI // Requests API Gateway to delete a Deployment resource. type DeleteDeploymentInput struct { - // [Required] The identifier of the Deployment resource to delete. + // The identifier of the Deployment resource to delete. // // This member is required. DeploymentId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string diff --git a/service/apigateway/api_op_DeleteDocumentationPart.go b/service/apigateway/api_op_DeleteDocumentationPart.go index ad1f130ef9a..c762ab1cd3d 100644 --- a/service/apigateway/api_op_DeleteDocumentationPart.go +++ b/service/apigateway/api_op_DeleteDocumentationPart.go @@ -10,6 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) +// Deletes a documentation part func (c *Client) DeleteDocumentationPart(ctx context.Context, params *DeleteDocumentationPartInput, optFns ...func(*Options)) (*DeleteDocumentationPartOutput, error) { if params == nil { params = &DeleteDocumentationPartInput{} @@ -28,12 +29,12 @@ func (c *Client) DeleteDocumentationPart(ctx context.Context, params *DeleteDocu // Deletes an existing documentation part of an API. type DeleteDocumentationPartInput struct { - // [Required] The identifier of the to-be-deleted documentation part. + // The identifier of the to-be-deleted documentation part. // // This member is required. DocumentationPartId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string diff --git a/service/apigateway/api_op_DeleteDocumentationVersion.go b/service/apigateway/api_op_DeleteDocumentationVersion.go index 368cd11167c..48a10460202 100644 --- a/service/apigateway/api_op_DeleteDocumentationVersion.go +++ b/service/apigateway/api_op_DeleteDocumentationVersion.go @@ -10,6 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) +// Deletes a documentation version. func (c *Client) DeleteDocumentationVersion(ctx context.Context, params *DeleteDocumentationVersionInput, optFns ...func(*Options)) (*DeleteDocumentationVersionOutput, error) { if params == nil { params = &DeleteDocumentationVersionInput{} @@ -28,12 +29,12 @@ func (c *Client) DeleteDocumentationVersion(ctx context.Context, params *DeleteD // Deletes an existing documentation version of an API. type DeleteDocumentationVersionInput struct { - // [Required] The version identifier of a to-be-deleted documentation snapshot. + // The version identifier of a to-be-deleted documentation snapshot. // // This member is required. DocumentationVersion *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string diff --git a/service/apigateway/api_op_DeleteDomainName.go b/service/apigateway/api_op_DeleteDomainName.go index 36ff2dc7006..b447880b1a4 100644 --- a/service/apigateway/api_op_DeleteDomainName.go +++ b/service/apigateway/api_op_DeleteDomainName.go @@ -29,7 +29,7 @@ func (c *Client) DeleteDomainName(ctx context.Context, params *DeleteDomainNameI // A request to delete the DomainName resource. type DeleteDomainNameInput struct { - // [Required] The name of the DomainName resource to be deleted. + // The name of the DomainName resource to be deleted. // // This member is required. DomainName *string diff --git a/service/apigateway/api_op_DeleteGatewayResponse.go b/service/apigateway/api_op_DeleteGatewayResponse.go index 7bebedbbf30..2fcac28fd2c 100644 --- a/service/apigateway/api_op_DeleteGatewayResponse.go +++ b/service/apigateway/api_op_DeleteGatewayResponse.go @@ -32,12 +32,12 @@ func (c *Client) DeleteGatewayResponse(ctx context.Context, params *DeleteGatewa // the given RestApi and resets it with the default settings. type DeleteGatewayResponseInput struct { - // [Required] The response type of the associated GatewayResponse. + // The response type of the associated GatewayResponse. // // This member is required. ResponseType types.GatewayResponseType - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string diff --git a/service/apigateway/api_op_DeleteIntegration.go b/service/apigateway/api_op_DeleteIntegration.go index da5b84c0836..31b6a78ac02 100644 --- a/service/apigateway/api_op_DeleteIntegration.go +++ b/service/apigateway/api_op_DeleteIntegration.go @@ -29,17 +29,17 @@ func (c *Client) DeleteIntegration(ctx context.Context, params *DeleteIntegratio // Represents a delete integration request. type DeleteIntegrationInput struct { - // [Required] Specifies a delete integration request's HTTP method. + // Specifies a delete integration request's HTTP method. // // This member is required. HttpMethod *string - // [Required] Specifies a delete integration request's resource identifier. + // Specifies a delete integration request's resource identifier. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string diff --git a/service/apigateway/api_op_DeleteIntegrationResponse.go b/service/apigateway/api_op_DeleteIntegrationResponse.go index 9c99881c38d..623b82ce7eb 100644 --- a/service/apigateway/api_op_DeleteIntegrationResponse.go +++ b/service/apigateway/api_op_DeleteIntegrationResponse.go @@ -29,23 +29,22 @@ func (c *Client) DeleteIntegrationResponse(ctx context.Context, params *DeleteIn // Represents a delete integration response request. type DeleteIntegrationResponseInput struct { - // [Required] Specifies a delete integration response request's HTTP method. + // Specifies a delete integration response request's HTTP method. // // This member is required. HttpMethod *string - // [Required] Specifies a delete integration response request's resource - // identifier. + // Specifies a delete integration response request's resource identifier. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] Specifies a delete integration response request's status code. + // Specifies a delete integration response request's status code. // // This member is required. StatusCode *string diff --git a/service/apigateway/api_op_DeleteMethod.go b/service/apigateway/api_op_DeleteMethod.go index 059dd81a19e..8e8b38b1f52 100644 --- a/service/apigateway/api_op_DeleteMethod.go +++ b/service/apigateway/api_op_DeleteMethod.go @@ -29,17 +29,17 @@ func (c *Client) DeleteMethod(ctx context.Context, params *DeleteMethodInput, op // Request to delete an existing Method resource. type DeleteMethodInput struct { - // [Required] The HTTP verb of the Method resource. + // The HTTP verb of the Method resource. // // This member is required. HttpMethod *string - // [Required] The Resource identifier for the Method resource. + // The Resource identifier for the Method resource. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string diff --git a/service/apigateway/api_op_DeleteMethodResponse.go b/service/apigateway/api_op_DeleteMethodResponse.go index cd4870e84e4..0b4ecaa571e 100644 --- a/service/apigateway/api_op_DeleteMethodResponse.go +++ b/service/apigateway/api_op_DeleteMethodResponse.go @@ -29,22 +29,22 @@ func (c *Client) DeleteMethodResponse(ctx context.Context, params *DeleteMethodR // A request to delete an existing MethodResponse resource. type DeleteMethodResponseInput struct { - // [Required] The HTTP verb of the Method resource. + // The HTTP verb of the Method resource. // // This member is required. HttpMethod *string - // [Required] The Resource identifier for the MethodResponse resource. + // The Resource identifier for the MethodResponse resource. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] The status code identifier for the MethodResponse resource. + // The status code identifier for the MethodResponse resource. // // This member is required. StatusCode *string diff --git a/service/apigateway/api_op_DeleteModel.go b/service/apigateway/api_op_DeleteModel.go index fcad3baaf46..c523a9f1949 100644 --- a/service/apigateway/api_op_DeleteModel.go +++ b/service/apigateway/api_op_DeleteModel.go @@ -29,12 +29,12 @@ func (c *Client) DeleteModel(ctx context.Context, params *DeleteModelInput, optF // Request to delete an existing model in an existing RestApi resource. type DeleteModelInput struct { - // [Required] The name of the model to delete. + // The name of the model to delete. // // This member is required. ModelName *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string diff --git a/service/apigateway/api_op_DeleteRequestValidator.go b/service/apigateway/api_op_DeleteRequestValidator.go index 72aabcbb8b5..83ac1366a0c 100644 --- a/service/apigateway/api_op_DeleteRequestValidator.go +++ b/service/apigateway/api_op_DeleteRequestValidator.go @@ -29,12 +29,12 @@ func (c *Client) DeleteRequestValidator(ctx context.Context, params *DeleteReque // Deletes a specified RequestValidator of a given RestApi. type DeleteRequestValidatorInput struct { - // [Required] The identifier of the RequestValidator to be deleted. + // The identifier of the RequestValidator to be deleted. // // This member is required. RequestValidatorId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string diff --git a/service/apigateway/api_op_DeleteResource.go b/service/apigateway/api_op_DeleteResource.go index 58de5ffef21..cc36aa5cc83 100644 --- a/service/apigateway/api_op_DeleteResource.go +++ b/service/apigateway/api_op_DeleteResource.go @@ -29,12 +29,12 @@ func (c *Client) DeleteResource(ctx context.Context, params *DeleteResourceInput // Request to delete a Resource. type DeleteResourceInput struct { - // [Required] The identifier of the Resource resource. + // The identifier of the Resource resource. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string diff --git a/service/apigateway/api_op_DeleteRestApi.go b/service/apigateway/api_op_DeleteRestApi.go index 4814e6728c9..15bd68fbbeb 100644 --- a/service/apigateway/api_op_DeleteRestApi.go +++ b/service/apigateway/api_op_DeleteRestApi.go @@ -29,7 +29,7 @@ func (c *Client) DeleteRestApi(ctx context.Context, params *DeleteRestApiInput, // Request to delete the specified API from your collection. type DeleteRestApiInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string diff --git a/service/apigateway/api_op_DeleteStage.go b/service/apigateway/api_op_DeleteStage.go index 18e7d431970..16a86bbbdf2 100644 --- a/service/apigateway/api_op_DeleteStage.go +++ b/service/apigateway/api_op_DeleteStage.go @@ -29,12 +29,12 @@ func (c *Client) DeleteStage(ctx context.Context, params *DeleteStageInput, optF // Requests API Gateway to delete a Stage resource. type DeleteStageInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] The name of the Stage resource to delete. + // The name of the Stage resource to delete. // // This member is required. StageName *string diff --git a/service/apigateway/api_op_DeleteUsagePlan.go b/service/apigateway/api_op_DeleteUsagePlan.go index 0014c60fb2f..6c21251fbcc 100644 --- a/service/apigateway/api_op_DeleteUsagePlan.go +++ b/service/apigateway/api_op_DeleteUsagePlan.go @@ -29,7 +29,7 @@ func (c *Client) DeleteUsagePlan(ctx context.Context, params *DeleteUsagePlanInp // The DELETE request to delete a usage plan of a given plan Id. type DeleteUsagePlanInput struct { - // [Required] The Id of the to-be-deleted usage plan. + // The Id of the to-be-deleted usage plan. // // This member is required. UsagePlanId *string diff --git a/service/apigateway/api_op_DeleteUsagePlanKey.go b/service/apigateway/api_op_DeleteUsagePlanKey.go index 0f52edfc810..8bb0785df19 100644 --- a/service/apigateway/api_op_DeleteUsagePlanKey.go +++ b/service/apigateway/api_op_DeleteUsagePlanKey.go @@ -31,13 +31,13 @@ func (c *Client) DeleteUsagePlanKey(ctx context.Context, params *DeleteUsagePlan // from the associated usage plan. type DeleteUsagePlanKeyInput struct { - // [Required] The Id of the UsagePlanKey resource to be deleted. + // The Id of the UsagePlanKey resource to be deleted. // // This member is required. KeyId *string - // [Required] The Id of the UsagePlan resource representing the usage plan - // containing the to-be-deleted UsagePlanKey resource representing a plan customer. + // The Id of the UsagePlan resource representing the usage plan containing the + // to-be-deleted UsagePlanKey resource representing a plan customer. // // This member is required. UsagePlanId *string diff --git a/service/apigateway/api_op_DeleteVpcLink.go b/service/apigateway/api_op_DeleteVpcLink.go index 7feed8798e0..855b503114f 100644 --- a/service/apigateway/api_op_DeleteVpcLink.go +++ b/service/apigateway/api_op_DeleteVpcLink.go @@ -29,8 +29,8 @@ func (c *Client) DeleteVpcLink(ctx context.Context, params *DeleteVpcLinkInput, // Deletes an existing VpcLink of a specified identifier. type DeleteVpcLinkInput struct { - // [Required] The identifier of the VpcLink. It is used in an Integration to - // reference this VpcLink. + // The identifier of the VpcLink. It is used in an Integration to reference this + // VpcLink. // // This member is required. VpcLinkId *string diff --git a/service/apigateway/api_op_FlushStageCache.go b/service/apigateway/api_op_FlushStageCache.go index 3001073a2a7..a03c6e547d1 100644 --- a/service/apigateway/api_op_FlushStageCache.go +++ b/service/apigateway/api_op_FlushStageCache.go @@ -29,12 +29,12 @@ func (c *Client) FlushStageCache(ctx context.Context, params *FlushStageCacheInp // Requests API Gateway to flush a stage's cache. type FlushStageCacheInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] The name of the stage to flush its cache. + // The name of the stage to flush its cache. // // This member is required. StageName *string diff --git a/service/apigateway/api_op_GenerateClientCertificate.go b/service/apigateway/api_op_GenerateClientCertificate.go index e4d32a1b977..62264a2384d 100644 --- a/service/apigateway/api_op_GenerateClientCertificate.go +++ b/service/apigateway/api_op_GenerateClientCertificate.go @@ -42,11 +42,7 @@ type GenerateClientCertificateInput struct { } // 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) +// while sending requests to the integration endpoint. type GenerateClientCertificateOutput struct { // The identifier of the client certificate. diff --git a/service/apigateway/api_op_GetAccount.go b/service/apigateway/api_op_GetAccount.go index c5873a4ab59..b5290ed75a3 100644 --- a/service/apigateway/api_op_GetAccount.go +++ b/service/apigateway/api_op_GetAccount.go @@ -32,52 +32,7 @@ type GetAccountInput struct { noSmithyDocumentSerde } -// 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) +// Represents an AWS account that is associated with API Gateway. type GetAccountOutput struct { // The version of the API keys used for the account. diff --git a/service/apigateway/api_op_GetApiKey.go b/service/apigateway/api_op_GetApiKey.go index 2aa4a2e0c66..c7cb479f382 100644 --- a/service/apigateway/api_op_GetApiKey.go +++ b/service/apigateway/api_op_GetApiKey.go @@ -30,7 +30,7 @@ func (c *Client) GetApiKey(ctx context.Context, params *GetApiKeyInput, optFns . // A request to get information about the current ApiKey resource. type GetApiKeyInput struct { - // [Required] The identifier of the ApiKey resource. + // The identifier of the ApiKey resource. // // This member is required. ApiKey *string @@ -45,8 +45,7 @@ type GetApiKeyInput struct { // 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) +// stage. type GetApiKeyOutput struct { // The timestamp when the API Key was created. diff --git a/service/apigateway/api_op_GetApiKeys.go b/service/apigateway/api_op_GetApiKeys.go index f901bf15e5d..1a29a2de221 100644 --- a/service/apigateway/api_op_GetApiKeys.go +++ b/service/apigateway/api_op_GetApiKeys.go @@ -52,9 +52,7 @@ type GetApiKeysInput struct { noSmithyDocumentSerde } -// 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) +// Represents a collection of API keys as represented by an ApiKeys resource. type GetApiKeysOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetAuthorizer.go b/service/apigateway/api_op_GetAuthorizer.go index 734ac776293..a248e4999bc 100644 --- a/service/apigateway/api_op_GetAuthorizer.go +++ b/service/apigateway/api_op_GetAuthorizer.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describe an existing Authorizer resource. AWS CLI -// (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html) +// Describe an existing Authorizer resource. func (c *Client) GetAuthorizer(ctx context.Context, params *GetAuthorizerInput, optFns ...func(*Options)) (*GetAuthorizerOutput, error) { if params == nil { params = &GetAuthorizerInput{} @@ -31,12 +30,12 @@ func (c *Client) GetAuthorizer(ctx context.Context, params *GetAuthorizerInput, // Request to describe an existing Authorizer resource. type GetAuthorizerInput struct { - // [Required] The identifier of the Authorizer resource. + // The identifier of the Authorizer resource. // // This member is required. AuthorizerId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -45,11 +44,7 @@ type GetAuthorizerInput struct { } // 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) +// Gateway will activate the authorizer when a client calls the method. type GetAuthorizerOutput struct { // Optional customer-defined field, used in OpenAPI imports and exports without @@ -83,15 +78,11 @@ type GetAuthorizerOutput struct { // The identifier for the authorizer resource. Id *string - // The identity source for which authorization is requested. - // - // * For a TOKEN or + // 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 + // 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 @@ -116,7 +107,7 @@ type GetAuthorizerOutput struct { // apply to the REQUEST authorizer. IdentityValidationExpression *string - // [Required] The name of the authorizer. + // The name of the authorizer. Name *string // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS diff --git a/service/apigateway/api_op_GetAuthorizers.go b/service/apigateway/api_op_GetAuthorizers.go index faf944b0401..b6a23ef631d 100644 --- a/service/apigateway/api_op_GetAuthorizers.go +++ b/service/apigateway/api_op_GetAuthorizers.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describe an existing Authorizers resource. AWS CLI -// (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html) +// Describe an existing Authorizers resource. func (c *Client) GetAuthorizers(ctx context.Context, params *GetAuthorizersInput, optFns ...func(*Options)) (*GetAuthorizersOutput, error) { if params == nil { params = &GetAuthorizersInput{} @@ -31,7 +30,7 @@ func (c *Client) GetAuthorizers(ctx context.Context, params *GetAuthorizersInput // Request to describe an existing Authorizers resource. type GetAuthorizersInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -46,11 +45,7 @@ type GetAuthorizersInput struct { noSmithyDocumentSerde } -// 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) +// Represents a collection of Authorizer resources. type GetAuthorizersOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetBasePathMapping.go b/service/apigateway/api_op_GetBasePathMapping.go index c36d3ab5b57..debbfce9825 100644 --- a/service/apigateway/api_op_GetBasePathMapping.go +++ b/service/apigateway/api_op_GetBasePathMapping.go @@ -29,15 +29,15 @@ func (c *Client) GetBasePathMapping(ctx context.Context, params *GetBasePathMapp // Request to describe a BasePathMapping resource. 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. + // 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. // // This member is required. BasePath *string - // [Required] The domain name of the BasePathMapping resource to be described. + // The domain name of the BasePathMapping resource to be described. // // This member is required. DomainName *string @@ -46,10 +46,7 @@ type GetBasePathMappingInput struct { } // 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) +// after the domain name. type GetBasePathMappingOutput struct { // The base path name that callers of the API must provide as part of the URL after diff --git a/service/apigateway/api_op_GetBasePathMappings.go b/service/apigateway/api_op_GetBasePathMappings.go index 01732fc8765..a7f144e15e4 100644 --- a/service/apigateway/api_op_GetBasePathMappings.go +++ b/service/apigateway/api_op_GetBasePathMappings.go @@ -31,7 +31,7 @@ func (c *Client) GetBasePathMappings(ctx context.Context, params *GetBasePathMap // A request to get information about a collection of BasePathMapping resources. type GetBasePathMappingsInput struct { - // [Required] The domain name of a BasePathMapping resource. + // The domain name of a BasePathMapping resource. // // This member is required. DomainName *string @@ -46,8 +46,7 @@ type GetBasePathMappingsInput struct { noSmithyDocumentSerde } -// Represents a collection of BasePathMapping resources. Use Custom Domain Names -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) +// Represents a collection of BasePathMapping resources. type GetBasePathMappingsOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetClientCertificate.go b/service/apigateway/api_op_GetClientCertificate.go index de8a3e37245..624dca7b99b 100644 --- a/service/apigateway/api_op_GetClientCertificate.go +++ b/service/apigateway/api_op_GetClientCertificate.go @@ -30,7 +30,7 @@ func (c *Client) GetClientCertificate(ctx context.Context, params *GetClientCert // A request to get information about the current ClientCertificate resource. type GetClientCertificateInput struct { - // [Required] The identifier of the ClientCertificate resource to be described. + // The identifier of the ClientCertificate resource to be described. // // This member is required. ClientCertificateId *string @@ -39,11 +39,7 @@ type GetClientCertificateInput struct { } // 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) +// while sending requests to the integration endpoint. type GetClientCertificateOutput struct { // The identifier of the client certificate. diff --git a/service/apigateway/api_op_GetClientCertificates.go b/service/apigateway/api_op_GetClientCertificates.go index 9350bef57c6..7308a8af97b 100644 --- a/service/apigateway/api_op_GetClientCertificates.go +++ b/service/apigateway/api_op_GetClientCertificates.go @@ -41,9 +41,7 @@ type GetClientCertificatesInput struct { noSmithyDocumentSerde } -// 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) +// Represents a collection of ClientCertificate resources. type GetClientCertificatesOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetDeployment.go b/service/apigateway/api_op_GetDeployment.go index df39bc857d5..7d28274e8c8 100644 --- a/service/apigateway/api_op_GetDeployment.go +++ b/service/apigateway/api_op_GetDeployment.go @@ -31,12 +31,12 @@ func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, // Requests API Gateway to get information about a Deployment resource. type GetDeploymentInput struct { - // [Required] The identifier of the Deployment resource to get information about. + // The identifier of the Deployment resource to get information about. // // This member is required. DeploymentId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -57,13 +57,7 @@ type GetDeploymentInput struct { // 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/) +// over the Internet. type GetDeploymentOutput struct { // A summary of the RestApi at the date and time that the deployment resource was diff --git a/service/apigateway/api_op_GetDeployments.go b/service/apigateway/api_op_GetDeployments.go index 1a8a102c4a3..463b065d686 100644 --- a/service/apigateway/api_op_GetDeployments.go +++ b/service/apigateway/api_op_GetDeployments.go @@ -31,7 +31,7 @@ func (c *Client) GetDeployments(ctx context.Context, params *GetDeploymentsInput // Requests API Gateway to get information about a Deployments collection. type GetDeploymentsInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -49,14 +49,6 @@ type GetDeploymentsInput struct { // 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/) type GetDeploymentsOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetDocumentationPart.go b/service/apigateway/api_op_GetDocumentationPart.go index 8294b34acae..bb7d86d02ae 100644 --- a/service/apigateway/api_op_GetDocumentationPart.go +++ b/service/apigateway/api_op_GetDocumentationPart.go @@ -11,6 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) +// Gets a documentation part. func (c *Client) GetDocumentationPart(ctx context.Context, params *GetDocumentationPartInput, optFns ...func(*Options)) (*GetDocumentationPartOutput, error) { if params == nil { params = &GetDocumentationPartInput{} @@ -29,12 +30,12 @@ func (c *Client) GetDocumentationPart(ctx context.Context, params *GetDocumentat // Gets a specified documentation part of a given API. type GetDocumentationPartInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. DocumentationPartId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -42,18 +43,7 @@ type GetDocumentationPartInput struct { noSmithyDocumentSerde } -// 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 +// A documentation part for a targeted API entity. type GetDocumentationPartOutput struct { // The DocumentationPart identifier, generated by API Gateway when the diff --git a/service/apigateway/api_op_GetDocumentationParts.go b/service/apigateway/api_op_GetDocumentationParts.go index ff2cd79e4d7..57e8051ffab 100644 --- a/service/apigateway/api_op_GetDocumentationParts.go +++ b/service/apigateway/api_op_GetDocumentationParts.go @@ -11,6 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) +// Gets documentation parts. func (c *Client) GetDocumentationParts(ctx context.Context, params *GetDocumentationPartsInput, optFns ...func(*Options)) (*GetDocumentationPartsOutput, error) { if params == nil { params = &GetDocumentationPartsInput{} @@ -30,7 +31,7 @@ func (c *Client) GetDocumentationParts(ctx context.Context, params *GetDocumenta // name, or path of API entities (targets). type GetDocumentationPartsInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -59,9 +60,7 @@ type GetDocumentationPartsInput struct { noSmithyDocumentSerde } -// 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 +// The collection of documentation parts of an API. type GetDocumentationPartsOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetDocumentationVersion.go b/service/apigateway/api_op_GetDocumentationVersion.go index bab41cecbdc..52dec1123a5 100644 --- a/service/apigateway/api_op_GetDocumentationVersion.go +++ b/service/apigateway/api_op_GetDocumentationVersion.go @@ -11,6 +11,7 @@ import ( "time" ) +// Gets a documentation version. func (c *Client) GetDocumentationVersion(ctx context.Context, params *GetDocumentationVersionInput, optFns ...func(*Options)) (*GetDocumentationVersionOutput, error) { if params == nil { params = &GetDocumentationVersionInput{} @@ -29,12 +30,12 @@ func (c *Client) GetDocumentationVersion(ctx context.Context, params *GetDocumen // Gets a documentation snapshot of an API. type GetDocumentationVersionInput struct { - // [Required] The version identifier of the to-be-retrieved documentation snapshot. + // The version identifier of the to-be-retrieved documentation snapshot. // // This member is required. DocumentationVersion *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -42,11 +43,7 @@ type GetDocumentationVersionInput struct { noSmithyDocumentSerde } -// 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 +// A snapshot of the documentation of an API. type GetDocumentationVersionOutput struct { // The date when the API documentation snapshot is created. diff --git a/service/apigateway/api_op_GetDocumentationVersions.go b/service/apigateway/api_op_GetDocumentationVersions.go index 5c37ae9e77a..d2b170bbd36 100644 --- a/service/apigateway/api_op_GetDocumentationVersions.go +++ b/service/apigateway/api_op_GetDocumentationVersions.go @@ -11,6 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) +// Gets documentation versions. func (c *Client) GetDocumentationVersions(ctx context.Context, params *GetDocumentationVersionsInput, optFns ...func(*Options)) (*GetDocumentationVersionsOutput, error) { if params == nil { params = &GetDocumentationVersionsInput{} @@ -29,7 +30,7 @@ func (c *Client) GetDocumentationVersions(ctx context.Context, params *GetDocume // Gets the documentation versions of an API. type GetDocumentationVersionsInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -44,11 +45,7 @@ type GetDocumentationVersionsInput struct { noSmithyDocumentSerde } -// 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 +// The collection of documentation snapshots of an API. type GetDocumentationVersionsOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetDomainName.go b/service/apigateway/api_op_GetDomainName.go index 2940220e37d..fcb6e44cdd3 100644 --- a/service/apigateway/api_op_GetDomainName.go +++ b/service/apigateway/api_op_GetDomainName.go @@ -32,7 +32,7 @@ func (c *Client) GetDomainName(ctx context.Context, params *GetDomainNameInput, // Request to get the name of a DomainName resource. type GetDomainNameInput struct { - // [Required] The name of the DomainName resource. + // The name of the DomainName resource. // // This member is required. DomainName *string @@ -41,16 +41,7 @@ type GetDomainNameInput struct { } // 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) +// (RestApi). type GetDomainNameOutput struct { // The reference to an AWS-managed certificate that will be used by edge-optimized @@ -70,24 +61,22 @@ type GetDomainNameOutput struct { // 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/). + // CloudFront documentation. DistributionDomainName *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). + // information, see Set up a Regional Custom Domain Name and AWS Regions and + // Endpoints for API Gateway. DistributionHostedZoneId *string // The custom domain name as an API host name, for example, my-api.example.com. DomainName *string - // The status of the DomainName migration. The valid values are AVAILABLE, - // UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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. + // 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 types.DomainNameStatus // An optional text message containing detailed information about status of the @@ -123,10 +112,8 @@ type GetDomainNameOutput struct { RegionalDomainName *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). + // more information, see Set up a Regional Custom Domain Name and AWS Regions and + // Endpoints for API Gateway. RegionalHostedZoneId *string // The Transport Layer Security (TLS) version + cipher suite for this DomainName. diff --git a/service/apigateway/api_op_GetDomainNames.go b/service/apigateway/api_op_GetDomainNames.go index 4697dff2a4d..7089e62fc3b 100644 --- a/service/apigateway/api_op_GetDomainNames.go +++ b/service/apigateway/api_op_GetDomainNames.go @@ -41,8 +41,7 @@ type GetDomainNamesInput struct { noSmithyDocumentSerde } -// Represents a collection of DomainName resources. Use Client-Side Certificate -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) +// Represents a collection of DomainName resources. type GetDomainNamesOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetExport.go b/service/apigateway/api_op_GetExport.go index 9c4d7224f4f..4573e0de076 100644 --- a/service/apigateway/api_op_GetExport.go +++ b/service/apigateway/api_op_GetExport.go @@ -29,18 +29,18 @@ func (c *Client) GetExport(ctx context.Context, params *GetExportInput, optFns . // Request a new export of a RestApi for a particular Stage. type GetExportInput struct { - // [Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x - // and 'swagger' for Swagger/OpenAPI 2.0. + // The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and + // 'swagger' for Swagger/OpenAPI 2.0. // // This member is required. ExportType *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] The name of the Stage that will be exported. + // The name of the Stage that will be exported. // // This member is required. StageName *string diff --git a/service/apigateway/api_op_GetGatewayResponse.go b/service/apigateway/api_op_GetGatewayResponse.go index e6f1732897c..84397af03c9 100644 --- a/service/apigateway/api_op_GetGatewayResponse.go +++ b/service/apigateway/api_op_GetGatewayResponse.go @@ -30,12 +30,12 @@ func (c *Client) GetGatewayResponse(ctx context.Context, params *GetGatewayRespo // Gets a GatewayResponse of a specified response type on the given RestApi. type GetGatewayResponseInput struct { - // [Required] The response type of the associated GatewayResponse. + // The response type of the associated GatewayResponse. // // This member is required. ResponseType types.GatewayResponseType - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -44,50 +44,7 @@ type GetGatewayResponseInput struct { } // 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) +// response parameters and mapping templates. type GetGatewayResponseOutput struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway diff --git a/service/apigateway/api_op_GetGatewayResponses.go b/service/apigateway/api_op_GetGatewayResponses.go index 48fd2d4a6e9..fe4d9a34c11 100644 --- a/service/apigateway/api_op_GetGatewayResponses.go +++ b/service/apigateway/api_op_GetGatewayResponses.go @@ -36,7 +36,7 @@ func (c *Client) GetGatewayResponses(ctx context.Context, params *GetGatewayResp // types. type GetGatewayResponsesInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -55,217 +55,7 @@ type GetGatewayResponsesInput struct { // 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) +// pagination is not supported for querying this collection. type GetGatewayResponsesOutput struct { // Returns the entire collection, because of no pagination support. diff --git a/service/apigateway/api_op_GetIntegration.go b/service/apigateway/api_op_GetIntegration.go index f305906e9ec..3c46b5c97b4 100644 --- a/service/apigateway/api_op_GetIntegration.go +++ b/service/apigateway/api_op_GetIntegration.go @@ -30,17 +30,17 @@ func (c *Client) GetIntegration(ctx context.Context, params *GetIntegrationInput // Represents a request to get the integration configuration. type GetIntegrationInput struct { - // [Required] Specifies a get integration request's HTTP method. + // Specifies a get integration request's HTTP method. // // This member is required. HttpMethod *string - // [Required] Specifies a get integration request's resource identifier + // Specifies a get integration request's resource identifier // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -48,15 +48,12 @@ type GetIntegrationInput struct { noSmithyDocumentSerde } -// 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) +// Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. 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 - // MethodrequestParameters. + // for cacheKeyParameters, these parameters must also be specified for Method + // requestParameters. CacheKeyParameters []string // Specifies a group of related cached parameters. By default, API Gateway uses the @@ -65,10 +62,8 @@ type GetIntegrationOutput struct { // resources. CacheNamespace *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. + // The ID of the VpcLink used for the integration when connectionType=VPC_LINK and + // undefined, otherwise. ConnectionId *string // The type of the network connection to the integration endpoint. The valid value @@ -78,17 +73,8 @@ type GetIntegrationOutput struct { ConnectionType types.ConnectionType // 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 + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // 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 types.ContentHandlingStrategy @@ -105,61 +91,25 @@ type GetIntegrationOutput struct { HttpMethod *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]types.IntegrationResponse // 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. + // 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 // A key-value map specifying request parameters that are passed from the method @@ -184,63 +134,31 @@ type GetIntegrationOutput struct { TlsConfig *types.TlsConfig // 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. + // following: 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 types.IntegrationType - // Specifies Uniform Resource Identifier (URI) of the integration endpoint. - // - // * For + // 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 + // URL according to the RFC-3986 specification, 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 + // 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 + // name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} + // is a designated subdomain supported by certain Amazon Web Services service for + // fast host-name lookup. action can be used for an Amazon Web Services 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 Amazon Web Services + // service resource, including the region of the integrated Amazon Web Services + // service, if applicable. For example, for integration with the S3 API of + // GetObject, 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 diff --git a/service/apigateway/api_op_GetIntegrationResponse.go b/service/apigateway/api_op_GetIntegrationResponse.go index a49f5171a14..20cf52dfda4 100644 --- a/service/apigateway/api_op_GetIntegrationResponse.go +++ b/service/apigateway/api_op_GetIntegrationResponse.go @@ -30,22 +30,22 @@ func (c *Client) GetIntegrationResponse(ctx context.Context, params *GetIntegrat // Represents a get integration response request. type GetIntegrationResponseInput struct { - // [Required] Specifies a get integration response request's HTTP method. + // Specifies a get integration response request's HTTP method. // // This member is required. HttpMethod *string - // [Required] Specifies a get integration response request's resource identifier. + // Specifies a get integration response request's resource identifier. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] Specifies a get integration response request's status code. + // Specifies a get integration response request's status code. // // This member is required. StatusCode *string @@ -55,23 +55,13 @@ type GetIntegrationResponseInput struct { // 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) +// back-end response. 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. + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // If this property is not defined, the response payload will be passed through + // from the integration response to the method response without modification. ContentHandling types.ContentHandlingStrategy // A key-value map specifying response parameters that are passed to the method diff --git a/service/apigateway/api_op_GetMethod.go b/service/apigateway/api_op_GetMethod.go index 15032eb192f..dd45fc2c1f7 100644 --- a/service/apigateway/api_op_GetMethod.go +++ b/service/apigateway/api_op_GetMethod.go @@ -30,17 +30,17 @@ func (c *Client) GetMethod(ctx context.Context, params *GetMethodInput, optFns . // Request to describe an existing Method resource. type GetMethodInput struct { - // [Required] Specifies the method request's HTTP method type. + // Specifies the method request's HTTP method type. // // This member is required. HttpMethod *string - // [Required] The Resource identifier for the Method resource. + // The Resource identifier for the Method resource. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -58,86 +58,6 @@ type GetMethodInput struct { // 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) type GetMethodOutput struct { // A boolean flag specifying whether a valid ApiKey is required to invoke this @@ -169,91 +89,9 @@ type GetMethodOutput struct { // 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 *types.Integration - // 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) + // Gets a method response associated with a given HTTP status code. MethodResponses map[string]types.MethodResponse // A human-friendly operation identifier for the method. For example, you can diff --git a/service/apigateway/api_op_GetMethodResponse.go b/service/apigateway/api_op_GetMethodResponse.go index 50ee4c02aec..5125e4634ef 100644 --- a/service/apigateway/api_op_GetMethodResponse.go +++ b/service/apigateway/api_op_GetMethodResponse.go @@ -29,22 +29,22 @@ func (c *Client) GetMethodResponse(ctx context.Context, params *GetMethodRespons // Request to describe a MethodResponse resource. type GetMethodResponseInput struct { - // [Required] The HTTP verb of the Method resource. + // The HTTP verb of the Method resource. // // This member is required. HttpMethod *string - // [Required] The Resource identifier for the MethodResponse resource. + // The Resource identifier for the MethodResponse resource. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] The status code for the MethodResponse resource. + // The status code for the MethodResponse resource. // // This member is required. StatusCode *string @@ -55,34 +55,6 @@ type GetMethodResponseInput struct { // 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, IntegrationCreating an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type GetMethodResponseOutput struct { // Specifies the Model resources used for the response's content-type. Response diff --git a/service/apigateway/api_op_GetModel.go b/service/apigateway/api_op_GetModel.go index 0f072990e60..b871f89465d 100644 --- a/service/apigateway/api_op_GetModel.go +++ b/service/apigateway/api_op_GetModel.go @@ -29,12 +29,12 @@ func (c *Client) GetModel(ctx context.Context, params *GetModelInput, optFns ... // Request to list information about a model in an existing RestApi resource. type GetModelInput struct { - // [Required] The name of the model as an identifier. + // The name of the model as an identifier. // // This member is required. ModelName *string - // [Required] The RestApi identifier under which the Model exists. + // The RestApi identifier under which the Model exists. // // This member is required. RestApiId *string @@ -47,14 +47,7 @@ type GetModelInput struct { noSmithyDocumentSerde } -// 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) +// Represents the data structure of a method's request or response payload. type GetModelOutput struct { // The content-type for the model. @@ -70,11 +63,10 @@ type GetModelOutput struct { Name *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 draft 4 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 // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_GetModelTemplate.go b/service/apigateway/api_op_GetModelTemplate.go index ca9822a100d..c6e098bcaf9 100644 --- a/service/apigateway/api_op_GetModelTemplate.go +++ b/service/apigateway/api_op_GetModelTemplate.go @@ -30,12 +30,12 @@ func (c *Client) GetModelTemplate(ctx context.Context, params *GetModelTemplateI // Request to generate a sample mapping template used to transform the payload. type GetModelTemplateInput struct { - // [Required] The name of the model for which to generate a template. + // The name of the model for which to generate a template. // // This member is required. ModelName *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -43,13 +43,11 @@ type GetModelTemplateInput struct { noSmithyDocumentSerde } -// 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) +// Represents a mapping template used to transform a payload. 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. + // The Apache Velocity Template Language (VTL) template content used for the + // template resource. Value *string // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_GetModels.go b/service/apigateway/api_op_GetModels.go index a7b5a8748a9..3b07640e674 100644 --- a/service/apigateway/api_op_GetModels.go +++ b/service/apigateway/api_op_GetModels.go @@ -31,7 +31,7 @@ func (c *Client) GetModels(ctx context.Context, params *GetModelsInput, optFns . // Request to list existing Models defined for a RestApi resource. type GetModelsInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -46,9 +46,7 @@ type GetModelsInput struct { noSmithyDocumentSerde } -// Represents a collection of Model resources. Method, MethodResponse, Models and -// Mappings -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html) +// Represents a collection of Model resources. type GetModelsOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetRequestValidator.go b/service/apigateway/api_op_GetRequestValidator.go index ef32c7d8952..a633ffe6b8e 100644 --- a/service/apigateway/api_op_GetRequestValidator.go +++ b/service/apigateway/api_op_GetRequestValidator.go @@ -29,12 +29,12 @@ func (c *Client) GetRequestValidator(ctx context.Context, params *GetRequestVali // Gets a RequestValidator of a given RestApi. type GetRequestValidatorInput struct { - // [Required] The identifier of the RequestValidator to be retrieved. + // The identifier of the RequestValidator to be retrieved. // // This member is required. RequestValidatorId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -42,14 +42,7 @@ type GetRequestValidatorInput struct { noSmithyDocumentSerde } -// 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) +// A set of validation rules for incoming Method requests. type GetRequestValidatorOutput struct { // The identifier of this RequestValidator. diff --git a/service/apigateway/api_op_GetRequestValidators.go b/service/apigateway/api_op_GetRequestValidators.go index 39da3aef5c6..44c98f8c2f7 100644 --- a/service/apigateway/api_op_GetRequestValidators.go +++ b/service/apigateway/api_op_GetRequestValidators.go @@ -30,7 +30,7 @@ func (c *Client) GetRequestValidators(ctx context.Context, params *GetRequestVal // Gets the RequestValidators collection of a given RestApi. type GetRequestValidatorsInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -45,12 +45,7 @@ type GetRequestValidatorsInput struct { noSmithyDocumentSerde } -// 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) +// A collection of RequestValidator resources of a given RestApi. type GetRequestValidatorsOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetResource.go b/service/apigateway/api_op_GetResource.go index ae4ea1ce668..36c1e8dfa7a 100644 --- a/service/apigateway/api_op_GetResource.go +++ b/service/apigateway/api_op_GetResource.go @@ -30,12 +30,12 @@ func (c *Client) GetResource(ctx context.Context, params *GetResourceInput, optF // Request to list information about a resource. type GetResourceInput struct { - // [Required] The identifier for the Resource resource. + // The identifier for the Resource resource. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -51,8 +51,7 @@ type GetResourceInput struct { noSmithyDocumentSerde } -// Represents an API resource. Create an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +// Represents an API resource. type GetResourceOutput struct { // The resource's identifier. @@ -67,85 +66,7 @@ type GetResourceOutput struct { // The last path segment for this resource. PathPart *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. + // Gets an API resource's method of a given HTTP verb. ResourceMethods map[string]types.Method // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_GetResources.go b/service/apigateway/api_op_GetResources.go index 80d811ddb92..3c89034772b 100644 --- a/service/apigateway/api_op_GetResources.go +++ b/service/apigateway/api_op_GetResources.go @@ -31,7 +31,7 @@ func (c *Client) GetResources(ctx context.Context, params *GetResourcesInput, op // Request to list information about a collection of resources. type GetResourcesInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -54,8 +54,7 @@ type GetResourcesInput struct { noSmithyDocumentSerde } -// Represents a collection of Resource resources. Create an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +// Represents a collection of Resource resources. type GetResourcesOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetRestApi.go b/service/apigateway/api_op_GetRestApi.go index ffd3c66f7d2..8b725839541 100644 --- a/service/apigateway/api_op_GetRestApi.go +++ b/service/apigateway/api_op_GetRestApi.go @@ -31,7 +31,7 @@ func (c *Client) GetRestApi(ctx context.Context, params *GetRestApiInput, optFns // The GET request to list an existing RestApi defined for your collection. type GetRestApiInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -39,18 +39,13 @@ type GetRestApiInput struct { noSmithyDocumentSerde } -// Represents a REST API. Create an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +// Represents a REST API. 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. + // 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 types.ApiKeySourceType // The list of binary media types supported by the RestApi. By default, the RestApi diff --git a/service/apigateway/api_op_GetRestApis.go b/service/apigateway/api_op_GetRestApis.go index 22667db72a2..1511a553d6f 100644 --- a/service/apigateway/api_op_GetRestApis.go +++ b/service/apigateway/api_op_GetRestApis.go @@ -42,9 +42,7 @@ type GetRestApisInput struct { } // 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) +// with your collection. A collection offers a paginated view of your APIs. type GetRestApisOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetSdk.go b/service/apigateway/api_op_GetSdk.go index 77bf45f1226..6d62079264f 100644 --- a/service/apigateway/api_op_GetSdk.go +++ b/service/apigateway/api_op_GetSdk.go @@ -29,18 +29,18 @@ func (c *Client) GetSdk(ctx context.Context, params *GetSdkInput, optFns ...func // Request a new generated client SDK for a RestApi and Stage. type GetSdkInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] The language for the generated SDK. Currently java, javascript, - // android, objectivec (for iOS), swift (for iOS), and ruby are supported. + // The language for the generated SDK. Currently java, javascript, android, + // objectivec (for iOS), swift (for iOS), and ruby are supported. // // This member is required. SdkType *string - // [Required] The name of the Stage that the SDK will use. + // The name of the Stage that the SDK will use. // // This member is required. StageName *string diff --git a/service/apigateway/api_op_GetSdkType.go b/service/apigateway/api_op_GetSdkType.go index 9ae7a66fe4b..44ce0ee950f 100644 --- a/service/apigateway/api_op_GetSdkType.go +++ b/service/apigateway/api_op_GetSdkType.go @@ -11,6 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) +// Gets an SDK type. func (c *Client) GetSdkType(ctx context.Context, params *GetSdkTypeInput, optFns ...func(*Options)) (*GetSdkTypeOutput, error) { if params == nil { params = &GetSdkTypeInput{} @@ -29,7 +30,7 @@ func (c *Client) GetSdkType(ctx context.Context, params *GetSdkTypeInput, optFns // Get an SdkType instance. type GetSdkTypeInput struct { - // [Required] The identifier of the queried SdkType instance. + // The identifier of the queried SdkType instance. // // This member is required. Id *string diff --git a/service/apigateway/api_op_GetSdkTypes.go b/service/apigateway/api_op_GetSdkTypes.go index 1628c34b16a..6f9e4e1b417 100644 --- a/service/apigateway/api_op_GetSdkTypes.go +++ b/service/apigateway/api_op_GetSdkTypes.go @@ -11,6 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) +// Gets SDK types func (c *Client) GetSdkTypes(ctx context.Context, params *GetSdkTypesInput, optFns ...func(*Options)) (*GetSdkTypesOutput, error) { if params == nil { params = &GetSdkTypesInput{} diff --git a/service/apigateway/api_op_GetStage.go b/service/apigateway/api_op_GetStage.go index 5f54c93e042..5390db57f2b 100644 --- a/service/apigateway/api_op_GetStage.go +++ b/service/apigateway/api_op_GetStage.go @@ -31,12 +31,12 @@ func (c *Client) GetStage(ctx context.Context, params *GetStageInput, optFns ... // Requests API Gateway to get information about a Stage resource. type GetStageInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] The name of the Stage resource to get information about. + // The name of the Stage resource to get information about. // // This member is required. StageName *string @@ -45,8 +45,7 @@ type GetStageInput struct { } // 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) +// callable by users. type GetStageOutput struct { // Settings for logging access in this stage. diff --git a/service/apigateway/api_op_GetStages.go b/service/apigateway/api_op_GetStages.go index 2a319d668ec..6b9211bbd2a 100644 --- a/service/apigateway/api_op_GetStages.go +++ b/service/apigateway/api_op_GetStages.go @@ -30,7 +30,7 @@ func (c *Client) GetStages(ctx context.Context, params *GetStagesInput, optFns . // Requests API Gateway to get information about one or more Stage resources. type GetStagesInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -42,8 +42,6 @@ type GetStagesInput struct { } // 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) type GetStagesOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetTags.go b/service/apigateway/api_op_GetTags.go index db860165eba..d37ea1b605e 100644 --- a/service/apigateway/api_op_GetTags.go +++ b/service/apigateway/api_op_GetTags.go @@ -29,7 +29,7 @@ func (c *Client) GetTags(ctx context.Context, params *GetTagsInput, optFns ...fu // Gets the Tags collection for a given resource. type GetTagsInput struct { - // [Required] The ARN of a resource that can be tagged. + // The ARN of a resource that can be tagged. // // This member is required. ResourceArn *string diff --git a/service/apigateway/api_op_GetUsage.go b/service/apigateway/api_op_GetUsage.go index b7d86fee305..6136aa38f02 100644 --- a/service/apigateway/api_op_GetUsage.go +++ b/service/apigateway/api_op_GetUsage.go @@ -31,17 +31,17 @@ func (c *Client) GetUsage(ctx context.Context, params *GetUsageInput, optFns ... // interval. type GetUsageInput struct { - // [Required] The ending date (e.g., 2016-12-31) of the usage data. + // The ending date (e.g., 2016-12-31) of the usage data. // // This member is required. EndDate *string - // [Required] The starting date (e.g., 2016-01-01) of the usage data. + // The starting date (e.g., 2016-01-01) of the usage data. // // This member is required. StartDate *string - // [Required] The Id of the usage plan associated with the usage data. + // The Id of the usage plan associated with the usage data. // // This member is required. UsagePlanId *string @@ -59,10 +59,7 @@ type GetUsageInput struct { noSmithyDocumentSerde } -// 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) +// Represents the usage data of a usage plan. type GetUsageOutput struct { // The ending date of the usage data. diff --git a/service/apigateway/api_op_GetUsagePlan.go b/service/apigateway/api_op_GetUsagePlan.go index e100cd110a7..7785720e1bd 100644 --- a/service/apigateway/api_op_GetUsagePlan.go +++ b/service/apigateway/api_op_GetUsagePlan.go @@ -30,7 +30,7 @@ func (c *Client) GetUsagePlan(ctx context.Context, params *GetUsagePlanInput, op // The GET request to get a usage plan of a given plan identifier. type GetUsagePlanInput struct { - // [Required] The identifier of the UsagePlan resource to be retrieved. + // The identifier of the UsagePlan resource to be retrieved. // // This member is required. UsagePlanId *string @@ -41,14 +41,11 @@ type GetUsagePlanInput struct { // Represents a usage plan used to specify who can assess associated API stages. // Optionally, target request rate and quota limits can be set. In some cases // clients can exceed the targets that you set. Don’t rely on usage plans to -// control costs. Consider using AWS Budgets +// control costs. Consider using Amazon Web Services Budgets // (https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) -// to monitor costs and AWS WAF +// to monitor costs and WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to -// manage API requests. 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) +// manage API requests. type GetUsagePlanOutput struct { // The associated API stages of a usage plan. @@ -73,7 +70,7 @@ type GetUsagePlanOutput struct { // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string - // Map containing method level throttling information for API stage in a usage + // A map containing method level throttling information for API stage in a usage // plan. Throttle *types.ThrottleSettings diff --git a/service/apigateway/api_op_GetUsagePlanKey.go b/service/apigateway/api_op_GetUsagePlanKey.go index 37bd8ecdaf0..b8ce8fb5869 100644 --- a/service/apigateway/api_op_GetUsagePlanKey.go +++ b/service/apigateway/api_op_GetUsagePlanKey.go @@ -29,15 +29,14 @@ func (c *Client) GetUsagePlanKey(ctx context.Context, params *GetUsagePlanKeyInp // The GET request to get a usage plan key of a given key identifier. type GetUsagePlanKeyInput struct { - // [Required] The key Id of the to-be-retrieved UsagePlanKey resource representing - // a plan customer. + // The key Id of the to-be-retrieved UsagePlanKey resource representing a plan + // customer. // // This member is required. KeyId *string - // [Required] The Id of the UsagePlan resource representing the usage plan - // containing the to-be-retrieved UsagePlanKey resource representing a plan - // customer. + // The Id of the UsagePlan resource representing the usage plan containing the + // to-be-retrieved UsagePlanKey resource representing a plan customer. // // This member is required. UsagePlanId *string @@ -45,10 +44,7 @@ type GetUsagePlanKeyInput struct { noSmithyDocumentSerde } -// 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) +// Represents a usage plan key to identify a plan customer. type GetUsagePlanKeyOutput struct { // The Id of a usage plan key. diff --git a/service/apigateway/api_op_GetUsagePlanKeys.go b/service/apigateway/api_op_GetUsagePlanKeys.go index 83d0bae0739..245aa8a4741 100644 --- a/service/apigateway/api_op_GetUsagePlanKeys.go +++ b/service/apigateway/api_op_GetUsagePlanKeys.go @@ -33,9 +33,8 @@ func (c *Client) GetUsagePlanKeys(ctx context.Context, params *GetUsagePlanKeysI // to a specified usage plan. type GetUsagePlanKeysInput struct { - // [Required] The Id of the UsagePlan resource representing the usage plan - // containing the to-be-retrieved UsagePlanKey resource representing a plan - // customer. + // The Id of the UsagePlan resource representing the usage plan containing the + // to-be-retrieved UsagePlanKey resource representing a plan customer. // // This member is required. UsagePlanId *string @@ -54,9 +53,7 @@ type GetUsagePlanKeysInput struct { } // 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) +// associated API keys and, possibly, other types of keys. type GetUsagePlanKeysOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetUsagePlans.go b/service/apigateway/api_op_GetUsagePlans.go index f6c8d78f832..e10714d0151 100644 --- a/service/apigateway/api_op_GetUsagePlans.go +++ b/service/apigateway/api_op_GetUsagePlans.go @@ -44,9 +44,7 @@ type GetUsagePlansInput struct { noSmithyDocumentSerde } -// 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) +// Represents a collection of usage plans for an AWS account. type GetUsagePlansOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_GetVpcLink.go b/service/apigateway/api_op_GetVpcLink.go index 4246d714f8d..9b4559cbc45 100644 --- a/service/apigateway/api_op_GetVpcLink.go +++ b/service/apigateway/api_op_GetVpcLink.go @@ -30,8 +30,8 @@ func (c *Client) GetVpcLink(ctx context.Context, params *GetVpcLinkInput, optFns // Gets a specified VPC link under the caller's account in a region. type GetVpcLinkInput struct { - // [Required] The identifier of the VpcLink. It is used in an Integration to - // reference this VpcLink. + // The identifier of the VpcLink. It is used in an Integration to reference this + // VpcLink. // // This member is required. VpcLinkId *string @@ -40,13 +40,7 @@ type GetVpcLinkInput struct { } // 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. +// Private Cloud (VPC). type GetVpcLinkOutput struct { // The description of the VPC link. diff --git a/service/apigateway/api_op_GetVpcLinks.go b/service/apigateway/api_op_GetVpcLinks.go index d0e94afc8d1..b22b1ff1eee 100644 --- a/service/apigateway/api_op_GetVpcLinks.go +++ b/service/apigateway/api_op_GetVpcLinks.go @@ -41,11 +41,7 @@ type GetVpcLinksInput struct { noSmithyDocumentSerde } -// 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) +// The collection of VPC links under the caller's account in a region. type GetVpcLinksOutput struct { // The current page of elements from this collection. diff --git a/service/apigateway/api_op_ImportApiKeys.go b/service/apigateway/api_op_ImportApiKeys.go index 7285e710034..0917db712b7 100644 --- a/service/apigateway/api_op_ImportApiKeys.go +++ b/service/apigateway/api_op_ImportApiKeys.go @@ -32,8 +32,7 @@ func (c *Client) ImportApiKeys(ctx context.Context, params *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). + // API Key File Format. // // This member is required. Body []byte diff --git a/service/apigateway/api_op_ImportDocumentationParts.go b/service/apigateway/api_op_ImportDocumentationParts.go index 876b8e8c654..c742a85bc31 100644 --- a/service/apigateway/api_op_ImportDocumentationParts.go +++ b/service/apigateway/api_op_ImportDocumentationParts.go @@ -11,6 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) +// Imports documentation parts func (c *Client) ImportDocumentationParts(ctx context.Context, params *ImportDocumentationPartsInput, optFns ...func(*Options)) (*ImportDocumentationPartsOutput, error) { if params == nil { params = &ImportDocumentationPartsInput{} @@ -29,13 +30,13 @@ func (c *Client) ImportDocumentationParts(ctx context.Context, params *ImportDoc // Import documentation parts from an external (e.g., OpenAPI) definition file. 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. + // Raw byte array representing the to-be-imported documentation parts. To import + // from an OpenAPI file, this is a JSON object. // // This member is required. Body []byte - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -52,13 +53,7 @@ type ImportDocumentationPartsInput struct { noSmithyDocumentSerde } -// 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 +// A collection of the imported DocumentationPart identifiers. type ImportDocumentationPartsOutput struct { // A list of the returned documentation part identifiers. diff --git a/service/apigateway/api_op_ImportRestApi.go b/service/apigateway/api_op_ImportRestApi.go index d859bf91897..42d9a160966 100644 --- a/service/apigateway/api_op_ImportRestApi.go +++ b/service/apigateway/api_op_ImportRestApi.go @@ -33,9 +33,9 @@ func (c *Client) ImportRestApi(ctx context.Context, params *ImportRestApiInput, // definition file. 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. + // 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. // // This member is required. Body []byte @@ -52,29 +52,20 @@ type ImportRestApiInput struct { // 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' + // command to exclude documentation from the imported API is: The AWS CLI command + // to set the regional endpoint on the imported API is: Parameters map[string]string noSmithyDocumentSerde } -// Represents a REST API. Create an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +// Represents a REST API. 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. + // 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 types.ApiKeySourceType // The list of binary media types supported by the RestApi. By default, the RestApi diff --git a/service/apigateway/api_op_PutGatewayResponse.go b/service/apigateway/api_op_PutGatewayResponse.go index 2b23ff3e48c..cf140b2f2ae 100644 --- a/service/apigateway/api_op_PutGatewayResponse.go +++ b/service/apigateway/api_op_PutGatewayResponse.go @@ -32,12 +32,12 @@ func (c *Client) PutGatewayResponse(ctx context.Context, params *PutGatewayRespo // status code on the given RestApi. type PutGatewayResponseInput struct { - // [Required] The response type of the associated GatewayResponse. + // The response type of the associated GatewayResponse // // This member is required. ResponseType types.GatewayResponseType - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -57,50 +57,7 @@ type PutGatewayResponseInput struct { } // 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) +// response parameters and mapping templates. type PutGatewayResponseOutput struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway diff --git a/service/apigateway/api_op_PutIntegration.go b/service/apigateway/api_op_PutIntegration.go index a1a26e42a5d..e02b431a12f 100644 --- a/service/apigateway/api_op_PutIntegration.go +++ b/service/apigateway/api_op_PutIntegration.go @@ -30,29 +30,29 @@ func (c *Client) PutIntegration(ctx context.Context, params *PutIntegrationInput // Sets up a method's integration. type PutIntegrationInput struct { - // [Required] Specifies a put integration request's HTTP method. + // Specifies the HTTP method for the integration. // // This member is required. HttpMethod *string - // [Required] Specifies a put integration request's resource ID. + // Specifies a put integration request's resource ID. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] Specifies a put integration input's type. + // Specifies a put integration input's type. // // This member is required. Type types.IntegrationType // A list of request parameters whose values API Gateway caches. To be valid values - // for cacheKeyParameters, these parameters must also be specified for - // MethodrequestParameters. + // for cacheKeyParameters, these parameters must also be specified for Method + // requestParameters. CacheKeyParameters []string // Specifies a group of related cached parameters. By default, API Gateway uses the @@ -61,10 +61,8 @@ type PutIntegrationInput struct { // resources. CacheNamespace *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. + // The ID of the VpcLink used for the integration. Specify this value only if you + // specify VPC_LINK as the connection type. ConnectionId *string // The type of the network connection to the integration endpoint. The valid value @@ -74,17 +72,8 @@ type PutIntegrationInput struct { ConnectionType types.ConnectionType // 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 + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // 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 types.ContentHandlingStrategy @@ -92,26 +81,13 @@ type PutIntegrationInput struct { // Specifies whether credentials are required for a put integration. Credentials *string - // Specifies a put integration HTTP method. When the integration type is HTTP or - // AWS, this field is required. + // The HTTP method for the integration. IntegrationHttpMethod *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 // A key-value map specifying request parameters that are passed from the method @@ -132,48 +108,40 @@ type PutIntegrationInput struct { // milliseconds or 29 seconds. TimeoutInMillis *int32 + // Specifies the TLS configuration for an integration. TlsConfig *types.TlsConfig - // Specifies Uniform Resource Identifier (URI) of the integration endpoint. - // - // * For + // 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 + // URL according to the RFC-3986 specification, 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 + // 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 + // name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} + // is a designated subdomain supported by certain Amazon Web Services service for + // fast host-name lookup. action can be used for an Amazon Web Services 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 Amazon Web Services + // service path-based API. The ensuing service_api refers to the path to an Amazon + // Web Services service resource, including the region of the integrated Amazon Web + // Services service, if applicable. For example, for integration with the S3 API of + // GetObject, 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} + // arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}. Uri *string noSmithyDocumentSerde } -// 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) +// Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. 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 - // MethodrequestParameters. + // for cacheKeyParameters, these parameters must also be specified for Method + // requestParameters. CacheKeyParameters []string // Specifies a group of related cached parameters. By default, API Gateway uses the @@ -182,10 +150,8 @@ type PutIntegrationOutput struct { // resources. CacheNamespace *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. + // The ID of the VpcLink used for the integration when connectionType=VPC_LINK and + // undefined, otherwise. ConnectionId *string // The type of the network connection to the integration endpoint. The valid value @@ -195,17 +161,8 @@ type PutIntegrationOutput struct { ConnectionType types.ConnectionType // 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 + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // 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 types.ContentHandlingStrategy @@ -222,61 +179,25 @@ type PutIntegrationOutput struct { HttpMethod *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]types.IntegrationResponse // 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. + // 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 // A key-value map specifying request parameters that are passed from the method @@ -301,63 +222,31 @@ type PutIntegrationOutput struct { TlsConfig *types.TlsConfig // 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. + // following: 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 types.IntegrationType - // Specifies Uniform Resource Identifier (URI) of the integration endpoint. - // - // * For + // 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 + // URL according to the RFC-3986 specification, 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 + // 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 + // name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} + // is a designated subdomain supported by certain Amazon Web Services service for + // fast host-name lookup. action can be used for an Amazon Web Services 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 Amazon Web Services + // service resource, including the region of the integrated Amazon Web Services + // service, if applicable. For example, for integration with the S3 API of + // GetObject, 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 diff --git a/service/apigateway/api_op_PutIntegrationResponse.go b/service/apigateway/api_op_PutIntegrationResponse.go index 0feea6c9b32..9de12ba328c 100644 --- a/service/apigateway/api_op_PutIntegrationResponse.go +++ b/service/apigateway/api_op_PutIntegrationResponse.go @@ -30,40 +30,31 @@ func (c *Client) PutIntegrationResponse(ctx context.Context, params *PutIntegrat // Represents a put integration response request. type PutIntegrationResponseInput struct { - // [Required] Specifies a put integration response request's HTTP method. + // Specifies a put integration response request's HTTP method. // // This member is required. HttpMethod *string - // [Required] Specifies a put integration response request's resource identifier. + // Specifies a put integration response request's resource identifier. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] Specifies the status code that is used to map the integration - // response to an existing MethodResponse. + // Specifies the status code that is used to map the integration response to an + // existing MethodResponse. // // This member is required. StatusCode *string // 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. + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // If this property is not defined, the response payload will be passed through + // from the integration response to the method response without modification. ContentHandling types.ContentHandlingStrategy // A key-value map specifying response parameters that are passed to the method @@ -90,23 +81,13 @@ type PutIntegrationResponseInput struct { // 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) +// back-end response. 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. + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // If this property is not defined, the response payload will be passed through + // from the integration response to the method response without modification. ContentHandling types.ContentHandlingStrategy // A key-value map specifying response parameters that are passed to the method diff --git a/service/apigateway/api_op_PutMethod.go b/service/apigateway/api_op_PutMethod.go index 681312165e9..e1ff8c6ac70 100644 --- a/service/apigateway/api_op_PutMethod.go +++ b/service/apigateway/api_op_PutMethod.go @@ -30,24 +30,24 @@ func (c *Client) PutMethod(ctx context.Context, params *PutMethodInput, optFns . // Request to add a method to an existing Resource resource. type PutMethodInput struct { - // [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. + // 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. // // This member is required. AuthorizationType *string - // [Required] Specifies the method request's HTTP method type. + // Specifies the method request's HTTP method type. // // This member is required. HttpMethod *string - // [Required] The Resource identifier for the new Method resource. + // The Resource identifier for the new Method resource. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -106,86 +106,6 @@ type PutMethodInput struct { // 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) type PutMethodOutput struct { // A boolean flag specifying whether a valid ApiKey is required to invoke this @@ -217,91 +137,9 @@ type PutMethodOutput struct { // 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 *types.Integration - // 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) + // Gets a method response associated with a given HTTP status code. MethodResponses map[string]types.MethodResponse // A human-friendly operation identifier for the method. For example, you can diff --git a/service/apigateway/api_op_PutMethodResponse.go b/service/apigateway/api_op_PutMethodResponse.go index e802619c82d..e2f43d59520 100644 --- a/service/apigateway/api_op_PutMethodResponse.go +++ b/service/apigateway/api_op_PutMethodResponse.go @@ -29,22 +29,22 @@ func (c *Client) PutMethodResponse(ctx context.Context, params *PutMethodRespons // Request to add a MethodResponse to an existing Method resource. type PutMethodResponseInput struct { - // [Required] The HTTP verb of the Method resource. + // The HTTP verb of the Method resource. // // This member is required. HttpMethod *string - // [Required] The Resource identifier for the Method resource. + // The Resource identifier for the Method resource. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] The method response's status code. + // The method response's status code. // // This member is required. StatusCode *string @@ -74,34 +74,6 @@ type PutMethodResponseInput struct { // 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, IntegrationCreating an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type PutMethodResponseOutput struct { // Specifies the Model resources used for the response's content-type. Response diff --git a/service/apigateway/api_op_PutRestApi.go b/service/apigateway/api_op_PutRestApi.go index ecdfa02e0a3..b130867a2c5 100644 --- a/service/apigateway/api_op_PutRestApi.go +++ b/service/apigateway/api_op_PutRestApi.go @@ -34,14 +34,14 @@ func (c *Client) PutRestApi(ctx context.Context, params *PutRestApiInput, optFns // as the request body. 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. + // 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. // // This member is required. Body []byte - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -64,18 +64,13 @@ type PutRestApiInput struct { noSmithyDocumentSerde } -// Represents a REST API. Create an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +// Represents a REST API. 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. + // 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 types.ApiKeySourceType // The list of binary media types supported by the RestApi. By default, the RestApi diff --git a/service/apigateway/api_op_TagResource.go b/service/apigateway/api_op_TagResource.go index f0b2c35f1a8..592325a8fc9 100644 --- a/service/apigateway/api_op_TagResource.go +++ b/service/apigateway/api_op_TagResource.go @@ -29,14 +29,14 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF // Adds or updates a tag on a given resource. type TagResourceInput struct { - // [Required] The ARN of a resource that can be tagged. + // The ARN of a resource that can be tagged. // // This member is required. ResourceArn *string - // [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. + // 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. // // This member is required. Tags map[string]string diff --git a/service/apigateway/api_op_TestInvokeAuthorizer.go b/service/apigateway/api_op_TestInvokeAuthorizer.go index 5bf0cf31e64..ef2f8989a12 100644 --- a/service/apigateway/api_op_TestInvokeAuthorizer.go +++ b/service/apigateway/api_op_TestInvokeAuthorizer.go @@ -11,10 +11,7 @@ import ( ) // 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) +// parameters, and an incoming request body. func (c *Client) TestInvokeAuthorizer(ctx context.Context, params *TestInvokeAuthorizerInput, optFns ...func(*Options)) (*TestInvokeAuthorizerOutput, error) { if params == nil { params = &TestInvokeAuthorizerInput{} @@ -30,37 +27,36 @@ func (c *Client) TestInvokeAuthorizer(ctx context.Context, params *TestInvokeAut return out, nil } -// Make a request to simulate the execution of an Authorizer. +// Make a request to simulate the invocation of an Authorizer. type TestInvokeAuthorizerInput struct { - // [Required] Specifies a test invoke authorizer request's Authorizer ID. + // Specifies a test invoke authorizer request's Authorizer ID. // // This member is required. AuthorizerId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Optional] A key-value map of additional context variables. + // A key-value map of additional context variables. AdditionalContext map[string]string - // [Optional] The simulated request body of an incoming invocation request. + // The simulated request body of an incoming invocation request. Body *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. + // 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 - // [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. + // 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 - // [Optional] The URI path, including query string, of the simulated invocation - // request. Use this to specify path parameters and query string parameters. + // The URI path, including query string, of the simulated invocation request. Use + // this to specify path parameters and query string parameters. PathWithQueryString *string // A key-value map of stage variables to simulate an invocation on a deployed @@ -72,12 +68,12 @@ type TestInvokeAuthorizerInput struct { // Represents the response of the test invoke request for a custom Authorizer type TestInvokeAuthorizerOutput struct { + + // The authorization response. Authorization map[string][]string - // 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. + // The open identity claims, with any supported custom attributes, returned from + // the Cognito Your User Pool configured for the API. Claims map[string]string // The HTTP status code that the client would have received. Value is 0 if the diff --git a/service/apigateway/api_op_TestInvokeMethod.go b/service/apigateway/api_op_TestInvokeMethod.go index 8c010bb385f..9a5532de1be 100644 --- a/service/apigateway/api_op_TestInvokeMethod.go +++ b/service/apigateway/api_op_TestInvokeMethod.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Simulate the execution of a Method in your RestApi with headers, parameters, and -// an incoming request body. +// Simulate the invocation of a Method in your RestApi with headers, parameters, +// and an incoming request body. func (c *Client) TestInvokeMethod(ctx context.Context, params *TestInvokeMethodInput, optFns ...func(*Options)) (*TestInvokeMethodOutput, error) { if params == nil { params = &TestInvokeMethodInput{} @@ -27,20 +27,20 @@ func (c *Client) TestInvokeMethod(ctx context.Context, params *TestInvokeMethodI return out, nil } -// Make a request to simulate the execution of a Method. +// Make a request to simulate the invocation of a Method. type TestInvokeMethodInput struct { - // [Required] Specifies a test invoke method request's HTTP method. + // Specifies a test invoke method request's HTTP method. // // This member is required. HttpMethod *string - // [Required] Specifies a test invoke method request's resource ID. + // Specifies a test invoke method request's resource ID. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string @@ -71,9 +71,7 @@ type TestInvokeMethodInput struct { noSmithyDocumentSerde } -// 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) +// Represents the response of the test invoke request in the HTTP method. type TestInvokeMethodOutput struct { // The body of the HTTP response. diff --git a/service/apigateway/api_op_UntagResource.go b/service/apigateway/api_op_UntagResource.go index d316088e9ee..0c1b1bb1b9a 100644 --- a/service/apigateway/api_op_UntagResource.go +++ b/service/apigateway/api_op_UntagResource.go @@ -29,12 +29,12 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, // Removes a tag from a given resource. type UntagResourceInput struct { - // [Required] The ARN of a resource that can be tagged. + // The ARN of a resource that can be tagged. // // This member is required. ResourceArn *string - // [Required] The Tag keys to delete. + // The Tag keys to delete. // // This member is required. TagKeys []string diff --git a/service/apigateway/api_op_UpdateAccount.go b/service/apigateway/api_op_UpdateAccount.go index 1e90768c809..ea261e2aace 100644 --- a/service/apigateway/api_op_UpdateAccount.go +++ b/service/apigateway/api_op_UpdateAccount.go @@ -30,59 +30,14 @@ func (c *Client) UpdateAccount(ctx context.Context, params *UpdateAccountInput, // Requests API Gateway to change information about the current Account resource. type UpdateAccountInput struct { - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// 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) +// Represents an AWS account that is associated with API Gateway. type UpdateAccountOutput struct { // The version of the API keys used for the account. diff --git a/service/apigateway/api_op_UpdateApiKey.go b/service/apigateway/api_op_UpdateApiKey.go index 93c56e5006e..7fd799a1e64 100644 --- a/service/apigateway/api_op_UpdateApiKey.go +++ b/service/apigateway/api_op_UpdateApiKey.go @@ -31,13 +31,13 @@ func (c *Client) UpdateApiKey(ctx context.Context, params *UpdateApiKeyInput, op // A request to change information about an ApiKey resource. type UpdateApiKeyInput struct { - // [Required] The identifier of the ApiKey resource to be updated. + // The identifier of the ApiKey resource to be updated. // // This member is required. ApiKey *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -46,8 +46,7 @@ type UpdateApiKeyInput struct { // 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) +// stage. type UpdateApiKeyOutput struct { // The timestamp when the API Key was created. diff --git a/service/apigateway/api_op_UpdateAuthorizer.go b/service/apigateway/api_op_UpdateAuthorizer.go index f8d85de359d..f03710ca5f0 100644 --- a/service/apigateway/api_op_UpdateAuthorizer.go +++ b/service/apigateway/api_op_UpdateAuthorizer.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an existing Authorizer resource. AWS CLI -// (https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html) +// Updates an existing Authorizer resource. func (c *Client) UpdateAuthorizer(ctx context.Context, params *UpdateAuthorizerInput, optFns ...func(*Options)) (*UpdateAuthorizerOutput, error) { if params == nil { params = &UpdateAuthorizerInput{} @@ -31,29 +30,25 @@ func (c *Client) UpdateAuthorizer(ctx context.Context, params *UpdateAuthorizerI // Request to update an existing Authorizer resource. type UpdateAuthorizerInput struct { - // [Required] The identifier of the Authorizer resource. + // The identifier of the Authorizer resource. // // This member is required. AuthorizerId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } // 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) +// Gateway will activate the authorizer when a client calls the method. type UpdateAuthorizerOutput struct { // Optional customer-defined field, used in OpenAPI imports and exports without @@ -87,15 +82,11 @@ type UpdateAuthorizerOutput struct { // The identifier for the authorizer resource. Id *string - // The identity source for which authorization is requested. - // - // * For a TOKEN or + // 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 + // 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 @@ -120,7 +111,7 @@ type UpdateAuthorizerOutput struct { // apply to the REQUEST authorizer. IdentityValidationExpression *string - // [Required] The name of the authorizer. + // The name of the authorizer. Name *string // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS diff --git a/service/apigateway/api_op_UpdateBasePathMapping.go b/service/apigateway/api_op_UpdateBasePathMapping.go index 0efd9864d2a..6b195fc143c 100644 --- a/service/apigateway/api_op_UpdateBasePathMapping.go +++ b/service/apigateway/api_op_UpdateBasePathMapping.go @@ -30,29 +30,26 @@ func (c *Client) UpdateBasePathMapping(ctx context.Context, params *UpdateBasePa // A request to change information about the BasePathMapping resource. type UpdateBasePathMappingInput struct { - // [Required] The base path of the BasePathMapping resource to change. To specify - // an empty base path, set this parameter to '(none)'. + // The base path of the BasePathMapping resource to change. To specify an empty + // base path, set this parameter to '(none)'. // // This member is required. BasePath *string - // [Required] The domain name of the BasePathMapping resource to change. + // The domain name of the BasePathMapping resource to change. // // This member is required. DomainName *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } // 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) +// after the domain name. type UpdateBasePathMappingOutput struct { // The base path name that callers of the API must provide as part of the URL after diff --git a/service/apigateway/api_op_UpdateClientCertificate.go b/service/apigateway/api_op_UpdateClientCertificate.go index 66807591ea9..f6bd1a3eaac 100644 --- a/service/apigateway/api_op_UpdateClientCertificate.go +++ b/service/apigateway/api_op_UpdateClientCertificate.go @@ -31,24 +31,20 @@ func (c *Client) UpdateClientCertificate(ctx context.Context, params *UpdateClie // A request to change information about an ClientCertificate resource. type UpdateClientCertificateInput struct { - // [Required] The identifier of the ClientCertificate resource to be updated. + // The identifier of the ClientCertificate resource to be updated. // // This member is required. ClientCertificateId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } // 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) +// while sending requests to the integration endpoint. type UpdateClientCertificateOutput struct { // The identifier of the client certificate. diff --git a/service/apigateway/api_op_UpdateDeployment.go b/service/apigateway/api_op_UpdateDeployment.go index 78d216841d1..1dcdb8420bb 100644 --- a/service/apigateway/api_op_UpdateDeployment.go +++ b/service/apigateway/api_op_UpdateDeployment.go @@ -37,13 +37,13 @@ type UpdateDeploymentInput struct { // This member is required. DeploymentId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -51,13 +51,7 @@ type UpdateDeploymentInput struct { // 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/) +// over the Internet. type UpdateDeploymentOutput struct { // A summary of the RestApi at the date and time that the deployment resource was diff --git a/service/apigateway/api_op_UpdateDocumentationPart.go b/service/apigateway/api_op_UpdateDocumentationPart.go index a5c444adda1..8f7c43799fd 100644 --- a/service/apigateway/api_op_UpdateDocumentationPart.go +++ b/service/apigateway/api_op_UpdateDocumentationPart.go @@ -11,6 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) +// Updates a documentation part. func (c *Client) UpdateDocumentationPart(ctx context.Context, params *UpdateDocumentationPartInput, optFns ...func(*Options)) (*UpdateDocumentationPartOutput, error) { if params == nil { params = &UpdateDocumentationPartInput{} @@ -29,35 +30,24 @@ func (c *Client) UpdateDocumentationPart(ctx context.Context, params *UpdateDocu // Updates an existing documentation part of a given API. type UpdateDocumentationPartInput struct { - // [Required] The identifier of the to-be-updated documentation part. + // The identifier of the to-be-updated documentation part. // // This member is required. DocumentationPartId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// 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 +// A documentation part for a targeted API entity. type UpdateDocumentationPartOutput struct { // The DocumentationPart identifier, generated by API Gateway when the diff --git a/service/apigateway/api_op_UpdateDocumentationVersion.go b/service/apigateway/api_op_UpdateDocumentationVersion.go index 8f25e1904ab..12fd6e65aca 100644 --- a/service/apigateway/api_op_UpdateDocumentationVersion.go +++ b/service/apigateway/api_op_UpdateDocumentationVersion.go @@ -12,6 +12,7 @@ import ( "time" ) +// Updates a documentation version. func (c *Client) UpdateDocumentationVersion(ctx context.Context, params *UpdateDocumentationVersionInput, optFns ...func(*Options)) (*UpdateDocumentationVersionOutput, error) { if params == nil { params = &UpdateDocumentationVersionInput{} @@ -30,28 +31,24 @@ func (c *Client) UpdateDocumentationVersion(ctx context.Context, params *UpdateD // Updates an existing documentation version of an API. type UpdateDocumentationVersionInput struct { - // [Required] The version identifier of the to-be-updated documentation version. + // The version identifier of the to-be-updated documentation version. // // This member is required. DocumentationVersion *string - // [Required] The string identifier of the associated RestApi.. + // The string identifier of the associated RestApi.. // // This member is required. RestApiId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// 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 +// A snapshot of the documentation of an API. type UpdateDocumentationVersionOutput struct { // The date when the API documentation snapshot is created. diff --git a/service/apigateway/api_op_UpdateDomainName.go b/service/apigateway/api_op_UpdateDomainName.go index 1752bad04b2..fb7a3cf9081 100644 --- a/service/apigateway/api_op_UpdateDomainName.go +++ b/service/apigateway/api_op_UpdateDomainName.go @@ -31,29 +31,20 @@ func (c *Client) UpdateDomainName(ctx context.Context, params *UpdateDomainNameI // A request to change information about the DomainName resource. type UpdateDomainNameInput struct { - // [Required] The name of the DomainName resource to be changed. + // The name of the DomainName resource to be changed. // // This member is required. DomainName *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } // 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) +// (RestApi). type UpdateDomainNameOutput struct { // The reference to an AWS-managed certificate that will be used by edge-optimized @@ -73,24 +64,22 @@ type UpdateDomainNameOutput struct { // 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/). + // CloudFront documentation. DistributionDomainName *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). + // information, see Set up a Regional Custom Domain Name and AWS Regions and + // Endpoints for API Gateway. DistributionHostedZoneId *string // The custom domain name as an API host name, for example, my-api.example.com. DomainName *string - // The status of the DomainName migration. The valid values are AVAILABLE, - // UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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. + // 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 types.DomainNameStatus // An optional text message containing detailed information about status of the @@ -126,10 +115,8 @@ type UpdateDomainNameOutput struct { RegionalDomainName *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). + // more information, see Set up a Regional Custom Domain Name and AWS Regions and + // Endpoints for API Gateway. RegionalHostedZoneId *string // The Transport Layer Security (TLS) version + cipher suite for this DomainName. diff --git a/service/apigateway/api_op_UpdateGatewayResponse.go b/service/apigateway/api_op_UpdateGatewayResponse.go index abeba7b4b38..cba0883e845 100644 --- a/service/apigateway/api_op_UpdateGatewayResponse.go +++ b/service/apigateway/api_op_UpdateGatewayResponse.go @@ -30,68 +30,25 @@ func (c *Client) UpdateGatewayResponse(ctx context.Context, params *UpdateGatewa // Updates a GatewayResponse of a specified response type on the given RestApi. type UpdateGatewayResponseInput struct { - // [Required] The response type of the associated GatewayResponse. + // The response type of the associated GatewayResponse. // // This member is required. ResponseType types.GatewayResponseType - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } // 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) +// response parameters and mapping templates. type UpdateGatewayResponseOutput struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway diff --git a/service/apigateway/api_op_UpdateIntegration.go b/service/apigateway/api_op_UpdateIntegration.go index dae3e579187..caa0ce45cfe 100644 --- a/service/apigateway/api_op_UpdateIntegration.go +++ b/service/apigateway/api_op_UpdateIntegration.go @@ -30,37 +30,34 @@ func (c *Client) UpdateIntegration(ctx context.Context, params *UpdateIntegratio // Represents an update integration request. type UpdateIntegrationInput struct { - // [Required] Represents an update integration request's HTTP method. + // Represents an update integration request's HTTP method. // // This member is required. HttpMethod *string - // [Required] Represents an update integration request's resource identifier. + // Represents an update integration request's resource identifier. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// 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) +// Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. 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 - // MethodrequestParameters. + // for cacheKeyParameters, these parameters must also be specified for Method + // requestParameters. CacheKeyParameters []string // Specifies a group of related cached parameters. By default, API Gateway uses the @@ -69,10 +66,8 @@ type UpdateIntegrationOutput struct { // resources. CacheNamespace *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. + // The ID of the VpcLink used for the integration when connectionType=VPC_LINK and + // undefined, otherwise. ConnectionId *string // The type of the network connection to the integration endpoint. The valid value @@ -82,17 +77,8 @@ type UpdateIntegrationOutput struct { ConnectionType types.ConnectionType // 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 + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // 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 types.ContentHandlingStrategy @@ -109,61 +95,25 @@ type UpdateIntegrationOutput struct { HttpMethod *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]types.IntegrationResponse // 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. + // 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 // A key-value map specifying request parameters that are passed from the method @@ -188,63 +138,31 @@ type UpdateIntegrationOutput struct { TlsConfig *types.TlsConfig // 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. + // following: 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 types.IntegrationType - // Specifies Uniform Resource Identifier (URI) of the integration endpoint. - // - // * For + // 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 + // URL according to the RFC-3986 specification, 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 + // 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 + // name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} + // is a designated subdomain supported by certain Amazon Web Services service for + // fast host-name lookup. action can be used for an Amazon Web Services 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 Amazon Web Services + // service resource, including the region of the integrated Amazon Web Services + // service, if applicable. For example, for integration with the S3 API of + // GetObject, 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 diff --git a/service/apigateway/api_op_UpdateIntegrationResponse.go b/service/apigateway/api_op_UpdateIntegrationResponse.go index 1f25d7d7718..becaf6ac851 100644 --- a/service/apigateway/api_op_UpdateIntegrationResponse.go +++ b/service/apigateway/api_op_UpdateIntegrationResponse.go @@ -30,29 +30,28 @@ func (c *Client) UpdateIntegrationResponse(ctx context.Context, params *UpdateIn // Represents an update integration response request. type UpdateIntegrationResponseInput struct { - // [Required] Specifies an update integration response request's HTTP method. + // Specifies an update integration response request's HTTP method. // // This member is required. HttpMethod *string - // [Required] Specifies an update integration response request's resource - // identifier. + // Specifies an update integration response request's resource identifier. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] Specifies an update integration response request's status code. + // Specifies an update integration response request's status code. // // This member is required. StatusCode *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -60,23 +59,13 @@ type UpdateIntegrationResponseInput struct { // 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) +// back-end response. 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. + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // If this property is not defined, the response payload will be passed through + // from the integration response to the method response without modification. ContentHandling types.ContentHandlingStrategy // A key-value map specifying response parameters that are passed to the method diff --git a/service/apigateway/api_op_UpdateMethod.go b/service/apigateway/api_op_UpdateMethod.go index 3e5527b6282..d0281867896 100644 --- a/service/apigateway/api_op_UpdateMethod.go +++ b/service/apigateway/api_op_UpdateMethod.go @@ -30,23 +30,23 @@ func (c *Client) UpdateMethod(ctx context.Context, params *UpdateMethodInput, op // Request to update an existing Method resource. type UpdateMethodInput struct { - // [Required] The HTTP verb of the Method resource. + // The HTTP verb of the Method resource. // // This member is required. HttpMethod *string - // [Required] The Resource identifier for the Method resource. + // The Resource identifier for the Method resource. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -62,86 +62,6 @@ type UpdateMethodInput struct { // 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) type UpdateMethodOutput struct { // A boolean flag specifying whether a valid ApiKey is required to invoke this @@ -173,91 +93,9 @@ type UpdateMethodOutput struct { // 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 *types.Integration - // 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) + // Gets a method response associated with a given HTTP status code. MethodResponses map[string]types.MethodResponse // A human-friendly operation identifier for the method. For example, you can diff --git a/service/apigateway/api_op_UpdateMethodResponse.go b/service/apigateway/api_op_UpdateMethodResponse.go index c7988f8af26..583354eba03 100644 --- a/service/apigateway/api_op_UpdateMethodResponse.go +++ b/service/apigateway/api_op_UpdateMethodResponse.go @@ -30,28 +30,28 @@ func (c *Client) UpdateMethodResponse(ctx context.Context, params *UpdateMethodR // A request to update an existing MethodResponse resource. type UpdateMethodResponseInput struct { - // [Required] The HTTP verb of the Method resource. + // The HTTP verb of the Method resource. // // This member is required. HttpMethod *string - // [Required] The Resource identifier for the MethodResponse resource. + // The Resource identifier for the MethodResponse resource. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] The status code for the MethodResponse resource. + // The status code for the MethodResponse resource. // // This member is required. StatusCode *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -60,34 +60,6 @@ type UpdateMethodResponseInput struct { // 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, IntegrationCreating an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type UpdateMethodResponseOutput struct { // Specifies the Model resources used for the response's content-type. Response diff --git a/service/apigateway/api_op_UpdateModel.go b/service/apigateway/api_op_UpdateModel.go index cf4ac07800a..5464dcc876e 100644 --- a/service/apigateway/api_op_UpdateModel.go +++ b/service/apigateway/api_op_UpdateModel.go @@ -30,31 +30,24 @@ func (c *Client) UpdateModel(ctx context.Context, params *UpdateModelInput, optF // Request to update an existing model in an existing RestApi resource. type UpdateModelInput struct { - // [Required] The name of the model to update. + // The name of the model to update. // // This member is required. ModelName *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// 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) +// Represents the data structure of a method's request or response payload. type UpdateModelOutput struct { // The content-type for the model. @@ -70,11 +63,10 @@ type UpdateModelOutput struct { Name *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 draft 4 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 // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_UpdateRequestValidator.go b/service/apigateway/api_op_UpdateRequestValidator.go index 5607d4c18bc..658b520e34c 100644 --- a/service/apigateway/api_op_UpdateRequestValidator.go +++ b/service/apigateway/api_op_UpdateRequestValidator.go @@ -30,31 +30,24 @@ func (c *Client) UpdateRequestValidator(ctx context.Context, params *UpdateReque // Updates a RequestValidator of a given RestApi. type UpdateRequestValidatorInput struct { - // [Required] The identifier of RequestValidator to be updated. + // The identifier of RequestValidator to be updated. // // This member is required. RequestValidatorId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// 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) +// A set of validation rules for incoming Method requests. type UpdateRequestValidatorOutput struct { // The identifier of this RequestValidator. diff --git a/service/apigateway/api_op_UpdateResource.go b/service/apigateway/api_op_UpdateResource.go index 6ca8fbd218c..f945bf64c24 100644 --- a/service/apigateway/api_op_UpdateResource.go +++ b/service/apigateway/api_op_UpdateResource.go @@ -30,25 +30,24 @@ func (c *Client) UpdateResource(ctx context.Context, params *UpdateResourceInput // Request to change information about a Resource resource. type UpdateResourceInput struct { - // [Required] The identifier of the Resource resource. + // The identifier of the Resource resource. // // This member is required. ResourceId *string - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// Represents an API resource. Create an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +// Represents an API resource. type UpdateResourceOutput struct { // The resource's identifier. @@ -63,85 +62,7 @@ type UpdateResourceOutput struct { // The last path segment for this resource. PathPart *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. + // Gets an API resource's method of a given HTTP verb. ResourceMethods map[string]types.Method // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_UpdateRestApi.go b/service/apigateway/api_op_UpdateRestApi.go index 5ecda63a7e8..d81a47a3992 100644 --- a/service/apigateway/api_op_UpdateRestApi.go +++ b/service/apigateway/api_op_UpdateRestApi.go @@ -31,30 +31,25 @@ func (c *Client) UpdateRestApi(ctx context.Context, params *UpdateRestApiInput, // Request to update an existing RestApi resource in your collection. type UpdateRestApiInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// Represents a REST API. Create an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +// Represents a REST API. 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. + // 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 types.ApiKeySourceType // The list of binary media types supported by the RestApi. By default, the RestApi diff --git a/service/apigateway/api_op_UpdateStage.go b/service/apigateway/api_op_UpdateStage.go index 6ecf187aa70..a144c596e8b 100644 --- a/service/apigateway/api_op_UpdateStage.go +++ b/service/apigateway/api_op_UpdateStage.go @@ -31,26 +31,25 @@ func (c *Client) UpdateStage(ctx context.Context, params *UpdateStageInput, optF // Requests API Gateway to change information about a Stage resource. type UpdateStageInput struct { - // [Required] The string identifier of the associated RestApi. + // The string identifier of the associated RestApi. // // This member is required. RestApiId *string - // [Required] The name of the Stage resource to change information about. + // The name of the Stage resource to change information about. // // This member is required. StageName *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } // 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) +// callable by users. type UpdateStageOutput struct { // Settings for logging access in this stage. diff --git a/service/apigateway/api_op_UpdateUsage.go b/service/apigateway/api_op_UpdateUsage.go index 5a041b018dc..e9fb9ef2b0b 100644 --- a/service/apigateway/api_op_UpdateUsage.go +++ b/service/apigateway/api_op_UpdateUsage.go @@ -32,28 +32,25 @@ func (c *Client) UpdateUsage(ctx context.Context, params *UpdateUsageInput, optF // usage plan associated with a specified API key. 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. + // The identifier of the API key associated with the usage plan in which a + // temporary extension is granted to the remaining quota. // // This member is required. KeyId *string - // [Required] The Id of the usage plan associated with the usage data. + // The Id of the usage plan associated with the usage data. // // This member is required. UsagePlanId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// 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) +// Represents the usage data of a usage plan. type UpdateUsageOutput struct { // The ending date of the usage data. diff --git a/service/apigateway/api_op_UpdateUsagePlan.go b/service/apigateway/api_op_UpdateUsagePlan.go index 1ddfa432ae1..4ad5f53a052 100644 --- a/service/apigateway/api_op_UpdateUsagePlan.go +++ b/service/apigateway/api_op_UpdateUsagePlan.go @@ -30,13 +30,13 @@ func (c *Client) UpdateUsagePlan(ctx context.Context, params *UpdateUsagePlanInp // The PATCH request to update a usage plan of a given plan Id. type UpdateUsagePlanInput struct { - // [Required] The Id of the to-be-updated usage plan. + // The Id of the to-be-updated usage plan. // // This member is required. UsagePlanId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -45,14 +45,11 @@ type UpdateUsagePlanInput struct { // Represents a usage plan used to specify who can assess associated API stages. // Optionally, target request rate and quota limits can be set. In some cases // clients can exceed the targets that you set. Don’t rely on usage plans to -// control costs. Consider using AWS Budgets +// control costs. Consider using Amazon Web Services Budgets // (https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) -// to monitor costs and AWS WAF +// to monitor costs and WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to -// manage API requests. 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) +// manage API requests. type UpdateUsagePlanOutput struct { // The associated API stages of a usage plan. @@ -77,7 +74,7 @@ type UpdateUsagePlanOutput struct { // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string - // Map containing method level throttling information for API stage in a usage + // A map containing method level throttling information for API stage in a usage // plan. Throttle *types.ThrottleSettings diff --git a/service/apigateway/api_op_UpdateVpcLink.go b/service/apigateway/api_op_UpdateVpcLink.go index 949c6feb370..2b424e5721d 100644 --- a/service/apigateway/api_op_UpdateVpcLink.go +++ b/service/apigateway/api_op_UpdateVpcLink.go @@ -30,27 +30,21 @@ func (c *Client) UpdateVpcLink(ctx context.Context, params *UpdateVpcLinkInput, // Updates an existing VpcLink of a specified identifier. type UpdateVpcLinkInput struct { - // [Required] The identifier of the VpcLink. It is used in an Integration to - // reference this VpcLink. + // The identifier of the VpcLink. It is used in an Integration to reference this + // VpcLink. // // This member is required. VpcLinkId *string - // A list of update operations to be applied to the specified resource and in the - // order specified in this list. + // For more information about supported patch operations, see Patch Operations + // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). PatchOperations []types.PatchOperation noSmithyDocumentSerde } // 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. +// Private Cloud (VPC). type UpdateVpcLinkOutput struct { // The description of the VPC link. diff --git a/service/apigateway/types/types.go b/service/apigateway/types/types.go index 565e9b62737..e1597bd141c 100644 --- a/service/apigateway/types/types.go +++ b/service/apigateway/types/types.go @@ -17,9 +17,7 @@ type AccessLogSettings struct { DestinationArn *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. + // $context variables. The format must include at least $context.requestId. Format *string noSmithyDocumentSerde @@ -28,8 +26,7 @@ type AccessLogSettings struct { // 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) +// stage. type ApiKey struct { // The timestamp when the API Key was created. @@ -83,11 +80,7 @@ type ApiStage struct { } // 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) +// Gateway will activate the authorizer when a client calls the method. type Authorizer struct { // Optional customer-defined field, used in OpenAPI imports and exports without @@ -121,15 +114,11 @@ type Authorizer struct { // The identifier for the authorizer resource. Id *string - // The identity source for which authorization is requested. - // - // * For a TOKEN or + // 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 + // 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 @@ -154,7 +143,7 @@ type Authorizer struct { // apply to the REQUEST authorizer. IdentityValidationExpression *string - // [Required] The name of the authorizer. + // The name of the authorizer. Name *string // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS @@ -173,10 +162,7 @@ type Authorizer struct { } // 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) +// after the domain name. type BasePathMapping struct { // The base path name that callers of the API must provide as part of the URL after @@ -214,11 +200,7 @@ type CanarySettings struct { } // 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) +// while sending requests to the integration endpoint. type ClientCertificate struct { // The identifier of the client certificate. @@ -245,13 +227,7 @@ type ClientCertificate struct { // 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/) +// over the Internet. type Deployment struct { // A summary of the RestApi at the date and time that the deployment resource was @@ -289,18 +265,7 @@ type DeploymentCanarySettings struct { noSmithyDocumentSerde } -// 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 +// A documentation part for a targeted API entity. type DocumentationPart struct { // The DocumentationPart identifier, generated by API Gateway when the @@ -328,11 +293,11 @@ type DocumentationPart struct { // Specifies the target API entity to which the documentation applies. type DocumentationPartLocation struct { - // [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. + // 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. // // This member is required. Type DocumentationPartType @@ -371,11 +336,7 @@ type DocumentationPartLocation struct { noSmithyDocumentSerde } -// 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 +// A snapshot of the documentation of an API. type DocumentationVersion struct { // The date when the API documentation snapshot is created. @@ -391,16 +352,7 @@ type DocumentationVersion struct { } // 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) +// (RestApi). type DomainName struct { // The reference to an AWS-managed certificate that will be used by edge-optimized @@ -420,24 +372,22 @@ type DomainName struct { // 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/). + // CloudFront documentation. DistributionDomainName *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). + // information, see Set up a Regional Custom Domain Name and AWS Regions and + // Endpoints for API Gateway. DistributionHostedZoneId *string // The custom domain name as an API host name, for example, my-api.example.com. DomainName *string - // The status of the DomainName migration. The valid values are AVAILABLE, - // UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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. + // 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 // An optional text message containing detailed information about status of the @@ -473,10 +423,8 @@ type DomainName struct { RegionalDomainName *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). + // more information, see Set up a Regional Custom Domain Name and AWS Regions and + // Endpoints for API Gateway. RegionalHostedZoneId *string // The Transport Layer Security (TLS) version + cipher suite for this DomainName. @@ -507,50 +455,7 @@ type EndpointConfiguration struct { } // 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) +// response parameters and mapping templates. type GatewayResponse struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway @@ -575,15 +480,12 @@ type GatewayResponse struct { noSmithyDocumentSerde } -// 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) +// Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. 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 - // MethodrequestParameters. + // for cacheKeyParameters, these parameters must also be specified for Method + // requestParameters. CacheKeyParameters []string // Specifies a group of related cached parameters. By default, API Gateway uses the @@ -592,10 +494,8 @@ type Integration struct { // resources. CacheNamespace *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. + // The ID of the VpcLink used for the integration when connectionType=VPC_LINK and + // undefined, otherwise. ConnectionId *string // The type of the network connection to the integration endpoint. The valid value @@ -605,17 +505,8 @@ type Integration struct { ConnectionType ConnectionType // 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 + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // 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 @@ -632,61 +523,25 @@ type Integration struct { HttpMethod *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 // 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. + // 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 // A key-value map specifying request parameters that are passed from the method @@ -711,63 +566,31 @@ type Integration struct { TlsConfig *TlsConfig // 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. + // following: 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 - // Specifies Uniform Resource Identifier (URI) of the integration endpoint. - // - // * For + // 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 + // URL according to the RFC-3986 specification, 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 + // 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 + // name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} + // is a designated subdomain supported by certain Amazon Web Services service for + // fast host-name lookup. action can be used for an Amazon Web Services 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 Amazon Web Services + // service resource, including the region of the integrated Amazon Web Services + // service, if applicable. For example, for integration with the S3 API of + // GetObject, 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 @@ -777,23 +600,13 @@ type Integration struct { // 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) +// back-end response. 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. + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // 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 // A key-value map specifying response parameters that are passed to the method @@ -840,86 +653,6 @@ type IntegrationResponse struct { // 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) type Method struct { // A boolean flag specifying whether a valid ApiKey is required to invoke this @@ -951,91 +684,9 @@ type Method struct { // 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 - // 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) + // Gets a method response associated with a given HTTP status code. MethodResponses map[string]MethodResponse // A human-friendly operation identifier for the method. For example, you can @@ -1067,34 +718,6 @@ type Method struct { // 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, IntegrationCreating an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) type MethodResponse struct { // Specifies the Model resources used for the response's content-type. Response @@ -1142,10 +765,8 @@ type MethodSetting struct { // Boolean. CachingEnabled bool - // Specifies whether full requests and responses are logged for this method, which - // affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to - // troubleshoot APIs, but can result in logging sensitive data. We recommend that - // you don't enable this option for production APIs. The PATCH path for this + // 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 @@ -1199,14 +820,7 @@ type MethodSnapshot struct { noSmithyDocumentSerde } -// 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) +// Represents the data structure of a method's request or response payload. type Model struct { // The content-type for the model. @@ -1222,19 +836,18 @@ type Model struct { Name *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 draft 4 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 noSmithyDocumentSerde } -// If specified, API Gateway performs two-way authentication between the client and -// the server. Clients must present a trusted certificate to access your custom -// domain name. +// The mutual TLS authentication configuration for a custom domain name. If +// specified, API Gateway performs two-way authentication between the client and +// the server. Clients must present a trusted certificate to access your API. type MutualTlsAuthentication struct { // An Amazon S3 URL that specifies the truststore for mutual TLS authentication, @@ -1258,29 +871,28 @@ type MutualTlsAuthentication struct { noSmithyDocumentSerde } -// If specified, API Gateway performs two-way authentication between the client and -// the server. Clients must present a trusted certificate to access your custom -// domain name. +// The mutual TLS authentication configuration for a custom domain name. If +// specified, API Gateway performs two-way authentication between the client and +// the server. Clients must present a trusted certificate to access your API. type MutualTlsAuthenticationInput struct { - // An Amazon S3 resource ARN that specifies the truststore for mutual TLS - // authentication, for example, s3://bucket-name/key-name. The truststore can - // contain certificates from public or private certificate authorities. To update - // the truststore, upload a new version to S3, and then update your custom domain - // name to use the new version. To update the truststore, you must have permissions - // to access the S3 object. + // An Amazon S3 URL that specifies the truststore for mutual TLS authentication, + // for example s3://bucket-name/key-name. The truststore can contain certificates + // from public or private certificate authorities. To update the truststore, upload + // a new version to S3, and then update your custom domain name to use the new + // version. To update the truststore, you must have permissions to access the S3 + // object. TruststoreUri *string // The version of the S3 object that contains your truststore. To specify a - // version, you must have versioning enabled for the S3 bucket. + // version, you must have versioning enabled for the S3 bucket TruststoreVersion *string noSmithyDocumentSerde } -// 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. +// For more information about supported patch operations, see Patch Operations +// (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). type PatchOperation struct { // The copy update operation's source as identified by a JSON-Pointer value @@ -1295,15 +907,14 @@ type PatchOperation struct { // 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. + // an error message.. Op Op - // The op operation's target, as identified by a JSON Pointer - // (https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08) value that - // references a location within the targeted resource. For example, if the target - // resource has an updateable property of {"name":"value"}, the path for this - // property is /name. If the name property value is a JSON object (e.g., {"name": - // {"child/name": "child-value"}}), the path for the child/name property will be + // The op operation's target, as identified by a JSON Pointer 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. @@ -1312,8 +923,7 @@ type PatchOperation struct { // 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). + // '{"a": ...}'. Value *string noSmithyDocumentSerde @@ -1325,8 +935,8 @@ type QuotaSettings struct { // The target maximum number of requests that can be made in a given time period. Limit int32 - // The day that a time period starts. For example, with a time period of WEEK, an - // offset of 0 starts on Sunday, and an offset of 1 starts on Monday. + // The number of requests subtracted from the given limit in the initial time + // period. Offset int32 // The time period in which the limit applies. Valid values are "DAY", "WEEK" or @@ -1336,14 +946,7 @@ type QuotaSettings struct { noSmithyDocumentSerde } -// 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) +// A set of validation rules for incoming Method requests. type RequestValidator struct { // The identifier of this RequestValidator. @@ -1363,8 +966,7 @@ type RequestValidator struct { noSmithyDocumentSerde } -// Represents an API resource. Create an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +// Represents an API resource. type Resource struct { // The resource's identifier. @@ -1379,102 +981,19 @@ type Resource struct { // The last path segment for this resource. PathPart *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. + // Gets an API resource's method of a given HTTP verb. ResourceMethods map[string]Method noSmithyDocumentSerde } -// Represents a REST API. Create an API -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html) +// Represents a REST API. 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. + // 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 // The list of binary media types supported by the RestApi. By default, the RestApi @@ -1570,8 +1089,7 @@ type SdkType struct { } // 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) +// callable by users. type Stage struct { // Settings for logging access in this stage. @@ -1661,13 +1179,13 @@ type ThrottleSettings struct { noSmithyDocumentSerde } +// Specifies the TLS configuration for an integration. 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 + // an integration endpoint is issued by a supported certificate authority. 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. @@ -1679,14 +1197,11 @@ type TlsConfig struct { // Represents a usage plan used to specify who can assess associated API stages. // Optionally, target request rate and quota limits can be set. In some cases // clients can exceed the targets that you set. Don’t rely on usage plans to -// control costs. Consider using AWS Budgets +// control costs. Consider using Amazon Web Services Budgets // (https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) -// to monitor costs and AWS WAF +// to monitor costs and WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to -// manage API requests. 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) +// manage API requests. type UsagePlan struct { // The associated API stages of a usage plan. @@ -1711,17 +1226,14 @@ type UsagePlan struct { // The collection of tags. Each tag element is associated with a given resource. Tags map[string]string - // Map containing method level throttling information for API stage in a usage + // A map containing method level throttling information for API stage in a usage // plan. Throttle *ThrottleSettings noSmithyDocumentSerde } -// 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) +// Represents a usage plan key to identify a plan customer. type UsagePlanKey struct { // The Id of a usage plan key. @@ -1740,13 +1252,7 @@ type UsagePlanKey struct { } // 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. +// Private Cloud (VPC). type VpcLink struct { // The description of the VPC link. diff --git a/service/apprunner/api_op_CreateVpcConnector.go b/service/apprunner/api_op_CreateVpcConnector.go index 7e825a3e212..06c75fe3c92 100644 --- a/service/apprunner/api_op_CreateVpcConnector.go +++ b/service/apprunner/api_op_CreateVpcConnector.go @@ -33,7 +33,8 @@ type CreateVpcConnectorInput struct { // A list of IDs of subnets that App Runner should use when it associates your // service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. - // App Runner determines the Amazon VPC from the subnets you specify. + // App Runner determines the Amazon VPC from the subnets you specify. App Runner + // currently only provides support for IPv4. // // This member is required. Subnets []string diff --git a/service/apprunner/types/types.go b/service/apprunner/types/types.go index c7c04ce5add..b9a40b64f0f 100644 --- a/service/apprunner/types/types.go +++ b/service/apprunner/types/types.go @@ -200,7 +200,7 @@ type CodeRepository struct { SourceCodeVersion *SourceCodeVersion // Configuration for building and running the service from a source code - // repository. + // repository. CodeConfiguration is required only for CreateService request. CodeConfiguration *CodeConfiguration noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_ActivateType.go b/service/cloudformation/api_op_ActivateType.go index 38ffaf9953e..4372ce66c1f 100644 --- a/service/cloudformation/api_op_ActivateType.go +++ b/service/cloudformation/api_op_ActivateType.go @@ -54,7 +54,7 @@ type ActivateTypeInput struct { // specify MajorVersion or VersionBump, but not both. MajorVersion *int64 - // The Amazon Resource Number (ARN) of the public extension. Conditional: You must + // The Amazon Resource Name (ARN) of the public extension. Conditional: You must // specify PublicTypeArn, or TypeName, Type, and PublisherId. PublicTypeArn *string @@ -95,7 +95,7 @@ type ActivateTypeInput struct { type ActivateTypeOutput struct { - // The Amazon Resource Number (ARN) of the activated extension, in this account and + // The Amazon Resource Name (ARN) of the activated extension, in this account and // region. Arn *string diff --git a/service/cloudformation/api_op_CreateChangeSet.go b/service/cloudformation/api_op_CreateChangeSet.go index f51cafce7d2..25660f8a360 100644 --- a/service/cloudformation/api_op_CreateChangeSet.go +++ b/service/cloudformation/api_op_CreateChangeSet.go @@ -85,7 +85,7 @@ type CreateChangeSetInput struct { // these capabilities, CloudFormation returns an InsufficientCapabilities // error. // - // If your stack template contains these resources, we recommend that you + // If your stack template contains these resources, we suggest that you // review all permissions associated with them and edit their permissions if // necessary. // @@ -138,8 +138,8 @@ type CreateChangeSetInput struct { // no effect. If you want to create a stack from a stack template that contains // macros and nested stacks, you must create or update the stack directly from the // template using the CreateStack or UpdateStack action, and specifying this - // capability. For more information on macros, see Using CloudFormation macros to - // perform custom processing on templates + // capability. For more information about macros, see Using CloudFormation macros + // to perform custom processing on templates // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). Capabilities []types.Capability diff --git a/service/cloudformation/api_op_CreateStackSet.go b/service/cloudformation/api_op_CreateStackSet.go index 02c01868269..0d69ff7e5f0 100644 --- a/service/cloudformation/api_op_CreateStackSet.go +++ b/service/cloudformation/api_op_CreateStackSet.go @@ -38,8 +38,8 @@ type CreateStackSetInput struct { // This member is required. StackSetName *string - // The Amazon Resource Number (ARN) of the IAM role to use to create this stack - // set. Specify an IAM role only if you are using customized administrator roles to + // The Amazon Resource Name (ARN) of the IAM role to use to create this stack set. + // Specify an IAM role only if you are using customized administrator roles to // control which users or groups can manage specific stack sets within the same // administrator account. For more information, see Prerequisites: Granting // Permissions for Stack Set Operations @@ -189,7 +189,7 @@ type CreateStackSetInput struct { PermissionModel types.PermissionModels // The stack ID you are importing into a new stack set. Specify the Amazon Resource - // Number (ARN) of the stack. + // Name (ARN) of the stack. StackId *string // The key-value pairs to associate with this stack set and the stacks created from diff --git a/service/cloudformation/api_op_DeleteStackSet.go b/service/cloudformation/api_op_DeleteStackSet.go index bd80300f26c..e8a6e35cd99 100644 --- a/service/cloudformation/api_op_DeleteStackSet.go +++ b/service/cloudformation/api_op_DeleteStackSet.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a stack set. Before you can delete a stack set, all of its member stack -// instances must be deleted. For more information about how to do this, see +// Deletes a stack set. Before you can delete a stack set, all its member stack +// instances must be deleted. For more information about how to complete this, see // DeleteStackInstances. func (c *Client) DeleteStackSet(ctx context.Context, params *DeleteStackSetInput, optFns ...func(*Options)) (*DeleteStackSetOutput, error) { if params == nil { diff --git a/service/cloudformation/api_op_DescribePublisher.go b/service/cloudformation/api_op_DescribePublisher.go index 65f369f1a89..7402c59a881 100644 --- a/service/cloudformation/api_op_DescribePublisher.go +++ b/service/cloudformation/api_op_DescribePublisher.go @@ -14,7 +14,7 @@ import ( // Returns information about a CloudFormation extension publisher. If you don't // supply a PublisherId, and you have registered as an extension publisher, // DescribePublisher returns information about your own publisher account. For more -// information on registering as a publisher, see: +// information about registering as a publisher, see: // // * RegisterPublisher // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html) diff --git a/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go b/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go index 85eae69f48d..58c58482c21 100644 --- a/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go +++ b/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go @@ -16,7 +16,7 @@ import ( // detection operation detects whether a stack's actual configuration differs, or // has drifted, from it's expected configuration, as defined in the stack template // and any values specified as template parameters. A stack is considered to have -// drifted if one or more of its resources have drifted. For more information on +// drifted if one or more of its resources have drifted. For more information about // stack and resource drift, see Detecting Unregulated Configuration Changes to // Stacks and Resources // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). diff --git a/service/cloudformation/api_op_DescribeStackResourceDrifts.go b/service/cloudformation/api_op_DescribeStackResourceDrifts.go index 0df961f80eb..10b35f326c6 100644 --- a/service/cloudformation/api_op_DescribeStackResourceDrifts.go +++ b/service/cloudformation/api_op_DescribeStackResourceDrifts.go @@ -88,8 +88,8 @@ type DescribeStackResourceDriftsOutput struct { // This member is required. StackResourceDrifts []types.StackResourceDrift - // If the request doesn't return all of the remaining results, NextToken is set to - // a token. To retrieve the next set of results, call DescribeStackResourceDrifts + // If the request doesn't return all the remaining results, NextToken is set to a + // token. To retrieve the next set of results, call DescribeStackResourceDrifts // again and assign that token to the request object's NextToken parameter. If the // request returns all results, NextToken is set to null. NextToken *string diff --git a/service/cloudformation/api_op_DescribeType.go b/service/cloudformation/api_op_DescribeType.go index 46e242a42d3..445591cf5c9 100644 --- a/service/cloudformation/api_op_DescribeType.go +++ b/service/cloudformation/api_op_DescribeType.go @@ -40,8 +40,8 @@ type DescribeTypeInput struct { // The version number of a public third-party extension. PublicVersionNumber *string - // The publisher ID of the extension publisher. Extensions provided by Amazon are - // not assigned a publisher ID. + // The publisher ID of the extension publisher. Extensions provided by Amazon Web + // Services are not assigned a publisher ID. PublisherId *string // The kind of extension. Conditional: You must specify either TypeName and Type, @@ -86,8 +86,8 @@ type DescribeTypeOutput struct { // The ID of the default version of the extension. The default version is used when // the extension version isn't specified. This applies only to private extensions // you have registered in your account. For public extensions, both those provided - // by Amazon and published by third parties, CloudFormation returns null. For more - // information, see RegisterType + // by Amazon Web Services and published by third parties, CloudFormation returns + // null. For more information, see RegisterType // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). // To set the default version of an extension, use SetTypeDefaultVersion. DefaultVersionId *string @@ -124,15 +124,15 @@ type DescribeTypeOutput struct { // role to provide your extension with the appropriate credentials. ExecutionRoleArn *string - // Whether or not the extension is activated in the account and region. This only - // applies to public third-party extensions. For all other extensions, - // CloudFormation returns null. + // Whether the extension is activated in the account and region. This only applies + // to public third-party extensions. For all other extensions, CloudFormation + // returns null. IsActivated *bool // Whether the specified extension version is set as the default version. This // applies only to private extensions you have registered in your account, and - // extensions published by Amazon. For public third-party extensions, whether or - // not they are activated in your account, CloudFormation returns null. + // extensions published by Amazon Web Services. For public third-party extensions, + // whether they are activated in your account, CloudFormation returns null. IsDefaultVersion *bool // When the specified extension version was registered. This applies only to: @@ -155,8 +155,8 @@ type DescribeTypeOutput struct { // Contains logging configuration information for private extensions. This applies // only to private extensions you have registered in your account. For public - // extensions, both those provided by Amazon and published by third parties, - // CloudFormation returns null. For more information, see RegisterType + // extensions, both those provided by Amazon Web Services and published by third + // parties, CloudFormation returns null. For more information, see RegisterType // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). LoggingConfig *types.LoggingConfig @@ -212,7 +212,7 @@ type DescribeTypeOutput struct { // activated in your account in order for the module itself to be activated. RequiredActivatedTypes []types.RequiredActivatedType - // The schema that defines the extension. For more information on extension + // The schema that defines the extension. For more information about extension // schemas, see Resource Provider Schema // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) // in the CloudFormation CLI User Guide. @@ -237,12 +237,12 @@ type DescribeTypeOutput struct { // The contract test status of the registered extension version. To return the // extension test status of a specific extension version, you must specify // VersionId. This applies only to registered private extension versions. - // CloudFormation doesn't return this information for public extensions, whether or - // not they are activated in your account. + // CloudFormation doesn't return this information for public extensions, whether + // they are activated in your account. // - // * PASSED: The extension has passed all - // its contract tests. An extension must have a test status of PASSED before it can - // be published. For more information, see Publishing extensions to make them + // * PASSED: The extension has passed all its + // contract tests. An extension must have a test status of PASSED before it can be + // published. For more information, see Publishing extensions to make them // available for public use // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) // in the CloudFormation Command Line Interface User Guide. @@ -260,8 +260,7 @@ type DescribeTypeOutput struct { // The description of the test status. To return the extension test status of a // specific extension version, you must specify VersionId. This applies only to // registered private extension versions. CloudFormation doesn't return this - // information for public extensions, whether or not they are activated in your - // account. + // information for public extensions, whether they are activated in your account. TypeTestsStatusDescription *string // The scope at which the extension is visible and usable in CloudFormation @@ -272,7 +271,7 @@ type DescribeTypeOutput struct { // extensions you register as PRIVATE. // // * PUBLIC: The extension is publicly visible - // and usable within any Amazon account. + // and usable within any Amazon Web Services account. Visibility types.Visibility // Metadata pertaining to the operation's result. diff --git a/service/cloudformation/api_op_DetectStackSetDrift.go b/service/cloudformation/api_op_DetectStackSetDrift.go index f401661fb61..48199b2d780 100644 --- a/service/cloudformation/api_op_DetectStackSetDrift.go +++ b/service/cloudformation/api_op_DetectStackSetDrift.go @@ -38,7 +38,7 @@ import ( // detailed information about a specific stack instance, including its drift status // and last drift time checked. // -// For more information on performing a drift +// For more information about performing a drift // detection operation on a stack set, see Detecting unmanaged changes in stack // sets // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html). @@ -86,7 +86,7 @@ type DetectStackSetDriftInput struct { OperationId *string // The user-specified preferences for how CloudFormation performs a stack set - // operation. For more information on maximum concurrent accounts and failure + // operation. For more information about maximum concurrent accounts and failure // tolerance, see Stack set operation options // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options). OperationPreferences *types.StackSetOperationPreferences diff --git a/service/cloudformation/api_op_ImportStacksToStackSet.go b/service/cloudformation/api_op_ImportStacksToStackSet.go index df7b791ea80..116318e5c26 100644 --- a/service/cloudformation/api_op_ImportStacksToStackSet.go +++ b/service/cloudformation/api_op_ImportStacksToStackSet.go @@ -53,7 +53,7 @@ type ImportStacksToStackSetInput struct { OperationId *string // The user-specified preferences for how CloudFormation performs a stack set - // operation. For more information on maximum concurrent accounts and failure + // operation. For more information about maximum concurrent accounts and failure // tolerance, see Stack set operation options // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options). OperationPreferences *types.StackSetOperationPreferences diff --git a/service/cloudformation/api_op_ListStackInstances.go b/service/cloudformation/api_op_ListStackInstances.go index fb4df69cb8c..c9ad631839e 100644 --- a/service/cloudformation/api_op_ListStackInstances.go +++ b/service/cloudformation/api_op_ListStackInstances.go @@ -64,9 +64,9 @@ type ListStackInstancesInput struct { // of results. MaxResults *int32 - // If the previous request didn't return all of the remaining results, the - // response's NextToken parameter value is set to a token. To retrieve the next set - // of results, call ListStackInstances again and assign that token to the request + // If the previous request didn't return all the remaining results, the response's + // NextToken parameter value is set to a token. To retrieve the next set of + // results, call ListStackInstances again and assign that token to the request // object's NextToken parameter. If there are no remaining results, the previous // response object's NextToken parameter is set to null. NextToken *string diff --git a/service/cloudformation/api_op_ListStackSetOperationResults.go b/service/cloudformation/api_op_ListStackSetOperationResults.go index ed793ee995c..b46c2cf19f1 100644 --- a/service/cloudformation/api_op_ListStackSetOperationResults.go +++ b/service/cloudformation/api_op_ListStackSetOperationResults.go @@ -63,7 +63,7 @@ type ListStackSetOperationResultsInput struct { // of results. MaxResults *int32 - // If the previous request didn't return all of the remaining results, the response + // If the previous request didn't return all the remaining results, the response // object's NextToken parameter value is set to a token. To retrieve the next set // of results, call ListStackSetOperationResults again and assign that token to the // request object's NextToken parameter. If there are no remaining results, the diff --git a/service/cloudformation/api_op_ListTypeRegistrations.go b/service/cloudformation/api_op_ListTypeRegistrations.go index cd0e6fdd0a0..b36916d8cf3 100644 --- a/service/cloudformation/api_op_ListTypeRegistrations.go +++ b/service/cloudformation/api_op_ListTypeRegistrations.go @@ -64,8 +64,8 @@ type ListTypeRegistrationsInput struct { type ListTypeRegistrationsOutput struct { - // If the request doesn't return all of the remaining results, NextToken is set to - // a token. To retrieve the next set of results, call this action again and assign + // If the request doesn't return all the remaining results, NextToken is set to a + // token. To retrieve the next set of results, call this action again and assign // that token to the request object's NextToken parameter. If the request returns // all results, NextToken is set to null. NextToken *string diff --git a/service/cloudformation/api_op_ListTypes.go b/service/cloudformation/api_op_ListTypes.go index 3cb9e25414a..6ba187e306a 100644 --- a/service/cloudformation/api_op_ListTypes.go +++ b/service/cloudformation/api_op_ListTypes.go @@ -53,11 +53,11 @@ type ListTypesInput struct { // of results. MaxResults *int32 - // If the previous paginated request didn't return all of the remaining results, - // the response object's NextToken parameter value is set to a token. To retrieve - // the next set of results, call this action again and assign that token to the - // request object's NextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // If the previous paginated request didn't return all the remaining results, the + // response object's NextToken parameter value is set to a token. To retrieve the + // next set of results, call this action again and assign that token to the request + // object's NextToken parameter. If there are no remaining results, the previous + // response object's NextToken parameter is set to null. NextToken *string // For resource types, the provisioning behavior of the resource type. @@ -96,11 +96,11 @@ type ListTypesInput struct { // activated in this account and region. // // * PUBLIC: Extensions that are publicly - // visible and available to be activated within any Amazon account. This includes - // extensions from Amazon, as well as third-party publishers. + // visible and available to be activated within any Amazon Web Services account. + // This includes extensions from Amazon Web Services, in addition to third-party + // publishers. // - // The default is - // PRIVATE. + // The default is PRIVATE. Visibility types.Visibility noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_PublishType.go b/service/cloudformation/api_op_PublishType.go index 719bab69182..8a1abbfc7c0 100644 --- a/service/cloudformation/api_op_PublishType.go +++ b/service/cloudformation/api_op_PublishType.go @@ -13,7 +13,7 @@ import ( // Publishes the specified extension to the CloudFormation registry as a public // extension in this region. Public extensions are available for use by all -// CloudFormation users. For more information on publishing extensions, see +// CloudFormation users. For more information about publishing extensions, see // Publishing extensions to make them available for public use // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) // in the CloudFormation CLI User Guide. To publish an extension, you must be @@ -37,7 +37,7 @@ func (c *Client) PublishType(ctx context.Context, params *PublishTypeInput, optF type PublishTypeInput struct { - // The Amazon Resource Number (ARN) of the extension. Conditional: You must specify + // The Amazon Resource Name (ARN) of the extension. Conditional: You must specify // Arn, or TypeName and Type. Arn *string @@ -63,7 +63,7 @@ type PublishTypeInput struct { type PublishTypeOutput struct { - // The Amazon Resource Number (ARN) assigned to the public extension upon + // The Amazon Resource Name (ARN) assigned to the public extension upon // publication. PublicTypeArn *string diff --git a/service/cloudformation/api_op_RegisterPublisher.go b/service/cloudformation/api_op_RegisterPublisher.go index ba33592d28e..b3ffc0f2b25 100644 --- a/service/cloudformation/api_op_RegisterPublisher.go +++ b/service/cloudformation/api_op_RegisterPublisher.go @@ -13,8 +13,8 @@ import ( // Registers your account as a publisher of public extensions in the CloudFormation // registry. Public extensions are available for use by all CloudFormation users. // This publisher ID applies to your account in all Amazon Web Services Regions. -// For information on requirements for registering as a public extension publisher, -// see Registering your account to publish CloudFormation extensions +// For information about requirements for registering as a public extension +// publisher, see Registering your account to publish CloudFormation extensions // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) // in the CloudFormation CLI User Guide. func (c *Client) RegisterPublisher(ctx context.Context, params *RegisterPublisherInput, optFns ...func(*Options)) (*RegisterPublisherOutput, error) { diff --git a/service/cloudformation/api_op_RegisterType.go b/service/cloudformation/api_op_RegisterType.go index ddc105b830f..b6981a5cfbc 100644 --- a/service/cloudformation/api_op_RegisterType.go +++ b/service/cloudformation/api_op_RegisterType.go @@ -23,9 +23,9 @@ import ( // * // Making the extension available for use in your account. // -// For more information on -// how to develop extensions and ready them for registration, see Creating Resource -// Providers +// For more information +// about how to develop extensions and ready them for registration, see Creating +// Resource Providers // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) // in the CloudFormation CLI User Guide. You can have a maximum of 50 resource // extension versions registered at a time. This maximum is per account and per @@ -55,9 +55,9 @@ func (c *Client) RegisterType(ctx context.Context, params *RegisterTypeInput, op type RegisterTypeInput struct { // A URL to the S3 bucket containing the extension project package that contains - // the necessary files for the extension you want to register. For information on - // generating a schema handler package for the extension you want to register, see - // submit + // the necessary files for the extension you want to register. For information + // about generating a schema handler package for the extension you want to + // register, see submit // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) // in the CloudFormation CLI User Guide. The user registering the extension must be // able to access the package in the S3 bucket. That's, the user needs to have @@ -70,7 +70,7 @@ type RegisterTypeInput struct { // This member is required. SchemaHandlerPackage *string - // The name of the extension being registered. We recommend that extension names + // The name of the extension being registered. We suggest that extension names // adhere to the following patterns: // // * For resource types, @@ -79,15 +79,18 @@ type RegisterTypeInput struct { // * For modules, // company_or_organization::service::type::MODULE. // - // The following organization - // namespaces are reserved and can't be used in your extension names: + // * For hooks, + // MyCompany::Testing::MyTestHook. + // + // The following organization namespaces are + // reserved and can't be used in your extension names: // // * Alexa // - // * - // AMZN + // * AMZN // - // * Amazon + // * + // Amazon // // * AWS // @@ -107,7 +110,7 @@ type RegisterTypeInput struct { // The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when // invoking the extension. For CloudFormation to assume the specified execution // role, the role must contain a trust relationship with the CloudFormation service - // principle (resources.cloudformation.amazonaws.com). For more information on + // principle (resources.cloudformation.amazonaws.com). For more information about // adding trust relationships, see Modifying a role trust policy in the Identity // and Access Management User Guide. If your extension calls Amazon Web Services // APIs in any of its handlers, you must create an IAM execution role diff --git a/service/cloudformation/api_op_UpdateStack.go b/service/cloudformation/api_op_UpdateStack.go index 43bc41e462d..4c69e609aac 100644 --- a/service/cloudformation/api_op_UpdateStack.go +++ b/service/cloudformation/api_op_UpdateStack.go @@ -62,7 +62,7 @@ type UpdateStackInput struct { // these capabilities, CloudFormation returns an InsufficientCapabilities // error. // - // If your stack template contains these resources, we recommend that you + // If your stack template contains these resources, we suggest that you // review all permissions associated with them and edit their permissions if // necessary. // @@ -188,7 +188,7 @@ type UpdateStackInput struct { // Structure containing the temporary overriding stack policy body. You can specify // either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL // parameter, but not both. If you want to update protected resources, specify a - // temporary overriding stack policy during this update. If you do not specify a + // temporary overriding stack policy during this update. If you don't specify a // stack policy, the current policy that is associated with the stack will be used. StackPolicyDuringUpdateBody *string @@ -197,7 +197,7 @@ type UpdateStackInput struct { // Region as the stack. You can specify either the StackPolicyDuringUpdateBody or // the StackPolicyDuringUpdateURL parameter, but not both. If you want to update // protected resources, specify a temporary overriding stack policy during this - // update. If you do not specify a stack policy, the current policy that is + // update. If you don't specify a stack policy, the current policy that is // associated with the stack will be used. StackPolicyDuringUpdateURL *string diff --git a/service/cloudformation/api_op_UpdateStackSet.go b/service/cloudformation/api_op_UpdateStackSet.go index b7820b19441..a067b8b3956 100644 --- a/service/cloudformation/api_op_UpdateStackSet.go +++ b/service/cloudformation/api_op_UpdateStackSet.go @@ -54,8 +54,8 @@ type UpdateStackSetInput struct { // stack instances with their existing stack instance status. Accounts []string - // The Amazon Resource Number (ARN) of the IAM role to use to update this stack - // set. Specify an IAM role only if you are using customized administrator roles to + // The Amazon Resource Name (ARN) of the IAM role to use to update this stack set. + // Specify an IAM role only if you are using customized administrator roles to // control which users or groups can manage specific stack sets within the same // administrator account. For more information, see Granting Permissions for Stack // Set Operations diff --git a/service/cloudformation/deserializers.go b/service/cloudformation/deserializers.go index 0423b6e730f..774ff48a37b 100644 --- a/service/cloudformation/deserializers.go +++ b/service/cloudformation/deserializers.go @@ -15822,6 +15822,19 @@ func awsAwsquery_deserializeDocumentStackSetOperation(v **types.StackSetOperatio sv.Status = types.StackSetOperationStatus(xtv) } + case strings.EqualFold("StatusReason", t.Name.Local): + val, err := decoder.Value() + if err != nil { + return err + } + if val == nil { + break + } + { + xtv := string(val) + sv.StatusReason = ptr.String(xtv) + } + default: // Do nothing and ignore the unexpected tag element err = decoder.Decoder.Skip() @@ -16297,6 +16310,19 @@ func awsAwsquery_deserializeDocumentStackSetOperationSummary(v **types.StackSetO sv.Status = types.StackSetOperationStatus(xtv) } + case strings.EqualFold("StatusReason", t.Name.Local): + val, err := decoder.Value() + if err != nil { + return err + } + if val == nil { + break + } + { + xtv := string(val) + sv.StatusReason = ptr.String(xtv) + } + default: // Do nothing and ignore the unexpected tag element err = decoder.Decoder.Skip() diff --git a/service/cloudformation/types/errors.go b/service/cloudformation/types/errors.go index 7fb0287d103..8f73076e5a3 100644 --- a/service/cloudformation/types/errors.go +++ b/service/cloudformation/types/errors.go @@ -167,8 +167,8 @@ func (e *InvalidStateTransitionException) ErrorMessage() string { func (e *InvalidStateTransitionException) ErrorCode() string { return "InvalidStateTransition" } func (e *InvalidStateTransitionException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The quota for the resource has already been reached. For information on resource -// and stack limitations, see CloudFormation quotas +// The quota for the resource has already been reached. For information about +// resource and stack limitations, see CloudFormation quotas // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) // in the CloudFormation User Guide. type LimitExceededException struct { diff --git a/service/cloudformation/types/types.go b/service/cloudformation/types/types.go index 5b735be404c..4fd7a2accab 100644 --- a/service/cloudformation/types/types.go +++ b/service/cloudformation/types/types.go @@ -336,7 +336,7 @@ type ManagedExecution struct { // Contains information about the module from which the resource was created, if // the resource was created from a module included in the stack template. For more -// information on modules, see Using modules to encapsulate and reuse resource +// information about modules, see Using modules to encapsulate and reuse resource // configurations in the CloudFormation User Guide. type ModuleInfo struct { @@ -823,17 +823,17 @@ type Stack struct { // * false: enable rollback. DisableRollback *bool - // Information on whether a stack's actual configuration differs, or has drifted, - // from it's expected configuration, as defined in the stack template and any - // values specified as template parameters. For more information, see Detecting + // Information about whether a stack's actual configuration differs, or has + // drifted, from it's expected configuration, as defined in the stack template and + // any values specified as template parameters. For more information, see Detecting // Unregulated Configuration Changes to Stacks and Resources // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackDriftInformation // Whether termination protection is enabled for the stack. For nested stacks // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), - // termination protection is set on the root stack and cannot be changed directly - // on the nested stack. For more information, see Protecting a Stack From Being + // termination protection is set on the root stack and can't be changed directly on + // the nested stack. For more information, see Protecting a Stack From Being // Deleted // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) // in the CloudFormation User Guide. @@ -1508,7 +1508,7 @@ type StackResourceDriftInformationSummary struct { // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). // If you performed an ContinueUpdateRollback operation on a stack, any resources // included in ResourcesToSkip will also have a status of NOT_CHECKED. For more - // information on skipping resources during rollback operations, see Continue + // information about skipping resources during rollback operations, see Continue // Rolling Back an Update // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html) // in the CloudFormation User Guide. @@ -1580,7 +1580,7 @@ type StackResourceSummary struct { // template requires. type StackSet struct { - // The Amazon Resource Number (ARN) of the IAM role used to create or update the + // The Amazon Resource Name (ARN) of the IAM role used to create or update the // stack set. Use customized administrator roles to control which users or groups // can manage specific stack sets within the same administrator account. For more // information, see Prerequisites: Granting Permissions for Stack Set Operations @@ -1637,7 +1637,7 @@ type StackSet struct { // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). PermissionModel PermissionModels - // The Amazon Resource Number (ARN) of the stack set. + // The Amazon Resource Name (ARN) of the stack set. StackSetARN *string // Detailed information about the drift status of the stack set. For stack sets, @@ -1761,7 +1761,7 @@ type StackSetOperation struct { // itself, in addition to all associated stack set instances. Action StackSetOperationAction - // The Amazon Resource Number (ARN) of the IAM role used to perform this stack set + // The Amazon Resource Name (ARN) of the IAM role used to perform this stack set // operation. Use customized administrator roles to control which users or groups // can manage specific stack sets within the same administrator account. For more // information, see Define Permissions for Multiple Administrators @@ -1844,11 +1844,14 @@ type StackSetOperation struct { // exceeding the failure tolerance for the operation. Status StackSetOperationStatus + // The status of the operation in details. + StatusReason *string + noSmithyDocumentSerde } // The user-specified preferences for how CloudFormation performs a stack set -// operation. For more information on maximum concurrent accounts and failure +// operation. For more information about maximum concurrent accounts and failure // tolerance, see Stack set operation options // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options). type StackSetOperationPreferences struct { @@ -2003,6 +2006,9 @@ type StackSetOperationSummary struct { // exceeding the failure tolerance for the operation. Status StackSetOperationStatus + // The status of the operation in details. + StatusReason *string + noSmithyDocumentSerde } @@ -2094,10 +2100,10 @@ type StackSummary struct { // The time the stack was deleted. DeletionTime *time.Time - // Summarizes information on whether a stack's actual configuration differs, or has - // drifted, from it's expected configuration, as defined in the stack template and - // any values specified as template parameters. For more information, see Detecting - // Unregulated Configuration Changes to Stacks and Resources + // Summarizes information about whether a stack's actual configuration differs, or + // has drifted, from it's expected configuration, as defined in the stack template + // and any values specified as template parameters. For more information, see + // Detecting Unregulated Configuration Changes to Stacks and Resources // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackDriftInformationSummary @@ -2191,8 +2197,7 @@ type TypeConfigurationDetails struct { // extension, CloudFormation returns {}. Configuration *string - // Whether or not this configuration data is the default configuration for the - // extension. + // Whether this configuration data is the default configuration for the extension. IsDefaultConfiguration *bool // When the configuration data was last updated for this extension. If a @@ -2294,9 +2299,9 @@ type TypeSummary struct { // The description of the extension. Description *string - // Whether or not the extension is activated for this account and region. This - // applies only to third-party public extensions. Extensions published by Amazon - // are activated by default. + // Whether the extension is activated for this account and region. This applies + // only to third-party public extensions. Extensions published by Amazon are + // activated by default. IsActivated *bool // When the specified extension version was registered. This applies only to: diff --git a/service/fsx/api_op_UpdateFileSystem.go b/service/fsx/api_op_UpdateFileSystem.go index a0d84a989e4..df8e093dd18 100644 --- a/service/fsx/api_op_UpdateFileSystem.go +++ b/service/fsx/api_op_UpdateFileSystem.go @@ -46,6 +46,9 @@ import ( // // * DataCompressionType // +// * +// LustreRootSquashConfiguration +// // * StorageCapacity // // * diff --git a/service/fsx/deserializers.go b/service/fsx/deserializers.go index 628c55878c5..c1045344568 100644 --- a/service/fsx/deserializers.go +++ b/service/fsx/deserializers.go @@ -8886,6 +8886,11 @@ func awsAwsjson11_deserializeDocumentLustreFileSystemConfiguration(v **types.Lus sv.PerUnitStorageThroughput = ptr.Int32(int32(i64)) } + case "RootSquashConfiguration": + if err := awsAwsjson11_deserializeDocumentLustreRootSquashConfiguration(&sv.RootSquashConfiguration, value); err != nil { + return err + } + case "WeeklyMaintenanceStartTime": if value != nil { jtv, ok := value.(string) @@ -8953,6 +8958,87 @@ func awsAwsjson11_deserializeDocumentLustreLogConfiguration(v **types.LustreLogC return nil } +func awsAwsjson11_deserializeDocumentLustreNoSquashNids(v *[]string, value interface{}) error { + if v == nil { + return fmt.Errorf("unexpected nil of type %T", v) + } + if value == nil { + return nil + } + + shape, ok := value.([]interface{}) + if !ok { + return fmt.Errorf("unexpected JSON type %v", value) + } + + var cv []string + if *v == nil { + cv = []string{} + } else { + cv = *v + } + + for _, value := range shape { + var col string + if value != nil { + jtv, ok := value.(string) + if !ok { + return fmt.Errorf("expected LustreNoSquashNid to be of type string, got %T instead", value) + } + col = jtv + } + cv = append(cv, col) + + } + *v = cv + return nil +} + +func awsAwsjson11_deserializeDocumentLustreRootSquashConfiguration(v **types.LustreRootSquashConfiguration, value interface{}) error { + if v == nil { + return fmt.Errorf("unexpected nil of type %T", v) + } + if value == nil { + return nil + } + + shape, ok := value.(map[string]interface{}) + if !ok { + return fmt.Errorf("unexpected JSON type %v", value) + } + + var sv *types.LustreRootSquashConfiguration + if *v == nil { + sv = &types.LustreRootSquashConfiguration{} + } else { + sv = *v + } + + for key, value := range shape { + switch key { + case "NoSquashNids": + if err := awsAwsjson11_deserializeDocumentLustreNoSquashNids(&sv.NoSquashNids, value); err != nil { + return err + } + + case "RootSquash": + if value != nil { + jtv, ok := value.(string) + if !ok { + return fmt.Errorf("expected LustreRootSquash to be of type string, got %T instead", value) + } + sv.RootSquash = ptr.String(jtv) + } + + default: + _, _ = key, value + + } + } + *v = sv + return nil +} + func awsAwsjson11_deserializeDocumentMissingFileSystemConfiguration(v **types.MissingFileSystemConfiguration, value interface{}) error { if v == nil { return fmt.Errorf("unexpected nil of type %T", v) diff --git a/service/fsx/serializers.go b/service/fsx/serializers.go index 5012693523a..0880f0befe8 100644 --- a/service/fsx/serializers.go +++ b/service/fsx/serializers.go @@ -2192,6 +2192,13 @@ func awsAwsjson11_serializeDocumentCreateFileSystemLustreConfiguration(v *types. ok.Integer(*v.PerUnitStorageThroughput) } + if v.RootSquashConfiguration != nil { + ok := object.Key("RootSquashConfiguration") + if err := awsAwsjson11_serializeDocumentLustreRootSquashConfiguration(v.RootSquashConfiguration, ok); err != nil { + return err + } + } + if v.WeeklyMaintenanceStartTime != nil { ok := object.Key("WeeklyMaintenanceStartTime") ok.String(*v.WeeklyMaintenanceStartTime) @@ -2817,6 +2824,36 @@ func awsAwsjson11_serializeDocumentLustreLogCreateConfiguration(v *types.LustreL return nil } +func awsAwsjson11_serializeDocumentLustreNoSquashNids(v []string, value smithyjson.Value) error { + array := value.Array() + defer array.Close() + + for i := range v { + av := array.Value() + av.String(v[i]) + } + return nil +} + +func awsAwsjson11_serializeDocumentLustreRootSquashConfiguration(v *types.LustreRootSquashConfiguration, value smithyjson.Value) error { + object := value.Object() + defer object.Close() + + if v.NoSquashNids != nil { + ok := object.Key("NoSquashNids") + if err := awsAwsjson11_serializeDocumentLustreNoSquashNids(v.NoSquashNids, ok); err != nil { + return err + } + } + + if v.RootSquash != nil { + ok := object.Key("RootSquash") + ok.String(*v.RootSquash) + } + + return nil +} + func awsAwsjson11_serializeDocumentOpenZFSClientConfiguration(v *types.OpenZFSClientConfiguration, value smithyjson.Value) error { object := value.Object() defer object.Close() @@ -3299,6 +3336,13 @@ func awsAwsjson11_serializeDocumentUpdateFileSystemLustreConfiguration(v *types. } } + if v.RootSquashConfiguration != nil { + ok := object.Key("RootSquashConfiguration") + if err := awsAwsjson11_serializeDocumentLustreRootSquashConfiguration(v.RootSquashConfiguration, ok); err != nil { + return err + } + } + if v.WeeklyMaintenanceStartTime != nil { ok := object.Key("WeeklyMaintenanceStartTime") ok.String(*v.WeeklyMaintenanceStartTime) diff --git a/service/fsx/types/types.go b/service/fsx/types/types.go index c1545ccac37..a15e419bc7f 100644 --- a/service/fsx/types/types.go +++ b/service/fsx/types/types.go @@ -571,6 +571,11 @@ type CreateFileSystemLustreConfiguration struct { // * For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB. PerUnitStorageThroughput *int32 + // The Lustre root squash configuration used when creating an Amazon FSx for Lustre + // file system. When enabled, root squash restricts root-level access from clients + // that try to access your file system as a root user. + RootSquashConfiguration *LustreRootSquashConfiguration + // (Optional) The preferred start time to perform weekly maintenance, formatted // d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, // beginning with Monday and ending with Sunday. @@ -594,8 +599,8 @@ type CreateFileSystemOntapConfiguration struct { // redundancy. // // For information about the use cases for Multi-AZ and Single-AZ - // deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html). + // deployments, refer to Choosing a file system deployment type + // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-AZ.html). // // This member is required. DeploymentType OntapDeploymentType @@ -1838,6 +1843,11 @@ type LustreFileSystemConfiguration struct { // 125, 250, 500, 1000. PerUnitStorageThroughput *int32 + // The Lustre root squash configuration for an Amazon FSx for Lustre file system. + // When enabled, root squash restricts root-level access from clients that try to + // access your file system as a root user. + RootSquashConfiguration *LustreRootSquashConfiguration + // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the // UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with // Monday and ending with Sunday. @@ -1935,6 +1945,48 @@ type LustreLogCreateConfiguration struct { noSmithyDocumentSerde } +// The configuration for Lustre root squash used to restrict root-level access from +// clients that try to access your FSx for Lustre file system as root. Use the +// RootSquash parameter to enable root squash. To learn more about Lustre root +// squash, see Lustre root squash +// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/root-squash.html). You can +// also use the NoSquashNids parameter to provide an array of clients who are not +// affected by the root squash setting. These clients will access the file system +// as root, with unrestricted privileges. +type LustreRootSquashConfiguration struct { + + // When root squash is enabled, you can optionally specify an array of NIDs of + // clients for which root squash does not apply. A client NID is a Lustre Network + // Identifier used to uniquely identify a client. You can specify the NID as either + // a single address or a range of addresses: + // + // * A single address is described in + // standard Lustre NID format by specifying the client’s IP address followed by the + // Lustre network ID (for example, 10.0.1.6@tcp). + // + // * An address range is described + // using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp). + NoSquashNids []string + + // You enable root squash by setting a user ID (UID) and group ID (GID) for the + // file system in the format UID:GID (for example, 365534:65534). The UID and GID + // values can range from 0 to 4294967294: + // + // * A non-zero value for UID and GID + // enables root squash. The UID and GID values can be different, but each must be a + // non-zero value. + // + // * A value of 0 (zero) for UID and GID indicates root, and + // therefore disables root squash. + // + // When root squash is enabled, the user ID and + // group ID of a root user accessing the file system are re-mapped to the UID and + // GID you provide. + RootSquash *string + + noSmithyDocumentSerde +} + // Configuration for the FSx for NetApp ONTAP file system. type OntapFileSystemConfiguration struct { @@ -2802,6 +2854,11 @@ type UpdateFileSystemLustreConfiguration struct { // data repositories associated with your file system to Amazon CloudWatch Logs. LogConfiguration *LustreLogCreateConfiguration + // The Lustre root squash configuration used when updating an Amazon FSx for Lustre + // file system. When enabled, root squash restricts root-level access from clients + // that try to access your file system as a root user. + RootSquashConfiguration *LustreRootSquashConfiguration + // (Optional) The preferred start time to perform weekly maintenance, formatted // d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, // beginning with Monday and ending with Sunday. diff --git a/service/lookoutmetrics/api_op_UpdateMetricSet.go b/service/lookoutmetrics/api_op_UpdateMetricSet.go index d136e5bfaef..f144a603372 100644 --- a/service/lookoutmetrics/api_op_UpdateMetricSet.go +++ b/service/lookoutmetrics/api_op_UpdateMetricSet.go @@ -46,7 +46,7 @@ type UpdateMetricSetInput struct { // The dataset's interval. MetricSetFrequency types.Frequency - // Contains information about source data used to generate a metric. + // Contains information about source data used to generate metrics. MetricSource *types.MetricSource // After an interval ends, the amount of seconds that the detector waits before diff --git a/service/lookoutmetrics/deserializers.go b/service/lookoutmetrics/deserializers.go index cbf168ca8f3..8f24aff4296 100644 --- a/service/lookoutmetrics/deserializers.go +++ b/service/lookoutmetrics/deserializers.go @@ -5457,6 +5457,96 @@ func awsRestjson1_deserializeDocumentAppFlowConfig(v **types.AppFlowConfig, valu return nil } +func awsRestjson1_deserializeDocumentAthenaSourceConfig(v **types.AthenaSourceConfig, value interface{}) error { + if v == nil { + return fmt.Errorf("unexpected nil of type %T", v) + } + if value == nil { + return nil + } + + shape, ok := value.(map[string]interface{}) + if !ok { + return fmt.Errorf("unexpected JSON type %v", value) + } + + var sv *types.AthenaSourceConfig + if *v == nil { + sv = &types.AthenaSourceConfig{} + } else { + sv = *v + } + + for key, value := range shape { + switch key { + case "BackTestConfiguration": + if err := awsRestjson1_deserializeDocumentBackTestConfiguration(&sv.BackTestConfiguration, value); err != nil { + return err + } + + case "DatabaseName": + if value != nil { + jtv, ok := value.(string) + if !ok { + return fmt.Errorf("expected AthenaDatabaseName to be of type string, got %T instead", value) + } + sv.DatabaseName = ptr.String(jtv) + } + + case "DataCatalog": + if value != nil { + jtv, ok := value.(string) + if !ok { + return fmt.Errorf("expected AthenaDataCatalog to be of type string, got %T instead", value) + } + sv.DataCatalog = ptr.String(jtv) + } + + case "RoleArn": + if value != nil { + jtv, ok := value.(string) + if !ok { + return fmt.Errorf("expected Arn to be of type string, got %T instead", value) + } + sv.RoleArn = ptr.String(jtv) + } + + case "S3ResultsPath": + if value != nil { + jtv, ok := value.(string) + if !ok { + return fmt.Errorf("expected AthenaS3ResultsPath to be of type string, got %T instead", value) + } + sv.S3ResultsPath = ptr.String(jtv) + } + + case "TableName": + if value != nil { + jtv, ok := value.(string) + if !ok { + return fmt.Errorf("expected AthenaTableName to be of type string, got %T instead", value) + } + sv.TableName = ptr.String(jtv) + } + + case "WorkGroupName": + if value != nil { + jtv, ok := value.(string) + if !ok { + return fmt.Errorf("expected AthenaWorkGroupName to be of type string, got %T instead", value) + } + sv.WorkGroupName = ptr.String(jtv) + } + + default: + _, _ = key, value + + } + } + *v = sv + return nil +} + func awsRestjson1_deserializeDocumentAttributeValue(v **types.AttributeValue, value interface{}) error { if v == nil { return fmt.Errorf("unexpected nil of type %T", v) @@ -5530,6 +5620,46 @@ func awsRestjson1_deserializeDocumentAttributeValue(v **types.AttributeValue, va return nil } +func awsRestjson1_deserializeDocumentBackTestConfiguration(v **types.BackTestConfiguration, value interface{}) error { + if v == nil { + return fmt.Errorf("unexpected nil of type %T", v) + } + if value == nil { + return nil + } + + shape, ok := value.(map[string]interface{}) + if !ok { + return fmt.Errorf("unexpected JSON type %v", value) + } + + var sv *types.BackTestConfiguration + if *v == nil { + sv = &types.BackTestConfiguration{} + } else { + sv = *v + } + + for key, value := range shape { + switch key { + case "RunBackTestMode": + if value != nil { + jtv, ok := value.(bool) + if !ok { + return fmt.Errorf("expected Boolean to be of type *bool, got %T instead", value) + } + sv.RunBackTestMode = ptr.Bool(jtv) + } + + default: + _, _ = key, value + + } + } + *v = sv + return nil +} + func awsRestjson1_deserializeDocumentBinaryListAttributeValue(v *[]string, value interface{}) error { if v == nil { return fmt.Errorf("unexpected nil of type %T", v) @@ -7343,6 +7473,11 @@ func awsRestjson1_deserializeDocumentMetricSource(v **types.MetricSource, value return err } + case "AthenaSourceConfig": + if err := awsRestjson1_deserializeDocumentAthenaSourceConfig(&sv.AthenaSourceConfig, value); err != nil { + return err + } + case "CloudWatchConfig": if err := awsRestjson1_deserializeDocumentCloudWatchConfig(&sv.CloudWatchConfig, value); err != nil { return err diff --git a/service/lookoutmetrics/serializers.go b/service/lookoutmetrics/serializers.go index 789b597fd7a..f46f08b82a4 100644 --- a/service/lookoutmetrics/serializers.go +++ b/service/lookoutmetrics/serializers.go @@ -2314,6 +2314,50 @@ func awsRestjson1_serializeDocumentAppFlowConfig(v *types.AppFlowConfig, value s return nil } +func awsRestjson1_serializeDocumentAthenaSourceConfig(v *types.AthenaSourceConfig, value smithyjson.Value) error { + object := value.Object() + defer object.Close() + + if v.BackTestConfiguration != nil { + ok := object.Key("BackTestConfiguration") + if err := awsRestjson1_serializeDocumentBackTestConfiguration(v.BackTestConfiguration, ok); err != nil { + return err + } + } + + if v.DatabaseName != nil { + ok := object.Key("DatabaseName") + ok.String(*v.DatabaseName) + } + + if v.DataCatalog != nil { + ok := object.Key("DataCatalog") + ok.String(*v.DataCatalog) + } + + if v.RoleArn != nil { + ok := object.Key("RoleArn") + ok.String(*v.RoleArn) + } + + if v.S3ResultsPath != nil { + ok := object.Key("S3ResultsPath") + ok.String(*v.S3ResultsPath) + } + + if v.TableName != nil { + ok := object.Key("TableName") + ok.String(*v.TableName) + } + + if v.WorkGroupName != nil { + ok := object.Key("WorkGroupName") + ok.String(*v.WorkGroupName) + } + + return nil +} + func awsRestjson1_serializeDocumentAutoDetectionMetricSource(v *types.AutoDetectionMetricSource, value smithyjson.Value) error { object := value.Object() defer object.Close() @@ -2349,6 +2393,18 @@ func awsRestjson1_serializeDocumentAutoDetectionS3SourceConfig(v *types.AutoDete return nil } +func awsRestjson1_serializeDocumentBackTestConfiguration(v *types.BackTestConfiguration, value smithyjson.Value) error { + object := value.Object() + defer object.Close() + + if v.RunBackTestMode != nil { + ok := object.Key("RunBackTestMode") + ok.Boolean(*v.RunBackTestMode) + } + + return nil +} + func awsRestjson1_serializeDocumentCloudWatchConfig(v *types.CloudWatchConfig, value smithyjson.Value) error { object := value.Object() defer object.Close() @@ -2534,6 +2590,13 @@ func awsRestjson1_serializeDocumentMetricSource(v *types.MetricSource, value smi } } + if v.AthenaSourceConfig != nil { + ok := object.Key("AthenaSourceConfig") + if err := awsRestjson1_serializeDocumentAthenaSourceConfig(v.AthenaSourceConfig, ok); err != nil { + return err + } + } + if v.CloudWatchConfig != nil { ok := object.Key("CloudWatchConfig") if err := awsRestjson1_serializeDocumentCloudWatchConfig(v.CloudWatchConfig, ok); err != nil { diff --git a/service/lookoutmetrics/types/types.go b/service/lookoutmetrics/types/types.go index 5b9602daf2f..6f49be0167f 100644 --- a/service/lookoutmetrics/types/types.go +++ b/service/lookoutmetrics/types/types.go @@ -243,6 +243,33 @@ type AppFlowConfig struct { noSmithyDocumentSerde } +// Details about an Amazon Athena datasource. +type AthenaSourceConfig struct { + + // Settings for backtest mode. + BackTestConfiguration *BackTestConfiguration + + // The database's data catalog. + DataCatalog *string + + // The database's name. + DatabaseName *string + + // An IAM role that gives Amazon Lookout for Metrics permission to access the data. + RoleArn *string + + // The database's results path. + S3ResultsPath *string + + // The database's table name. + TableName *string + + // The database's work group name. + WorkGroupName *string + + noSmithyDocumentSerde +} + // An attribute value. type AttributeValue struct { @@ -288,6 +315,17 @@ type AutoDetectionS3SourceConfig struct { noSmithyDocumentSerde } +// Settings for backtest mode. +type BackTestConfiguration struct { + + // Run a backtest instead of monitoring new data. + // + // This member is required. + RunBackTestMode *bool + + noSmithyDocumentSerde +} + // Details about an Amazon CloudWatch datasource. type CloudWatchConfig struct { @@ -619,22 +657,22 @@ type MetricSetSummary struct { noSmithyDocumentSerde } -// Contains information about source data used to generate a metric. +// Contains information about source data used to generate metrics. type MetricSource struct { - // An object containing information about the AppFlow configuration. + // Details about an AppFlow datasource. AppFlowConfig *AppFlowConfig - // An object containing information about the Amazon CloudWatch monitoring - // configuration. + // Details about an Amazon Athena datasource. + AthenaSourceConfig *AthenaSourceConfig + + // Details about an Amazon CloudWatch monitoring datasource. CloudWatchConfig *CloudWatchConfig - // An object containing information about the Amazon Relational Database Service - // (RDS) configuration. + // Details about an Amazon Relational Database Service (RDS) datasource. RDSSourceConfig *RDSSourceConfig - // An object containing information about the Amazon Redshift database - // configuration. + // Details about an Amazon Redshift database datasource. RedshiftSourceConfig *RedshiftSourceConfig // Contains information about the configuration of the S3 bucket that contains @@ -762,7 +800,7 @@ type SNSConfiguration struct { // This member is required. SnsTopicArn *string - // The text format for alerts. + // The format of the SNS topic. SnsFormat SnsFormat noSmithyDocumentSerde diff --git a/service/lookoutmetrics/validators.go b/service/lookoutmetrics/validators.go index c5254216e17..610c79ea578 100644 --- a/service/lookoutmetrics/validators.go +++ b/service/lookoutmetrics/validators.go @@ -668,6 +668,38 @@ func validateAnomalyGroupTimeSeriesFeedback(v *types.AnomalyGroupTimeSeriesFeedb } } +func validateAthenaSourceConfig(v *types.AthenaSourceConfig) error { + if v == nil { + return nil + } + invalidParams := smithy.InvalidParamsError{Context: "AthenaSourceConfig"} + if v.BackTestConfiguration != nil { + if err := validateBackTestConfiguration(v.BackTestConfiguration); err != nil { + invalidParams.AddNested("BackTestConfiguration", err.(smithy.InvalidParamsError)) + } + } + if invalidParams.Len() > 0 { + return invalidParams + } else { + return nil + } +} + +func validateBackTestConfiguration(v *types.BackTestConfiguration) error { + if v == nil { + return nil + } + invalidParams := smithy.InvalidParamsError{Context: "BackTestConfiguration"} + if v.RunBackTestMode == nil { + invalidParams.Add(smithy.NewErrParamRequired("RunBackTestMode")) + } + if invalidParams.Len() > 0 { + return invalidParams + } else { + return nil + } +} + func validateLambdaConfiguration(v *types.LambdaConfiguration) error { if v == nil { return nil @@ -736,6 +768,11 @@ func validateMetricSource(v *types.MetricSource) error { invalidParams.AddNested("RedshiftSourceConfig", err.(smithy.InvalidParamsError)) } } + if v.AthenaSourceConfig != nil { + if err := validateAthenaSourceConfig(v.AthenaSourceConfig); err != nil { + invalidParams.AddNested("AthenaSourceConfig", err.(smithy.InvalidParamsError)) + } + } if invalidParams.Len() > 0 { return invalidParams } else { diff --git a/service/sagemaker/api_op_CreateAutoMLJob.go b/service/sagemaker/api_op_CreateAutoMLJob.go index bdbd1465f90..4eea37d90ad 100644 --- a/service/sagemaker/api_op_CreateAutoMLJob.go +++ b/service/sagemaker/api_op_CreateAutoMLJob.go @@ -40,7 +40,9 @@ type CreateAutoMLJobInput struct { // An array of channel objects that describes the input data and its location. Each // channel is a named input source. Similar to InputDataConfig supported by . - // Format(s) supported: CSV. Minimum of 500 rows. + // Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the + // training dataset. There is not a minimum number of rows required for the + // validation dataset. // // This member is required. InputDataConfig []types.AutoMLChannel @@ -56,7 +58,7 @@ type CreateAutoMLJobInput struct { // This member is required. RoleArn *string - // Contains CompletionCriteria and SecurityConfig settings for the AutoML job. + // A collection of settings used to configure an AutoML job. AutoMLJobConfig *types.AutoMLJobConfig // Defines the objective metric used to measure the predictive quality of an AutoML @@ -72,10 +74,8 @@ type CreateAutoMLJobInput struct { // model deployment. ModelDeployConfig *types.ModelDeployConfig - // Defines the type of supervised learning available for the candidates. Options - // include: BinaryClassification, MulticlassClassification, and Regression. For - // more information, see Amazon SageMaker Autopilot problem types and algorithm - // support + // Defines the type of supervised learning available for the candidates. For more + // information, see Amazon SageMaker Autopilot problem types and algorithm support // (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-problem-types.html). ProblemType types.ProblemType diff --git a/service/sagemaker/api_op_CreateEndpointConfig.go b/service/sagemaker/api_op_CreateEndpointConfig.go index 9c5fcd603d8..c29229b8b32 100644 --- a/service/sagemaker/api_op_CreateEndpointConfig.go +++ b/service/sagemaker/api_op_CreateEndpointConfig.go @@ -69,7 +69,7 @@ type CreateEndpointConfigInput struct { // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpointAsync.html). AsyncInferenceConfig *types.AsyncInferenceConfig - // + // Configuration to control how SageMaker captures inference data. DataCaptureConfig *types.DataCaptureConfig // The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service diff --git a/service/sagemaker/api_op_CreateModelPackage.go b/service/sagemaker/api_op_CreateModelPackage.go index 268275fd804..3b088c35ab9 100644 --- a/service/sagemaker/api_op_CreateModelPackage.go +++ b/service/sagemaker/api_op_CreateModelPackage.go @@ -126,7 +126,11 @@ type CreateModelPackageInput struct { Tags []types.Tag // The machine learning task your model package accomplishes. Common machine - // learning tasks include object detection and image classification. + // learning tasks include object detection and image classification. The following + // tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" | + // "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" | "FILL_MASK" | + // "CLASSIFICATION" | "REGRESSION" | "OTHER". Specify "OTHER" if none of the tasks + // listed fit your use case. Task *string // Specifies configurations for one or more transform jobs that SageMaker runs to diff --git a/service/sagemaker/api_op_CreateTransformJob.go b/service/sagemaker/api_op_CreateTransformJob.go index 63578254d56..fd925c6bed5 100644 --- a/service/sagemaker/api_op_CreateTransformJob.go +++ b/service/sagemaker/api_op_CreateTransformJob.go @@ -24,20 +24,22 @@ import ( // * ModelName - Identifies the model to use. ModelName must be the name // of an existing Amazon SageMaker model in the same Amazon Web Services Region and // Amazon Web Services account. For information on creating a model, see -// CreateModel. +// CreateModel +// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html). // -// * TransformInput - Describes the dataset to be transformed and the -// Amazon S3 location where it is stored. +// * +// TransformInput - Describes the dataset to be transformed and the Amazon S3 +// location where it is stored. // -// * TransformOutput - Identifies the -// Amazon S3 location where you want Amazon SageMaker to save the results from the -// transform job. +// * TransformOutput - Identifies the Amazon S3 +// location where you want Amazon SageMaker to save the results from the transform +// job. // -// * TransformResources - Identifies the ML compute instances for -// the transform job. +// * TransformResources - Identifies the ML compute instances for the +// transform job. // -// For more information about how batch transformation works, -// see Batch Transform +// For more information about how batch transformation works, see +// Batch Transform // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html). func (c *Client) CreateTransformJob(ctx context.Context, params *CreateTransformJobInput, optFns ...func(*Options)) (*CreateTransformJobOutput, error) { if params == nil { diff --git a/service/sagemaker/api_op_DescribeEndpoint.go b/service/sagemaker/api_op_DescribeEndpoint.go index c7cf4130841..69527f812af 100644 --- a/service/sagemaker/api_op_DescribeEndpoint.go +++ b/service/sagemaker/api_op_DescribeEndpoint.go @@ -114,7 +114,7 @@ type DescribeEndpointOutput struct { // API. AsyncInferenceConfig *types.AsyncInferenceConfig - // + // The currently active data capture configuration used by your Endpoint. DataCaptureConfig *types.DataCaptureConfigSummary // If the status of the endpoint is Failed, the reason why it failed. diff --git a/service/sagemaker/api_op_DescribeEndpointConfig.go b/service/sagemaker/api_op_DescribeEndpointConfig.go index 741f39e177f..79cdb7b1ba8 100644 --- a/service/sagemaker/api_op_DescribeEndpointConfig.go +++ b/service/sagemaker/api_op_DescribeEndpointConfig.go @@ -68,7 +68,7 @@ type DescribeEndpointConfigOutput struct { // API. AsyncInferenceConfig *types.AsyncInferenceConfig - // + // Configuration to control how SageMaker captures inference data. DataCaptureConfig *types.DataCaptureConfig // Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when diff --git a/service/sagemaker/deserializers.go b/service/sagemaker/deserializers.go index 9aeb001aa9f..7bc7906e74d 100644 --- a/service/sagemaker/deserializers.go +++ b/service/sagemaker/deserializers.go @@ -29158,6 +29158,46 @@ func awsAwsjson11_deserializeDocumentAutoMLCandidate(v **types.AutoMLCandidate, return nil } +func awsAwsjson11_deserializeDocumentAutoMLCandidateGenerationConfig(v **types.AutoMLCandidateGenerationConfig, value interface{}) error { + if v == nil { + return fmt.Errorf("unexpected nil of type %T", v) + } + if value == nil { + return nil + } + + shape, ok := value.(map[string]interface{}) + if !ok { + return fmt.Errorf("unexpected JSON type %v", value) + } + + var sv *types.AutoMLCandidateGenerationConfig + if *v == nil { + sv = &types.AutoMLCandidateGenerationConfig{} + } else { + sv = *v + } + + for key, value := range shape { + switch key { + case "FeatureSpecificationS3Uri": + if value != nil { + jtv, ok := value.(string) + if !ok { + return fmt.Errorf("expected S3Uri to be of type string, got %T instead", value) + } + sv.FeatureSpecificationS3Uri = ptr.String(jtv) + } + + default: + _, _ = key, value + + } + } + *v = sv + return nil +} + func awsAwsjson11_deserializeDocumentAutoMLCandidates(v *[]types.AutoMLCandidate, value interface{}) error { if v == nil { return fmt.Errorf("unexpected nil of type %T", v) @@ -29686,6 +29726,11 @@ func awsAwsjson11_deserializeDocumentAutoMLJobConfig(v **types.AutoMLJobConfig, for key, value := range shape { switch key { + case "CandidateGenerationConfig": + if err := awsAwsjson11_deserializeDocumentAutoMLCandidateGenerationConfig(&sv.CandidateGenerationConfig, value); err != nil { + return err + } + case "CompletionCriteria": if err := awsAwsjson11_deserializeDocumentAutoMLJobCompletionCriteria(&sv.CompletionCriteria, value); err != nil { return err diff --git a/service/sagemaker/serializers.go b/service/sagemaker/serializers.go index fcf641a4a3f..f623884bef6 100644 --- a/service/sagemaker/serializers.go +++ b/service/sagemaker/serializers.go @@ -14255,6 +14255,18 @@ func awsAwsjson11_serializeDocumentAttributeNames(v []string, value smithyjson.V return nil } +func awsAwsjson11_serializeDocumentAutoMLCandidateGenerationConfig(v *types.AutoMLCandidateGenerationConfig, value smithyjson.Value) error { + object := value.Object() + defer object.Close() + + if v.FeatureSpecificationS3Uri != nil { + ok := object.Key("FeatureSpecificationS3Uri") + ok.String(*v.FeatureSpecificationS3Uri) + } + + return nil +} + func awsAwsjson11_serializeDocumentAutoMLChannel(v *types.AutoMLChannel, value smithyjson.Value) error { object := value.Object() defer object.Close() @@ -14367,6 +14379,13 @@ func awsAwsjson11_serializeDocumentAutoMLJobConfig(v *types.AutoMLJobConfig, val object := value.Object() defer object.Close() + if v.CandidateGenerationConfig != nil { + ok := object.Key("CandidateGenerationConfig") + if err := awsAwsjson11_serializeDocumentAutoMLCandidateGenerationConfig(v.CandidateGenerationConfig, ok); err != nil { + return err + } + } + if v.CompletionCriteria != nil { ok := object.Key("CompletionCriteria") if err := awsAwsjson11_serializeDocumentAutoMLJobCompletionCriteria(v.CompletionCriteria, ok); err != nil { diff --git a/service/sagemaker/types/types.go b/service/sagemaker/types/types.go index 3eb70ec9093..ce1a4e30d43 100644 --- a/service/sagemaker/types/types.go +++ b/service/sagemaker/types/types.go @@ -1532,6 +1532,21 @@ type AutoMLCandidate struct { noSmithyDocumentSerde } +// Stores the config information for how a candidate is generated (optional). +type AutoMLCandidateGenerationConfig struct { + + // A URL to the Amazon S3 data source containing selected features from the input + // data source to run an Autopilot job (optional). This file should be in json + // format as shown below: { "FeatureAttributeNames":["col1", "col2", ...] }. The + // key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", + // ...] is case sensitive and should be a list of strings containing unique values + // that are a subset of the column names in the input data. The list of columns + // provided must not include the target column. + FeatureSpecificationS3Uri *string + + noSmithyDocumentSerde +} + // Information about the steps for a candidate and what step it is working on. type AutoMLCandidateStep struct { @@ -1572,7 +1587,9 @@ type AutoMLChannel struct { // The channel type (optional) is an enum string. The default value is training. // Channels for training and validation must share the same ContentType and - // TargetAttributeName. + // TargetAttributeName. For information on specifying training and validation + // channel types, see How to specify training and validation datasets + // (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-data-sources-training-or-validation). ChannelType AutoMLChannelType // You can use Gzip or None. The default value is None. @@ -1626,7 +1643,8 @@ type AutoMLDataSplitConfig struct { // The validation fraction (optional) is a float that specifies the portion of the // training dataset to be used for validation. The default value is 0.2, and values - // can range from 0 to 1. We recommend setting this value to be less than 0.5. + // must be greater than 0 and less than 1. We recommend setting this value to be + // less than 0.5. ValidationFraction *float32 noSmithyDocumentSerde @@ -1670,6 +1688,9 @@ type AutoMLJobCompletionCriteria struct { // A collection of settings used for an AutoML job. type AutoMLJobConfig struct { + // The configuration for generating a candidate for an AutoML job (optional). + CandidateGenerationConfig *AutoMLCandidateGenerationConfig + // How long an AutoML job is allowed to run, or how many candidates a job is // allowed to generate. CompletionCriteria *AutoMLJobCompletionCriteria @@ -2046,22 +2067,25 @@ type CapacitySize struct { noSmithyDocumentSerde } -// +// Configuration specifying how to treat different headers. If no headers are +// specified SageMaker will by default base64 encode when capturing the data. type CaptureContentTypeHeader struct { - // + // The list of all content type headers that SageMaker will treat as CSV and + // capture accordingly. CsvContentTypes []string - // + // The list of all content type headers that SageMaker will treat as JSON and + // capture accordingly. JsonContentTypes []string noSmithyDocumentSerde } -// +// Specifies data Model Monitor will capture. type CaptureOption struct { - // + // Specify the boundary of data to capture. // // This member is required. CaptureMode CaptureMode @@ -2605,60 +2629,77 @@ type CustomImage struct { noSmithyDocumentSerde } -// +// Configuration to control how SageMaker captures inference data. type DataCaptureConfig struct { - // + // Specifies data Model Monitor will capture. You can configure whether to collect + // only input, only output, or both // // This member is required. CaptureOptions []CaptureOption - // + // The Amazon S3 location used to capture the data. // // This member is required. DestinationS3Uri *string - // + // The percentage of requests SageMaker will capture. A lower value is recommended + // for Endpoints with high traffic. // // This member is required. InitialSamplingPercentage *int32 - // + // Configuration specifying how to treat different headers. If no headers are + // specified SageMaker will by default base64 encode when capturing the data. CaptureContentTypeHeader *CaptureContentTypeHeader - // + // Whether data capture should be enabled or disabled (defaults to enabled). EnableCapture bool + // The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service + // key that SageMaker uses to encrypt data on the storage volume attached to the ML + // compute instance that hosts the endpoint. The KmsKeyId can be any of the + // following formats: // + // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // + // * Key ARN: + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // + // * + // Alias name: alias/ExampleAlias + // + // * Alias name ARN: + // arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias KmsKeyId *string noSmithyDocumentSerde } -// +// The currently active data capture configuration used by your Endpoint. type DataCaptureConfigSummary struct { - // + // Whether data capture is currently functional. // // This member is required. CaptureStatus CaptureStatus - // + // The percentage of requests being captured by your Endpoint. // // This member is required. CurrentSamplingPercentage *int32 - // + // The Amazon S3 location being used to capture the data. // // This member is required. DestinationS3Uri *string - // + // Whether data capture is enabled or disabled. // // This member is required. EnableCapture bool - // + // The KMS key being used to encrypt the data in Amazon S3. // // This member is required. KmsKeyId *string @@ -3458,7 +3499,7 @@ type Endpoint struct { // This member is required. LastModifiedTime *time.Time - // + // The currently active data capture configuration used by your Endpoint. DataCaptureConfig *DataCaptureConfigSummary // If the endpoint failed, the reason it failed. @@ -6995,7 +7036,9 @@ type MetricDatum struct { // The dataset split from which the AutoML job produced the metric. Set MetricSetSource - // The name of the standard metric. + // The name of the standard metric. For definitions of the standard metrics, see + // Autopilot candidate metrics + // (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-metrics). StandardMetricName AutoMLMetricExtendedEnum // The value of the metric. @@ -12429,9 +12472,10 @@ type TransformOutput struct { // role's account. For more information, see KMS-Managed Encryption Keys // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the // Amazon Simple Storage Service Developer Guide. The KMS key policy must grant - // permission to the IAM role that you specify in your CreateModel request. For - // more information, see Using Key Policies in Amazon Web Services KMS - // (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the + // permission to the IAM role that you specify in your CreateModel + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html) + // request. For more information, see Using Key Policies in Amazon Web Services KMS + // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the // Amazon Web Services Key Management Service Developer Guide. KmsKeyId *string diff --git a/service/secretsmanager/api_op_PutResourcePolicy.go b/service/secretsmanager/api_op_PutResourcePolicy.go index c7f927b3ee7..5bcae98e0c4 100644 --- a/service/secretsmanager/api_op_PutResourcePolicy.go +++ b/service/secretsmanager/api_op_PutResourcePolicy.go @@ -55,8 +55,7 @@ type PutResourcePolicyInput struct { SecretId *string // Specifies whether to block resource-based policies that allow broad access to - // the secret. By default, Secrets Manager blocks policies that allow broad access, - // for example those that use a wildcard for the principal. + // the secret, for example those that use a wildcard for the principal. BlockPublicPolicy bool noSmithyDocumentSerde diff --git a/service/sso/internal/endpoints/endpoints.go b/service/sso/internal/endpoints/endpoints.go index c8d1689927d..7aefaa4289d 100644 --- a/service/sso/internal/endpoints/endpoints.go +++ b/service/sso/internal/endpoints/endpoints.go @@ -151,6 +151,9 @@ var defaultPartitions = endpoints.Partitions{ Region: "ap-northeast-2", }, }, + endpoints.EndpointKey{ + Region: "ap-northeast-3", + }: endpoints.Endpoint{}, endpoints.EndpointKey{ Region: "ap-south-1", }: endpoints.Endpoint{ diff --git a/service/voiceid/deserializers.go b/service/voiceid/deserializers.go index 07a386050e7..a446db1d930 100644 --- a/service/voiceid/deserializers.go +++ b/service/voiceid/deserializers.go @@ -4502,6 +4502,22 @@ func awsAwsjson10_deserializeDocumentSpeaker(v **types.Speaker, value interface{ sv.GeneratedSpeakerId = ptr.String(jtv) } + case "LastAccessedAt": + if value != nil { + switch jtv := value.(type) { + case json.Number: + f64, err := jtv.Float64() + if err != nil { + return err + } + sv.LastAccessedAt = ptr.Time(smithytime.ParseEpochSeconds(f64)) + + default: + return fmt.Errorf("expected Timestamp to be a JSON Number, got %T instead", value) + + } + } + case "Status": if value != nil { jtv, ok := value.(string) @@ -4911,6 +4927,22 @@ func awsAwsjson10_deserializeDocumentSpeakerSummary(v **types.SpeakerSummary, va sv.GeneratedSpeakerId = ptr.String(jtv) } + case "LastAccessedAt": + if value != nil { + switch jtv := value.(type) { + case json.Number: + f64, err := jtv.Float64() + if err != nil { + return err + } + sv.LastAccessedAt = ptr.Time(smithytime.ParseEpochSeconds(f64)) + + default: + return fmt.Errorf("expected Timestamp to be a JSON Number, got %T instead", value) + + } + } + case "Status": if value != nil { jtv, ok := value.(string) diff --git a/service/voiceid/types/enums.go b/service/voiceid/types/enums.go index d8f45842c95..f4c5fdc3e8d 100644 --- a/service/voiceid/types/enums.go +++ b/service/voiceid/types/enums.go @@ -12,6 +12,7 @@ const ( AuthenticationDecisionSpeakerNotEnrolled AuthenticationDecision = "SPEAKER_NOT_ENROLLED" AuthenticationDecisionSpeakerOptedOut AuthenticationDecision = "SPEAKER_OPTED_OUT" AuthenticationDecisionSpeakerIdNotProvided AuthenticationDecision = "SPEAKER_ID_NOT_PROVIDED" + AuthenticationDecisionSpeakerExpired AuthenticationDecision = "SPEAKER_EXPIRED" ) // Values returns all known values for AuthenticationDecision. Note that this can @@ -25,6 +26,7 @@ func (AuthenticationDecision) Values() []AuthenticationDecision { "SPEAKER_NOT_ENROLLED", "SPEAKER_OPTED_OUT", "SPEAKER_ID_NOT_PROVIDED", + "SPEAKER_EXPIRED", } } diff --git a/service/voiceid/types/types.go b/service/voiceid/types/types.go index 6ee508b886f..fc1ca8139c7 100644 --- a/service/voiceid/types/types.go +++ b/service/voiceid/types/types.go @@ -437,6 +437,10 @@ type Speaker struct { // The service-generated identifier for the speaker. GeneratedSpeakerId *string + // The timestamp when the speaker was last accessed for enrollment, re-enrollment + // or a successful authentication. This timestamp is accurate to one hour. + LastAccessedAt *time.Time + // The current status of the speaker. Status SpeakerStatus @@ -546,6 +550,10 @@ type SpeakerSummary struct { // The service-generated identifier for the speaker. GeneratedSpeakerId *string + // The timestamp when the speaker was last accessed for enrollment, re-enrollment + // or a successful authentication. This timestamp is accurate to one hour. + LastAccessedAt *time.Time + // The current status of the speaker. Status SpeakerStatus