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 V2 UpdateApi API operation.

Syntax

Update-AG2Api
-ApiId <String>
-CorsConfiguration_AllowCredential <Boolean>
-CorsConfiguration_AllowHeader <String[]>
-CorsConfiguration_AllowMethod <String[]>
-CorsConfiguration_AllowOrigin <String[]>
-ApiKeySelectionExpression <String>
-CredentialsArn <String>
-Description <String>
-DisableExecuteApiEndpoint <Boolean>
-DisableSchemaValidation <Boolean>
-CorsConfiguration_ExposeHeader <String[]>
-IpAddressType <IpAddressType>
-CorsConfiguration_MaxAge <Int32>
-Name <String>
-RouteKey <String>
-RouteSelectionExpression <String>
-Target <String>
-Version <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonApiGatewayV2Config>

Description

Updates an Api resource.

Parameters

-ApiId <String>
The API identifier.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ApiKeySelectionExpression <String>
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonApiGatewayV2Config>
Amazon.PowerShell.Cmdlets.AG2.AmazonApiGatewayV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CorsConfiguration_AllowCredential <Boolean>
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCorsConfiguration_AllowCredentials
-CorsConfiguration_AllowHeader <String[]>
Represents a collection of allowed headers. Supported only for HTTP APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCorsConfiguration_AllowHeaders
-CorsConfiguration_AllowMethod <String[]>
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCorsConfiguration_AllowMethods
-CorsConfiguration_AllowOrigin <String[]>
Represents a collection of allowed origins. Supported only for HTTP APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCorsConfiguration_AllowOrigins
-CorsConfiguration_ExposeHeader <String[]>
Represents a collection of exposed headers. Supported only for HTTP APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCorsConfiguration_ExposeHeaders
-CorsConfiguration_MaxAge <Int32>
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CredentialsArn <String>
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The description of the API.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisableExecuteApiEndpoint <Boolean>
Specifies whether clients can invoke your API by using the default execute-api 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisableSchemaValidation <Boolean>
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-IpAddressType <IpAddressType>
The IP address types that can invoke your API or domain name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the API.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RouteKey <String>
This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RouteSelectionExpression <String>
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.UpdateApiResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Target <String>
This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Version <String>
A version identifier for the API.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.ApiGatewayV2.Model.UpdateApiResponse
This cmdlet returns an Amazon.ApiGatewayV2.Model.UpdateApiResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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