AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Billing and Cost Management Dashboards UpdateScheduledReport API operation.

Syntax

Update-BCMDScheduledReport
-Arn <String>
-ClearWidgetDateRangeOverride <Boolean>
-ClearWidgetId <Boolean>
-DashboardArn <String>
-Description <String>
-ScheduleConfig_SchedulePeriod_EndTime <DateTime>
-Name <String>
-ScheduledReportExecutionRoleArn <String>
-ScheduleConfig_ScheduleExpression <String>
-ScheduleConfig_ScheduleExpressionTimeZone <String>
-ScheduleConfig_SchedulePeriod_StartTime <DateTime>
-ScheduleConfig_State <ScheduleState>
-WidgetDateRangeOverride_EndTime_Type <DateTimeType>
-WidgetDateRangeOverride_StartTime_Type <DateTimeType>
-WidgetDateRangeOverride_EndTime_Value <String>
-WidgetDateRangeOverride_StartTime_Value <String>
-WidgetId <String[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBCMDashboardsConfig>

Description

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.

Parameters

-Arn <String>
The ARN of the scheduled report to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClearWidgetDateRangeOverride <Boolean>
Set to true to clear existing widgetDateRangeOverride.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClearWidgetId <Boolean>
Set to true to clear existing widgetIds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesClearWidgetIds
-ClientConfig <AmazonBCMDashboardsConfig>
Amazon.PowerShell.Cmdlets.BCMD.AmazonBCMDashboardsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DashboardArn <String>
The ARN of the dashboard to associate with the scheduled report.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The new description for the scheduled report.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The new name for the scheduled report.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScheduleConfig_ScheduleExpression <String>
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: cron(minutes hours day_of_month month day_of_week year).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScheduleConfig_ScheduleExpressionTimeZone <String>
The time zone for the schedule expression, for example, UTC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScheduleConfig_SchedulePeriod_EndTime <DateTime>
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 ValidationException.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScheduleConfig_SchedulePeriod_StartTime <DateTime>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScheduleConfig_State <ScheduleState>
The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScheduledReportExecutionRoleArn <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WidgetDateRangeOverride_EndTime_Type <DateTimeType>
The type of date/time value: ABSOLUTE for specific dates or RELATIVE for dynamic time periods.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WidgetDateRangeOverride_EndTime_Value <String>
The actual date/time value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WidgetDateRangeOverride_StartTime_Type <DateTimeType>
The type of date/time value: ABSOLUTE for specific dates or RELATIVE for dynamic time periods.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WidgetDateRangeOverride_StartTime_Value <String>
The actual date/time value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WidgetId <String[]>
The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWidgetIds

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.BCMDashboards.Model.UpdateScheduledReportResponse
This cmdlet returns a System.String object. The service call response (type Amazon.BCMDashboards.Model.UpdateScheduledReportResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z