You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Budgets::Types::TimePeriod

Inherits:

Struct

• Object
• Struct
• Aws::Budgets::Types::TimePeriod

Defined in:

gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb

Overview

Note:

When making an API call, you may pass TimePeriod data as a hash:

{
  start: Time.now,
  end: Time.now,
}

The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

Instance Attribute Summary

• #end ⇒ Time

  The end date for a budget.

• #start ⇒ Time

  The start date for a budget.

Instance Attribute Details

#end ⇒ Time

The end date for a budget. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.

After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the UpdateBudget operation.

Returns:

• (Time)

# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1316

class TimePeriod < Struct.new(
  :start,
  :end)
  include Aws::Structure
end

#start ⇒ Time

The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.

You can change your start date with the UpdateBudget operation.

Returns:

• (Time)

# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1316

class TimePeriod < Struct.new(
  :start,
  :end)
  include Aws::Structure
end