Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. bcm
  6. getScheduledReport

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.bcm.getScheduledReport

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Creates and manages a scheduled report for an AWS Billing and Cost Management Dashboards dashboard. A scheduled report renders a snapshot of the dashboard on a cron schedule, using an IAM role that the service assumes to read the underlying cost and usage data.

    Using getScheduledReport

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getScheduledReport(args: GetScheduledReportArgs, opts?: InvokeOptions): Promise<GetScheduledReportResult>
function getScheduledReportOutput(args: GetScheduledReportOutputArgs, opts?: InvokeOutputOptions): Output<GetScheduledReportResult>
    def get_scheduled_report(arn: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetScheduledReportResult
def get_scheduled_report_output(arn: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOutputOptions] = None) -> Output[GetScheduledReportResult]
    func LookupScheduledReport(ctx *Context, args *LookupScheduledReportArgs, opts ...InvokeOption) (*LookupScheduledReportResult, error)
func LookupScheduledReportOutput(ctx *Context, args *LookupScheduledReportOutputArgs, opts ...InvokeOption) LookupScheduledReportResultOutput

    > Note: This function is named LookupScheduledReport in the Go SDK.

    public static class GetScheduledReport 
{
    public static Task<GetScheduledReportResult> InvokeAsync(GetScheduledReportArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduledReportResult> Invoke(GetScheduledReportInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduledReportResult> Invoke(GetScheduledReportInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetScheduledReportResult> getScheduledReport(GetScheduledReportArgs args, InvokeOptions options)
public static Output<GetScheduledReportResult> getScheduledReport(GetScheduledReportArgs args, InvokeOptions options)
public static Output<GetScheduledReportResult> getScheduledReport(GetScheduledReportArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:bcm:getScheduledReport
  arguments:
    # arguments dictionary
    data "aws-native_bcm_get_scheduled_report" "name" {
    # arguments
}

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the scheduled report.
    Arn string
    The Amazon Resource Name (ARN) of the scheduled report.
    arn string
    The Amazon Resource Name (ARN) of the scheduled report.
    arn String
    The Amazon Resource Name (ARN) of the scheduled report.
    arn string
    The Amazon Resource Name (ARN) of the scheduled report.
    arn str
    The Amazon Resource Name (ARN) of the scheduled report.
    arn String
    The Amazon Resource Name (ARN) of the scheduled report.

    getScheduledReport Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the scheduled report.
    CreatedAt string
    The timestamp when the scheduled report was created.
    DashboardArn string
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    Description string
    A description of the scheduled report's purpose or contents.
    HealthStatus Pulumi.AwsNative.Bcm.Outputs.ScheduledReportHealthStatus
    The health status of the scheduled report at its last refresh time.
    Name string
    The name of the scheduled report.
    ScheduleConfig Pulumi.AwsNative.Bcm.Outputs.ScheduledReportScheduleConfig
    The schedule configuration that defines when and how often the report is generated.
    ScheduledReportExecutionRoleArn string
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags applied to the scheduled report.
    UpdatedAt string
    The timestamp when the scheduled report was last modified.
    WidgetDateRangeOverride Pulumi.AwsNative.Bcm.Outputs.ScheduledReportDateTimeRange
    The date range override applied to widgets in the scheduled report.
    WidgetIds List<string>
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.
    Arn string
    The Amazon Resource Name (ARN) of the scheduled report.
    CreatedAt string
    The timestamp when the scheduled report was created.
    DashboardArn string
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    Description string
    A description of the scheduled report's purpose or contents.
    HealthStatus ScheduledReportHealthStatus
    The health status of the scheduled report at its last refresh time.
    Name string
    The name of the scheduled report.
    ScheduleConfig ScheduledReportScheduleConfig
    The schedule configuration that defines when and how often the report is generated.
    ScheduledReportExecutionRoleArn string
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    Tags Tag
    The tags applied to the scheduled report.
    UpdatedAt string
    The timestamp when the scheduled report was last modified.
    WidgetDateRangeOverride ScheduledReportDateTimeRange
    The date range override applied to widgets in the scheduled report.
    WidgetIds []string
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.
    arn string
    The Amazon Resource Name (ARN) of the scheduled report.
    created_at string
    The timestamp when the scheduled report was created.
    dashboard_arn string
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    description string
    A description of the scheduled report's purpose or contents.
    health_status object
    The health status of the scheduled report at its last refresh time.
    name string
    The name of the scheduled report.
    schedule_config object
    The schedule configuration that defines when and how often the report is generated.
    scheduled_report_execution_role_arn string
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    tags list(object)
    The tags applied to the scheduled report.
    updated_at string
    The timestamp when the scheduled report was last modified.
    widget_date_range_override object
    The date range override applied to widgets in the scheduled report.
    widget_ids list(string)
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.
    arn String
    The Amazon Resource Name (ARN) of the scheduled report.
    createdAt String
    The timestamp when the scheduled report was created.
    dashboardArn String
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    description String
    A description of the scheduled report's purpose or contents.
    healthStatus ScheduledReportHealthStatus
    The health status of the scheduled report at its last refresh time.
    name String
    The name of the scheduled report.
    scheduleConfig ScheduledReportScheduleConfig
    The schedule configuration that defines when and how often the report is generated.
    scheduledReportExecutionRoleArn String
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    tags List<Tag>
    The tags applied to the scheduled report.
    updatedAt String
    The timestamp when the scheduled report was last modified.
    widgetDateRangeOverride ScheduledReportDateTimeRange
    The date range override applied to widgets in the scheduled report.
    widgetIds List<String>
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.
    arn string
    The Amazon Resource Name (ARN) of the scheduled report.
    createdAt string
    The timestamp when the scheduled report was created.
    dashboardArn string
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    description string
    A description of the scheduled report's purpose or contents.
    healthStatus ScheduledReportHealthStatus
    The health status of the scheduled report at its last refresh time.
    name string
    The name of the scheduled report.
    scheduleConfig ScheduledReportScheduleConfig
    The schedule configuration that defines when and how often the report is generated.
    scheduledReportExecutionRoleArn string
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    tags Tag[]
    The tags applied to the scheduled report.
    updatedAt string
    The timestamp when the scheduled report was last modified.
    widgetDateRangeOverride ScheduledReportDateTimeRange
    The date range override applied to widgets in the scheduled report.
    widgetIds string[]
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.
    arn str
    The Amazon Resource Name (ARN) of the scheduled report.
    created_at str
    The timestamp when the scheduled report was created.
    dashboard_arn str
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    description str
    A description of the scheduled report's purpose or contents.
    health_status ScheduledReportHealthStatus
    The health status of the scheduled report at its last refresh time.
    name str
    The name of the scheduled report.
    schedule_config ScheduledReportScheduleConfig
    The schedule configuration that defines when and how often the report is generated.
    scheduled_report_execution_role_arn str
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    tags Sequence[root_Tag]
    The tags applied to the scheduled report.
    updated_at str
    The timestamp when the scheduled report was last modified.
    widget_date_range_override ScheduledReportDateTimeRange
    The date range override applied to widgets in the scheduled report.
    widget_ids Sequence[str]
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.
    arn String
    The Amazon Resource Name (ARN) of the scheduled report.
    createdAt String
    The timestamp when the scheduled report was created.
    dashboardArn String
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    description String
    A description of the scheduled report's purpose or contents.
    healthStatus Property Map
    The health status of the scheduled report at its last refresh time.
    name String
    The name of the scheduled report.
    scheduleConfig Property Map
    The schedule configuration that defines when and how often the report is generated.
    scheduledReportExecutionRoleArn String
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    tags List<Property Map>
    The tags applied to the scheduled report.
    updatedAt String
    The timestamp when the scheduled report was last modified.
    widgetDateRangeOverride Property Map
    The date range override applied to widgets in the scheduled report.
    widgetIds List<String>
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.

    Supporting Types

    ScheduledReportDateTimeRange

    end_time object
    The end of the range.
    start_time object
    The start of the range.
    endTime Property Map
    The end of the range.
    startTime Property Map
    The start of the range.

    ScheduledReportDateTimeType

    ScheduledReportDateTimeValue

    Type Pulumi.AwsNative.Bcm.ScheduledReportDateTimeType
    Whether Value is an absolute date or a duration relative to now.
    Value string
    The date, or an ISO 8601 duration when Type is RELATIVE.
    Type ScheduledReportDateTimeType
    Whether Value is an absolute date or a duration relative to now.
    Value string
    The date, or an ISO 8601 duration when Type is RELATIVE.
    type "ABSOLUTE" | "RELATIVE"
    Whether Value is an absolute date or a duration relative to now.
    value string
    The date, or an ISO 8601 duration when Type is RELATIVE.
    type ScheduledReportDateTimeType
    Whether Value is an absolute date or a duration relative to now.
    value String
    The date, or an ISO 8601 duration when Type is RELATIVE.
    type ScheduledReportDateTimeType
    Whether Value is an absolute date or a duration relative to now.
    value string
    The date, or an ISO 8601 duration when Type is RELATIVE.
    type ScheduledReportDateTimeType
    Whether Value is an absolute date or a duration relative to now.
    value str
    The date, or an ISO 8601 duration when Type is RELATIVE.
    type "ABSOLUTE" | "RELATIVE"
    Whether Value is an absolute date or a duration relative to now.
    value String
    The date, or an ISO 8601 duration when Type is RELATIVE.

    ScheduledReportHealthStatus

    StatusCode Pulumi.AwsNative.Bcm.ScheduledReportHealthStatusCode
    Whether the scheduled report is healthy.
    LastRefreshedAt string
    The time at which the health status was last refreshed.
    StatusCode ScheduledReportHealthStatusCode
    Whether the scheduled report is healthy.
    LastRefreshedAt string
    The time at which the health status was last refreshed.
    status_code "HEALTHY" | "UNHEALTHY"
    Whether the scheduled report is healthy.
    last_refreshed_at string
    The time at which the health status was last refreshed.
    statusCode ScheduledReportHealthStatusCode
    Whether the scheduled report is healthy.
    lastRefreshedAt String
    The time at which the health status was last refreshed.
    statusCode ScheduledReportHealthStatusCode
    Whether the scheduled report is healthy.
    lastRefreshedAt string
    The time at which the health status was last refreshed.
    status_code ScheduledReportHealthStatusCode
    Whether the scheduled report is healthy.
    last_refreshed_at str
    The time at which the health status was last refreshed.
    statusCode "HEALTHY" | "UNHEALTHY"
    Whether the scheduled report is healthy.
    lastRefreshedAt String
    The time at which the health status was last refreshed.

    ScheduledReportHealthStatusCode

    ScheduledReportScheduleConfig

    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).
    ScheduleExpressionTimeZone string
    The time zone for the schedule expression, for example, UTC.
    SchedulePeriod Pulumi.AwsNative.Bcm.Inputs.ScheduledReportSchedulePeriod
    The time period during which the schedule is active.
    State Pulumi.AwsNative.Bcm.ScheduledReportScheduleState
    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.
    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).
    ScheduleExpressionTimeZone string
    The time zone for the schedule expression, for example, UTC.
    SchedulePeriod ScheduledReportSchedulePeriod
    The time period during which the schedule is active.
    State ScheduledReportScheduleState
    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.
    schedule_expression 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).
    schedule_expression_time_zone string
    The time zone for the schedule expression, for example, UTC.
    schedule_period object
    The time period during which the schedule is active.
    state "ENABLED" | "DISABLED"
    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.
    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).
    scheduleExpressionTimeZone String
    The time zone for the schedule expression, for example, UTC.
    schedulePeriod ScheduledReportSchedulePeriod
    The time period during which the schedule is active.
    state ScheduledReportScheduleState
    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.
    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).
    scheduleExpressionTimeZone string
    The time zone for the schedule expression, for example, UTC.
    schedulePeriod ScheduledReportSchedulePeriod
    The time period during which the schedule is active.
    state ScheduledReportScheduleState
    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.
    schedule_expression str
    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).
    schedule_expression_time_zone str
    The time zone for the schedule expression, for example, UTC.
    schedule_period ScheduledReportSchedulePeriod
    The time period during which the schedule is active.
    state ScheduledReportScheduleState
    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.
    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).
    scheduleExpressionTimeZone String
    The time zone for the schedule expression, for example, UTC.
    schedulePeriod Property Map
    The time period during which the schedule is active.
    state "ENABLED" | "DISABLED"
    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.

    ScheduledReportSchedulePeriod

    EndTime string
    The time at which the schedule stops being active.
    StartTime string
    The time at which the schedule becomes active.
    EndTime string
    The time at which the schedule stops being active.
    StartTime string
    The time at which the schedule becomes active.
    end_time string
    The time at which the schedule stops being active.
    start_time string
    The time at which the schedule becomes active.
    endTime String
    The time at which the schedule stops being active.
    startTime String
    The time at which the schedule becomes active.
    endTime string
    The time at which the schedule stops being active.
    startTime string
    The time at which the schedule becomes active.
    end_time str
    The time at which the schedule stops being active.
    start_time str
    The time at which the schedule becomes active.
    endTime String
    The time at which the schedule stops being active.
    startTime String
    The time at which the schedule becomes active.

    ScheduledReportScheduleState

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial