AWS.Tools.MigrationHubConfig.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.MigrationHubConfig</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.MHC.GetMHCHomeRegionCmdlet"> <summary> Returns the calling account’s home region, if configured. This API is used by other AWS services to determine the regional endpoint for calling AWS Application Discovery Service and Migration Hub. You must call <c>GetHomeRegion</c> at least once before you call any other AWS Application Discovery Service and AWS Migration Hub APIs, to obtain the account's Migration Hub home region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.GetMHCHomeRegionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HomeRegion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MigrationHubConfig.Model.GetHomeRegionResponse). Specifying the name of a property of type Amazon.MigrationHubConfig.Model.GetHomeRegionResponse 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.MHC.GetMHCHomeRegionControlCmdlet"> <summary> This API permits filtering on the <c>ControlId</c> and <c>HomeRegion</c> fields.<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.MHC.GetMHCHomeRegionControlCmdlet.ControlId"> <summary> <para> <para>The <c>ControlID</c> is a unique identifier string of your <c>HomeRegionControl</c> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.GetMHCHomeRegionControlCmdlet.HomeRegion"> <summary> <para> <para>The name of the home region you'd like to view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.GetMHCHomeRegionControlCmdlet.Target_Id"> <summary> <para> <para>The <c>TargetID</c> is a 12-character identifier of the <c>ACCOUNT</c> for which the control was created. (This must be the current account.) </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.GetMHCHomeRegionControlCmdlet.Target_Type"> <summary> <para> <para>The target type is always an <c>ACCOUNT</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.GetMHCHomeRegionControlCmdlet.MaxResult"> <summary> <para> <para>The maximum number of filtering results to display per page. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.GetMHCHomeRegionControlCmdlet.NextToken"> <summary> <para> <para>If a <c>NextToken</c> was returned by a previous call, more results are available. To retrieve the next page of results, make the call again using the returned token in <c>NextToken</c>.</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.MHC.GetMHCHomeRegionControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HomeRegionControls'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MigrationHubConfig.Model.DescribeHomeRegionControlsResponse). Specifying the name of a property of type Amazon.MigrationHubConfig.Model.DescribeHomeRegionControlsResponse 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.MHC.GetMHCHomeRegionControlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HomeRegion parameter. The -PassThru parameter is deprecated, use -Select '^HomeRegion' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.GetMHCHomeRegionControlCmdlet.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.MHC.NewMHCHomeRegionControlCmdlet"> <summary> This API sets up the home region for the calling account only. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.NewMHCHomeRegionControlCmdlet.DryRun"> <summary> <para> <para>Optional Boolean flag to indicate whether any effect should take place. It tests whether the caller has permission to make the call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.NewMHCHomeRegionControlCmdlet.HomeRegion"> <summary> <para> <para>The name of the home region of the calling account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.NewMHCHomeRegionControlCmdlet.Target_Id"> <summary> <para> <para>The <c>TargetID</c> is a 12-character identifier of the <c>ACCOUNT</c> for which the control was created. (This must be the current account.) </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.NewMHCHomeRegionControlCmdlet.Target_Type"> <summary> <para> <para>The target type is always an <c>ACCOUNT</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.NewMHCHomeRegionControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HomeRegionControl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MigrationHubConfig.Model.CreateHomeRegionControlResponse). Specifying the name of a property of type Amazon.MigrationHubConfig.Model.CreateHomeRegionControlResponse 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.MHC.NewMHCHomeRegionControlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HomeRegion parameter. The -PassThru parameter is deprecated, use -Select '^HomeRegion' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.NewMHCHomeRegionControlCmdlet.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.MHC.RemoveMHCHomeRegionControlCmdlet"> <summary> This operation deletes the home region configuration for the calling account. The operation does not delete discovery or migration tracking data in the home region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.RemoveMHCHomeRegionControlCmdlet.ControlId"> <summary> <para> <para>A unique identifier that's generated for each home region control. It's always a string that begins with "hrc-" followed by 12 lowercase letters and numbers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.RemoveMHCHomeRegionControlCmdlet.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.MigrationHubConfig.Model.DeleteHomeRegionControlResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.RemoveMHCHomeRegionControlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ControlId parameter. The -PassThru parameter is deprecated, use -Select '^ControlId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MHC.RemoveMHCHomeRegionControlCmdlet.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> |