AWS.Tools.AppSync.XML
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.AppSync</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.AddASYNResourceTagCmdlet"> <summary> Tags a resource with user-supplied tags. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.AddASYNResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The <c>GraphqlApi</c> Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.AddASYNResourceTagCmdlet.Tag"> <summary> <para> <para>A <c>TagMap</c> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.AddASYNResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.AddASYNResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.AddASYNResourceTagCmdlet.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.ASYN.ClearASYNApiCacheCmdlet"> <summary> Flushes an <c>ApiCache</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.ClearASYNApiCacheCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.ClearASYNApiCacheCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.FlushApiCacheResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.ClearASYNApiCacheCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.ClearASYNApiCacheCmdlet.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.ASYN.GetASYNApiAssociationCmdlet"> <summary> Retrieves an <c>ApiAssociation</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiAssociationCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApiAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetApiAssociationResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetApiAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiCacheCmdlet"> <summary> Retrieves an <c>ApiCache</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiCacheCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiCacheCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApiCache'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetApiCacheResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetApiCacheResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiCacheCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiKeyListCmdlet"> <summary> Lists the API keys for a given API. <note><para> API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call <c>DeleteApiKey</c> to manually delete a key before it's automatically deleted. </para></note><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiKeyListCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiKeyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that you want the request to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>25</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiKeyListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiKeyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApiKeys'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.ListApiKeysResponse). Specifying the name of a property of type Amazon.AppSync.Model.ListApiKeysResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiKeyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNApiKeyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceCmdlet"> <summary> Retrieves a <c>DataSource</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceCmdlet.Name"> <summary> <para> <para>The name of the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetDataSourceResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceIntrospectionCmdlet"> <summary> Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceIntrospectionCmdlet.IncludeModelsSDL"> <summary> <para> <para>A boolean flag that determines whether SDL should be generated for introspected types or not. If set to <c>true</c>, each model will contain an <c>sdl</c> property that contains the SDL for that type. The SDL only contains the type data and no additional metadata or directives. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceIntrospectionCmdlet.IntrospectionId"> <summary> <para> <para>The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceIntrospectionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of introspected types that will be returned in a single response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceIntrospectionCmdlet.NextToken"> <summary> <para> <para>Determines the number of types to be returned in a single response before paginating. This value is typically taken from <c>nextToken</c> value from the previous response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceIntrospectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetDataSourceIntrospectionResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetDataSourceIntrospectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceIntrospectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IntrospectionId parameter. The -PassThru parameter is deprecated, use -Select '^IntrospectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceListCmdlet"> <summary> Lists the data sources for a given API.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceListCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that you want the request to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>25</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.ListDataSourcesResponse). Specifying the name of a property of type Amazon.AppSync.Model.ListDataSourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDataSourceListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDomainNameCmdlet"> <summary> Retrieves a custom <c>DomainName</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDomainNameCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDomainNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainNameConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetDomainNameResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetDomainNameResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDomainNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDomainNameListCmdlet"> <summary> Lists multiple custom domain names.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDomainNameListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that you want the request to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDomainNameListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDomainNameListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainNameConfigs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.ListDomainNamesResponse). Specifying the name of a property of type Amazon.AppSync.Model.ListDomainNamesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNDomainNameListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNFunctionCmdlet"> <summary> Get a <c>Function</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNFunctionCmdlet.ApiId"> <summary> <para> <para>The GraphQL API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNFunctionCmdlet.FunctionId"> <summary> <para> <para>The <c>Function</c> ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FunctionConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetFunctionResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetFunctionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNFunctionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FunctionId parameter. The -PassThru parameter is deprecated, use -Select '^FunctionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNFunctionListCmdlet"> <summary> List multiple functions.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNFunctionListCmdlet.ApiId"> <summary> <para> <para>The GraphQL API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNFunctionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that you want the request to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>25</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNFunctionListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNFunctionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Functions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.ListFunctionsResponse). Specifying the name of a property of type Amazon.AppSync.Model.ListFunctionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNFunctionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNFunctionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiCmdlet"> <summary> Retrieves a <c>GraphqlApi</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiCmdlet.ApiId"> <summary> <para> <para>The API ID for the GraphQL API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GraphqlApi'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetGraphqlApiResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetGraphqlApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiEnvironmentVariableCmdlet"> <summary> Retrieves the list of environmental variable key-value pairs associated with an API by its ID value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiEnvironmentVariableCmdlet.ApiId"> <summary> <para> <para>The ID of the API from which the environmental variable list will be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiEnvironmentVariableCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentVariables'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetGraphqlApiEnvironmentVariablesResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetGraphqlApiEnvironmentVariablesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiEnvironmentVariableCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiListCmdlet"> <summary> Lists your GraphQL APIs.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiListCmdlet.ApiType"> <summary> <para> <para>The value that indicates whether the GraphQL API is a standard API (<c>GRAPHQL</c>) or merged API (<c>MERGED</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that you want the request to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>25</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiListCmdlet.Owner"> <summary> <para> <para>The account owner of the GraphQL API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GraphqlApis'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.ListGraphqlApisResponse). Specifying the name of a property of type Amazon.AppSync.Model.ListGraphqlApisResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiType parameter. The -PassThru parameter is deprecated, use -Select '^ApiType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNGraphqlApiListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNIntrospectionSchemaCmdlet"> <summary> Retrieves the introspection schema for a GraphQL API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNIntrospectionSchemaCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNIntrospectionSchemaCmdlet.Format"> <summary> <para> <para>The schema format: SDL or JSON.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNIntrospectionSchemaCmdlet.IncludeDirective"> <summary> <para> <para>A flag that specifies whether the schema introspection should contain directives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNIntrospectionSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Schema'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetIntrospectionSchemaResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetIntrospectionSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNIntrospectionSchemaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverCmdlet"> <summary> Retrieves a <c>Resolver</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverCmdlet.FieldName"> <summary> <para> <para>The resolver field name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverCmdlet.TypeName"> <summary> <para> <para>The resolver type name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Resolver'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetResolverResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetResolverResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FieldName parameter. The -PassThru parameter is deprecated, use -Select '^FieldName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListCmdlet"> <summary> Lists the resolvers for a given API and type.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListCmdlet.TypeName"> <summary> <para> <para>The type name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that you want the request to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>25</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Resolvers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.ListResolversResponse). Specifying the name of a property of type Amazon.AppSync.Model.ListResolversResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TypeName parameter. The -PassThru parameter is deprecated, use -Select '^TypeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListByFunctionCmdlet"> <summary> List the resolvers that are associated with a specific function.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListByFunctionCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListByFunctionCmdlet.FunctionId"> <summary> <para> <para>The function ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListByFunctionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that you want the request to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>25</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListByFunctionCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListByFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Resolvers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.ListResolversByFunctionResponse). Specifying the name of a property of type Amazon.AppSync.Model.ListResolversByFunctionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListByFunctionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FunctionId parameter. The -PassThru parameter is deprecated, use -Select '^FunctionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResolverListByFunctionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResourceTagCmdlet"> <summary> Lists the tags for a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The <c>GraphqlApi</c> Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.AppSync.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSchemaCreationStatusCmdlet"> <summary> Retrieves the current status of a schema creation operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSchemaCreationStatusCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSchemaCreationStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetSchemaCreationStatusResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetSchemaCreationStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSchemaCreationStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSourceApiAssociationCmdlet"> <summary> Retrieves a <c>SourceApiAssociation</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSourceApiAssociationCmdlet.AssociationId"> <summary> <para> <para>The ID generated by the AppSync service for the source API association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSourceApiAssociationCmdlet.MergedApiIdentifier"> <summary> <para> <para>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSourceApiAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SourceApiAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetSourceApiAssociationResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetSourceApiAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSourceApiAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSourceApiAssociationListCmdlet"> <summary> Lists the <c>SourceApiAssociationSummary</c> data.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSourceApiAssociationListCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSourceApiAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that you want the request to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSourceApiAssociationListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSourceApiAssociationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SourceApiAssociationSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.ListSourceApiAssociationsResponse). Specifying the name of a property of type Amazon.AppSync.Model.ListSourceApiAssociationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSourceApiAssociationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNSourceApiAssociationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeCmdlet"> <summary> Retrieves a <c>Type</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeCmdlet.Format"> <summary> <para> <para>The type format: SDL or JSON.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeCmdlet.TypeName"> <summary> <para> <para>The type name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Type'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.GetTypeResponse). Specifying the name of a property of type Amazon.AppSync.Model.GetTypeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TypeName parameter. The -PassThru parameter is deprecated, use -Select '^TypeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeListCmdlet"> <summary> Lists the types for a given API.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeListCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeListCmdlet.Format"> <summary> <para> <para>The type format: SDL or JSON.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that you want the request to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>25</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Types'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.ListTypesResponse). Specifying the name of a property of type Amazon.AppSync.Model.ListTypesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypeListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypesByAssociationListCmdlet"> <summary> Lists <c>Type</c> objects by the source API association ID.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypesByAssociationListCmdlet.AssociationId"> <summary> <para> <para>The ID generated by the AppSync service for the source API association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypesByAssociationListCmdlet.Format"> <summary> <para> <para>The format type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypesByAssociationListCmdlet.MergedApiIdentifier"> <summary> <para> <para>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypesByAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that you want the request to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypesByAssociationListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypesByAssociationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Types'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.ListTypesByAssociationResponse). Specifying the name of a property of type Amazon.AppSync.Model.ListTypesByAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypesByAssociationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.GetASYNTypesByAssociationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiCacheCmdlet"> <summary> Creates a cache for the GraphQL API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiCacheCmdlet.ApiCachingBehavior"> <summary> <para> <para>Caching behavior.</para><ul><li><para><b>FULL_REQUEST_CACHING</b>: All requests are fully cached.</para></li><li><para><b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are cached.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiCacheCmdlet.ApiId"> <summary> <para> <para>The GraphQL API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiCacheCmdlet.AtRestEncryptionEnabled"> <summary> <para> <para>At-rest encryption flag for cache. You cannot update this setting after creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiCacheCmdlet.HealthMetricsConfig"> <summary> <para> <para>Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:</para><ul><li><para>NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.</para></li><li><para>EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.</para></li></ul><para>Metrics will be recorded by API ID. You can set the value to <c>ENABLED</c> or <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiCacheCmdlet.TransitEncryptionEnabled"> <summary> <para> <para>Transit encryption flag when connecting to cache. You cannot update this setting after creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiCacheCmdlet.Ttl"> <summary> <para> <para>TTL in seconds for cache entries.</para><para>Valid values are 1–3,600 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiCacheCmdlet.Type"> <summary> <para> <para>The cache instance type. Valid values are </para><ul><li><para><c>SMALL</c></para></li><li><para><c>MEDIUM</c></para></li><li><para><c>LARGE</c></para></li><li><para><c>XLARGE</c></para></li><li><para><c>LARGE_2X</c></para></li><li><para><c>LARGE_4X</c></para></li><li><para><c>LARGE_8X</c> (not available in all regions)</para></li><li><para><c>LARGE_12X</c></para></li></ul><para>Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.</para><para>The following legacy instance types are available, but their use is discouraged:</para><ul><li><para><b>T2_SMALL</b>: A t2.small instance type.</para></li><li><para><b>T2_MEDIUM</b>: A t2.medium instance type.</para></li><li><para><b>R4_LARGE</b>: A r4.large instance type.</para></li><li><para><b>R4_XLARGE</b>: A r4.xlarge instance type.</para></li><li><para><b>R4_2XLARGE</b>: A r4.2xlarge instance type.</para></li><li><para><b>R4_4XLARGE</b>: A r4.4xlarge instance type.</para></li><li><para><b>R4_8XLARGE</b>: A r4.8xlarge instance type.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiCacheCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApiCache'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.CreateApiCacheResponse). Specifying the name of a property of type Amazon.AppSync.Model.CreateApiCacheResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiCacheCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiCacheCmdlet.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.ASYN.NewASYNApiKeyCmdlet"> <summary> Creates a unique key that you can distribute to clients who invoke your API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiKeyCmdlet.ApiId"> <summary> <para> <para>The ID for your GraphQL API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiKeyCmdlet.Description"> <summary> <para> <para>A description of the purpose of the API key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiKeyCmdlet.Expire"> <summary> <para> <para>From the creation time, the time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApiKey'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.CreateApiKeyResponse). Specifying the name of a property of type Amazon.AppSync.Model.CreateApiKeyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNApiKeyCmdlet.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.ASYN.NewASYNDataSourceCmdlet"> <summary> Creates a <c>DataSource</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.ApiId"> <summary> <para> <para>The API ID for the GraphQL API for the <c>DataSource</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.HttpConfig_AuthorizationConfig"> <summary> <para> <para>The authorization configuration in case the HTTP endpoint requires authorization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.OpenSearchServiceConfig_AwsRegion"> <summary> <para> <para>The Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.Description"> <summary> <para> <para>A description of the <c>DataSource</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.DynamodbConfig"> <summary> <para> <para>Amazon DynamoDB settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.ElasticsearchConfig"> <summary> <para> <para>Amazon OpenSearch Service settings.</para><para>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use <a>CreateDataSourceRequest$openSearchServiceConfig</a> to create an OpenSearch data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.HttpConfig_Endpoint"> <summary> <para> <para>The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.OpenSearchServiceConfig_Endpoint"> <summary> <para> <para>The endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.EventBridgeConfig_EventBusArn"> <summary> <para> <para>The ARN of the event bus. For more information about event buses, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html">Amazon EventBridge event buses</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.LambdaConfig"> <summary> <para> <para>Lambda settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.MetricsConfig"> <summary> <para> <para>Enables or disables enhanced data source metrics for specified data sources. Note that <c>metricsConfig</c> won't be used unless the <c>dataSourceLevelMetricsBehavior</c> value is set to <c>PER_DATA_SOURCE_METRICS</c>. If the <c>dataSourceLevelMetricsBehavior</c> is set to <c>FULL_REQUEST_DATA_SOURCE_METRICS</c> instead, <c>metricsConfig</c> will be ignored. However, you can still set its value.</para><para><c>metricsConfig</c> can be <c>ENABLED</c> or <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.Name"> <summary> <para> <para>A user-supplied name for the <c>DataSource</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.RelationalDatabaseConfig_RdsHttpEndpointConfig"> <summary> <para> <para>Amazon RDS HTTP endpoint settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.RelationalDatabaseConfig_RelationalDatabaseSourceType"> <summary> <para> <para>Source type for the relational database.</para><ul><li><para><b>RDS_HTTP_ENDPOINT</b>: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.ServiceRoleArn"> <summary> <para> <para>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.Type"> <summary> <para> <para>The type of the <c>DataSource</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.CreateDataSourceResponse). Specifying the name of a property of type Amazon.AppSync.Model.CreateDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDataSourceCmdlet.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.ASYN.NewASYNDomainNameCmdlet"> <summary> Creates a custom <c>DomainName</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDomainNameCmdlet.CertificateArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDomainNameCmdlet.Description"> <summary> <para> <para>A description of the <c>DomainName</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDomainNameCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDomainNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainNameConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.CreateDomainNameResponse). Specifying the name of a property of type Amazon.AppSync.Model.CreateDomainNameResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDomainNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNDomainNameCmdlet.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.ASYN.NewASYNFunctionCmdlet"> <summary> Creates a <c>Function</c> object. <para> A function is a reusable entity. You can use multiple functions to compose the resolver logic. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.ApiId"> <summary> <para> <para>The GraphQL API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.Code"> <summary> <para> <para>The <c>function</c> code that contains the request and response functions. When code is used, the <c>runtime</c> is required. The <c>runtime</c> value must be <c>APPSYNC_JS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.SyncConfig_ConflictDetection"> <summary> <para> <para>The Conflict Detection strategy to use.</para><ul><li><para><b>VERSION</b>: Detect conflicts based on object versions for this resolver.</para></li><li><para><b>NONE</b>: Do not detect conflicts when invoking this resolver.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.SyncConfig_ConflictHandler"> <summary> <para> <para>The Conflict Resolution strategy to perform in the event of a conflict.</para><ul><li><para><b>OPTIMISTIC_CONCURRENCY</b>: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.</para></li><li><para><b>AUTOMERGE</b>: Resolve conflicts with the Automerge conflict resolution strategy.</para></li><li><para><b>LAMBDA</b>: Resolve conflicts with an Lambda function supplied in the <c>LambdaConflictHandlerConfig</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.DataSourceName"> <summary> <para> <para>The <c>Function</c><c>DataSource</c> name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.Description"> <summary> <para> <para>The <c>Function</c> description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.FunctionVersion"> <summary> <para> <para>The <c>version</c> of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the <c>functionVersion</c> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.LambdaConflictHandlerConfig_LambdaConflictHandlerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.MaxBatchSize"> <summary> <para> <para>The maximum batching size for a resolver.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.Name"> <summary> <para> <para>The <c>Function</c> name. The function name does not have to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.Runtime_Name"> <summary> <para> <para>The <c>name</c> of the runtime to use. Currently, the only allowed value is <c>APPSYNC_JS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.RequestMappingTemplate"> <summary> <para> <para>The <c>Function</c> request mapping template. Functions support only the 2018-05-29 version of the request mapping template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.ResponseMappingTemplate"> <summary> <para> <para>The <c>Function</c> response mapping template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.Runtime_RuntimeVersion"> <summary> <para> <para>The <c>version</c> of the runtime to use. Currently, the only allowed version is <c>1.0.0</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FunctionConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.CreateFunctionResponse). Specifying the name of a property of type Amazon.AppSync.Model.CreateFunctionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNFunctionCmdlet.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.ASYN.NewASYNGraphqlApiCmdlet"> <summary> Creates a <c>GraphqlApi</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.AdditionalAuthenticationProvider"> <summary> <para> <para>A list of additional authentication providers for the <c>GraphqlApi</c> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.ApiType"> <summary> <para> <para>The value that indicates whether the GraphQL API is a standard API (<c>GRAPHQL</c>) or merged API (<c>MERGED</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.AuthenticationType"> <summary> <para> <para>The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.LambdaAuthorizerConfig_AuthorizerResultTtlInSecond"> <summary> <para> <para>The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for <c>authorizerResultTtlInSeconds</c>, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a <c>ttlOverride</c> key in its response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.LambdaAuthorizerConfig_AuthorizerUri"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (<c>.../v3</c>), or an alias ARN. </para><para><b>Note</b>: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:</para><para><c>aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.OpenIDConnectConfig_AuthTTL"> <summary> <para> <para>The number of milliseconds that a token is valid after being authenticated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.OpenIDConnectConfig_ClientId"> <summary> <para> <para>The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.LogConfig_CloudWatchLogsRoleArn"> <summary> <para> <para>The service role that AppSync assumes to publish to CloudWatch logs in your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.EnhancedMetricsConfig_DataSourceLevelMetricsBehavior"> <summary> <para> <para>Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:</para><ul><li><para>Requests: The number of invocations that occured during a request.</para></li><li><para>Latency: The time to complete a data source invocation.</para></li><li><para>Errors: The number of errors that occurred during a data source invocation.</para></li></ul><para>These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. <c>dataSourceLevelMetricsBehavior</c> accepts one of these values at a time:</para><ul><li><para><c>FULL_REQUEST_DATA_SOURCE_METRICS</c>: Records and emits metric data for all data sources in the request.</para></li><li><para><c>PER_DATA_SOURCE_METRICS</c>: Records and emits metric data for data sources that have the <c>metricsConfig</c> value set to <c>ENABLED</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.LogConfig_ExcludeVerboseContent"> <summary> <para> <para>Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.LogConfig_FieldLogLevel"> <summary> <para> <para>The field logging level. Values can be NONE, ERROR, or ALL.</para><ul><li><para><b>NONE</b>: No field-level logs are captured.</para></li><li><para><b>ERROR</b>: Logs the following information only for the fields that are in error:</para><ul><li><para>The error section in the server response.</para></li><li><para>Field-level errors.</para></li><li><para>The generated request/response functions that got resolved for error fields.</para></li></ul></li><li><para><b>ALL</b>: The following information is logged for all fields in the query:</para><ul><li><para>Field-level tracing information.</para></li><li><para>The generated request/response functions that got resolved for each field.</para></li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.OpenIDConnectConfig_IatTTL"> <summary> <para> <para>The number of milliseconds that a token is valid after it's issued to a user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.LambdaAuthorizerConfig_IdentityValidationExpression"> <summary> <para> <para>A regular expression for validation of tokens before the Lambda function is called.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.IntrospectionConfig"> <summary> <para> <para>Sets the value of the GraphQL API to enable (<c>ENABLED</c>) or disable (<c>DISABLED</c>) introspection. If no value is provided, the introspection configuration will be set to <c>ENABLED</c> by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.</para><para>For more information about introspection, see <a href="https://graphql.org/learn/introspection/">GraphQL introspection</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.OpenIDConnectConfig_Issuer"> <summary> <para> <para>The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of <c>iss</c> in the ID token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.MergedApiExecutionRoleArn"> <summary> <para> <para>The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the <c>AUTO_MERGE</c> to update the merged API endpoint with the source API changes automatically.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.Name"> <summary> <para> <para>A user-supplied name for the <c>GraphqlApi</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.EnhancedMetricsConfig_OperationLevelMetricsConfig"> <summary> <para> <para> Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:</para><ul><li><para>Requests: The number of times a specified GraphQL operation was called.</para></li><li><para>GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.</para></li></ul><para>Metrics will be recorded by API ID and operation name. You can set the value to <c>ENABLED</c> or <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.OwnerContact"> <summary> <para> <para>The owner contact information for an API resource.</para><para>This field accepts any string input with a length of 0 - 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.QueryDepthLimit"> <summary> <para> <para>The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is <c>0</c> (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between <c>1</c> and <c>75</c> nested levels. This field will produce a limit error if the operation falls out of bounds.</para><para>Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.ResolverCountLimit"> <summary> <para> <para>The maximum number of resolvers that can be invoked in a single request. The default value is <c>0</c> (or unspecified), which will set the limit to <c>10000</c>. When specified, the limit value can be between <c>1</c> and <c>10000</c>. This field will produce a limit error if the operation falls out of bounds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.EnhancedMetricsConfig_ResolverLevelMetricsBehavior"> <summary> <para> <para>Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:</para><ul><li><para>GraphQL errors: The number of GraphQL errors that occurred.</para></li><li><para>Requests: The number of invocations that occurred during a request. </para></li><li><para>Latency: The time to complete a resolver invocation.</para></li><li><para>Cache hits: The number of cache hits during a request.</para></li><li><para>Cache misses: The number of cache misses during a request.</para></li></ul><para>These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. <c>resolverLevelMetricsBehavior</c> accepts one of these values at a time:</para><ul><li><para><c>FULL_REQUEST_RESOLVER_METRICS</c>: Records and emits metric data for all resolvers in the request.</para></li><li><para><c>PER_RESOLVER_METRICS</c>: Records and emits metric data for resolvers that have the <c>metricsConfig</c> value set to <c>ENABLED</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.Tag"> <summary> <para> <para>A <c>TagMap</c> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.UserPoolConfig"> <summary> <para> <para>The Amazon Cognito user pool configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.Visibility"> <summary> <para> <para>Sets the value of the GraphQL API to public (<c>GLOBAL</c>) or private (<c>PRIVATE</c>). If no value is provided, the visibility will be set to <c>GLOBAL</c> by default. This value cannot be changed once the API has been created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.XrayEnabled"> <summary> <para> <para>A flag indicating whether to use X-Ray tracing for the <c>GraphqlApi</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GraphqlApi'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.CreateGraphqlApiResponse). Specifying the name of a property of type Amazon.AppSync.Model.CreateGraphqlApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNGraphqlApiCmdlet.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.ASYN.NewASYNResolverCmdlet"> <summary> Creates a <c>Resolver</c> object. <para> A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.ApiId"> <summary> <para> <para>The ID for the GraphQL API for which the resolver is being created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.CachingConfig_CachingKey"> <summary> <para> <para>The caching keys for a resolver that has caching activated.</para><para>Valid values are entries from the <c>$context.arguments</c>, <c>$context.source</c>, and <c>$context.identity</c> maps.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.Code"> <summary> <para> <para>The <c>resolver</c> code that contains the request and response functions. When code is used, the <c>runtime</c> is required. The <c>runtime</c> value must be <c>APPSYNC_JS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.SyncConfig_ConflictDetection"> <summary> <para> <para>The Conflict Detection strategy to use.</para><ul><li><para><b>VERSION</b>: Detect conflicts based on object versions for this resolver.</para></li><li><para><b>NONE</b>: Do not detect conflicts when invoking this resolver.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.SyncConfig_ConflictHandler"> <summary> <para> <para>The Conflict Resolution strategy to perform in the event of a conflict.</para><ul><li><para><b>OPTIMISTIC_CONCURRENCY</b>: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.</para></li><li><para><b>AUTOMERGE</b>: Resolve conflicts with the Automerge conflict resolution strategy.</para></li><li><para><b>LAMBDA</b>: Resolve conflicts with an Lambda function supplied in the <c>LambdaConflictHandlerConfig</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.DataSourceName"> <summary> <para> <para>The name of the data source for which the resolver is being created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.FieldName"> <summary> <para> <para>The name of the field to attach the resolver to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.PipelineConfig_Function"> <summary> <para> <para>A list of <c>Function</c> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.Kind"> <summary> <para> <para>The resolver type.</para><ul><li><para><b>UNIT</b>: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.</para></li><li><para><b>PIPELINE</b>: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of <c>Function</c> objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.LambdaConflictHandlerConfig_LambdaConflictHandlerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.MaxBatchSize"> <summary> <para> <para>The maximum batching size for a resolver.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.MetricsConfig"> <summary> <para> <para>Enables or disables enhanced resolver metrics for specified resolvers. Note that <c>metricsConfig</c> won't be used unless the <c>resolverLevelMetricsBehavior</c> value is set to <c>PER_RESOLVER_METRICS</c>. If the <c>resolverLevelMetricsBehavior</c> is set to <c>FULL_REQUEST_RESOLVER_METRICS</c> instead, <c>metricsConfig</c> will be ignored. However, you can still set its value.</para><para><c>metricsConfig</c> can be <c>ENABLED</c> or <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.Runtime_Name"> <summary> <para> <para>The <c>name</c> of the runtime to use. Currently, the only allowed value is <c>APPSYNC_JS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.RequestMappingTemplate"> <summary> <para> <para>The mapping template to use for requests.</para><para>A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).</para><para>VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.ResponseMappingTemplate"> <summary> <para> <para>The mapping template to use for responses from the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.Runtime_RuntimeVersion"> <summary> <para> <para>The <c>version</c> of the runtime to use. Currently, the only allowed version is <c>1.0.0</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.CachingConfig_Ttl"> <summary> <para> <para>The TTL in seconds for a resolver that has caching activated.</para><para>Valid values are 1–3,600 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.TypeName"> <summary> <para> <para>The name of the <c>Type</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Resolver'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.CreateResolverResponse). Specifying the name of a property of type Amazon.AppSync.Model.CreateResolverResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceName parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNResolverCmdlet.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.ASYN.NewASYNTypeCmdlet"> <summary> Creates a <c>Type</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNTypeCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNTypeCmdlet.Definition"> <summary> <para> <para>The type definition, in GraphQL Schema Definition Language (SDL) format.</para><para>For more information, see the <a href="http://graphql.org/learn/schema/">GraphQL SDL documentation</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNTypeCmdlet.Format"> <summary> <para> <para>The type format: SDL or JSON.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNTypeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Type'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.CreateTypeResponse). Specifying the name of a property of type Amazon.AppSync.Model.CreateTypeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNTypeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Definition parameter. The -PassThru parameter is deprecated, use -Select '^Definition' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.NewASYNTypeCmdlet.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.ASYN.RemoveASYNApiCacheCmdlet"> <summary> Deletes an <c>ApiCache</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNApiCacheCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNApiCacheCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.DeleteApiCacheResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNApiCacheCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNApiCacheCmdlet.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.ASYN.RemoveASYNApiKeyCmdlet"> <summary> Deletes an API key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNApiKeyCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNApiKeyCmdlet.Id"> <summary> <para> <para>The ID for the API key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNApiKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.DeleteApiKeyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNApiKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNApiKeyCmdlet.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.ASYN.RemoveASYNDataSourceCmdlet"> <summary> Deletes a <c>DataSource</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNDataSourceCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNDataSourceCmdlet.Name"> <summary> <para> <para>The name of the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.DeleteDataSourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNDataSourceCmdlet.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.ASYN.RemoveASYNDomainNameCmdlet"> <summary> Deletes a custom <c>DomainName</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNDomainNameCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNDomainNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.DeleteDomainNameResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNDomainNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNDomainNameCmdlet.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.ASYN.RemoveASYNFunctionCmdlet"> <summary> Deletes a <c>Function</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNFunctionCmdlet.ApiId"> <summary> <para> <para>The GraphQL API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNFunctionCmdlet.FunctionId"> <summary> <para> <para>The <c>Function</c> ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.DeleteFunctionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNFunctionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FunctionId parameter. The -PassThru parameter is deprecated, use -Select '^FunctionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNFunctionCmdlet.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.ASYN.RemoveASYNGraphqlApiCmdlet"> <summary> Deletes a <c>GraphqlApi</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNGraphqlApiCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNGraphqlApiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.DeleteGraphqlApiResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNGraphqlApiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNGraphqlApiCmdlet.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.ASYN.RemoveASYNResolverCmdlet"> <summary> Deletes a <c>Resolver</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNResolverCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNResolverCmdlet.FieldName"> <summary> <para> <para>The resolver field name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNResolverCmdlet.TypeName"> <summary> <para> <para>The name of the resolver type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNResolverCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.DeleteResolverResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNResolverCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FieldName parameter. The -PassThru parameter is deprecated, use -Select '^FieldName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNResolverCmdlet.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.ASYN.RemoveASYNResourceTagCmdlet"> <summary> Untags a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The <c>GraphqlApi</c> Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of <c>TagKey</c> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNResourceTagCmdlet.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.ASYN.RemoveASYNTypeCmdlet"> <summary> Deletes a <c>Type</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNTypeCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNTypeCmdlet.TypeName"> <summary> <para> <para>The type name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNTypeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.DeleteTypeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNTypeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TypeName parameter. The -PassThru parameter is deprecated, use -Select '^TypeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.RemoveASYNTypeCmdlet.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.ASYN.StartASYNApiAssociationCmdlet"> <summary> Maps an endpoint to your custom domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNApiAssociationCmdlet.ApiId"> <summary> <para> <para>The API ID. Private APIs can not be associated with custom domains.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNApiAssociationCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNApiAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApiAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.AssociateApiResponse). Specifying the name of a property of type Amazon.AppSync.Model.AssociateApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNApiAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNApiAssociationCmdlet.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.ASYN.StartASYNDataSourceIntrospectionCmdlet"> <summary> Creates a new introspection. Returns the <c>introspectionId</c> of the new introspection after its creation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNDataSourceIntrospectionCmdlet.RdsDataApiConfig_DatabaseName"> <summary> <para> <para>The name of the database in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNDataSourceIntrospectionCmdlet.RdsDataApiConfig_ResourceArn"> <summary> <para> <para>The resource ARN of the RDS cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNDataSourceIntrospectionCmdlet.RdsDataApiConfig_SecretArn"> <summary> <para> <para>The secret's ARN that was obtained from Secrets Manager. A secret consists of secret information, the secret value, plus metadata about the secret. A secret value can be a string or binary. It typically includes the ARN, secret name and description, policies, tags, encryption key from the Key Management Service, and key rotation data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNDataSourceIntrospectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.StartDataSourceIntrospectionResponse). Specifying the name of a property of type Amazon.AppSync.Model.StartDataSourceIntrospectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNDataSourceIntrospectionCmdlet.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.ASYN.StartASYNMergedGraphqlApiCmdlet"> <summary> Creates an association between a Merged API and source API using the source API's identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNMergedGraphqlApiCmdlet.Description"> <summary> <para> <para>The description field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNMergedGraphqlApiCmdlet.MergedApiIdentifier"> <summary> <para> <para>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNMergedGraphqlApiCmdlet.SourceApiAssociationConfig_MergeType"> <summary> <para> <para>The property that indicates which merging option is enabled in the source API association.</para><para>Valid merge types are <c>MANUAL_MERGE</c> (default) and <c>AUTO_MERGE</c>. Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use <c>MergedApiExecutionRoleArn</c> to perform merge operations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNMergedGraphqlApiCmdlet.SourceApiIdentifier"> <summary> <para> <para>The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNMergedGraphqlApiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SourceApiAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.AssociateMergedGraphqlApiResponse). Specifying the name of a property of type Amazon.AppSync.Model.AssociateMergedGraphqlApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNMergedGraphqlApiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SourceApiIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^SourceApiIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNMergedGraphqlApiCmdlet.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.ASYN.StartASYNSchemaCreationCmdlet"> <summary> Adds a new schema to your GraphQL API. <para> This operation is asynchronous. Use to determine when it has completed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSchemaCreationCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSchemaCreationCmdlet.Definition"> <summary> <para> <para>The schema definition, in GraphQL schema language format.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSchemaCreationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.StartSchemaCreationResponse). Specifying the name of a property of type Amazon.AppSync.Model.StartSchemaCreationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSchemaCreationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSchemaCreationCmdlet.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.ASYN.StartASYNSchemaMergeCmdlet"> <summary> Initiates a merge operation. Returns a status that shows the result of the merge operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSchemaMergeCmdlet.AssociationId"> <summary> <para> <para>The ID generated by the AppSync service for the source API association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSchemaMergeCmdlet.MergedApiIdentifier"> <summary> <para> <para>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSchemaMergeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SourceApiAssociationStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.StartSchemaMergeResponse). Specifying the name of a property of type Amazon.AppSync.Model.StartSchemaMergeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSchemaMergeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSchemaMergeCmdlet.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.ASYN.StartASYNSourceGraphqlApiCmdlet"> <summary> Creates an association between a Merged API and source API using the Merged API's identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSourceGraphqlApiCmdlet.Description"> <summary> <para> <para>The description field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSourceGraphqlApiCmdlet.MergedApiIdentifier"> <summary> <para> <para>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSourceGraphqlApiCmdlet.SourceApiAssociationConfig_MergeType"> <summary> <para> <para>The property that indicates which merging option is enabled in the source API association.</para><para>Valid merge types are <c>MANUAL_MERGE</c> (default) and <c>AUTO_MERGE</c>. Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use <c>MergedApiExecutionRoleArn</c> to perform merge operations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSourceGraphqlApiCmdlet.SourceApiIdentifier"> <summary> <para> <para>The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSourceGraphqlApiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SourceApiAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.AssociateSourceGraphqlApiResponse). Specifying the name of a property of type Amazon.AppSync.Model.AssociateSourceGraphqlApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSourceGraphqlApiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MergedApiIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^MergedApiIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StartASYNSourceGraphqlApiCmdlet.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.ASYN.StopASYNApiAssociationCmdlet"> <summary> Removes an <c>ApiAssociation</c> object from a custom domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNApiAssociationCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNApiAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.DisassociateApiResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNApiAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNApiAssociationCmdlet.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.ASYN.StopASYNMergedGraphqlApiCmdlet"> <summary> Deletes an association between a Merged API and source API using the source API's identifier and the association ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNMergedGraphqlApiCmdlet.AssociationId"> <summary> <para> <para>The ID generated by the AppSync service for the source API association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNMergedGraphqlApiCmdlet.SourceApiIdentifier"> <summary> <para> <para>The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNMergedGraphqlApiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SourceApiAssociationStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.DisassociateMergedGraphqlApiResponse). Specifying the name of a property of type Amazon.AppSync.Model.DisassociateMergedGraphqlApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNMergedGraphqlApiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SourceApiIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^SourceApiIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNMergedGraphqlApiCmdlet.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.ASYN.StopASYNSourceGraphqlApiCmdlet"> <summary> Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNSourceGraphqlApiCmdlet.AssociationId"> <summary> <para> <para>The ID generated by the AppSync service for the source API association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNSourceGraphqlApiCmdlet.MergedApiIdentifier"> <summary> <para> <para>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNSourceGraphqlApiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SourceApiAssociationStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.DisassociateSourceGraphqlApiResponse). Specifying the name of a property of type Amazon.AppSync.Model.DisassociateSourceGraphqlApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNSourceGraphqlApiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MergedApiIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^MergedApiIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.StopASYNSourceGraphqlApiCmdlet.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.ASYN.TestASYNCodeCmdlet"> <summary> Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For <c>APPSYNC_JS</c> runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.TestASYNCodeCmdlet.Code"> <summary> <para> <para>The code definition to be evaluated. Note that <c>code</c> and <c>runtime</c> are both required for this action. The <c>runtime</c> value must be <c>APPSYNC_JS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.TestASYNCodeCmdlet.Context"> <summary> <para> <para>The map that holds all of the contextual information for your resolver invocation. A <c>context</c> is required for this action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.TestASYNCodeCmdlet.Function"> <summary> <para> <para>The function within the code to be evaluated. If provided, the valid values are <c>request</c> and <c>response</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.TestASYNCodeCmdlet.Runtime_Name"> <summary> <para> <para>The <c>name</c> of the runtime to use. Currently, the only allowed value is <c>APPSYNC_JS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.TestASYNCodeCmdlet.Runtime_RuntimeVersion"> <summary> <para> <para>The <c>version</c> of the runtime to use. Currently, the only allowed version is <c>1.0.0</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.TestASYNCodeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.EvaluateCodeResponse). Specifying the name of a property of type Amazon.AppSync.Model.EvaluateCodeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.TestASYNMappingTemplateCmdlet"> <summary> Evaluates a given template and returns the response. The mapping template can be a request or response template. <para> Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type. </para><para> Mapping templates are written in the Apache Velocity Template Language (VTL). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.TestASYNMappingTemplateCmdlet.Context"> <summary> <para> <para>The map that holds all of the contextual information for your resolver invocation. A <c>context</c> is required for this action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.TestASYNMappingTemplateCmdlet.Template"> <summary> <para> <para>The mapping template; this can be a request or response template. A <c>template</c> is required for this action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.TestASYNMappingTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.EvaluateMappingTemplateResponse). Specifying the name of a property of type Amazon.AppSync.Model.EvaluateMappingTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiCacheCmdlet"> <summary> Updates the cache for the GraphQL API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiCacheCmdlet.ApiCachingBehavior"> <summary> <para> <para>Caching behavior.</para><ul><li><para><b>FULL_REQUEST_CACHING</b>: All requests are fully cached.</para></li><li><para><b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are cached.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiCacheCmdlet.ApiId"> <summary> <para> <para>The GraphQL API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiCacheCmdlet.HealthMetricsConfig"> <summary> <para> <para>Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:</para><ul><li><para>NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.</para></li><li><para>EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.</para></li></ul><para>Metrics will be recorded by API ID. You can set the value to <c>ENABLED</c> or <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiCacheCmdlet.Ttl"> <summary> <para> <para>TTL in seconds for cache entries.</para><para>Valid values are 1–3,600 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiCacheCmdlet.Type"> <summary> <para> <para>The cache instance type. Valid values are </para><ul><li><para><c>SMALL</c></para></li><li><para><c>MEDIUM</c></para></li><li><para><c>LARGE</c></para></li><li><para><c>XLARGE</c></para></li><li><para><c>LARGE_2X</c></para></li><li><para><c>LARGE_4X</c></para></li><li><para><c>LARGE_8X</c> (not available in all regions)</para></li><li><para><c>LARGE_12X</c></para></li></ul><para>Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.</para><para>The following legacy instance types are available, but their use is discouraged:</para><ul><li><para><b>T2_SMALL</b>: A t2.small instance type.</para></li><li><para><b>T2_MEDIUM</b>: A t2.medium instance type.</para></li><li><para><b>R4_LARGE</b>: A r4.large instance type.</para></li><li><para><b>R4_XLARGE</b>: A r4.xlarge instance type.</para></li><li><para><b>R4_2XLARGE</b>: A r4.2xlarge instance type.</para></li><li><para><b>R4_4XLARGE</b>: A r4.4xlarge instance type.</para></li><li><para><b>R4_8XLARGE</b>: A r4.8xlarge instance type.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiCacheCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApiCache'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.UpdateApiCacheResponse). Specifying the name of a property of type Amazon.AppSync.Model.UpdateApiCacheResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiCacheCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiCacheCmdlet.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.ASYN.UpdateASYNApiKeyCmdlet"> <summary> Updates an API key. You can update the key as long as it's not deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiKeyCmdlet.ApiId"> <summary> <para> <para>The ID for the GraphQL API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiKeyCmdlet.Description"> <summary> <para> <para>A description of the purpose of the API key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiKeyCmdlet.Expire"> <summary> <para> <para>From the update time, the time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiKeyCmdlet.Id"> <summary> <para> <para>The API key ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ApiKey'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.UpdateApiKeyResponse). Specifying the name of a property of type Amazon.AppSync.Model.UpdateApiKeyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNApiKeyCmdlet.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.ASYN.UpdateASYNDataSourceCmdlet"> <summary> Updates a <c>DataSource</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.HttpConfig_AuthorizationConfig"> <summary> <para> <para>The authorization configuration in case the HTTP endpoint requires authorization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.OpenSearchServiceConfig_AwsRegion"> <summary> <para> <para>The Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.Description"> <summary> <para> <para>The new description for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.DynamodbConfig"> <summary> <para> <para>The new Amazon DynamoDB configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.ElasticsearchConfig"> <summary> <para> <para>The new OpenSearch configuration.</para><para>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. Instead, use <a>UpdateDataSourceRequest$openSearchServiceConfig</a> to update an OpenSearch data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.HttpConfig_Endpoint"> <summary> <para> <para>The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.OpenSearchServiceConfig_Endpoint"> <summary> <para> <para>The endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.EventBridgeConfig_EventBusArn"> <summary> <para> <para>The ARN of the event bus. For more information about event buses, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html">Amazon EventBridge event buses</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.LambdaConfig"> <summary> <para> <para>The new Lambda configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.MetricsConfig"> <summary> <para> <para>Enables or disables enhanced data source metrics for specified data sources. Note that <c>metricsConfig</c> won't be used unless the <c>dataSourceLevelMetricsBehavior</c> value is set to <c>PER_DATA_SOURCE_METRICS</c>. If the <c>dataSourceLevelMetricsBehavior</c> is set to <c>FULL_REQUEST_DATA_SOURCE_METRICS</c> instead, <c>metricsConfig</c> will be ignored. However, you can still set its value.</para><para><c>metricsConfig</c> can be <c>ENABLED</c> or <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.Name"> <summary> <para> <para>The new name for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.RelationalDatabaseConfig_RdsHttpEndpointConfig"> <summary> <para> <para>Amazon RDS HTTP endpoint settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.RelationalDatabaseConfig_RelationalDatabaseSourceType"> <summary> <para> <para>Source type for the relational database.</para><ul><li><para><b>RDS_HTTP_ENDPOINT</b>: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.ServiceRoleArn"> <summary> <para> <para>The new service role Amazon Resource Name (ARN) for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.Type"> <summary> <para> <para>The new data source type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.UpdateDataSourceResponse). Specifying the name of a property of type Amazon.AppSync.Model.UpdateDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDataSourceCmdlet.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.ASYN.UpdateASYNDomainNameCmdlet"> <summary> Updates a custom <c>DomainName</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDomainNameCmdlet.Description"> <summary> <para> <para>A description of the <c>DomainName</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDomainNameCmdlet.DomainName"> <summary> <para> <para>The domain name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDomainNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainNameConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.UpdateDomainNameResponse). Specifying the name of a property of type Amazon.AppSync.Model.UpdateDomainNameResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDomainNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNDomainNameCmdlet.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.ASYN.UpdateASYNFunctionCmdlet"> <summary> Updates a <c>Function</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.ApiId"> <summary> <para> <para>The GraphQL API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.Code"> <summary> <para> <para>The <c>function</c> code that contains the request and response functions. When code is used, the <c>runtime</c> is required. The <c>runtime</c> value must be <c>APPSYNC_JS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.SyncConfig_ConflictDetection"> <summary> <para> <para>The Conflict Detection strategy to use.</para><ul><li><para><b>VERSION</b>: Detect conflicts based on object versions for this resolver.</para></li><li><para><b>NONE</b>: Do not detect conflicts when invoking this resolver.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.SyncConfig_ConflictHandler"> <summary> <para> <para>The Conflict Resolution strategy to perform in the event of a conflict.</para><ul><li><para><b>OPTIMISTIC_CONCURRENCY</b>: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.</para></li><li><para><b>AUTOMERGE</b>: Resolve conflicts with the Automerge conflict resolution strategy.</para></li><li><para><b>LAMBDA</b>: Resolve conflicts with an Lambda function supplied in the <c>LambdaConflictHandlerConfig</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.DataSourceName"> <summary> <para> <para>The <c>Function</c><c>DataSource</c> name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.Description"> <summary> <para> <para>The <c>Function</c> description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.FunctionId"> <summary> <para> <para>The function ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.FunctionVersion"> <summary> <para> <para>The <c>version</c> of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the <c>functionVersion</c> is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.LambdaConflictHandlerConfig_LambdaConflictHandlerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.MaxBatchSize"> <summary> <para> <para>The maximum batching size for a resolver.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.Name"> <summary> <para> <para>The <c>Function</c> name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.Runtime_Name"> <summary> <para> <para>The <c>name</c> of the runtime to use. Currently, the only allowed value is <c>APPSYNC_JS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.RequestMappingTemplate"> <summary> <para> <para>The <c>Function</c> request mapping template. Functions support only the 2018-05-29 version of the request mapping template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.ResponseMappingTemplate"> <summary> <para> <para>The <c>Function</c> request mapping template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.Runtime_RuntimeVersion"> <summary> <para> <para>The <c>version</c> of the runtime to use. Currently, the only allowed version is <c>1.0.0</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FunctionConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.UpdateFunctionResponse). Specifying the name of a property of type Amazon.AppSync.Model.UpdateFunctionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FunctionId parameter. The -PassThru parameter is deprecated, use -Select '^FunctionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNFunctionCmdlet.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.ASYN.UpdateASYNGraphqlApiCmdlet"> <summary> Updates a <c>GraphqlApi</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.AdditionalAuthenticationProvider"> <summary> <para> <para>A list of additional authentication providers for the <c>GraphqlApi</c> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.AuthenticationType"> <summary> <para> <para>The new authentication type for the <c>GraphqlApi</c> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.LambdaAuthorizerConfig_AuthorizerResultTtlInSecond"> <summary> <para> <para>The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for <c>authorizerResultTtlInSeconds</c>, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a <c>ttlOverride</c> key in its response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.LambdaAuthorizerConfig_AuthorizerUri"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (<c>.../v3</c>), or an alias ARN. </para><para><b>Note</b>: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:</para><para><c>aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.OpenIDConnectConfig_AuthTTL"> <summary> <para> <para>The number of milliseconds that a token is valid after being authenticated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.OpenIDConnectConfig_ClientId"> <summary> <para> <para>The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.LogConfig_CloudWatchLogsRoleArn"> <summary> <para> <para>The service role that AppSync assumes to publish to CloudWatch logs in your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.EnhancedMetricsConfig_DataSourceLevelMetricsBehavior"> <summary> <para> <para>Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:</para><ul><li><para>Requests: The number of invocations that occured during a request.</para></li><li><para>Latency: The time to complete a data source invocation.</para></li><li><para>Errors: The number of errors that occurred during a data source invocation.</para></li></ul><para>These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. <c>dataSourceLevelMetricsBehavior</c> accepts one of these values at a time:</para><ul><li><para><c>FULL_REQUEST_DATA_SOURCE_METRICS</c>: Records and emits metric data for all data sources in the request.</para></li><li><para><c>PER_DATA_SOURCE_METRICS</c>: Records and emits metric data for data sources that have the <c>metricsConfig</c> value set to <c>ENABLED</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.LogConfig_ExcludeVerboseContent"> <summary> <para> <para>Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.LogConfig_FieldLogLevel"> <summary> <para> <para>The field logging level. Values can be NONE, ERROR, or ALL.</para><ul><li><para><b>NONE</b>: No field-level logs are captured.</para></li><li><para><b>ERROR</b>: Logs the following information only for the fields that are in error:</para><ul><li><para>The error section in the server response.</para></li><li><para>Field-level errors.</para></li><li><para>The generated request/response functions that got resolved for error fields.</para></li></ul></li><li><para><b>ALL</b>: The following information is logged for all fields in the query:</para><ul><li><para>Field-level tracing information.</para></li><li><para>The generated request/response functions that got resolved for each field.</para></li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.OpenIDConnectConfig_IatTTL"> <summary> <para> <para>The number of milliseconds that a token is valid after it's issued to a user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.LambdaAuthorizerConfig_IdentityValidationExpression"> <summary> <para> <para>A regular expression for validation of tokens before the Lambda function is called.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.IntrospectionConfig"> <summary> <para> <para>Sets the value of the GraphQL API to enable (<c>ENABLED</c>) or disable (<c>DISABLED</c>) introspection. If no value is provided, the introspection configuration will be set to <c>ENABLED</c> by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.</para><para>For more information about introspection, see <a href="https://graphql.org/learn/introspection/">GraphQL introspection</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.OpenIDConnectConfig_Issuer"> <summary> <para> <para>The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of <c>iss</c> in the ID token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.MergedApiExecutionRoleArn"> <summary> <para> <para>The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the <c>AUTO_MERGE</c> to update the merged API endpoint with the source API changes automatically.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.Name"> <summary> <para> <para>The new name for the <c>GraphqlApi</c> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.EnhancedMetricsConfig_OperationLevelMetricsConfig"> <summary> <para> <para> Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:</para><ul><li><para>Requests: The number of times a specified GraphQL operation was called.</para></li><li><para>GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.</para></li></ul><para>Metrics will be recorded by API ID and operation name. You can set the value to <c>ENABLED</c> or <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.OwnerContact"> <summary> <para> <para>The owner contact information for an API resource.</para><para>This field accepts any string input with a length of 0 - 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.QueryDepthLimit"> <summary> <para> <para>The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is <c>0</c> (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between <c>1</c> and <c>75</c> nested levels. This field will produce a limit error if the operation falls out of bounds.</para><para>Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.ResolverCountLimit"> <summary> <para> <para>The maximum number of resolvers that can be invoked in a single request. The default value is <c>0</c> (or unspecified), which will set the limit to <c>10000</c>. When specified, the limit value can be between <c>1</c> and <c>10000</c>. This field will produce a limit error if the operation falls out of bounds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.EnhancedMetricsConfig_ResolverLevelMetricsBehavior"> <summary> <para> <para>Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:</para><ul><li><para>GraphQL errors: The number of GraphQL errors that occurred.</para></li><li><para>Requests: The number of invocations that occurred during a request. </para></li><li><para>Latency: The time to complete a resolver invocation.</para></li><li><para>Cache hits: The number of cache hits during a request.</para></li><li><para>Cache misses: The number of cache misses during a request.</para></li></ul><para>These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. <c>resolverLevelMetricsBehavior</c> accepts one of these values at a time:</para><ul><li><para><c>FULL_REQUEST_RESOLVER_METRICS</c>: Records and emits metric data for all resolvers in the request.</para></li><li><para><c>PER_RESOLVER_METRICS</c>: Records and emits metric data for resolvers that have the <c>metricsConfig</c> value set to <c>ENABLED</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.UserPoolConfig"> <summary> <para> <para>The new Amazon Cognito user pool configuration for the <c>~GraphqlApi</c> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.XrayEnabled"> <summary> <para> <para>A flag indicating whether to use X-Ray tracing for the <c>GraphqlApi</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GraphqlApi'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.UpdateGraphqlApiResponse). Specifying the name of a property of type Amazon.AppSync.Model.UpdateGraphqlApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNGraphqlApiCmdlet.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.ASYN.UpdateASYNResolverCmdlet"> <summary> Updates a <c>Resolver</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.CachingConfig_CachingKey"> <summary> <para> <para>The caching keys for a resolver that has caching activated.</para><para>Valid values are entries from the <c>$context.arguments</c>, <c>$context.source</c>, and <c>$context.identity</c> maps.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.Code"> <summary> <para> <para>The <c>resolver</c> code that contains the request and response functions. When code is used, the <c>runtime</c> is required. The <c>runtime</c> value must be <c>APPSYNC_JS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.SyncConfig_ConflictDetection"> <summary> <para> <para>The Conflict Detection strategy to use.</para><ul><li><para><b>VERSION</b>: Detect conflicts based on object versions for this resolver.</para></li><li><para><b>NONE</b>: Do not detect conflicts when invoking this resolver.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.SyncConfig_ConflictHandler"> <summary> <para> <para>The Conflict Resolution strategy to perform in the event of a conflict.</para><ul><li><para><b>OPTIMISTIC_CONCURRENCY</b>: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.</para></li><li><para><b>AUTOMERGE</b>: Resolve conflicts with the Automerge conflict resolution strategy.</para></li><li><para><b>LAMBDA</b>: Resolve conflicts with an Lambda function supplied in the <c>LambdaConflictHandlerConfig</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.DataSourceName"> <summary> <para> <para>The new data source name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.FieldName"> <summary> <para> <para>The new field name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.PipelineConfig_Function"> <summary> <para> <para>A list of <c>Function</c> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.Kind"> <summary> <para> <para>The resolver type.</para><ul><li><para><b>UNIT</b>: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.</para></li><li><para><b>PIPELINE</b>: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of <c>Function</c> objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.LambdaConflictHandlerConfig_LambdaConflictHandlerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.MaxBatchSize"> <summary> <para> <para>The maximum batching size for a resolver.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.MetricsConfig"> <summary> <para> <para>Enables or disables enhanced resolver metrics for specified resolvers. Note that <c>metricsConfig</c> won't be used unless the <c>resolverLevelMetricsBehavior</c> value is set to <c>PER_RESOLVER_METRICS</c>. If the <c>resolverLevelMetricsBehavior</c> is set to <c>FULL_REQUEST_RESOLVER_METRICS</c> instead, <c>metricsConfig</c> will be ignored. However, you can still set its value.</para><para><c>metricsConfig</c> can be <c>ENABLED</c> or <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.Runtime_Name"> <summary> <para> <para>The <c>name</c> of the runtime to use. Currently, the only allowed value is <c>APPSYNC_JS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.RequestMappingTemplate"> <summary> <para> <para>The new request mapping template.</para><para>A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).</para><para>VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.ResponseMappingTemplate"> <summary> <para> <para>The new response mapping template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.Runtime_RuntimeVersion"> <summary> <para> <para>The <c>version</c> of the runtime to use. Currently, the only allowed version is <c>1.0.0</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.CachingConfig_Ttl"> <summary> <para> <para>The TTL in seconds for a resolver that has caching activated.</para><para>Valid values are 1–3,600 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.TypeName"> <summary> <para> <para>The new type name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Resolver'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.UpdateResolverResponse). Specifying the name of a property of type Amazon.AppSync.Model.UpdateResolverResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FieldName parameter. The -PassThru parameter is deprecated, use -Select '^FieldName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNResolverCmdlet.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.ASYN.UpdateASYNSourceApiAssociationCmdlet"> <summary> Updates some of the configuration choices of a particular source API association. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNSourceApiAssociationCmdlet.AssociationId"> <summary> <para> <para>The ID generated by the AppSync service for the source API association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNSourceApiAssociationCmdlet.Description"> <summary> <para> <para>The description field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNSourceApiAssociationCmdlet.MergedApiIdentifier"> <summary> <para> <para>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNSourceApiAssociationCmdlet.SourceApiAssociationConfig_MergeType"> <summary> <para> <para>The property that indicates which merging option is enabled in the source API association.</para><para>Valid merge types are <c>MANUAL_MERGE</c> (default) and <c>AUTO_MERGE</c>. Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use <c>MergedApiExecutionRoleArn</c> to perform merge operations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNSourceApiAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SourceApiAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.UpdateSourceApiAssociationResponse). Specifying the name of a property of type Amazon.AppSync.Model.UpdateSourceApiAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNSourceApiAssociationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociationId parameter. The -PassThru parameter is deprecated, use -Select '^AssociationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNSourceApiAssociationCmdlet.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.ASYN.UpdateASYNTypeCmdlet"> <summary> Updates a <c>Type</c> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNTypeCmdlet.ApiId"> <summary> <para> <para>The API ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNTypeCmdlet.Definition"> <summary> <para> <para>The new definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNTypeCmdlet.Format"> <summary> <para> <para>The new type format: SDL or JSON.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNTypeCmdlet.TypeName"> <summary> <para> <para>The new type name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNTypeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Type'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.UpdateTypeResponse). Specifying the name of a property of type Amazon.AppSync.Model.UpdateTypeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNTypeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TypeName parameter. The -PassThru parameter is deprecated, use -Select '^TypeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.UpdateASYNTypeCmdlet.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.ASYN.WriteASYNGraphqlApiEnvironmentVariableCmdlet"> <summary> Creates a list of environmental variables in an API by its ID value. <para> When creating an environmental variable, it must follow the constraints below: </para><ul><li><para> Both JavaScript and VTL templates support environmental variables. </para></li><li><para> Environmental variables are not evaluated before function invocation. </para></li><li><para> Environmental variables only support string values. </para></li><li><para> Any defined value in an environmental variable is considered a string literal and not expanded. </para></li><li><para> Variable evaluations should ideally be performed in the function code. </para></li></ul><para> When creating an environmental variable key-value pair, it must follow the additional constraints below: </para><ul><li><para> Keys must begin with a letter. </para></li><li><para> Keys must be at least two characters long. </para></li><li><para> Keys can only contain letters, numbers, and the underscore character (_). </para></li><li><para> Values can be up to 512 characters long. </para></li><li><para> You can configure up to 50 key-value pairs in a GraphQL API. </para></li></ul><para> You can create a list of environmental variables by adding it to the <c>environmentVariables</c> payload as a list in the format <c>{"key1":"value1","key2":"value2", …}</c>. Note that each call of the <c>PutGraphqlApiEnvironmentVariables</c> action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.WriteASYNGraphqlApiEnvironmentVariableCmdlet.ApiId"> <summary> <para> <para>The ID of the API to which the environmental variable list will be written.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.WriteASYNGraphqlApiEnvironmentVariableCmdlet.EnvironmentVariable"> <summary> <para> <para>The list of environmental variables to add to the API.</para><para>When creating an environmental variable key-value pair, it must follow the additional constraints below:</para><ul><li><para>Keys must begin with a letter.</para></li><li><para>Keys must be at least two characters long.</para></li><li><para>Keys can only contain letters, numbers, and the underscore character (_).</para></li><li><para>Values can be up to 512 characters long.</para></li><li><para>You can configure up to 50 key-value pairs in a GraphQL API.</para></li></ul><para>You can create a list of environmental variables by adding it to the <c>environmentVariables</c> payload as a list in the format <c>{"key1":"value1","key2":"value2", …}</c>. Note that each call of the <c>PutGraphqlApiEnvironmentVariables</c> action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.WriteASYNGraphqlApiEnvironmentVariableCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentVariables'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.PutGraphqlApiEnvironmentVariablesResponse). Specifying the name of a property of type Amazon.AppSync.Model.PutGraphqlApiEnvironmentVariablesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.WriteASYNGraphqlApiEnvironmentVariableCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASYN.WriteASYNGraphqlApiEnvironmentVariableCmdlet.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> |