AWS.Tools.APIGateway.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.APIGateway</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.AG.AddAGResourceTagCmdlet"> <summary> Adds or updates a tag on a given resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.AddAGResourceTagCmdlet.ResourceArn"> <summary> <para> <para>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.AddAGResourceTagCmdlet.Tag"> <summary> <para> <para>[Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.AddAGResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.AddAGResourceTagCmdlet.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.AG.ClearAGStageAuthorizersCacheCmdlet"> <summary> Flushes all authorizer cache entries on a stage. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ClearAGStageAuthorizersCacheCmdlet.RestApiId"> <summary> <para> <para>The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ClearAGStageAuthorizersCacheCmdlet.StageName"> <summary> <para> <para>The name of the stage to flush.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ClearAGStageAuthorizersCacheCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ClearAGStageAuthorizersCacheCmdlet.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.AG.ClearAGStageCacheCmdlet"> <summary> Flushes a stage's cache. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ClearAGStageCacheCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ClearAGStageCacheCmdlet.StageName"> <summary> <para> <para>[Required] The name of the stage to flush its cache.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ClearAGStageCacheCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ClearAGStageCacheCmdlet.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.AG.GetAGAccountCmdlet"> <summary> Gets information about the current <a>Account</a> resource. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGApiKeyCmdlet"> <summary> Gets information about the current <a>ApiKey</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGApiKeyCmdlet.ApiKey"> <summary> <para> <para>[Required] The identifier of the <a>ApiKey</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGApiKeyCmdlet.IncludeValue"> <summary> <para> <para>A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains the key value.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGApiKeyListCmdlet"> <summary> Gets information about the current <a>ApiKeys</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGApiKeyListCmdlet.CustomerId"> <summary> <para> <para>The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGApiKeyListCmdlet.IncludeValue"> <summary> <para> <para>A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains key values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGApiKeyListCmdlet.NameQuery"> <summary> <para> <para>The name of queried API keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGApiKeyListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGApiKeyListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGAuthorizerCmdlet"> <summary> Describe an existing <a>Authorizer</a> resource. <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html">AWS CLI</a></div> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGAuthorizerCmdlet.AuthorizerId"> <summary> <para> <para>[Required] The identifier of the <a>Authorizer</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGAuthorizerCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGAuthorizerListCmdlet"> <summary> Describe an existing <a>Authorizers</a> resource. <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html">AWS CLI</a></div><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGAuthorizerListCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGAuthorizerListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGAuthorizerListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGBasePathMappingCmdlet"> <summary> Describe a <a>BasePathMapping</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGBasePathMappingCmdlet.BasePath"> <summary> <para> <para>[Required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGBasePathMappingCmdlet.DomainName"> <summary> <para> <para>[Required] The domain name of the <a>BasePathMapping</a> resource to be described.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGBasePathMappingListCmdlet"> <summary> Represents a collection of <a>BasePathMapping</a> resources.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGBasePathMappingListCmdlet.DomainName"> <summary> <para> <para>[Required] The domain name of a <a>BasePathMapping</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGBasePathMappingListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGBasePathMappingListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGClientCertificateCmdlet"> <summary> Gets information about the current <a>ClientCertificate</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGClientCertificateCmdlet.ClientCertificateId"> <summary> <para> <para>[Required] The identifier of the <a>ClientCertificate</a> resource to be described.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGClientCertificateListCmdlet"> <summary> Gets a collection of <a>ClientCertificate</a> resources.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGClientCertificateListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGClientCertificateListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGDeploymentCmdlet"> <summary> Gets information about a <a>Deployment</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDeploymentCmdlet.DeploymentId"> <summary> <para> <para>[Required] The identifier of the <a>Deployment</a> resource to get information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDeploymentCmdlet.Embed"> <summary> <para> <para>A query parameter to retrieve the specified embedded resources of the returned <a>Deployment</a> resource in the response. In a REST API call, this <code>embed</code> parameter value is a list of comma-separated strings, as in <code>GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2</code>. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the <code>"apisummary"</code> string. For example, <code>GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDeploymentCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGDeploymentListCmdlet"> <summary> Gets information about a <a>Deployments</a> collection.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDeploymentListCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDeploymentListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDeploymentListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationPartCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationPartCmdlet.DocumentationPartId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationPartCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationPartListCmdlet"> <summary> <br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationPartListCmdlet.LocationStatus"> <summary> <para> <para>The status of the API documentation parts to retrieve. Valid values are <code>DOCUMENTED</code> for retrieving <a>DocumentationPart</a> resources with content and <code>UNDOCUMENTED</code> for <a>DocumentationPart</a> resources without content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationPartListCmdlet.NameQuery"> <summary> <para> <para>The name of API entities of the to-be-retrieved documentation parts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationPartListCmdlet.Path"> <summary> <para> <para>The path of API entities of the to-be-retrieved documentation parts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationPartListCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationPartListCmdlet.Type"> <summary> <para> <para>The type of API entities of the to-be-retrieved documentation parts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationPartListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationPartListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationVersionCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationVersionCmdlet.DocumentationVersion"> <summary> <para> <para>[Required] The version identifier of the to-be-retrieved documentation snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationVersionCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationVersionListCmdlet"> <summary> <br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationVersionListCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationVersionListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDocumentationVersionListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGDomainNameCmdlet"> <summary> Represents a domain name that is contained in a simpler, more intuitive URL that can be called. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDomainNameCmdlet.DomainName"> <summary> <para> <para>[Required] The name of the <a>DomainName</a> resource.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGDomainNameListCmdlet"> <summary> Represents a collection of <a>DomainName</a> resources.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDomainNameListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGDomainNameListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGExportCmdlet"> <summary> Exports a deployed version of a <a>RestApi</a> in a specified format. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGExportCmdlet.Accept"> <summary> <para> <para>The content-type of the export, for example <code>application/json</code>. Currently <code>application/json</code> and <code>application/yaml</code> are supported for <code>exportType</code> of<code>oas30</code> and <code>swagger</code>. This should be specified in the <code>Accept</code> header for direct API requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGExportCmdlet.ExportType"> <summary> <para> <para>[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGExportCmdlet.Parameter"> <summary> <para> <para>A key-value map of query string parameters that specify properties of the export, depending on the requested <code>exportType</code>. For <code>exportType</code><code>oas30</code> and <code>swagger</code>, any combination of the following parameters are supported: <code>extensions='integrations'</code> or <code>extensions='apigateway'</code> will export the API with x-amazon-apigateway-integration extensions. <code>extensions='authorizers'</code> will export the API with x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API with Postman extensions, allowing for import to the Postman tool</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGExportCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGExportCmdlet.StageName"> <summary> <para> <para>[Required] The name of the <a>Stage</a> that will be exported.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGGatewayResponseCmdlet"> <summary> Gets a <a>GatewayResponse</a> of a specified response type on the given <a>RestApi</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGGatewayResponseCmdlet.ResponseType"> <summary> <para> <para>[Required] <para>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul></para></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGGatewayResponseCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGGatewayResponseListCmdlet"> <summary> Gets the <a>GatewayResponses</a> collection on the given <a>RestApi</a>. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default <a>GatewayResponses</a> collection for the supported response types.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGGatewayResponseListCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGGatewayResponseListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The <a>GatewayResponses</a> collection does not support pagination and the limit does not apply here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGGatewayResponseListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set. The <a>GatewayResponse</a> collection does not support pagination and the position does not apply here.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGIntegrationCmdlet"> <summary> Get the integration settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGIntegrationCmdlet.HttpMethod"> <summary> <para> <para>[Required] Specifies a get integration request's HTTP method.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGIntegrationCmdlet.ResourceId"> <summary> <para> <para>[Required] Specifies a get integration request's resource identifier</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGIntegrationCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGIntegrationResponseCmdlet"> <summary> Represents a get integration response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGIntegrationResponseCmdlet.HttpMethod"> <summary> <para> <para>[Required] Specifies a get integration response request's HTTP method.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGIntegrationResponseCmdlet.ResourceId"> <summary> <para> <para>[Required] Specifies a get integration response request's resource identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGIntegrationResponseCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGIntegrationResponseCmdlet.StatusCode"> <summary> <para> <para>[Required] Specifies a get integration response request's status code.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGMethodCmdlet"> <summary> Describe an existing <a>Method</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGMethodCmdlet.HttpMethod"> <summary> <para> <para>[Required] Specifies the method request's HTTP method type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGMethodCmdlet.ResourceId"> <summary> <para> <para>[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGMethodCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGMethodResponseCmdlet"> <summary> Describes a <a>MethodResponse</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGMethodResponseCmdlet.HttpMethod"> <summary> <para> <para>[Required] The HTTP verb of the <a>Method</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGMethodResponseCmdlet.ResourceId"> <summary> <para> <para>[Required] The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGMethodResponseCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGMethodResponseCmdlet.StatusCode"> <summary> <para> <para>[Required] The status code for the <a>MethodResponse</a> resource.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGModelCmdlet"> <summary> Describes an existing model defined for a <a>RestApi</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGModelCmdlet.Flatten"> <summary> <para> <para>A query parameter of a Boolean value to resolve (<code>true</code>) all external model references and returns a flattened model schema or not (<code>false</code>) The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGModelCmdlet.ModelName"> <summary> <para> <para>[Required] The name of the model as an identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGModelCmdlet.RestApiId"> <summary> <para> <para>[Required] The <a>RestApi</a> identifier under which the <a>Model</a> exists.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGModelListCmdlet"> <summary> Describes existing <a>Models</a> defined for a <a>RestApi</a> resource.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGModelListCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGModelListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGModelListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGModelTemplateCmdlet"> <summary> Generates a sample mapping template that can be used to transform a payload into the structure of a model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGModelTemplateCmdlet.ModelName"> <summary> <para> <para>[Required] The name of the model for which to generate a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGModelTemplateCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGRequestValidatorCmdlet"> <summary> Gets a <a>RequestValidator</a> of a given <a>RestApi</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGRequestValidatorCmdlet.RequestValidatorId"> <summary> <para> <para>[Required] The identifier of the <a>RequestValidator</a> to be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGRequestValidatorCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGResourceCmdlet"> <summary> Lists information about a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGResourceCmdlet.Embed"> <summary> <para> <para>A query parameter to retrieve the specified resources embedded in the returned <a>Resource</a> representation in the response. This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded <a>Method</a> resources this way. The query parameter value must be a single-valued list and contain the <code>"methods"</code> string. For example, <code>GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGResourceCmdlet.ResourceId"> <summary> <para> <para>[Required] The identifier for the <a>Resource</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGResourceCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGResourceListCmdlet"> <summary> Lists information about a collection of <a>Resource</a> resources.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGResourceListCmdlet.Embed"> <summary> <para> <para>A query parameter used to retrieve the specified resources embedded in the returned <a>Resources</a> resource in the response. This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded <a>Method</a> resources this way. The query parameter value must be a single-valued list and contain the <code>"methods"</code> string. For example, <code>GET /restapis/{restapi_id}/resources?embed=methods</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGResourceListCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGResourceListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGResourceListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGResourceTagCmdlet"> <summary> Gets the <a>Tags</a> collection for a given resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGResourceTagCmdlet.Position"> <summary> <para> <para>(Not currently supported) The current pagination position in the paged result set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGResourceTagCmdlet.ResourceArn"> <summary> <para> <para>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGResourceTagCmdlet.Limit"> <summary> <para> <para>(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGRestApiCmdlet"> <summary> Lists the <a>RestApi</a> resource in the collection. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGRestApiCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGRestApiListCmdlet"> <summary> Lists the <a>RestApis</a> resources for your collection.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGRestApiListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGRestApiListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGSdkCmdlet"> <summary> Generates a client SDK for a <a>RestApi</a> and <a>Stage</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGSdkCmdlet.Parameter"> <summary> <para> <para>A string-to-string key-value map of query parameters <code>sdkType</code>-dependent properties of the SDK. For <code>sdkType</code> of <code>objectivec</code> or <code>swift</code>, a parameter named <code>classPrefix</code> is required. For <code>sdkType</code> of <code>android</code>, parameters named <code>groupId</code>, <code>artifactId</code>, <code>artifactVersion</code>, and <code>invokerPackage</code> are required. For <code>sdkType</code> of <code>java</code>, parameters named <code>serviceName</code> and <code>javaPackageName</code> are required. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGSdkCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGSdkCmdlet.SdkType"> <summary> <para> <para>[Required] The language for the generated SDK. Currently <code>java</code>, <code>javascript</code>, <code>android</code>, <code>objectivec</code> (for iOS), <code>swift</code> (for iOS), and <code>ruby</code> are supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGSdkCmdlet.StageName"> <summary> <para> <para>[Required] The name of the <a>Stage</a> that the SDK will use.</para> </para> </summary> </member> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.AG.GetAGSdkTypeCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGSdkTypeCmdlet.Id"> <summary> <para> <para>[Required] The identifier of the queried <a>SdkType</a> instance.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGSdkTypeListCmdlet"> <summary> <br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGSdkTypeListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGSdkTypeListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGStageCmdlet"> <summary> Gets information about a <a>Stage</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGStageCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGStageCmdlet.StageName"> <summary> <para> <para>[Required] The name of the <a>Stage</a> resource to get information about.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGStageListCmdlet"> <summary> Gets information about one or more <a>Stage</a> resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGStageListCmdlet.DeploymentId"> <summary> <para> <para>The stages' deployment identifiers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGStageListCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGUsageCmdlet"> <summary> Gets the usage data of a usage plan in a specified time interval. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsageCmdlet.EndDate"> <summary> <para> <para>[Required] The ending date (e.g., 2016-12-31) of the usage data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsageCmdlet.KeyId"> <summary> <para> <para>The Id of the API key associated with the resultant usage data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsageCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsageCmdlet.StartDate"> <summary> <para> <para>[Required] The starting date (e.g., 2016-01-01) of the usage data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsageCmdlet.UsagePlanId"> <summary> <para> <para>[Required] The Id of the usage plan associated with the usage data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsageCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanCmdlet"> <summary> Gets a usage plan of a given plan identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanCmdlet.UsagePlanId"> <summary> <para> <para>[Required] The identifier of the <a>UsagePlan</a> resource to be retrieved.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanKeyCmdlet"> <summary> Gets a usage plan key of a given key identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanKeyCmdlet.KeyId"> <summary> <para> <para>[Required] The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanKeyCmdlet.UsagePlanId"> <summary> <para> <para>[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanKeyListCmdlet"> <summary> Gets all the usage plan keys representing the API keys added to a specified usage plan.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanKeyListCmdlet.NameQuery"> <summary> <para> <para>A query parameter specifying the name of the to-be-returned usage plan keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanKeyListCmdlet.UsagePlanId"> <summary> <para> <para>[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanKeyListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanKeyListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanListCmdlet"> <summary> Gets all the usage plans of the caller's account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanListCmdlet.KeyId"> <summary> <para> <para>The identifier of the API key associated with the usage plans.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGUsagePlanListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGValidatorListCmdlet"> <summary> Gets the <a>RequestValidators</a> collection of a given <a>RestApi</a>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGValidatorListCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGValidatorListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGValidatorListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGVpcLinkCmdlet"> <summary> Gets a specified VPC link under the caller's account in a region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGVpcLinkCmdlet.VpcLinkId"> <summary> <para> <para>[Required] The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.GetAGVpcLinkListCmdlet"> <summary> Gets the <a>VpcLinks</a> collection under the caller's account in a selected region.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGVpcLinkListCmdlet.Limit"> <summary> <para> <para>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.GetAGVpcLinkListCmdlet.Position"> <summary> <para> <para>The current pagination position in the paged result set.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Position, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.ImportAGApiKeyCmdlet"> <summary> Import API keys from an external source, such as a CSV-formatted file. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGApiKeyCmdlet.Body"> <summary> <para> <para>The payload of the POST request to import API keys. For the payload format, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html">API Key File Format</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGApiKeyCmdlet.FailOnWarning"> <summary> <para> <para>A query parameter to indicate whether to rollback <a>ApiKey</a> importation (<code>true</code>) or not (<code>false</code>) when error is encountered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGApiKeyCmdlet.Format"> <summary> <para> <para>A query parameter to specify the input format to imported API keys. Currently, only the <code>csv</code> format is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGApiKeyCmdlet.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.AG.ImportAGDocumentationPartListCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGDocumentationPartListCmdlet.Body"> <summary> <para> <para>[Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGDocumentationPartListCmdlet.FailOnWarning"> <summary> <para> <para>A query parameter to specify whether to rollback the documentation importation (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGDocumentationPartListCmdlet.Mode"> <summary> <para> <para>A query parameter to indicate whether to overwrite (<code>OVERWRITE</code>) any existing <a>DocumentationParts</a> definition or to merge (<code>MERGE</code>) the new definition into the existing one. The default value is <code>MERGE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGDocumentationPartListCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGDocumentationPartListCmdlet.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.AG.ImportAGRestApiCmdlet"> <summary> A feature of the API Gateway control service for creating a new API from an external API definition file. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGRestApiCmdlet.Body"> <summary> <para> <para>[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGRestApiCmdlet.FailOnWarning"> <summary> <para> <para>A query parameter to indicate whether to rollback the API creation (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGRestApiCmdlet.Parameter"> <summary> <para> <para>A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.</para><para> To exclude <a>DocumentationParts</a> from the import, set <code>parameters</code> as <code>ignore=documentation</code>.</para><para> To configure the endpoint type, set <code>parameters</code> as <code>endpointConfigurationTypes=EDGE</code>, <code>endpointConfigurationTypes=REGIONAL</code>, or <code>endpointConfigurationTypes=PRIVATE</code>. The default endpoint type is <code>EDGE</code>.</para><para> To handle imported <code>basepath</code>, set <code>parameters</code> as <code>basepath=ignore</code>, <code>basepath=prepend</code> or <code>basepath=split</code>.</para><para>For example, the AWS CLI command to exclude documentation from the imported API is:</para><pre><code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'</code></pre><para>The AWS CLI command to set the regional endpoint on the imported API is:</para><pre><code>aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'</code></pre> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.ImportAGRestApiCmdlet.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.AG.NewAGApiKeyCmdlet"> <summary> Create an <a>ApiKey</a> resource. <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html">AWS CLI</a></div> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGApiKeyCmdlet.CustomerId"> <summary> <para> <para>An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGApiKeyCmdlet.Description"> <summary> <para> <para>The description of the <a>ApiKey</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGApiKeyCmdlet.Enabled"> <summary> <para> <para>Specifies whether the <a>ApiKey</a> can be used by callers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGApiKeyCmdlet.GenerateDistinctId"> <summary> <para> <para>Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGApiKeyCmdlet.Name"> <summary> <para> <para>The name of the <a>ApiKey</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGApiKeyCmdlet.StageKey"> <summary> <para> <para>DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGApiKeyCmdlet.Tag"> <summary> <para> <para>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGApiKeyCmdlet.Value"> <summary> <para> <para>Specifies a value of the API key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGApiKeyCmdlet.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.AG.NewAGAuthorizerCmdlet"> <summary> Adds a new <a>Authorizer</a> resource to an existing <a>RestApi</a> resource. <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html">AWS CLI</a></div> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGAuthorizerCmdlet.AuthorizerCredential"> <summary> <para> <para>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGAuthorizerCmdlet.AuthorizerResultTtlInSecond"> <summary> <para> <para>The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGAuthorizerCmdlet.AuthorizerUri"> <summary> <para> <para>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGAuthorizerCmdlet.AuthType"> <summary> <para> <para>Optional customer-defined field, used in OpenAPI imports and exports without functional impact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGAuthorizerCmdlet.IdentitySource"> <summary> <para> <para>The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> or <code>COGNITO_USER_POOLS</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGAuthorizerCmdlet.IdentityValidationExpression"> <summary> <para> <para>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. For <code>COGNITO_USER_POOLS</code> authorizers, API Gateway will match the <code>aud</code> field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGAuthorizerCmdlet.Name"> <summary> <para> <para>[Required] The name of the authorizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGAuthorizerCmdlet.ProviderARNs"> <summary> <para> <para>A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGAuthorizerCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGAuthorizerCmdlet.Type"> <summary> <para> <para>[Required] The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGAuthorizerCmdlet.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.AG.NewAGBasePathMappingCmdlet"> <summary> Creates a new <a>BasePathMapping</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGBasePathMappingCmdlet.BasePath"> <summary> <para> <para>The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGBasePathMappingCmdlet.DomainName"> <summary> <para> <para>[Required] The domain name of the <a>BasePathMapping</a> resource to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGBasePathMappingCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGBasePathMappingCmdlet.Stage"> <summary> <para> <para>The name of the API's stage that you want to use for this mapping. Specify '(none)' if you do not want callers to explicitly specify the stage name after any base path name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGBasePathMappingCmdlet.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.AG.NewAGClientCertificateCmdlet"> <summary> Generates a <a>ClientCertificate</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGClientCertificateCmdlet.Description"> <summary> <para> <para>The description of the <a>ClientCertificate</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGClientCertificateCmdlet.Tag"> <summary> <para> <para>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGClientCertificateCmdlet.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.AG.NewAGDeploymentCmdlet"> <summary> Creates a <a>Deployment</a> resource, which makes a specified <a>RestApi</a> callable over the internet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDeploymentCmdlet.CacheClusterEnabled"> <summary> <para> <para>Enables a cache cluster for the <a>Stage</a> resource specified in the input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDeploymentCmdlet.CacheClusterSize"> <summary> <para> <para>Specifies the cache cluster size for the <a>Stage</a> resource specified in the input, if a cache cluster is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDeploymentCmdlet.Description"> <summary> <para> <para>The description for the <a>Deployment</a> resource to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDeploymentCmdlet.CanarySettings_PercentTraffic"> <summary> <para> <para>The percentage (0.0-100.0) of traffic routed to the canary deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDeploymentCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDeploymentCmdlet.StageDescription"> <summary> <para> <para>The description of the <a>Stage</a> resource for the <a>Deployment</a> resource to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDeploymentCmdlet.StageName"> <summary> <para> <para>The name of the <a>Stage</a> resource for the <a>Deployment</a> resource to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDeploymentCmdlet.CanarySettings_StageVariableOverride"> <summary> <para> <para>A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDeploymentCmdlet.TracingEnabled"> <summary> <para> <para>Specifies whether active tracing with X-ray is enabled for the <a>Stage</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDeploymentCmdlet.CanarySettings_UseStageCache"> <summary> <para> <para>A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDeploymentCmdlet.Variable"> <summary> <para> <para>A map that defines the stage variables for the <a>Stage</a> resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDeploymentCmdlet.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.AG.NewAGDocumentationPartCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationPartCmdlet.Location_Method"> <summary> <para> <para>The HTTP verb of a method. It is a valid field for the API entity types of <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. The default value is <code>*</code> for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>method</code> attribute must match that of the parent entity exactly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationPartCmdlet.Location_Name"> <summary> <para> <para>The name of the targeted API entity. It is a valid and required field for the API entity types of <code>AUTHORIZER</code>, <code>MODEL</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code> and <code>RESPONSE_HEADER</code>. It is an invalid field for any other entity type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationPartCmdlet.Location_Path"> <summary> <para> <para>The URL path of the target. It is a valid field for the API entity types of <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. The default value is <code>/</code> for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>path</code> attribute must match that of the parent entity as a prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationPartCmdlet.Property"> <summary> <para> <para>[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationPartCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationPartCmdlet.Location_StatusCode"> <summary> <para> <para>The HTTP status code of a response. It is a valid field for the API entity types of <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. The default value is <code>*</code> for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>statusCode</code> attribute must match that of the parent entity exactly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationPartCmdlet.Location_Type"> <summary> <para> <para>[Required] The type of API entity to which the documentation content applies. Valid values are <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. Content inheritance does not apply to any entity of the <code>API</code>, <code>AUTHORIZER</code>, <code>METHOD</code>, <code>MODEL</code>, <code>REQUEST_BODY</code>, or <code>RESOURCE</code> type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationPartCmdlet.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.AG.NewAGDocumentationVersionCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationVersionCmdlet.Description"> <summary> <para> <para>A description about the new documentation snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationVersionCmdlet.DocumentationVersion"> <summary> <para> <para>[Required] The version identifier of the new snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationVersionCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationVersionCmdlet.StageName"> <summary> <para> <para>The stage name to be associated with the new documentation snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDocumentationVersionCmdlet.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.AG.NewAGDomainNameCmdlet"> <summary> Creates a new domain name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDomainNameCmdlet.CertificateArn"> <summary> <para> <para>The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDomainNameCmdlet.CertificateBody"> <summary> <para> <para>[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDomainNameCmdlet.CertificateChain"> <summary> <para> <para>[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDomainNameCmdlet.CertificateName"> <summary> <para> <para>The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDomainNameCmdlet.CertificatePrivateKey"> <summary> <para> <para>[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDomainNameCmdlet.DomainName"> <summary> <para> <para>[Required] The name of the <a>DomainName</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDomainNameCmdlet.RegionalCertificateArn"> <summary> <para> <para>The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDomainNameCmdlet.RegionalCertificateName"> <summary> <para> <para>The user-friendly name of the certificate that will be used by regional endpoint for this domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDomainNameCmdlet.SecurityPolicy"> <summary> <para> <para>The Transport Layer Security (TLS) version + cipher suite for this <a>DomainName</a>. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDomainNameCmdlet.Tag"> <summary> <para> <para>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDomainNameCmdlet.EndpointConfiguration_Type"> <summary> <para> <para>A list of endpoint types of an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>). For an edge-optimized API and its custom domain name, the endpoint type is <code>"EDGE"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGDomainNameCmdlet.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.AG.NewAGModelCmdlet"> <summary> Adds a new <a>Model</a> resource to an existing <a>RestApi</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGModelCmdlet.ContentType"> <summary> <para> <para>[Required] The content-type for the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGModelCmdlet.Description"> <summary> <para> <para>The description of the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGModelCmdlet.Name"> <summary> <para> <para>[Required] The name of the model. Must be alphanumeric.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGModelCmdlet.RestApiId"> <summary> <para> <para>[Required] The <a>RestApi</a> identifier under which the <a>Model</a> will be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGModelCmdlet.Schema"> <summary> <para> <para>The schema for the model. For <code>application/json</code> models, this should be <a href="https://tools.ietf.org/html/draft-zyp-json-schema-04" target="_blank">JSON schema draft 4</a> model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGModelCmdlet.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.AG.NewAGRequestValidatorCmdlet"> <summary> Creates a <a>ReqeustValidator</a> of a given <a>RestApi</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRequestValidatorCmdlet.Name"> <summary> <para> <para>The name of the to-be-created <a>RequestValidator</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRequestValidatorCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRequestValidatorCmdlet.ValidateRequestBody"> <summary> <para> <para>A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (<code>true</code>) or not (<code>false</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRequestValidatorCmdlet.ValidateRequestParameter"> <summary> <para> <para>A Boolean flag to indicate whether to validate request parameters, <code>true</code>, or not <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRequestValidatorCmdlet.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.AG.NewAGResourceCmdlet"> <summary> Creates a <a>Resource</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGResourceCmdlet.ParentId"> <summary> <para> <para>[Required] The parent resource's identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGResourceCmdlet.PathPart"> <summary> <para> <para>The last path segment for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGResourceCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGResourceCmdlet.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.AG.NewAGRestApiCmdlet"> <summary> Creates a new <a>RestApi</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRestApiCmdlet.ApiKeySource"> <summary> <para> <para>The source of the API key for metering requests according to a usage plan. Valid values are: <ul><li><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. </li><li><code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRestApiCmdlet.BinaryMediaType"> <summary> <para> <para>The list of binary media types supported by the <a>RestApi</a>. By default, the <a>RestApi</a> supports only UTF-8-encoded text payloads.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRestApiCmdlet.CloneFrom"> <summary> <para> <para>The ID of the <a>RestApi</a> that you want to clone from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRestApiCmdlet.Description"> <summary> <para> <para>The description of the <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRestApiCmdlet.MinimumCompressionSize"> <summary> <para> <para>A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRestApiCmdlet.Name"> <summary> <para> <para>[Required] The name of the <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRestApiCmdlet.Policy"> <summary> <para> A stringified JSON policy document that applies to this RestApi regardless of the caller and <a>Method</a> configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRestApiCmdlet.Tag"> <summary> <para> <para>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRestApiCmdlet.EndpointConfiguration_Type"> <summary> <para> <para>A list of endpoint types of an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>). For an edge-optimized API and its custom domain name, the endpoint type is <code>"EDGE"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRestApiCmdlet.Version"> <summary> <para> <para>A version identifier for the API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGRestApiCmdlet.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.AG.NewAGStageCmdlet"> <summary> Creates a new <a>Stage</a> resource that references a pre-existing <a>Deployment</a> for the API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.CacheClusterEnabled"> <summary> <para> <para>Whether cache clustering is enabled for the stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.CacheClusterSize"> <summary> <para> <para>The stage's cache cluster size.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.CanarySettings_DeploymentId"> <summary> <para> <para>The ID of the canary deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.DeploymentId"> <summary> <para> <para>[Required] The identifier of the <a>Deployment</a> resource for the <a>Stage</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.Description"> <summary> <para> <para>The description of the <a>Stage</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.DocumentationVersion"> <summary> <para> <para>The version of the associated API documentation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.CanarySettings_PercentTraffic"> <summary> <para> <para>The percent (0-100) of traffic diverted to a canary deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.StageName"> <summary> <para> <para>[Required] The name for the <a>Stage</a> resource. 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.AG.NewAGStageCmdlet.CanarySettings_StageVariableOverride"> <summary> <para> <para>Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.Tag"> <summary> <para> <para>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.TracingEnabled"> <summary> <para> <para>Specifies whether active tracing with X-ray is enabled for the <a>Stage</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.CanarySettings_UseStageCache"> <summary> <para> <para>A Boolean flag to indicate whether the canary deployment uses the stage cache or not.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.Variable"> <summary> <para> <para>A map that defines the stage variables for the new <a>Stage</a> resource. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGStageCmdlet.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.AG.NewAGUsagePlanCmdlet"> <summary> Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanCmdlet.ApiStage"> <summary> <para> <para>The associated API stages of the usage plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanCmdlet.Throttle_BurstLimit"> <summary> <para> <para>The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanCmdlet.Description"> <summary> <para> <para>The description of the usage plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanCmdlet.Quota_Limit"> <summary> <para> <para>The maximum number of requests that can be made in a given time period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanCmdlet.Name"> <summary> <para> <para>[Required] The name of the usage plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanCmdlet.Quota_Offset"> <summary> <para> <para>The number of requests subtracted from the given limit in the initial time period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanCmdlet.Quota_Period"> <summary> <para> <para>The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanCmdlet.Throttle_RateLimit"> <summary> <para> <para>The API request steady-state rate limit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanCmdlet.Tag"> <summary> <para> <para>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanCmdlet.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.AG.NewAGUsagePlanKeyCmdlet"> <summary> Creates a usage plan key for adding an existing API key to a usage plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanKeyCmdlet.KeyId"> <summary> <para> <para>[Required] The identifier of a <a>UsagePlanKey</a> resource for a plan customer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanKeyCmdlet.KeyType"> <summary> <para> <para>[Required] The type of a <a>UsagePlanKey</a> resource for a plan customer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanKeyCmdlet.UsagePlanId"> <summary> <para> <para>[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-created <a>UsagePlanKey</a> resource representing a plan customer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGUsagePlanKeyCmdlet.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.AG.NewAGVpcLinkCmdlet"> <summary> Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGVpcLinkCmdlet.Description"> <summary> <para> <para>The description of the VPC link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGVpcLinkCmdlet.Name"> <summary> <para> <para>[Required] The name used to label and identify the VPC link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGVpcLinkCmdlet.Tag"> <summary> <para> <para>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGVpcLinkCmdlet.TargetArn"> <summary> <para> <para>[Required] The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.NewAGVpcLinkCmdlet.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.AG.RemoveAGApiKeyCmdlet"> <summary> Deletes the <a>ApiKey</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGApiKeyCmdlet.ApiKey"> <summary> <para> <para>[Required] The identifier of the <a>ApiKey</a> resource to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGApiKeyCmdlet.PassThru"> <summary> Returns the value passed to the ApiKey parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGApiKeyCmdlet.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.AG.RemoveAGAuthorizerCmdlet"> <summary> Deletes an existing <a>Authorizer</a> resource. <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html">AWS CLI</a></div> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGAuthorizerCmdlet.AuthorizerId"> <summary> <para> <para>[Required] The identifier of the <a>Authorizer</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGAuthorizerCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGAuthorizerCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGAuthorizerCmdlet.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.AG.RemoveAGBasePathMappingCmdlet"> <summary> Deletes the <a>BasePathMapping</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGBasePathMappingCmdlet.BasePath"> <summary> <para> <para>[Required] The base path name of the <a>BasePathMapping</a> resource to delete.</para><para>To specify an empty base path, set this parameter to <code>'(none)'</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGBasePathMappingCmdlet.DomainName"> <summary> <para> <para>[Required] The domain name of the <a>BasePathMapping</a> resource to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGBasePathMappingCmdlet.PassThru"> <summary> Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGBasePathMappingCmdlet.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.AG.RemoveAGClientCertificateCmdlet"> <summary> Deletes the <a>ClientCertificate</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGClientCertificateCmdlet.ClientCertificateId"> <summary> <para> <para>[Required] The identifier of the <a>ClientCertificate</a> resource to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGClientCertificateCmdlet.PassThru"> <summary> Returns the value passed to the ClientCertificateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGClientCertificateCmdlet.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.AG.RemoveAGDeploymentCmdlet"> <summary> Deletes a <a>Deployment</a> resource. Deleting a deployment will only succeed if there are no <a>Stage</a> resources associated with it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDeploymentCmdlet.DeploymentId"> <summary> <para> <para>[Required] The identifier of the <a>Deployment</a> resource to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDeploymentCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDeploymentCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDeploymentCmdlet.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.AG.RemoveAGDocumentationPartCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDocumentationPartCmdlet.DocumentationPartId"> <summary> <para> <para>[Required] The identifier of the to-be-deleted documentation part.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDocumentationPartCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDocumentationPartCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDocumentationPartCmdlet.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.AG.RemoveAGDocumentationVersionCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDocumentationVersionCmdlet.DocumentationVersion"> <summary> <para> <para>[Required] The version identifier of a to-be-deleted documentation snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDocumentationVersionCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDocumentationVersionCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDocumentationVersionCmdlet.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.AG.RemoveAGDomainNameCmdlet"> <summary> Deletes the <a>DomainName</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDomainNameCmdlet.DomainName"> <summary> <para> <para>[Required] The name of the <a>DomainName</a> resource to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDomainNameCmdlet.PassThru"> <summary> Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGDomainNameCmdlet.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.AG.RemoveAGGatewayResponseCmdlet"> <summary> Clears any customization of a <a>GatewayResponse</a> of a specified response type on the given <a>RestApi</a> and resets it with the default settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGGatewayResponseCmdlet.ResponseType"> <summary> <para> <para>[Required] <para>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul></para></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGGatewayResponseCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGGatewayResponseCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGGatewayResponseCmdlet.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.AG.RemoveAGIntegrationCmdlet"> <summary> Represents a delete integration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGIntegrationCmdlet.HttpMethod"> <summary> <para> <para>[Required] Specifies a delete integration request's HTTP method.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGIntegrationCmdlet.ResourceId"> <summary> <para> <para>[Required] Specifies a delete integration request's resource identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGIntegrationCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGIntegrationCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGIntegrationCmdlet.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.AG.RemoveAGIntegrationResponseCmdlet"> <summary> Represents a delete integration response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGIntegrationResponseCmdlet.HttpMethod"> <summary> <para> <para>[Required] Specifies a delete integration response request's HTTP method.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGIntegrationResponseCmdlet.ResourceId"> <summary> <para> <para>[Required] Specifies a delete integration response request's resource identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGIntegrationResponseCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGIntegrationResponseCmdlet.StatusCode"> <summary> <para> <para>[Required] Specifies a delete integration response request's status code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGIntegrationResponseCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGIntegrationResponseCmdlet.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.AG.RemoveAGMethodCmdlet"> <summary> Deletes an existing <a>Method</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGMethodCmdlet.HttpMethod"> <summary> <para> <para>[Required] The HTTP verb of the <a>Method</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGMethodCmdlet.ResourceId"> <summary> <para> <para>[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGMethodCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGMethodCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGMethodCmdlet.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.AG.RemoveAGMethodResponseCmdlet"> <summary> Deletes an existing <a>MethodResponse</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGMethodResponseCmdlet.HttpMethod"> <summary> <para> <para>[Required] The HTTP verb of the <a>Method</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGMethodResponseCmdlet.ResourceId"> <summary> <para> <para>[Required] The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGMethodResponseCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGMethodResponseCmdlet.StatusCode"> <summary> <para> <para>[Required] The status code identifier for the <a>MethodResponse</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGMethodResponseCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGMethodResponseCmdlet.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.AG.RemoveAGModelCmdlet"> <summary> Deletes a model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGModelCmdlet.ModelName"> <summary> <para> <para>[Required] The name of the model to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGModelCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGModelCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGModelCmdlet.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.AG.RemoveAGRequestValidatorCmdlet"> <summary> Deletes a <a>RequestValidator</a> of a given <a>RestApi</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGRequestValidatorCmdlet.RequestValidatorId"> <summary> <para> <para>[Required] The identifier of the <a>RequestValidator</a> to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGRequestValidatorCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGRequestValidatorCmdlet.PassThru"> <summary> Returns the value passed to the RequestValidatorId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGRequestValidatorCmdlet.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.AG.RemoveAGResourceCmdlet"> <summary> Deletes a <a>Resource</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGResourceCmdlet.ResourceId"> <summary> <para> <para>[Required] The identifier of the <a>Resource</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGResourceCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGResourceCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGResourceCmdlet.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.AG.RemoveAGResourceTagCmdlet"> <summary> Removes a tag from a given resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGResourceTagCmdlet.ResourceArn"> <summary> <para> <para>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGResourceTagCmdlet.TagKey"> <summary> <para> <para>[Required] The Tag keys to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGResourceTagCmdlet.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.AG.RemoveAGRestApiCmdlet"> <summary> Deletes the specified API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGRestApiCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGRestApiCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGRestApiCmdlet.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.AG.RemoveAGStageCmdlet"> <summary> Deletes a <a>Stage</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGStageCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGStageCmdlet.StageName"> <summary> <para> <para>[Required] The name of the <a>Stage</a> resource to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGStageCmdlet.PassThru"> <summary> Returns the value passed to the RestApiId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGStageCmdlet.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.AG.RemoveAGUsagePlanCmdlet"> <summary> Deletes a usage plan of a given plan Id. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGUsagePlanCmdlet.UsagePlanId"> <summary> <para> <para>[Required] The Id of the to-be-deleted usage plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGUsagePlanCmdlet.PassThru"> <summary> Returns the value passed to the UsagePlanId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGUsagePlanCmdlet.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.AG.RemoveAGUsagePlanKeyCmdlet"> <summary> Deletes a usage plan key and remove the underlying API key from the associated usage plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGUsagePlanKeyCmdlet.KeyId"> <summary> <para> <para>[Required] The Id of the <a>UsagePlanKey</a> resource to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGUsagePlanKeyCmdlet.UsagePlanId"> <summary> <para> <para>[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a plan customer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGUsagePlanKeyCmdlet.PassThru"> <summary> Returns the value passed to the UsagePlanId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGUsagePlanKeyCmdlet.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.AG.RemoveAGVpcLinkCmdlet"> <summary> Deletes an existing <a>VpcLink</a> of a specified identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGVpcLinkCmdlet.VpcLinkId"> <summary> <para> <para>[Required] The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGVpcLinkCmdlet.PassThru"> <summary> Returns the value passed to the VpcLinkId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.RemoveAGVpcLinkCmdlet.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.AG.TestAGInvokeAuthorizerCmdlet"> <summary> Simulate the execution of an <a>Authorizer</a> in your <a>RestApi</a> with headers, parameters, and an incoming request body. <div class="seeAlso"><a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html">Use Lambda Function as Authorizer</a><a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html">Use Cognito User Pool as Authorizer</a></div> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeAuthorizerCmdlet.AdditionalContext"> <summary> <para> <para>[Optional] A key-value map of additional context variables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeAuthorizerCmdlet.AuthorizerId"> <summary> <para> <para>[Required] Specifies a test invoke authorizer request's <a>Authorizer</a> ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeAuthorizerCmdlet.Body"> <summary> <para> <para>[Optional] The simulated request body of an incoming invocation request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeAuthorizerCmdlet.Header"> <summary> <para> <para>[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeAuthorizerCmdlet.MultiValueHeader"> <summary> <para> <para>[Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeAuthorizerCmdlet.PathWithQueryString"> <summary> <para> <para>[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeAuthorizerCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeAuthorizerCmdlet.StageVariable"> <summary> <para> <para>A key-value map of stage variables to simulate an invocation on a deployed <a>Stage</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeMethodCmdlet"> <summary> Simulate the execution of a <a>Method</a> in your <a>RestApi</a> with headers, parameters, and an incoming request body. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeMethodCmdlet.Body"> <summary> <para> <para>The simulated request body of an incoming invocation request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeMethodCmdlet.ClientCertificateId"> <summary> <para> <para>A <a>ClientCertificate</a> identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeMethodCmdlet.Header"> <summary> <para> <para>A key-value map of headers to simulate an incoming invocation request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeMethodCmdlet.HttpMethod"> <summary> <para> <para>[Required] Specifies a test invoke method request's HTTP method.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeMethodCmdlet.MultiValueHeader"> <summary> <para> <para>The headers as a map from string to list of values to simulate an incoming invocation request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeMethodCmdlet.PathWithQueryString"> <summary> <para> <para>The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeMethodCmdlet.ResourceId"> <summary> <para> <para>[Required] Specifies a test invoke method request's resource ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeMethodCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.TestAGInvokeMethodCmdlet.StageVariable"> <summary> <para> <para>A key-value map of stage variables to simulate an invocation on a deployed <a>Stage</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AG.UpdateAGAccountCmdlet"> <summary> Changes information about the current <a>Account</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGAccountCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGAccountCmdlet.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.AG.UpdateAGApiKeyCmdlet"> <summary> Changes information about an <a>ApiKey</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGApiKeyCmdlet.ApiKey"> <summary> <para> <para>[Required] The identifier of the <a>ApiKey</a> resource to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGApiKeyCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGApiKeyCmdlet.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.AG.UpdateAGAuthorizerCmdlet"> <summary> Updates an existing <a>Authorizer</a> resource. <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html">AWS CLI</a></div> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGAuthorizerCmdlet.AuthorizerId"> <summary> <para> <para>[Required] The identifier of the <a>Authorizer</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGAuthorizerCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGAuthorizerCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGAuthorizerCmdlet.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.AG.UpdateAGBasePathMappingCmdlet"> <summary> Changes information about the <a>BasePathMapping</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGBasePathMappingCmdlet.BasePath"> <summary> <para> <para>[Required] The base path of the <a>BasePathMapping</a> resource to change.</para><para>To specify an empty base path, set this parameter to <code>'(none)'</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGBasePathMappingCmdlet.DomainName"> <summary> <para> <para>[Required] The domain name of the <a>BasePathMapping</a> resource to change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGBasePathMappingCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGBasePathMappingCmdlet.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.AG.UpdateAGClientCertificateCmdlet"> <summary> Changes information about an <a>ClientCertificate</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGClientCertificateCmdlet.ClientCertificateId"> <summary> <para> <para>[Required] The identifier of the <a>ClientCertificate</a> resource to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGClientCertificateCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGClientCertificateCmdlet.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.AG.UpdateAGDeploymentCmdlet"> <summary> Changes information about a <a>Deployment</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDeploymentCmdlet.DeploymentId"> <summary> <para> <para>The replacement identifier for the <a>Deployment</a> resource to change information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDeploymentCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDeploymentCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDeploymentCmdlet.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.AG.UpdateAGDocumentationPartCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDocumentationPartCmdlet.DocumentationPartId"> <summary> <para> <para>[Required] The identifier of the to-be-updated documentation part.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDocumentationPartCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDocumentationPartCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDocumentationPartCmdlet.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.AG.UpdateAGDocumentationVersionCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDocumentationVersionCmdlet.DocumentationVersion"> <summary> <para> <para>[Required] The version identifier of the to-be-updated documentation version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDocumentationVersionCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDocumentationVersionCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDocumentationVersionCmdlet.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.AG.UpdateAGDomainNameCmdlet"> <summary> Changes information about the <a>DomainName</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDomainNameCmdlet.DomainName"> <summary> <para> <para>[Required] The name of the <a>DomainName</a> resource to be changed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDomainNameCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGDomainNameCmdlet.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.AG.UpdateAGGatewayResponseCmdlet"> <summary> Updates a <a>GatewayResponse</a> of a specified response type on the given <a>RestApi</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGGatewayResponseCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGGatewayResponseCmdlet.ResponseType"> <summary> <para> <para>[Required] <para>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul></para></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGGatewayResponseCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGGatewayResponseCmdlet.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.AG.UpdateAGIntegrationCmdlet"> <summary> Represents an update integration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGIntegrationCmdlet.HttpMethod"> <summary> <para> <para>[Required] Represents an update integration request's HTTP method.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGIntegrationCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGIntegrationCmdlet.ResourceId"> <summary> <para> <para>[Required] Represents an update integration request's resource identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGIntegrationCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGIntegrationCmdlet.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.AG.UpdateAGIntegrationResponseCmdlet"> <summary> Represents an update integration response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGIntegrationResponseCmdlet.HttpMethod"> <summary> <para> <para>[Required] Specifies an update integration response request's HTTP method.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGIntegrationResponseCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGIntegrationResponseCmdlet.ResourceId"> <summary> <para> <para>[Required] Specifies an update integration response request's resource identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGIntegrationResponseCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGIntegrationResponseCmdlet.StatusCode"> <summary> <para> <para>[Required] Specifies an update integration response request's status code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGIntegrationResponseCmdlet.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.AG.UpdateAGMethodCmdlet"> <summary> Updates an existing <a>Method</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGMethodCmdlet.HttpMethod"> <summary> <para> <para>[Required] The HTTP verb of the <a>Method</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGMethodCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGMethodCmdlet.ResourceId"> <summary> <para> <para>[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGMethodCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGMethodCmdlet.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.AG.UpdateAGMethodResponseCmdlet"> <summary> Updates an existing <a>MethodResponse</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGMethodResponseCmdlet.HttpMethod"> <summary> <para> <para>[Required] The HTTP verb of the <a>Method</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGMethodResponseCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGMethodResponseCmdlet.ResourceId"> <summary> <para> <para>[Required] The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGMethodResponseCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGMethodResponseCmdlet.StatusCode"> <summary> <para> <para>[Required] The status code for the <a>MethodResponse</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGMethodResponseCmdlet.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.AG.UpdateAGModelCmdlet"> <summary> Changes information about a model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGModelCmdlet.ModelName"> <summary> <para> <para>[Required] The name of the model to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGModelCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGModelCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGModelCmdlet.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.AG.UpdateAGRequestValidatorCmdlet"> <summary> Updates a <a>RequestValidator</a> of a given <a>RestApi</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGRequestValidatorCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGRequestValidatorCmdlet.RequestValidatorId"> <summary> <para> <para>[Required] The identifier of <a>RequestValidator</a> to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGRequestValidatorCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGRequestValidatorCmdlet.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.AG.UpdateAGResourceCmdlet"> <summary> Changes information about a <a>Resource</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGResourceCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGResourceCmdlet.ResourceId"> <summary> <para> <para>[Required] The identifier of the <a>Resource</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGResourceCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGResourceCmdlet.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.AG.UpdateAGRestApiCmdlet"> <summary> Changes information about the specified API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGRestApiCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGRestApiCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGRestApiCmdlet.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.AG.UpdateAGStageCmdlet"> <summary> Changes information about a <a>Stage</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGStageCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGStageCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGStageCmdlet.StageName"> <summary> <para> <para>[Required] The name of the <a>Stage</a> resource to change information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGStageCmdlet.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.AG.UpdateAGUsageCmdlet"> <summary> Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGUsageCmdlet.KeyId"> <summary> <para> <para>[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGUsageCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGUsageCmdlet.UsagePlanId"> <summary> <para> <para>[Required] The Id of the usage plan associated with the usage data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGUsageCmdlet.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.AG.UpdateAGUsagePlanCmdlet"> <summary> Updates a usage plan of a given plan Id. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGUsagePlanCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGUsagePlanCmdlet.UsagePlanId"> <summary> <para> <para>[Required] The Id of the to-be-updated usage plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGUsagePlanCmdlet.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.AG.UpdateAGVpcLinkCmdlet"> <summary> Updates an existing <a>VpcLink</a> of a specified identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGVpcLinkCmdlet.PatchOperation"> <summary> <para> <para>A list of update operations to be applied to the specified resource and in the order specified in this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGVpcLinkCmdlet.VpcLinkId"> <summary> <para> <para>[Required] The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.UpdateAGVpcLinkCmdlet.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.AG.WriteAGGatewayResponseCmdlet"> <summary> Creates a customization of a <a>GatewayResponse</a> of a specified response type and status code on the given <a>RestApi</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGGatewayResponseCmdlet.ResponseParameter"> <summary> <para> <para><para>Response parameters (paths, query strings and headers) of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs.</para></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGGatewayResponseCmdlet.ResponseTemplate"> <summary> <para> <para><para>Response templates of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs.</para></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGGatewayResponseCmdlet.ResponseType"> <summary> <para> <para>[Required] <para>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul></para></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGGatewayResponseCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGGatewayResponseCmdlet.StatusCode"> <summary> <para> The HTTP status code of the <a>GatewayResponse</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGGatewayResponseCmdlet.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.AG.WriteAGIntegrationCmdlet"> <summary> Sets up a method's integration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.CacheKeyParameter"> <summary> <para> <para>An API-specific tag group of related cached parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.CacheNamespace"> <summary> <para> <para>A list of request parameters whose values are to be cached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.ConnectionId"> <summary> <para> <para>The (<a href="https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id"><code>id</code></a>) of the <a>VpcLink</a> used for the integration when <code>connectionType=VPC_LINK</code> and undefined, otherwise.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.ConnectionType"> <summary> <para> <para>The type of the network connection to the integration endpoint. The valid value is <code>INTERNET</code> for connections through the public routable internet or <code>VPC_LINK</code> for private connections between API Gateway and a network load balancer in a VPC. The default value is <code>INTERNET</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.ContentHandling"> <summary> <para> <para>Specifies how to handle request payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</para><ul><li><para><code>CONVERT_TO_BINARY</code>: Converts a request payload from a Base64-encoded string to the corresponding binary blob.</para></li><li><para><code>CONVERT_TO_TEXT</code>: Converts a request payload from a binary blob to a Base64-encoded string.</para></li></ul><para>If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the <code>passthroughBehavior</code> is configured to support payload pass-through.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.TargetCredential"> <summary> <para> <para>Specifies whether credentials are required for a put integration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.HttpMethod"> <summary> <para> <para>[Required] Specifies a put integration request's HTTP method.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.IntegrationHttpMethod"> <summary> <para> <para>Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.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 <code>requestTemplates</code> property on the Integration resource. There are three valid values: <code>WHEN_NO_MATCH</code>, <code>WHEN_NO_TEMPLATES</code>, and <code>NEVER</code>. </para><ul><li><para><code>WHEN_NO_MATCH</code> passes the request body for unmapped content types through to the integration back end without transformation.</para></li><li><para><code>NEVER</code> rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.</para></li><li><para><code>WHEN_NO_TEMPLATES</code> allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.RequestParameter"> <summary> <para> <para>A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> must be a valid and unique method request parameter name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.RequestTemplate"> <summary> <para> <para>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.ResourceId"> <summary> <para> <para>[Required] Specifies a put integration request's resource ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.TimeoutInMilli"> <summary> <para> <para>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.Type"> <summary> <para> <para>[Required] Specifies a put integration input's type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.Uri"> <summary> <para> <para>Specifies Uniform Resource Identifier (URI) of the integration endpoint.</para><ul><li><para> For <code>HTTP</code> or <code>HTTP_PROXY</code> integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the <a target="_blank" href="https://en.wikipedia.org/wiki/Uniform_Resource_Identifier">RFC-3986 specification</a>, for either standard integration, where <code>connectionType</code> is not <code>VPC_LINK</code>, or private integration, where <code>connectionType</code> is <code>VPC_LINK</code>. For a private HTTP integration, the URI is not used for routing. </para></li><li><para> For <code>AWS</code> or <code>AWS_PROXY</code> integrations, the URI is of the form <code>arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}</code>. Here, <code>{Region}</code> is the API Gateway region (e.g., <code>us-east-1</code>); <code>{service}</code> is the name of the integrated AWS service (e.g., <code>s3</code>); and <code>{subdomain}</code> is a designated subdomain supported by certain AWS service for fast host-name lookup. <code>action</code> can be used for an AWS service action-based API, using an <code>Action={name}&{p1}={v1}&p2={v2}...</code> query string. The ensuing <code>{service_api}</code> refers to a supported action <code>{name}</code> plus any required input parameters. Alternatively, <code>path</code> can be used for an AWS service path-based API. The ensuing <code>service_api</code> refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of <code><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html">GetObject</a></code>, the <code>uri</code> can be either <code>arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}</code> or <code>arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationCmdlet.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.AG.WriteAGIntegrationResponseCmdlet"> <summary> Represents a put integration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationResponseCmdlet.ContentHandling"> <summary> <para> <para>Specifies how to handle response payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</para><ul><li><para><code>CONVERT_TO_BINARY</code>: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</para></li><li><para><code>CONVERT_TO_TEXT</code>: Converts a response payload from a binary blob to a Base64-encoded string.</para></li></ul><para>If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationResponseCmdlet.HttpMethod"> <summary> <para> <para>[Required] Specifies a put integration response request's HTTP method.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationResponseCmdlet.ResourceId"> <summary> <para> <para>[Required] Specifies a put integration response request's resource identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationResponseCmdlet.ResponseParameter"> <summary> <para> <para>A key-value map specifying response parameters that are passed to the method response from the back end. 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 <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The mapped non-static value must match the pattern of <code>integration.response.header.{name}</code> or <code>integration.response.body.{JSON-expression}</code>, where <code>name</code> must be a valid and unique response header name and <code>JSON-expression</code> a valid JSON expression without the <code>$</code> prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationResponseCmdlet.ResponseTemplate"> <summary> <para> <para>Specifies a put integration response's templates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationResponseCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationResponseCmdlet.SelectionPattern"> <summary> <para> <para>Specifies the selection pattern of a put integration response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationResponseCmdlet.StatusCode"> <summary> <para> <para>[Required] Specifies the status code that is used to map the integration response to an existing <a>MethodResponse</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGIntegrationResponseCmdlet.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.AG.WriteAGMethodCmdlet"> <summary> Add a method to an existing <a>Resource</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodCmdlet.ApiKeyRequired"> <summary> <para> <para>Specifies whether the method required a valid <a>ApiKey</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodCmdlet.AuthorizationScope"> <summary> <para> <para>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodCmdlet.AuthorizationType"> <summary> <para> <para>[Required] The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodCmdlet.AuthorizerId"> <summary> <para> <para>Specifies the identifier of an <a>Authorizer</a> to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodCmdlet.HttpMethod"> <summary> <para> <para>[Required] Specifies the method request's HTTP method type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodCmdlet.OperationName"> <summary> <para> <para>A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodCmdlet.RequestModel"> <summary> <para> <para>Specifies the <a>Model</a> resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a <a>Model</a> name as the value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodCmdlet.RequestParameter"> <summary> <para> <para>A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in <a>Integration</a> to be mapped to integration request parameters or body-mapping templates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodCmdlet.RequestValidatorId"> <summary> <para> <para>The identifier of a <a>RequestValidator</a> for validating the method request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodCmdlet.ResourceId"> <summary> <para> <para>[Required] The <a>Resource</a> identifier for the new <a>Method</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodCmdlet.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.AG.WriteAGMethodResponseCmdlet"> <summary> Adds a <a>MethodResponse</a> to an existing <a>Method</a> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodResponseCmdlet.HttpMethod"> <summary> <para> <para>[Required] The HTTP verb of the <a>Method</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodResponseCmdlet.ResourceId"> <summary> <para> <para>[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodResponseCmdlet.ResponseModel"> <summary> <para> <para>Specifies the <a>Model</a> resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a <a>Model</a> name as the value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodResponseCmdlet.ResponseParameter"> <summary> <para> <para>A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in <code>integration.response.header.{name}</code>, a static value enclosed within a pair of single quotes (e.g., <code>'application/json'</code>), or a JSON expression from the back-end response payload in the form of <code>integration.response.body.{JSON-expression}</code>, where <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodResponseCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodResponseCmdlet.StatusCode"> <summary> <para> <para>[Required] The method response's status code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGMethodResponseCmdlet.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.AG.WriteAGRestApiCmdlet"> <summary> A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGRestApiCmdlet.Body"> <summary> <para> <para>[Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGRestApiCmdlet.FailOnWarning"> <summary> <para> <para>A query parameter to indicate whether to rollback the API update (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGRestApiCmdlet.Mode"> <summary> <para> <para>The <code>mode</code> query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGRestApiCmdlet.Parameter"> <summary> <para> <para>Custom header parameters as part of the request. For example, to exclude <a>DocumentationParts</a> from an imported API, set <code>ignore=documentation</code> as a <code>parameters</code> value, as in the AWS CLI command of <code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGRestApiCmdlet.RestApiId"> <summary> <para> <para>[Required] The string identifier of the associated <a>RestApi</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AG.WriteAGRestApiCmdlet.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> |