AWS.Tools.BCMDashboards.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.BCMDashboards</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.BCMD.AddBCMDResourceTagCmdlet"> <summary> Adds or updates tags for a specified dashboard resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.AddBCMDResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The unique identifier for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.AddBCMDResourceTagCmdlet.ResourceTag"> <summary> <para> <para>The tags to add to the dashboard resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.AddBCMDResourceTagCmdlet.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.BCMDashboards.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.AddBCMDResourceTagCmdlet.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.BCMD.GetBCMDDashboardCmdlet"> <summary> Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDDashboardCmdlet.Arn"> <summary> <para> <para>The ARN of the dashboard to retrieve. This is required to uniquely identify the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDDashboardCmdlet.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.BCMDashboards.Model.GetDashboardResponse). Specifying the name of a property of type Amazon.BCMDashboards.Model.GetDashboardResponse 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.BCMD.GetBCMDDashboardListCmdlet"> <summary> Returns a list of all dashboards in your account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDDashboardListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. The default value is 20.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDDashboardListCmdlet.NextToken"> <summary> <para> <para>The token for the next page of results. Use the value returned in the previous response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDDashboardListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Dashboards'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDashboards.Model.ListDashboardsResponse). Specifying the name of a property of type Amazon.BCMDashboards.Model.ListDashboardsResponse 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.BCMD.GetBCMDDashboardListCmdlet.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.BCMD.GetBCMDResourcePolicyCmdlet"> <summary> Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the dashboard whose resource-based policy you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDResourcePolicyCmdlet.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.BCMDashboards.Model.GetResourcePolicyResponse). Specifying the name of a property of type Amazon.BCMDashboards.Model.GetResourcePolicyResponse 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.BCMD.GetBCMDResourceTagCmdlet"> <summary> Returns a list of all tags associated with a specified dashboard resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The unique identifier for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceTags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDashboards.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.BCMDashboards.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="T:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDScheduledReportCmdlet"> <summary> Retrieves the configuration and metadata of a specified scheduled report. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDScheduledReportCmdlet.Arn"> <summary> <para> <para>The ARN of the scheduled report to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDScheduledReportCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ScheduledReport'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDashboards.Model.GetScheduledReportResponse). Specifying the name of a property of type Amazon.BCMDashboards.Model.GetScheduledReportResponse 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.BCMD.GetBCMDScheduledReportListCmdlet"> <summary> Returns a list of scheduled reports in your account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDScheduledReportListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. Valid range is 1 to 100. The default value is 50.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDScheduledReportListCmdlet.NextToken"> <summary> <para> <para>The token for the next page of results. Use the value returned in the previous response.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.GetBCMDScheduledReportListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ScheduledReports'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDashboards.Model.ListScheduledReportsResponse). Specifying the name of a property of type Amazon.BCMDashboards.Model.ListScheduledReportsResponse 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.BCMD.GetBCMDScheduledReportListCmdlet.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.BCMD.InvokeBCMDScheduledReportCmdlet"> <summary> Triggers an immediate execution of a scheduled report, outside of its regular schedule. The scheduled report must be in <c>ENABLED</c> state. Calling this operation on a <c>DISABLED</c> scheduled report returns a <c>ValidationException</c>. <note><para> If a <c>clientToken</c> is provided, the service uses it for idempotency. Requests with the same client token will not trigger a new execution within the same minute. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.InvokeBCMDScheduledReportCmdlet.Arn"> <summary> <para> <para>The ARN of the scheduled report to execute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.InvokeBCMDScheduledReportCmdlet.DryRun"> <summary> <para> <para>When set to <c>true</c>, validates the scheduled report configuration without triggering an actual execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.InvokeBCMDScheduledReportCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.InvokeBCMDScheduledReportCmdlet.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.BCMDashboards.Model.ExecuteScheduledReportResponse). Specifying the name of a property of type Amazon.BCMDashboards.Model.ExecuteScheduledReportResponse 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.BCMD.InvokeBCMDScheduledReportCmdlet.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.BCMD.NewBCMDDashboardCmdlet"> <summary> Creates a new dashboard that can contain multiple widgets displaying cost and usage data. You can add custom widgets or use predefined widgets, arranging them in your preferred layout. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDDashboardCmdlet.Description"> <summary> <para> <para>A description of the dashboard's purpose or contents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDDashboardCmdlet.Name"> <summary> <para> <para>The name of the dashboard. The name must be unique within your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDDashboardCmdlet.ResourceTag"> <summary> <para> <para>The tags to apply to the dashboard resource for organization and management.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDDashboardCmdlet.Widget"> <summary> <para> <para>An array of widget configurations that define the visualizations to be displayed in the dashboard. Each dashboard can contain up to 20 widgets.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDDashboardCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDashboards.Model.CreateDashboardResponse). Specifying the name of a property of type Amazon.BCMDashboards.Model.CreateDashboardResponse 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.BCMD.NewBCMDDashboardCmdlet.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.BCMD.NewBCMDScheduledReportCmdlet"> <summary> Creates a new scheduled report for a dashboard. A scheduled report automatically generates and delivers dashboard snapshots on a recurring schedule. Reports are delivered within 15 minutes of the scheduled delivery time. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_DashboardArn"> <summary> <para> <para>The ARN of the dashboard to generate the scheduled report from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_Description"> <summary> <para> <para>A description of the scheduled report's purpose or contents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_ScheduleConfig_SchedulePeriod_EndTime"> <summary> <para> <para>The end time of the schedule period. If not specified, defaults to 3 years from the time of the create or update request. The maximum allowed value is 3 years from the current time. Setting an end time beyond this limit returns a <c>ValidationException</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_Name"> <summary> <para> <para>The name of the scheduled report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ResourceTag"> <summary> <para> <para>The tags to apply to the scheduled report resource for organization and management.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_ScheduledReportExecutionRoleArn"> <summary> <para> <para>The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_ScheduleConfig_ScheduleExpression"> <summary> <para> <para>The schedule expression that specifies when to trigger the scheduled report run. This value must be a cron expression consisting of six fields separated by white spaces: <c>cron(minutes hours day_of_month month day_of_week year)</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_ScheduleConfig_ScheduleExpressionTimeZone"> <summary> <para> <para>The time zone for the schedule expression, for example, <c>UTC</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_ScheduleConfig_SchedulePeriod_StartTime"> <summary> <para> <para>The start time of the schedule period. If not specified, defaults to the time of the create or update request. The start time cannot be more than 5 minutes before the time of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_ScheduleConfig_State"> <summary> <para> <para>The state of the schedule. <c>ENABLED</c> means the scheduled report runs according to its schedule expression. <c>DISABLED</c> means the scheduled report is paused and will not run until re-enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_WidgetDateRangeOverride_EndTime_Type"> <summary> <para> <para>The type of date/time value: <c>ABSOLUTE</c> for specific dates or <c>RELATIVE</c> for dynamic time periods.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_WidgetDateRangeOverride_StartTime_Type"> <summary> <para> <para>The type of date/time value: <c>ABSOLUTE</c> for specific dates or <c>RELATIVE</c> for dynamic time periods.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_WidgetDateRangeOverride_EndTime_Value"> <summary> <para> <para>The actual date/time value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_WidgetDateRangeOverride_StartTime_Value"> <summary> <para> <para>The actual date/time value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ScheduledReport_WidgetId"> <summary> <para> <para>The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.NewBCMDScheduledReportCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDashboards.Model.CreateScheduledReportResponse). Specifying the name of a property of type Amazon.BCMDashboards.Model.CreateScheduledReportResponse 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.BCMD.NewBCMDScheduledReportCmdlet.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.BCMD.RemoveBCMDDashboardCmdlet"> <summary> Deletes a specified dashboard. This action cannot be undone. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.RemoveBCMDDashboardCmdlet.Arn"> <summary> <para> <para>The ARN of the dashboard to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.RemoveBCMDDashboardCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDashboards.Model.DeleteDashboardResponse). Specifying the name of a property of type Amazon.BCMDashboards.Model.DeleteDashboardResponse 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.BCMD.RemoveBCMDDashboardCmdlet.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.BCMD.RemoveBCMDResourceTagCmdlet"> <summary> Removes specified tags from a dashboard resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.RemoveBCMDResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The unique identifier for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.RemoveBCMDResourceTagCmdlet.ResourceTagKey"> <summary> <para> <para>The keys of the tags to remove from the dashboard resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.RemoveBCMDResourceTagCmdlet.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.BCMDashboards.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.RemoveBCMDResourceTagCmdlet.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.BCMD.RemoveBCMDScheduledReportCmdlet"> <summary> Deletes a specified scheduled report. This is an irreversible operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.RemoveBCMDScheduledReportCmdlet.Arn"> <summary> <para> <para>The ARN of the scheduled report to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.RemoveBCMDScheduledReportCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDashboards.Model.DeleteScheduledReportResponse). Specifying the name of a property of type Amazon.BCMDashboards.Model.DeleteScheduledReportResponse 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.BCMD.RemoveBCMDScheduledReportCmdlet.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.BCMD.UpdateBCMDDashboardCmdlet"> <summary> Updates an existing dashboard's properties, including its name, description, and widget configurations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDDashboardCmdlet.Arn"> <summary> <para> <para>The ARN of the dashboard to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDDashboardCmdlet.Description"> <summary> <para> <para>The new description for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDDashboardCmdlet.Name"> <summary> <para> <para>The new name for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDDashboardCmdlet.Widget"> <summary> <para> <para>The updated array of widget configurations for the dashboard. Replaces all existing widgets.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDDashboardCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDashboards.Model.UpdateDashboardResponse). Specifying the name of a property of type Amazon.BCMDashboards.Model.UpdateDashboardResponse 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.BCMD.UpdateBCMDDashboardCmdlet.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.BCMD.UpdateBCMDScheduledReportCmdlet"> <summary> Updates an existing scheduled report's properties, including its name, description, schedule configuration, and widget settings. Only the parameters included in the request are updated; all other properties remain unchanged. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.Arn"> <summary> <para> <para>The ARN of the scheduled report to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.ClearWidgetDateRangeOverride"> <summary> <para> <para>Set to true to clear existing widgetDateRangeOverride.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.ClearWidgetId"> <summary> <para> <para>Set to true to clear existing widgetIds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.DashboardArn"> <summary> <para> <para>The ARN of the dashboard to associate with the scheduled report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.Description"> <summary> <para> <para>The new description for the scheduled report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.ScheduleConfig_SchedulePeriod_EndTime"> <summary> <para> <para>The end time of the schedule period. If not specified, defaults to 3 years from the time of the create or update request. The maximum allowed value is 3 years from the current time. Setting an end time beyond this limit returns a <c>ValidationException</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.Name"> <summary> <para> <para>The new name for the scheduled report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.ScheduledReportExecutionRoleArn"> <summary> <para> <para>The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.ScheduleConfig_ScheduleExpression"> <summary> <para> <para>The schedule expression that specifies when to trigger the scheduled report run. This value must be a cron expression consisting of six fields separated by white spaces: <c>cron(minutes hours day_of_month month day_of_week year)</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.ScheduleConfig_ScheduleExpressionTimeZone"> <summary> <para> <para>The time zone for the schedule expression, for example, <c>UTC</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.ScheduleConfig_SchedulePeriod_StartTime"> <summary> <para> <para>The start time of the schedule period. If not specified, defaults to the time of the create or update request. The start time cannot be more than 5 minutes before the time of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.ScheduleConfig_State"> <summary> <para> <para>The state of the schedule. <c>ENABLED</c> means the scheduled report runs according to its schedule expression. <c>DISABLED</c> means the scheduled report is paused and will not run until re-enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.WidgetDateRangeOverride_EndTime_Type"> <summary> <para> <para>The type of date/time value: <c>ABSOLUTE</c> for specific dates or <c>RELATIVE</c> for dynamic time periods.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.WidgetDateRangeOverride_StartTime_Type"> <summary> <para> <para>The type of date/time value: <c>ABSOLUTE</c> for specific dates or <c>RELATIVE</c> for dynamic time periods.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.WidgetDateRangeOverride_EndTime_Value"> <summary> <para> <para>The actual date/time value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.WidgetDateRangeOverride_StartTime_Value"> <summary> <para> <para>The actual date/time value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.WidgetId"> <summary> <para> <para>The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BCMD.UpdateBCMDScheduledReportCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BCMDashboards.Model.UpdateScheduledReportResponse). Specifying the name of a property of type Amazon.BCMDashboards.Model.UpdateScheduledReportResponse 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.BCMD.UpdateBCMDScheduledReportCmdlet.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> |