AWS.Tools.CostOptimizationHub.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CostOptimizationHub</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.COH.GetCOHEnrollmentStatusListCmdlet"> <summary> Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHEnrollmentStatusListCmdlet.AccountId"> <summary> <para> <para>The enrollment status of a specific account ID in the organization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHEnrollmentStatusListCmdlet.IncludeOrganizationInfo"> <summary> <para> <para>Indicates whether to return the enrollment status for the organization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHEnrollmentStatusListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects that are returned for the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHEnrollmentStatusListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHEnrollmentStatusListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CostOptimizationHub.Model.ListEnrollmentStatusesResponse). Specifying the name of a property of type Amazon.CostOptimizationHub.Model.ListEnrollmentStatusesResponse 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.COH.GetCOHEnrollmentStatusListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COH.GetCOHPreferenceCmdlet"> <summary> Returns a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented—estimated savings after discounts or estimated savings before discounts, for example. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHPreferenceCmdlet.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.CostOptimizationHub.Model.GetPreferencesResponse). Specifying the name of a property of type Amazon.CostOptimizationHub.Model.GetPreferencesResponse 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.COH.GetCOHRecommendationCmdlet"> <summary> Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation. <para> The <code>recommendationId</code> is only valid for up to a maximum of 24 hours as recommendations are refreshed daily. To retrieve the <code>recommendationId</code>, use the <code>ListRecommendations</code> API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationCmdlet.RecommendationId"> <summary> <para> <para>The ID for the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationCmdlet.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.CostOptimizationHub.Model.GetRecommendationResponse). Specifying the name of a property of type Amazon.CostOptimizationHub.Model.GetRecommendationResponse 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.COH.GetCOHRecommendationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RecommendationId parameter. The -PassThru parameter is deprecated, use -Select '^RecommendationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet"> <summary> Returns a list of recommendations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.Filter_AccountId"> <summary> <para> <para>The account that the recommendation is for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.Filter_ActionType"> <summary> <para> <para>The type of action you can take by adopting the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.OrderBy_Dimension"> <summary> <para> <para>Sorts by dimension values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.Filter_ImplementationEffort"> <summary> <para> <para>The effort required to implement the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.IncludeAllRecommendation"> <summary> <para> <para>List of all recommendations for a resource, or a single recommendation if de-duped by <code>resourceId</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.OrderBy_Order"> <summary> <para> <para>The order that's used to sort the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.Filter_RecommendationId"> <summary> <para> <para>The IDs for the recommendations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.Filter_Region"> <summary> <para> <para>The Amazon Web Services Region of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.Filter_ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.Filter_ResourceId"> <summary> <para> <para>The resource ID of the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.Filter_ResourceType"> <summary> <para> <para>The resource type of the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.Filter_RestartNeeded"> <summary> <para> <para>Whether or not implementing the recommendation requires a restart.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.Filter_RollbackPossible"> <summary> <para> <para>Whether or not implementing the recommendation can be rolled back.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.Filter_Tag"> <summary> <para> <para>A list of tags assigned to the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of recommendations that are returned for the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CostOptimizationHub.Model.ListRecommendationsResponse). Specifying the name of a property of type Amazon.CostOptimizationHub.Model.ListRecommendationsResponse 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.COH.GetCOHRecommendationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IncludeAllRecommendation parameter. The -PassThru parameter is deprecated, use -Select '^IncludeAllRecommendation' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet"> <summary> Returns a concise representation of savings estimates for resources. Also returns de-duped savings across different types of recommendations. <note><para> The following filters are not supported for this API: <code>recommendationIds</code>, <code>resourceArns</code>, and <code>resourceIds</code>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.Filter_AccountId"> <summary> <para> <para>The account that the recommendation is for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.Filter_ActionType"> <summary> <para> <para>The type of action you can take by adopting the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.GroupBy"> <summary> <para> <para>The grouping of recommendations by a dimension.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.Filter_ImplementationEffort"> <summary> <para> <para>The effort required to implement the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.Filter_RecommendationId"> <summary> <para> <para>The IDs for the recommendations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.Filter_Region"> <summary> <para> <para>The Amazon Web Services Region of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.Filter_ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.Filter_ResourceId"> <summary> <para> <para>The resource ID of the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.Filter_ResourceType"> <summary> <para> <para>The resource type of the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.Filter_RestartNeeded"> <summary> <para> <para>Whether or not implementing the recommendation requires a restart.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.Filter_RollbackPossible"> <summary> <para> <para>Whether or not implementing the recommendation can be rolled back.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.Filter_Tag"> <summary> <para> <para>A list of tags assigned to the recommendation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of recommendations that are returned for the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.GetCOHRecommendationSummaryListCmdlet.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.CostOptimizationHub.Model.ListRecommendationSummariesResponse). Specifying the name of a property of type Amazon.CostOptimizationHub.Model.ListRecommendationSummariesResponse 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.COH.GetCOHRecommendationSummaryListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupBy parameter. The -PassThru parameter is deprecated, use -Select '^GroupBy' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COH.UpdateCOHEnrollmentStatusCmdlet"> <summary> Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service. <para> If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization. </para><para> You must have the appropriate permissions to opt in to Cost Optimization Hub and to view its recommendations. When you opt in, Cost Optimization Hub automatically creates a service-linked role in your account to access its data. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.UpdateCOHEnrollmentStatusCmdlet.IncludeMemberAccount"> <summary> <para> <para>Indicates whether to enroll member accounts of the organization if the account is the management account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.UpdateCOHEnrollmentStatusCmdlet.Status"> <summary> <para> <para>Sets the account status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.UpdateCOHEnrollmentStatusCmdlet.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.CostOptimizationHub.Model.UpdateEnrollmentStatusResponse). Specifying the name of a property of type Amazon.CostOptimizationHub.Model.UpdateEnrollmentStatusResponse 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.COH.UpdateCOHEnrollmentStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Status parameter. The -PassThru parameter is deprecated, use -Select '^Status' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.UpdateCOHEnrollmentStatusCmdlet.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.COH.UpdateCOHPreferenceCmdlet"> <summary> Updates a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.UpdateCOHPreferenceCmdlet.MemberAccountDiscountVisibility"> <summary> <para> <para>Sets the "member account discount visibility" preference.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.UpdateCOHPreferenceCmdlet.SavingsEstimationMode"> <summary> <para> <para>Sets the "savings estimation mode" preference.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COH.UpdateCOHPreferenceCmdlet.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.CostOptimizationHub.Model.UpdatePreferencesResponse). Specifying the name of a property of type Amazon.CostOptimizationHub.Model.UpdatePreferencesResponse 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.COH.UpdateCOHPreferenceCmdlet.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> |