1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package apigatewayv2
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/apigatewayv2/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates an Integration.
func (c *Client) UpdateIntegration(ctx context.Context, params *UpdateIntegrationInput, optFns ...func(*Options)) (*UpdateIntegrationOutput, error) {
if params == nil {
params = &UpdateIntegrationInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateIntegration", params, optFns, c.addOperationUpdateIntegrationMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateIntegrationOutput)
out.ResultMetadata = metadata
return out, nil
}
// Updates an Integration.
type UpdateIntegrationInput struct {
// The API identifier.
//
// This member is required.
ApiId *string
// The integration ID.
//
// This member is required.
IntegrationId *string
// The ID of the VPC link for a private integration. Supported only for HTTP APIs.
ConnectionId *string
// The type of the network connection to the integration endpoint. Specify
// INTERNET for connections through the public routable internet or VPC_LINK for
// private connections between API Gateway and resources in a VPC. The default
// value is INTERNET.
ConnectionType types.ConnectionType
// Supported only for WebSocket APIs. 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 route response or method response without
// modification.
ContentHandlingStrategy types.ContentHandlingStrategy
// Specifies the credentials required for the integration, if any. For AWS
// integrations, three options are available. To specify an IAM Role for API
// Gateway to assume, use the role's Amazon Resource Name (ARN). To require that
// the caller's identity be passed through from the request, specify the string
// arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS
// services, specify null.
CredentialsArn *string
// The description of the integration
Description *string
// Specifies the integration's HTTP method type.
IntegrationMethod *string
// Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service
// action to invoke. To learn more, see [Integration subtype reference].
//
// [Integration subtype reference]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html
IntegrationSubtype *string
// The integration type of an integration. One of the following:
//
// AWS: for integrating the route or 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. Supported only for WebSocket
// APIs.
//
// AWS_PROXY: for integrating the route or method request with a Lambda function
// or other AWS service action. This integration is also referred to as a Lambda
// proxy integration.
//
// HTTP: for integrating the route or method request with an HTTP endpoint. This
// integration is also referred to as the HTTP custom integration. Supported only
// for WebSocket APIs.
//
// HTTP_PROXY: for integrating the route or method request with an HTTP endpoint,
// with the client request passed through as-is. This is also referred to as HTTP
// proxy integration. For HTTP API private integrations, use an HTTP_PROXY
// integration.
//
// MOCK: for integrating the route or method request with API Gateway as a
// "loopback" endpoint without invoking any backend. Supported only for WebSocket
// APIs.
IntegrationType types.IntegrationType
// For a Lambda integration, specify the URI of a Lambda function.
//
// For an HTTP integration, specify a fully-qualified URL.
//
// For an HTTP API private integration, specify the ARN of an Application Load
// Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If
// you specify the ARN of an AWS Cloud Map service, API Gateway uses
// DiscoverInstances to identify resources. You can use query parameters to target
// specific resources. To learn more, see [DiscoverInstances]. For private integrations, all
// resources must be owned by the same AWS account.
//
// [DiscoverInstances]: https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html
IntegrationUri *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. Supported
// only for WebSocket APIs.
//
// WHEN_NO_MATCH passes the request body for unmapped content types through to the
// integration backend 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 HTTP 415 Unsupported Media
// Type response.
PassthroughBehavior types.PassthroughBehavior
// Specifies the format of the payload sent to an integration. Required for HTTP
// APIs.
PayloadFormatVersion *string
// For WebSocket APIs, a key-value map specifying request parameters that are
// passed from the method request to the backend. The key is an integration request
// parameter name and the associated value is a method request parameter value or
// static value that must be enclosed within single quotes and pre-encoded as
// required by the backend. The method request parameter value must match the
// pattern of method.request.{location}.{name} , where {location} is querystring,
// path, or header; and {name} must be a valid and unique method request parameter
// name.
//
// For HTTP API integrations with a specified integrationSubtype, request
// parameters are a key-value map specifying parameters that are passed to
// AWS_PROXY integrations. You can provide static values, or map request data,
// stage variables, or context variables that are evaluated at runtime. To learn
// more, see [Working with AWS service integrations for HTTP APIs].
//
// For HTTP API integrations, without a specified integrationSubtype request
// parameters are a key-value map specifying how to transform HTTP requests before
// sending them to the backend. The key should follow the pattern
// <action>:<header|querystring|path>.<location> where action can be append,
// overwrite or remove. For values, you can provide static values, or map request
// data, stage variables, or context variables that are evaluated at runtime. To
// learn more, see [Transforming API requests and responses].
//
// [Working with AWS service integrations for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html
// [Transforming API requests and responses]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
RequestParameters map[string]string
// Represents a map of Velocity templates that are applied on the request payload
// based on the value of the Content-Type header sent by the client. The content
// type value is the key in this map, and the template (as a String) is the value.
// Supported only for WebSocket APIs.
RequestTemplates map[string]string
// Supported only for HTTP APIs. You use response parameters to transform the HTTP
// response from a backend integration before returning the response to clients.
// Specify a key-value map from a selection key to response parameters. The
// selection key must be a valid HTTP status code within the range of 200-599.
// Response parameters are a key-value map. The key must match pattern
// <action>:<header>.<location> or overwrite.statuscode. The action can be append,
// overwrite or remove. The value can be a static value, or map to response data,
// stage variables, or context variables that are evaluated at runtime. To learn
// more, see [Transforming API requests and responses].
//
// [Transforming API requests and responses]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
ResponseParameters map[string]map[string]string
// The template selection expression for the integration.
TemplateSelectionExpression *string
// Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and
// between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29
// seconds for WebSocket APIs and 30 seconds for HTTP APIs.
TimeoutInMillis *int32
// The TLS configuration for a private integration. If you specify a TLS
// configuration, private integration traffic uses the HTTPS protocol. Supported
// only for HTTP APIs.
TlsConfig *types.TlsConfigInput
noSmithyDocumentSerde
}
type UpdateIntegrationOutput struct {
// Specifies whether an integration is managed by API Gateway. If you created an
// API using using quick create, the resulting integration is managed by API
// Gateway. You can update a managed integration, but you can't delete it.
ApiGatewayManaged *bool
// The ID of the VPC link for a private integration. Supported only for HTTP APIs.
ConnectionId *string
// The type of the network connection to the integration endpoint. Specify
// INTERNET for connections through the public routable internet or VPC_LINK for
// private connections between API Gateway and resources in a VPC. The default
// value is INTERNET.
ConnectionType types.ConnectionType
// Supported only for WebSocket APIs. 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 route response or method response without
// modification.
ContentHandlingStrategy types.ContentHandlingStrategy
// Specifies the credentials required for the integration, if any. For AWS
// integrations, three options are available. To specify an IAM Role for API
// Gateway to assume, use the role's Amazon Resource Name (ARN). To require that
// the caller's identity be passed through from the request, specify the string
// arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS
// services, specify null.
CredentialsArn *string
// Represents the description of an integration.
Description *string
// Represents the identifier of an integration.
IntegrationId *string
// Specifies the integration's HTTP method type.
IntegrationMethod *string
// The integration response selection expression for the integration. Supported
// only for WebSocket APIs. See [Integration Response Selection Expressions].
//
// [Integration Response Selection Expressions]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions
IntegrationResponseSelectionExpression *string
// Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service
// action to invoke. To learn more, see [Integration subtype reference].
//
// [Integration subtype reference]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html
IntegrationSubtype *string
// The integration type of an integration. One of the following:
//
// AWS: for integrating the route or 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. Supported only for WebSocket
// APIs.
//
// AWS_PROXY: for integrating the route or method request with a Lambda function
// or other AWS service action. This integration is also referred to as a Lambda
// proxy integration.
//
// HTTP: for integrating the route or method request with an HTTP endpoint. This
// integration is also referred to as the HTTP custom integration. Supported only
// for WebSocket APIs.
//
// HTTP_PROXY: for integrating the route or method request with an HTTP endpoint,
// with the client request passed through as-is. This is also referred to as HTTP
// proxy integration.
//
// MOCK: for integrating the route or method request with API Gateway as a
// "loopback" endpoint without invoking any backend. Supported only for WebSocket
// APIs.
IntegrationType types.IntegrationType
// For a Lambda integration, specify the URI of a Lambda function.
//
// For an HTTP integration, specify a fully-qualified URL.
//
// For an HTTP API private integration, specify the ARN of an Application Load
// Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If
// you specify the ARN of an AWS Cloud Map service, API Gateway uses
// DiscoverInstances to identify resources. You can use query parameters to target
// specific resources. To learn more, see [DiscoverInstances]. For private integrations, all
// resources must be owned by the same AWS account.
//
// [DiscoverInstances]: https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html
IntegrationUri *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. Supported
// only for WebSocket APIs.
//
// WHEN_NO_MATCH passes the request body for unmapped content types through to the
// integration backend 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 HTTP 415 Unsupported Media
// Type response.
PassthroughBehavior types.PassthroughBehavior
// Specifies the format of the payload sent to an integration. Required for HTTP
// APIs.
PayloadFormatVersion *string
// For WebSocket APIs, a key-value map specifying request parameters that are
// passed from the method request to the backend. The key is an integration request
// parameter name and the associated value is a method request parameter value or
// static value that must be enclosed within single quotes and pre-encoded as
// required by the backend. The method request parameter value must match the
// pattern of method.request.{location}.{name} , where {location} is querystring,
// path, or header; and {name} must be a valid and unique method request parameter
// name.
//
// For HTTP API integrations with a specified integrationSubtype, request
// parameters are a key-value map specifying parameters that are passed to
// AWS_PROXY integrations. You can provide static values, or map request data,
// stage variables, or context variables that are evaluated at runtime. To learn
// more, see [Working with AWS service integrations for HTTP APIs].
//
// For HTTP API integrations, without a specified integrationSubtype request
// parameters are a key-value map specifying how to transform HTTP requests before
// sending them to backend integrations. The key should follow the pattern
// <action>:<header|querystring|path>.<location>. The action can be append,
// overwrite or remove. For values, you can provide static values, or map request
// data, stage variables, or context variables that are evaluated at runtime. To
// learn more, see [Transforming API requests and responses].
//
// [Working with AWS service integrations for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html
// [Transforming API requests and responses]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
RequestParameters map[string]string
// Represents a map of Velocity templates that are applied on the request payload
// based on the value of the Content-Type header sent by the client. The content
// type value is the key in this map, and the template (as a String) is the value.
// Supported only for WebSocket APIs.
RequestTemplates map[string]string
// Supported only for HTTP APIs. You use response parameters to transform the HTTP
// response from a backend integration before returning the response to clients.
// Specify a key-value map from a selection key to response parameters. The
// selection key must be a valid HTTP status code within the range of 200-599.
// Response parameters are a key-value map. The key must match pattern
// <action>:<header>.<location> or overwrite.statuscode. The action can be append,
// overwrite or remove. The value can be a static value, or map to response data,
// stage variables, or context variables that are evaluated at runtime. To learn
// more, see [Transforming API requests and responses].
//
// [Transforming API requests and responses]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
ResponseParameters map[string]map[string]string
// The template selection expression for the integration. Supported only for
// WebSocket APIs.
TemplateSelectionExpression *string
// Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and
// between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29
// seconds for WebSocket APIs and 30 seconds for HTTP APIs.
TimeoutInMillis *int32
// The TLS configuration for a private integration. If you specify a TLS
// configuration, private integration traffic uses the HTTPS protocol. Supported
// only for HTTP APIs.
TlsConfig *types.TlsConfig
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateIntegrationMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateIntegration{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateIntegration{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateIntegration"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpUpdateIntegrationValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateIntegration(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateIntegration(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateIntegration",
}
}
|