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> Creates a new Tag resource to represent a tag. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.AddAG2ResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The resource ARN for the tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.AddAG2ResourceTagCmdlet.Tag"> <summary> <para> <para>The collection of tags. Each tag element is associated with a given resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.AddAG2ResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.AddAG2ResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </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> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.AG2.ExportAG2ApiCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ExportAG2ApiCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ExportAG2ApiCmdlet.ExportVersion"> <summary> <para> <para>The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ExportAG2ApiCmdlet.IncludeExtension"> <summary> <para> <para>Specifies whether to include <a href="https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html">API Gateway extensions</a> in the exported API definition. API Gateway extensions are included by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ExportAG2ApiCmdlet.OutputType"> <summary> <para> <para>The output type of the exported definition file. Valid values are JSON and YAML.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ExportAG2ApiCmdlet.Specification"> <summary> <para> <para>The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ExportAG2ApiCmdlet.StageName"> <summary> <para> <para>The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ExportAG2ApiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Body'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.ExportApiResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.ExportApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ExportAG2ApiCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ExportAG2ApiCmdlet.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="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiCmdlet.Select"> <summary> 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.GetApiResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiListCmdlet"> <summary> Gets a collection of Api resources.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetApisResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetApisResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingCmdlet"> <summary> Gets an 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="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingCmdlet.Select"> <summary> 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.GetApiMappingResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetApiMappingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiMappingId parameter. The -PassThru parameter is deprecated, use -Select '^ApiMappingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingListCmdlet"> <summary> Gets API mappings.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingListCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elements to be returned for this resource.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingListCmdlet.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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetApiMappingsResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetApiMappingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ApiMappingListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerCmdlet.Select"> <summary> 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.GetAuthorizerResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetAuthorizerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerListCmdlet"> <summary> Gets the Authorizers for an API.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetAuthorizersResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetAuthorizersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2AuthorizerListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentCmdlet.Select"> <summary> 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.GetDeploymentResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetDeploymentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentListCmdlet"> <summary> Gets the Deployments for an API.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetDeploymentsResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetDeploymentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DeploymentListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DomainNameCmdlet.Select"> <summary> 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.GetDomainNameResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetDomainNameResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DomainNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2DomainNameListCmdlet"> <summary> Gets the domain names for an AWS account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DomainNameListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetDomainNamesResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetDomainNamesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2DomainNameListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationCmdlet.Select"> <summary> 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.GetIntegrationResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetIntegrationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationListCmdlet"> <summary> Gets the Integrations for an API.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetIntegrationsResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetIntegrationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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> <para>The integration response ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseCmdlet.Select"> <summary> 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.GetIntegrationResponseResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetIntegrationResponseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseListCmdlet"> <summary> Gets the IntegrationResponses for an Integration.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetIntegrationResponsesResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetIntegrationResponsesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2IntegrationResponseListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelCmdlet.Select"> <summary> 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.GetModelResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetModelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelListCmdlet"> <summary> Gets the Models for an API.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetModelsResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetModelsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Value'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetModelTemplateResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetModelTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2ModelTemplateCmdlet.PassThru"> <summary> 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. </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="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteCmdlet.Select"> <summary> 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.GetRouteResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetRouteResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteListCmdlet"> <summary> Gets the Routes for an API.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetRoutesResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetRoutesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseCmdlet.Select"> <summary> 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.GetRouteResponseResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetRouteResponseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseListCmdlet"> <summary> Gets the RouteResponses for a Route.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetRouteResponsesResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetRouteResponsesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2RouteResponseListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageCmdlet.Select"> <summary> 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.GetStageResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetStageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageListCmdlet"> <summary> Gets the Stages for an API.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetStagesResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetStagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2StageListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2TagCmdlet"> <summary> Gets a collection of Tag resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2TagCmdlet.ResourceArn"> <summary> <para> <para>The resource ARN for the tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2TagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetTagsResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2TagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2VpcLinkCmdlet"> <summary> Gets a VPC link. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2VpcLinkCmdlet.VpcLinkId"> <summary> <para> <para>The ID of the VPC link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2VpcLinkCmdlet.Select"> <summary> 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.GetVpcLinkResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetVpcLinkResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2VpcLinkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VpcLinkId parameter. The -PassThru parameter is deprecated, use -Select '^VpcLinkId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.GetAG2VpcLinkListCmdlet"> <summary> Gets a collection of VPC links.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2VpcLinkListCmdlet.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.GetAG2VpcLinkListCmdlet.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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2VpcLinkListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.GetVpcLinksResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.GetVpcLinksResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.GetAG2VpcLinkListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG2.ImportAG2ApiCmdlet"> <summary> Imports an API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ImportAG2ApiCmdlet.Basepath"> <summary> <para> <para>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ImportAG2ApiCmdlet.Body"> <summary> <para> <para>The OpenAPI definition. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ImportAG2ApiCmdlet.FailOnWarning"> <summary> <para> <para>Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ImportAG2ApiCmdlet.Select"> <summary> 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.ImportApiResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.ImportApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ImportAG2ApiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Body parameter. The -PassThru parameter is deprecated, use -Select '^Body' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ImportAG2ApiCmdlet.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.NewAG2ApiCmdlet"> <summary> Creates an Api resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.CorsConfiguration_AllowCredential"> <summary> <para> <para>Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.CorsConfiguration_AllowHeader"> <summary> <para> <para>Represents a collection of allowed headers. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.CorsConfiguration_AllowMethod"> <summary> <para> <para>Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.CorsConfiguration_AllowOrigin"> <summary> <para> <para>Represents a collection of allowed origins. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.ApiKeySelectionExpression"> <summary> <para> <para>An API key selection expression. Supported only for WebSocket APIs. 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.CredentialsArn"> <summary> <para> <para>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, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.</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.DisableExecuteApiEndpoint"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.DisableSchemaValidation"> <summary> <para> <para>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.CorsConfiguration_ExposeHeader"> <summary> <para> <para>Represents a collection of exposed headers. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.CorsConfiguration_MaxAge"> <summary> <para> <para>The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.</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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.RouteKey"> <summary> <para> <para>This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.RouteSelectionExpression"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.Tag"> <summary> <para> <para>The collection of tags. Each tag element is associated with a given resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.Target"> <summary> <para> <para>This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.</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.Select"> <summary> 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.CreateApiResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </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 API mapping key. </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.Select"> <summary> 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.CreateApiMappingResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateApiMappingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ApiMappingCmdlet.PassThru"> <summary> 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. </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.JwtConfiguration_Audience"> <summary> <para> <para>A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href="https://tools.ietf.org/html/rfc7519#section-4.1.3">RFC 7519</a>. Supported only for HTTP APIs.</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, don't specify this parameter. Supported only for REQUEST authorizers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.AuthorizerPayloadFormatVersion"> <summary> <para> <para>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.AuthorizerResultTtlInSecond"> <summary> <para> <para>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.AuthorizerType"> <summary> <para> <para>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable> , where <replaceable></replaceable>{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. Supported only for REQUEST authorizers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.EnableSimpleResponse"> <summary> <para> <para>Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a></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 a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</para><para>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.IdentityValidationExpression"> <summary> <para> <para>This parameter is not used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.JwtConfiguration_Issuer"> <summary> <para> <para>The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>{region}</replaceable>.amazonaws.com/<replaceable>{userPoolId}</replaceable> . Required for the JWT authorizer type. Supported only for HTTP APIs.</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.Select"> <summary> 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.CreateAuthorizerResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateAuthorizerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2AuthorizerCmdlet.PassThru"> <summary> 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. </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.Select"> <summary> 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.CreateDeploymentResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateDeploymentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DeploymentCmdlet.PassThru"> <summary> 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. </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 collection of tags associated with a domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DomainNameCmdlet.MutualTlsAuthentication_TruststoreUri"> <summary> <para> <para>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DomainNameCmdlet.MutualTlsAuthentication_TruststoreVersion"> <summary> <para> <para>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DomainNameCmdlet.Select"> <summary> 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.CreateDomainNameResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateDomainNameResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2DomainNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </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 ID of the VPC link for a private integration. Supported only for HTTP APIs.</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. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.ContentHandlingStrategy"> <summary> <para> <para>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</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.IntegrationSubtype"> <summary> <para> <para>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</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. Supported only for WebSocket APIs.</para><para>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</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. Supported only for WebSocket APIs.</para><para>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</para><para>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.IntegrationUri"> <summary> <para> <para>For a Lambda integration, specify the URI of a Lambda function.</para><para>For an HTTP integration, specify a fully-qualified URL.</para><para>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</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. Supported only for WebSocket APIs.</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.PayloadFormatVersion"> <summary> <para> <para>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.RequestParameter"> <summary> <para> <para>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable> , where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.</para><para>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</para><para>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</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. Supported only for WebSocket APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.ResponseParameter"> <summary> <para> <para>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.TlsConfig_ServerNameToVerify"> <summary> <para> <para>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</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 for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.Select"> <summary> 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.CreateIntegrationResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateIntegrationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationCmdlet.PassThru"> <summary> 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. </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. Supported only for WebSocket APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationResponseCmdlet.Select"> <summary> 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.CreateIntegrationResponseResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateIntegrationResponseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2IntegrationResponseCmdlet.PassThru"> <summary> 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. </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.Select"> <summary> 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.CreateModelResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateModelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2ModelCmdlet.PassThru"> <summary> 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. </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. Supported only for WebSocket APIs.</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. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, 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. 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. Supported only for WebSocket APIs.</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. Supported only for WebSocket APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.RequestParameter"> <summary> <para> <para>The request parameters for the route. Supported only for WebSocket APIs.</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. Supported only for WebSocket APIs.</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.Select"> <summary> 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.CreateRouteResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateRouteResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteCmdlet.PassThru"> <summary> 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. </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. Supported only for WebSocket APIs.</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.Select"> <summary> 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.CreateRouteResponseResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateRouteResponseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2RouteResponseCmdlet.PassThru"> <summary> 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. </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.AutoDeploy"> <summary> <para> <para>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</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. Supported only for WebSocket APIs.</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. Supported only for WebSocket APIs.</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: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.RouteSetting"> <summary> <para> <para>Route settings for the stage, by routeKey.</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> <para>A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.Tag"> <summary> <para> <para>The collection of tags. Each tag element is associated with a given resource.</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.Select"> <summary> 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.CreateStageResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateStageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2StageCmdlet.PassThru"> <summary> 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. </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.NewAG2VpcLinkCmdlet"> <summary> Creates a VPC link. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2VpcLinkCmdlet.Name"> <summary> <para> <para>The name of the VPC link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2VpcLinkCmdlet.SecurityGroupId"> <summary> <para> <para>A list of security group IDs for the VPC link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2VpcLinkCmdlet.SubnetId"> <summary> <para> <para>A list of subnet IDs to include in the VPC link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2VpcLinkCmdlet.Tag"> <summary> <para> <para>A list of tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2VpcLinkCmdlet.Select"> <summary> 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.CreateVpcLinkResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.CreateVpcLinkResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2VpcLinkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.NewAG2VpcLinkCmdlet.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.RemoveAG2AccessLogSettingCmdlet"> <summary> Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2AccessLogSettingCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2AccessLogSettingCmdlet.StageName"> <summary> <para> <para>The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2AccessLogSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteAccessLogSettingsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2AccessLogSettingCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2AccessLogSettingCmdlet.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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteApiResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ApiCmdlet.PassThru"> <summary> 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. </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteApiMappingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ApiMappingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiMappingId parameter. The -PassThru parameter is deprecated, use -Select '^ApiMappingId' instead. This parameter will be removed in a future version. </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteAuthorizerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2AuthorizerCmdlet.PassThru"> <summary> 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. </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.RemoveAG2CorsConfigurationCmdlet"> <summary> Deletes a CORS configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2CorsConfigurationCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2CorsConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteCorsConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2CorsConfigurationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2CorsConfigurationCmdlet.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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteDeploymentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2DeploymentCmdlet.PassThru"> <summary> 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. </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteDomainNameResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2DomainNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteIntegrationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationCmdlet.PassThru"> <summary> 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. </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteIntegrationResponseResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2IntegrationResponseCmdlet.PassThru"> <summary> 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. </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteModelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ModelCmdlet.PassThru"> <summary> 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. </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> Deletes a Tag. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The resource ARN for the tag.</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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2ResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteRouteResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteCmdlet.PassThru"> <summary> 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. </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.RemoveAG2RouteRequestParameterCmdlet"> <summary> Deletes a route request parameter. Supported only for WebSocket APIs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteRequestParameterCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteRequestParameterCmdlet.RequestParameterKey"> <summary> <para> <para>The route request parameter key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteRequestParameterCmdlet.RouteId"> <summary> <para> <para>The route ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteRequestParameterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteRouteRequestParameterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteRequestParameterCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteRequestParameterCmdlet.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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteRouteResponseResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteResponseCmdlet.PassThru"> <summary> 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. </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.RemoveAG2RouteSettingCmdlet"> <summary> Deletes the RouteSettings for a stage. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteSettingCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteSettingCmdlet.RouteKey"> <summary> <para> <para>The route key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteSettingCmdlet.StageName"> <summary> <para> <para>The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteRouteSettingsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteSettingCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2RouteSettingCmdlet.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. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2StageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteStageResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2StageCmdlet.PassThru"> <summary> 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. </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.RemoveAG2VpcLinkCmdlet"> <summary> Deletes a VPC link. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2VpcLinkCmdlet.VpcLinkId"> <summary> <para> <para>The ID of the VPC link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2VpcLinkCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.DeleteVpcLinkResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2VpcLinkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VpcLinkId parameter. The -PassThru parameter is deprecated, use -Select '^VpcLinkId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.RemoveAG2VpcLinkCmdlet.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.ResetAG2AuthorizersCacheCmdlet"> <summary> Resets all authorizer cache entries on a stage. Supported only for HTTP APIs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ResetAG2AuthorizersCacheCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ResetAG2AuthorizersCacheCmdlet.StageName"> <summary> <para> <para>The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ResetAG2AuthorizersCacheCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.ResetAuthorizersCacheResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ResetAG2AuthorizersCacheCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.ResetAG2AuthorizersCacheCmdlet.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.CorsConfiguration_AllowCredential"> <summary> <para> <para>Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.CorsConfiguration_AllowHeader"> <summary> <para> <para>Represents a collection of allowed headers. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.CorsConfiguration_AllowMethod"> <summary> <para> <para>Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.CorsConfiguration_AllowOrigin"> <summary> <para> <para>Represents a collection of allowed origins. Supported only for HTTP APIs.</para> </para> </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. Supported only for WebSocket APIs. 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.CredentialsArn"> <summary> <para> <para>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.</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.DisableExecuteApiEndpoint"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.DisableSchemaValidation"> <summary> <para> <para>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.CorsConfiguration_ExposeHeader"> <summary> <para> <para>Represents a collection of exposed headers. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.CorsConfiguration_MaxAge"> <summary> <para> <para>The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.</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.RouteKey"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.RouteSelectionExpression"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.Target"> <summary> <para> <para>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.</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.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiCmdlet.PassThru"> <summary> 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. </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.UpdateAG2ApiImportCmdlet"> <summary> Puts an Api resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiImportCmdlet.ApiId"> <summary> <para> <para>The API identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiImportCmdlet.Basepath"> <summary> <para> <para>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiImportCmdlet.Body"> <summary> <para> <para>The OpenAPI definition. Supported only for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiImportCmdlet.FailOnWarning"> <summary> <para> <para>Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiImportCmdlet.Select"> <summary> 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.ReimportApiResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.ReimportApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiImportCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiImportCmdlet.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.Select"> <summary> 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.UpdateApiMappingResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateApiMappingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ApiMappingCmdlet.PassThru"> <summary> 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. </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.JwtConfiguration_Audience"> <summary> <para> <para>A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href="https://tools.ietf.org/html/rfc7519#section-4.1.3">RFC 7519</a>. Supported only for HTTP APIs.</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, don't specify this parameter.</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.AuthorizerPayloadFormatVersion"> <summary> <para> <para>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.AuthorizerResultTtlInSecond"> <summary> <para> <para>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.AuthorizerType"> <summary> <para> <para>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable> , where <replaceable></replaceable>{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. Supported only for REQUEST authorizers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.EnableSimpleResponse"> <summary> <para> <para>Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a></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 a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</para><para>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.IdentityValidationExpression"> <summary> <para> <para>This parameter is not used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.JwtConfiguration_Issuer"> <summary> <para> <para>The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>{region}</replaceable>.amazonaws.com/<replaceable>{userPoolId}</replaceable> . Required for the JWT authorizer type. Supported only for HTTP APIs.</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.Select"> <summary> 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.UpdateAuthorizerResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateAuthorizerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2AuthorizerCmdlet.PassThru"> <summary> 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. </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.Select"> <summary> 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.UpdateDeploymentResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateDeploymentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DeploymentCmdlet.PassThru"> <summary> 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. </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.MutualTlsAuthentication_TruststoreUri"> <summary> <para> <para>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DomainNameCmdlet.MutualTlsAuthentication_TruststoreVersion"> <summary> <para> <para>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DomainNameCmdlet.Select"> <summary> 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.UpdateDomainNameResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateDomainNameResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2DomainNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </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 ID of the VPC link for a private integration. Supported only for HTTP APIs.</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. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.ContentHandlingStrategy"> <summary> <para> <para>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</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.IntegrationSubtype"> <summary> <para> <para>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</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. Supported only for WebSocket APIs.</para><para>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</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. Supported only for WebSocket APIs.</para><para>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</para><para>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.IntegrationUri"> <summary> <para> <para>For a Lambda integration, specify the URI of a Lambda function.</para><para>For an HTTP integration, specify a fully-qualified URL.</para><para>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</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. Supported only for WebSocket APIs.</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.PayloadFormatVersion"> <summary> <para> <para>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.RequestParameter"> <summary> <para> <para>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable> , where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.</para><para>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</para><para>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</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. Supported only for WebSocket APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.ResponseParameter"> <summary> <para> <para>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.TlsConfig_ServerNameToVerify"> <summary> <para> <para>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</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 for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.Select"> <summary> 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.UpdateIntegrationResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateIntegrationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationCmdlet.PassThru"> <summary> 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. </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>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</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> <para>The integration response ID.</para> </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.<replaceable>{name}</replaceable> , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.<replaceable>{name}</replaceable> or integration.response.body.<replaceable>{JSON-expression}</replaceable> , where <replaceable>{name}</replaceable> is a valid and unique response header name and <replaceable>{JSON-expression}</replaceable> 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. Supported only for WebSocket APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationResponseCmdlet.Select"> <summary> 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.UpdateIntegrationResponseResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateIntegrationResponseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2IntegrationResponseCmdlet.PassThru"> <summary> 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. </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.Select"> <summary> 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.UpdateModelResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateModelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2ModelCmdlet.PassThru"> <summary> 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. </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. Supported only for WebSocket APIs.</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. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, 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. 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. Supported only for WebSocket APIs.</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. Supported only for WebSocket APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.RequestParameter"> <summary> <para> <para>The request parameters for the route. Supported only for WebSocket APIs.</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. Supported only for WebSocket APIs.</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.Select"> <summary> 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.UpdateRouteResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateRouteResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteCmdlet.PassThru"> <summary> 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. </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. Supported only for WebSocket APIs.</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.Select"> <summary> 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.UpdateRouteResponseResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateRouteResponseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2RouteResponseCmdlet.PassThru"> <summary> 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. </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.AutoDeploy"> <summary> <para> <para>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</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. Supported only for WebSocket APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.DeploymentId"> <summary> <para> <para>The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.</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: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</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. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.StageVariable"> <summary> <para> <para>A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</para> </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.Select"> <summary> 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.UpdateStageResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateStageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2StageCmdlet.PassThru"> <summary> 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. </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> <member name="T:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2VpcLinkCmdlet"> <summary> Updates a VPC link. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2VpcLinkCmdlet.Name"> <summary> <para> <para>The name of the VPC link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2VpcLinkCmdlet.VpcLinkId"> <summary> <para> <para>The ID of the VPC link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2VpcLinkCmdlet.Select"> <summary> 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.UpdateVpcLinkResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.Model.UpdateVpcLinkResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2VpcLinkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VpcLinkId parameter. The -PassThru parameter is deprecated, use -Select '^VpcLinkId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG2.UpdateAG2VpcLinkCmdlet.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> |