AWS.Tools.ApiGatewayV2.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ApiGatewayV2</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.AG2.AddAG2ResourceTagCmdlet"> <summary> Tag an APIGW resource </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.AddAG2ResourceTagCmdlet.ResourceArn"> <summary> <para> <para>AWS resource arn </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.AddAG2ResourceTagCmdlet.Tag"> <summary> <para> <para>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..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.AddAG2ResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.AddAG2ResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiCmdlet"> <summary> Gets an Api resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiListCmdlet"> <summary> Gets a collection of Api resources.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elements to be returned for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiListCmdlet.NextToken"> <summary> <para> <para>The next page of elements from this collection. Not valid for the last element of the collection.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingCmdlet"> <summary> The API mapping. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingCmdlet.ApiMappingId"> <summary> <para> <para>The API mapping identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerCmdlet"> <summary> Gets an Authorizer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerCmdlet.AuthorizerId"> <summary> <para> <para>The authorizer identifier.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerListCmdlet"> <summary> Gets the Authorizers for an API.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerListCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elements to be returned for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerListCmdlet.NextToken"> <summary> <para> <para>The next page of elements from this collection. Not valid for the last element of the collection.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentCmdlet"> <summary> Gets a Deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentCmdlet.DeploymentId"> <summary> <para> <para>The deployment ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentListCmdlet"> <summary> Gets the Deployments for an API.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentListCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elements to be returned for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentListCmdlet.NextToken"> <summary> <para> <para>The next page of elements from this collection. Not valid for the last element of the collection.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2DomainNameCmdlet"> <summary> Gets a domain name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DomainNameCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2DomainNameListCmdlet"> <summary> Gets the domain names for an AWS account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DomainNameListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elements to be returned for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DomainNameListCmdlet.NextToken"> <summary> <para> <para>The next page of elements from this collection. Not valid for the last element of the collection.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationCmdlet"> <summary> Gets an Integration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationCmdlet.IntegrationId"> <summary> <para> <para>The integration ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationListCmdlet"> <summary> Gets the Integrations for an API.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationListCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elements to be returned for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationListCmdlet.NextToken"> <summary> <para> <para>The next page of elements from this collection. Not valid for the last element of the collection.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseCmdlet"> <summary> Gets an IntegrationResponses. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseCmdlet.IntegrationId"> <summary> <para> <para>The integration ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseCmdlet.IntegrationResponseId"> <summary> <para> The integration response ID. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseListCmdlet"> <summary> Gets the IntegrationResponses for an Integration.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseListCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseListCmdlet.IntegrationId"> <summary> <para> <para>The integration ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elements to be returned for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseListCmdlet.NextToken"> <summary> <para> <para>The next page of elements from this collection. Not valid for the last element of the collection.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelCmdlet"> <summary> Gets a Model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelCmdlet.ModelId"> <summary> <para> <para>The model ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelListCmdlet"> <summary> Gets the Models for an API.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelListCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elements to be returned for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelListCmdlet.NextToken"> <summary> <para> <para>The next page of elements from this collection. Not valid for the last element of the collection.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelTemplateCmdlet"> <summary> Gets a model template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelTemplateCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelTemplateCmdlet.ModelId"> <summary> <para> <para>The model ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteCmdlet"> <summary> Gets a Route. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteCmdlet.RouteId"> <summary> <para> <para>The route ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteListCmdlet"> <summary> Gets the Routes for an API.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteListCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elements to be returned for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteListCmdlet.NextToken"> <summary> <para> <para>The next page of elements from this collection. Not valid for the last element of the collection.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseCmdlet"> <summary> Gets a RouteResponse. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseCmdlet.RouteId"> <summary> <para> <para>The route ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseCmdlet.RouteResponseId"> <summary> <para> <para>The route response ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseListCmdlet"> <summary> Gets the RouteResponses for a Route.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseListCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseListCmdlet.RouteId"> <summary> <para> <para>The route ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elements to be returned for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseListCmdlet.NextToken"> <summary> <para> <para>The next page of elements from this collection. Not valid for the last element of the collection.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageCmdlet"> <summary> Gets a Stage. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageCmdlet.StageName"> <summary> <para> <para>The stage name.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageListCmdlet"> <summary> Gets the Stages for an API.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageListCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elements to be returned for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageListCmdlet.NextToken"> <summary> <para> <para>The next page of elements from this collection. Not valid for the last element of the collection.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2TagCmdlet"> <summary> Gets the Tags for an API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2TagCmdlet.ResourceArn"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet"> <summary> Creates an Api resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.ApiKeySelectionExpression"> <summary> <para> <para>An API key selection expression. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.Description"> <summary> <para> <para>The description of the API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.DisableSchemaValidation"> <summary> <para> <para>Avoid validating models when creating a deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.Name"> <summary> <para> <para>The name of the API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.ProtocolType"> <summary> <para> <para>The API protocol: Currently only WEBSOCKET is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.RouteSelectionExpression"> <summary> <para> <para>The route selection expression for the API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.Tag"> <summary> <para> <para>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..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.Version"> <summary> <para> <para>A version identifier for the API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiMappingCmdlet"> <summary> Creates an API mapping. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiMappingCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiMappingCmdlet.ApiMappingKey"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiMappingCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiMappingCmdlet.Stage"> <summary> <para> <para>The API stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiMappingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet"> <summary> Creates an Authorizer for an API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.AuthorizerCredentialsArn"> <summary> <para> <para>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.AuthorizerResultTtlInSecond"> <summary> <para> <para>The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.AuthorizerType"> <summary> <para> <para>The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.AuthorizerUri"> <summary> <para> <para>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.IdentitySource"> <summary> <para> <para>The identity source for which authorization is requested.</para><para>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 and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.IdentityValidationExpression"> <summary> <para> <para>The validation expression does not apply to the REQUEST authorizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.Name"> <summary> <para> <para>The name of the authorizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.ProviderArn"> <summary> <para> <para>For REQUEST authorizer, this is not defined.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.NewAG2DeploymentCmdlet"> <summary> Creates a Deployment for an API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DeploymentCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DeploymentCmdlet.Description"> <summary> <para> <para>The description for the deployment resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DeploymentCmdlet.StageName"> <summary> <para> <para>The name of the Stage resource for the Deployment resource to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DeploymentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.NewAG2DomainNameCmdlet"> <summary> Creates a domain name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DomainNameCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DomainNameCmdlet.DomainNameConfiguration"> <summary> <para> <para>The domain name configurations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DomainNameCmdlet.Tag"> <summary> <para> <para>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..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DomainNameCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet"> <summary> Creates an Integration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.ConnectionId"> <summary> <para> <para>The connection ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.ConnectionType"> <summary> <para> <para>The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.ContentHandlingStrategy"> <summary> <para> <para>Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</para><para> CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</para><para> CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.CredentialsArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.Description"> <summary> <para> <para>The description of the integration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.IntegrationMethod"> <summary> <para> <para>Specifies the integration's HTTP method type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.IntegrationType"> <summary> <para> <para>The integration type of an integration. One of the following:</para><para> 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.</para><para> AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.</para><para> HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as HTTP custom integration.</para><para> HTTP_PROXY: for integrating 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.</para><para> MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.IntegrationUri"> <summary> <para> <para>For a Lambda proxy integration, this is the URI of the Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.PassthroughBehavior"> <summary> <para> <para>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.</para><para> WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</para><para> NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</para><para> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.RequestParameter"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.RequestTemplate"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.TemplateSelectionExpression"> <summary> <para> <para>The template selection expression for the integration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.TimeoutInMilli"> <summary> <para> <para>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationResponseCmdlet"> <summary> Creates an IntegrationResponses. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationResponseCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationResponseCmdlet.ContentHandlingStrategy"> <summary> <para> <para>Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</para><para> CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</para><para> CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationResponseCmdlet.IntegrationId"> <summary> <para> <para>The integration ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationResponseCmdlet.IntegrationResponseKey"> <summary> <para> <para>The integration response key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationResponseCmdlet.ResponseParameter"> <summary> <para> <para>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationResponseCmdlet.ResponseTemplate"> <summary> <para> <para>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationResponseCmdlet.TemplateSelectionExpression"> <summary> <para> <para>The template selection expression for the integration response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationResponseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.NewAG2ModelCmdlet"> <summary> Creates a Model for an API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ModelCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ModelCmdlet.ContentType"> <summary> <para> <para>The content-type for the model, for example, "application/json".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ModelCmdlet.Description"> <summary> <para> <para>The description of the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ModelCmdlet.Name"> <summary> <para> <para>The name of the model. Must be alphanumeric.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ModelCmdlet.Schema"> <summary> <para> <para>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ModelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet"> <summary> Creates a Route for an API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.ApiKeyRequired"> <summary> <para> <para>Specifies whether an API key is required for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.AuthorizationScope"> <summary> <para> <para>The authorization scopes supported by this route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.AuthorizationType"> <summary> <para> <para>The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.AuthorizerId"> <summary> <para> <para>The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.ModelSelectionExpression"> <summary> <para> <para>The model selection expression for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.OperationName"> <summary> <para> <para>The operation name for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.RequestModel"> <summary> <para> <para>The request models for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.RequestParameter"> <summary> <para> <para>The request parameters for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.RouteKey"> <summary> <para> <para>The route key for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.RouteResponseSelectionExpression"> <summary> <para> <para>The route response selection expression for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.Target"> <summary> <para> <para>The target for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteResponseCmdlet"> <summary> Creates a RouteResponse for a Route. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteResponseCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteResponseCmdlet.ModelSelectionExpression"> <summary> <para> <para>The model selection expression for the route response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteResponseCmdlet.ResponseModel"> <summary> <para> <para>The response models for the route response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteResponseCmdlet.ResponseParameter"> <summary> <para> <para>The route response parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteResponseCmdlet.RouteId"> <summary> <para> <para>The route ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteResponseCmdlet.RouteResponseKey"> <summary> <para> <para>The route response key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteResponseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet"> <summary> Creates a Stage for an API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.ClientCertificateId"> <summary> <para> <para>The identifier of a client certificate for a Stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.DefaultRouteSettings_DataTraceEnabled"> <summary> <para> <para>Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.DeploymentId"> <summary> <para> <para>The deployment identifier of the API stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.Description"> <summary> <para> <para>The description for the API stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.AccessLogSettings_DestinationArn"> <summary> <para> <para>The ARN of the CloudWatch Logs log group to receive access logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.DefaultRouteSettings_DetailedMetricsEnabled"> <summary> <para> <para>Specifies whether detailed metrics are enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.AccessLogSettings_Format"> <summary> <para> <para>A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.DefaultRouteSettings_LoggingLevel"> <summary> <para> <para>Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.RouteSetting"> <summary> <para> <para>Route settings for the stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.StageName"> <summary> <para> <para>The name of the stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.StageVariable"> <summary> <para> Amazon.ApiGatewayV2.Model.CreateStageRequest.StageVariables </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.Tag"> <summary> <para> <para>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..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.DefaultRouteSettings_ThrottlingBurstLimit"> <summary> <para> <para>Specifies the throttling burst limit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.DefaultRouteSettings_ThrottlingRateLimit"> <summary> <para> <para>Specifies the throttling rate limit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ApiCmdlet"> <summary> Deletes an Api resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ApiCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ApiCmdlet.PassThru"> <summary> Returns the value passed to the ApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ApiCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ApiMappingCmdlet"> <summary> Deletes an API mapping. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ApiMappingCmdlet.ApiMappingId"> <summary> <para> <para>The API mapping identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ApiMappingCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ApiMappingCmdlet.PassThru"> <summary> Returns the value passed to the ApiMappingId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ApiMappingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2AuthorizerCmdlet"> <summary> Deletes an Authorizer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2AuthorizerCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2AuthorizerCmdlet.AuthorizerId"> <summary> <para> <para>The authorizer identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2AuthorizerCmdlet.PassThru"> <summary> Returns the value passed to the ApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2AuthorizerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2DeploymentCmdlet"> <summary> Deletes a Deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2DeploymentCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2DeploymentCmdlet.DeploymentId"> <summary> <para> <para>The deployment ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2DeploymentCmdlet.PassThru"> <summary> Returns the value passed to the ApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2DeploymentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2DomainNameCmdlet"> <summary> Deletes a domain name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2DomainNameCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2DomainNameCmdlet.PassThru"> <summary> Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2DomainNameCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationCmdlet"> <summary> Deletes an Integration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationCmdlet.IntegrationId"> <summary> <para> <para>The integration ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationCmdlet.PassThru"> <summary> Returns the value passed to the ApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationResponseCmdlet"> <summary> Deletes an IntegrationResponses. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationResponseCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationResponseCmdlet.IntegrationId"> <summary> <para> <para>The integration ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationResponseCmdlet.IntegrationResponseId"> <summary> <para> <para>The integration response ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationResponseCmdlet.PassThru"> <summary> Returns the value passed to the ApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationResponseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ModelCmdlet"> <summary> Deletes a Model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ModelCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ModelCmdlet.ModelId"> <summary> <para> <para>The model ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ModelCmdlet.PassThru"> <summary> Returns the value passed to the ApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ModelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ResourceTagCmdlet"> <summary> Untag an APIGW resource </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ResourceTagCmdlet.ResourceArn"> <summary> <para> <para>AWS resource arn </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ResourceTagCmdlet.TagKey"> <summary> <para> <para>The Tag keys to delete</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteCmdlet"> <summary> Deletes a Route. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteCmdlet.RouteId"> <summary> <para> <para>The route ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteCmdlet.PassThru"> <summary> Returns the value passed to the ApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteResponseCmdlet"> <summary> Deletes a RouteResponse. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteResponseCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteResponseCmdlet.RouteId"> <summary> <para> <para>The route ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteResponseCmdlet.RouteResponseId"> <summary> <para> <para>The route response ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteResponseCmdlet.PassThru"> <summary> Returns the value passed to the ApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteResponseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2StageCmdlet"> <summary> Deletes a Stage. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2StageCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2StageCmdlet.StageName"> <summary> <para> <para>The stage name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2StageCmdlet.PassThru"> <summary> Returns the value passed to the ApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2StageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet"> <summary> Updates an Api resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.ApiKeySelectionExpression"> <summary> <para> <para>An API key selection expression. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.Description"> <summary> <para> <para>The description of the API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.DisableSchemaValidation"> <summary> <para> <para>Avoid validating models when creating a deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.Name"> <summary> <para> <para>The name of the API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.RouteSelectionExpression"> <summary> <para> <para>The route selection expression for the API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.Version"> <summary> <para> <para>A version identifier for the API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiMappingCmdlet"> <summary> The API mapping. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiMappingCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiMappingCmdlet.ApiMappingId"> <summary> <para> <para>The API mapping identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiMappingCmdlet.ApiMappingKey"> <summary> <para> <para>The API mapping key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiMappingCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiMappingCmdlet.Stage"> <summary> <para> <para>The API stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiMappingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet"> <summary> Updates an Authorizer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.AuthorizerCredentialsArn"> <summary> <para> <para>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.AuthorizerId"> <summary> <para> <para>The authorizer identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.AuthorizerResultTtlInSecond"> <summary> <para> <para>The time to live (TTL), in seconds, of cached authorizer results. If it is zero, authorization caching is disabled. If it is greater than zero, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.AuthorizerType"> <summary> <para> <para>The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.AuthorizerUri"> <summary> <para> <para>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.IdentitySource"> <summary> <para> <para>The identity source for which authorization is requested.</para><para>For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.IdentityValidationExpression"> <summary> <para> <para>The validation expression does not apply to the REQUEST authorizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.Name"> <summary> <para> <para>The name of the authorizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.ProviderArn"> <summary> <para> <para>For REQUEST authorizer, this is not defined.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DeploymentCmdlet"> <summary> Updates a Deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DeploymentCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DeploymentCmdlet.DeploymentId"> <summary> <para> <para>The deployment ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DeploymentCmdlet.Description"> <summary> <para> <para>The description for the deployment resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DeploymentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DomainNameCmdlet"> <summary> Updates a domain name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DomainNameCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DomainNameCmdlet.DomainNameConfiguration"> <summary> <para> <para>The domain name configurations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DomainNameCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet"> <summary> Updates an Integration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.ConnectionId"> <summary> <para> <para>The connection ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.ConnectionType"> <summary> <para> <para>The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.ContentHandlingStrategy"> <summary> <para> <para>Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</para><para> CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</para><para> CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.CredentialsArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.Description"> <summary> <para> <para>The description of the integration</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.IntegrationId"> <summary> <para> <para>The integration ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.IntegrationMethod"> <summary> <para> <para>Specifies the integration's HTTP method type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.IntegrationType"> <summary> <para> <para>The integration type of an integration. One of the following:</para><para> 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.</para><para> AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.</para><para> HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.</para><para> HTTP_PROXY: for integrating 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.</para><para> MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.IntegrationUri"> <summary> <para> <para>For a Lambda proxy integration, this is the URI of the Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.PassthroughBehavior"> <summary> <para> <para>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.</para><para> WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</para><para> NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</para><para> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.RequestParameter"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.RequestTemplate"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.TemplateSelectionExpression"> <summary> <para> <para>The template selection expression for the integration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.TimeoutInMilli"> <summary> <para> <para>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationResponseCmdlet"> <summary> Updates an IntegrationResponses. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationResponseCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationResponseCmdlet.ContentHandlingStrategy"> <summary> <para> <para>Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</para><para> CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</para><para> CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationResponseCmdlet.IntegrationId"> <summary> <para> <para>The integration ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationResponseCmdlet.IntegrationResponseId"> <summary> <para> The integration response ID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationResponseCmdlet.IntegrationResponseKey"> <summary> <para> <para>The integration response key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationResponseCmdlet.ResponseParameter"> <summary> <para> <para>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationResponseCmdlet.ResponseTemplate"> <summary> <para> <para>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationResponseCmdlet.TemplateSelectionExpression"> <summary> <para> <para>The template selection expression for the integration response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationResponseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ModelCmdlet"> <summary> Updates a Model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ModelCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ModelCmdlet.ContentType"> <summary> <para> <para>The content-type for the model, for example, "application/json".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ModelCmdlet.Description"> <summary> <para> <para>The description of the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ModelCmdlet.ModelId"> <summary> <para> <para>The model ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ModelCmdlet.Name"> <summary> <para> <para>The name of the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ModelCmdlet.Schema"> <summary> <para> <para>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ModelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet"> <summary> Updates a Route. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.ApiKeyRequired"> <summary> <para> <para>Specifies whether an API key is required for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.AuthorizationScope"> <summary> <para> <para>The authorization scopes supported by this route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.AuthorizationType"> <summary> <para> <para>The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.AuthorizerId"> <summary> <para> <para>The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.ModelSelectionExpression"> <summary> <para> <para>The model selection expression for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.OperationName"> <summary> <para> <para>The operation name for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.RequestModel"> <summary> <para> <para>The request models for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.RequestParameter"> <summary> <para> <para>The request parameters for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.RouteId"> <summary> <para> <para>The route ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.RouteKey"> <summary> <para> <para>The route key for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.RouteResponseSelectionExpression"> <summary> <para> <para>The route response selection expression for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.Target"> <summary> <para> <para>The target for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteResponseCmdlet"> <summary> Updates a RouteResponse. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteResponseCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteResponseCmdlet.ModelSelectionExpression"> <summary> <para> <para>The model selection expression for the route response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteResponseCmdlet.ResponseModel"> <summary> <para> <para>The response models for the route response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteResponseCmdlet.ResponseParameter"> <summary> <para> <para>The route response parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteResponseCmdlet.RouteId"> <summary> <para> <para>The route ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteResponseCmdlet.RouteResponseId"> <summary> <para> <para>The route response ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteResponseCmdlet.RouteResponseKey"> <summary> <para> <para>The route response key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteResponseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet"> <summary> Updates a Stage. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.ClientCertificateId"> <summary> <para> <para>The identifier of a client certificate for a Stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.DefaultRouteSettings_DataTraceEnabled"> <summary> <para> <para>Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.DeploymentId"> <summary> <para> <para>The deployment identifier for the API stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.Description"> <summary> <para> <para>The description for the API stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.AccessLogSettings_DestinationArn"> <summary> <para> <para>The ARN of the CloudWatch Logs log group to receive access logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.DefaultRouteSettings_DetailedMetricsEnabled"> <summary> <para> <para>Specifies whether detailed metrics are enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.AccessLogSettings_Format"> <summary> <para> <para>A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.DefaultRouteSettings_LoggingLevel"> <summary> <para> <para>Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.RouteSetting"> <summary> <para> <para>Route settings for the stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.StageName"> <summary> <para> <para>The stage name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.StageVariable"> <summary> <para> Amazon.ApiGatewayV2.Model.UpdateStageRequest.StageVariables </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.DefaultRouteSettings_ThrottlingBurstLimit"> <summary> <para> <para>Specifies the throttling burst limit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.DefaultRouteSettings_ThrottlingRateLimit"> <summary> <para> <para>Specifies the throttling rate limit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |