AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon API Gateway PutIntegration API operation.

Syntax

Write-AGIntegration
-RestApiId <String>
-CacheKeyParameter <String[]>
-CacheNamespace <String>
-ConnectionId <String>
-ConnectionType <ConnectionType>
-ContentHandling <ContentHandlingStrategy>
-TargetCredential <String>
-HttpMethod <String>
-IntegrationHttpMethod <String>
-PassthroughBehavior <String>
-RequestParameter <Hashtable>
-RequestTemplate <Hashtable>
-ResourceId <String>
-TimeoutInMilli <Int32>
-Type <IntegrationType>
-Uri <String>
-Force <SwitchParameter>

Description

Sets up a method's integration.

Parameters

-CacheKeyParameter <String[]>
Specifies a put integration input's cache key parameters.
Required?False
Position?Named
Accept pipeline input?False
-CacheNamespace <String>
Specifies a put integration input's cache namespace.
Required?False
Position?Named
Accept pipeline input?False
-ConnectionId <String>
The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
Required?False
Position?Named
Accept pipeline input?False
-ConnectionType <ConnectionType>
The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and an network load balancer in a VPC. The default value is INTERNET.
Required?False
Position?Named
Accept pipeline input?False
-ContentHandling <ContentHandlingStrategy>
Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-HttpMethod <String>
Specifies a put integration request's HTTP method.
Required?False
Position?Named
Accept pipeline input?False
-IntegrationHttpMethod <String>
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
Required?False
Position?Named
Accept pipeline input?False
-PassthroughBehavior <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.
Required?False
Position?Named
Accept pipeline input?False
-RequestParameter <Hashtable>
A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
Required?False
Position?Named
Accept pipeline input?False
-RequestTemplate <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?False
-ResourceId <String>
Specifies a put integration request's resource ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestApiId <String>
The string identifier of the associated RestApi.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-TargetCredential <String>
Specifies whether credentials are required for a put integration.
Required?False
Position?Named
Accept pipeline input?False
-TimeoutInMilli <Int32>
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
Required?False
Position?Named
Accept pipeline input?False
Specifies a put integration input's type.
Required?False
Position?Named
Accept pipeline input?False
-Uri <String>
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, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, 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}
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the RestApiId parameter.

Outputs

This cmdlet returns a Amazon.APIGateway.Model.PutIntegrationResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z