Class: Aws::Billing::Types::CreditData

Inherits:

Struct

• Object
• Struct
• Aws::Billing::Types::CreditData

Includes:

Structure

Defined in:

lib/aws-sdk-billing/types.rb

Overview

Detailed information about an Amazon Web Services credit, including its identifier, type, monetary amounts, applicable products, sharing configuration, and current enabled status.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_has_credit_sharing_enabled ⇒ Boolean

  Whether the owning account has account-level credit sharing turned on.

• #account_id ⇒ String

  The Amazon Web Services account ID that owns the credit.

• #applicable_product_names ⇒ Array<String>

  The names of Amazon Web Services services this credit applies to.

• #application_type ⇒ String

  When the credit is applied during bill computation.

• #cost_category_arn ⇒ String

  The Amazon Resource Name (ARN) of the Cost Category controlling the credit's sharing scope.

• #credit_console_visibility ⇒ String

  The display configuration for the credit in the Amazon Web Services Billing console.

• #credit_id ⇒ String

  The unique identifier for the credit.

• #credit_sharing_type ⇒ String

  The sharing configuration for the credit.

• #credit_status ⇒ String

  Whether the credit participates in billing runs.

• #credit_type ⇒ String

  The type of credit.

• #description ⇒ String

  A human-readable description of the credit.

• #end_date ⇒ Time

  The date the credit expires, as Unix epoch seconds.

• #estimated_amount ⇒ Types::Amount

  The estimated remaining balance, including in-flight (open) bills that have not yet been finalized.

• #exhaust_date ⇒ Time

  The date the credit balance reached zero, as Unix epoch seconds.

• #initial_amount ⇒ Types::Amount

  The initial amount of the credit when it was issued.

• #purchase_type_applications ⇒ Array<String>

  Restricts which purchase types this credit applies to.

• #remaining_amount ⇒ Types::Amount

  The unused balance of the credit.

• #rule_name ⇒ String

  The rule name within the Cost Category.

• #shareable_accounts ⇒ Array<String>

  The Amazon Web Services account IDs entitled to apply this credit.

• #start_date ⇒ Time

  The date the credit becomes valid, as Unix epoch seconds.

Instance Attribute Details

#account_has_credit_sharing_enabled ⇒ Boolean

Whether the owning account has account-level credit sharing turned on.

Returns:

• (Boolean)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#account_id ⇒ String

The Amazon Web Services account ID that owns the credit.

Returns:

• (String)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#applicable_product_names ⇒ Array<String>

The names of Amazon Web Services services this credit applies to.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#application_type ⇒ String

When the credit is applied during bill computation. Valid values: BEFORE_CROSS_SERVICE_DISCOUNTS, AFTER_DISCOUNTS.

Returns:

• (String)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#cost_category_arn ⇒ String

The Amazon Resource Name (ARN) of the Cost Category controlling the credit's sharing scope. Present only when creditSharingType is COST_CATEGORY_RULE.

Returns:

• (String)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#credit_console_visibility ⇒ String

The display configuration for the credit in the Amazon Web Services Billing console.

Returns:

• (String)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#credit_id ⇒ String

The unique identifier for the credit.

Returns:

• (String)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#credit_sharing_type ⇒ String

The sharing configuration for the credit. Valid values: DEFAULT, DISABLED, CUSTOM, COST_CATEGORY_RULE.

Returns:

• (String)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#credit_status ⇒ String

Whether the credit participates in billing runs. Valid values: ENABLED, DISABLED.

Returns:

• (String)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#credit_type ⇒ String

The type of credit. Examples: Promotion, Refund, TrueUp.

Returns:

• (String)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A human-readable description of the credit.

Returns:

• (String)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#end_date ⇒ Time

The date the credit expires, as Unix epoch seconds.

Returns:

• (Time)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_amount ⇒ Types::Amount

The estimated remaining balance, including in-flight (open) bills that have not yet been finalized.

Returns:

• (Types::Amount)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#exhaust_date ⇒ Time

The date the credit balance reached zero, as Unix epoch seconds.

Returns:

• (Time)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#initial_amount ⇒ Types::Amount

The initial amount of the credit when it was issued.

Returns:

• (Types::Amount)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#purchase_type_applications ⇒ Array<String>

Restricts which purchase types this credit applies to. When null or omitted, the credit applies to all purchase types.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#remaining_amount ⇒ Types::Amount

The unused balance of the credit.

Returns:

• (Types::Amount)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#rule_name ⇒ String

The rule name within the Cost Category. Present only when creditSharingType is COST_CATEGORY_RULE.

Returns:

• (String)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#shareable_accounts ⇒ Array<String>

The Amazon Web Services account IDs entitled to apply this credit.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end

#start_date ⇒ Time

The date the credit becomes valid, as Unix epoch seconds.

Returns:

• (Time)

# File 'lib/aws-sdk-billing/types.rb', line 619

class CreditData < Struct.new(
  :credit_id,
  :account_id,
  :credit_type,
  :initial_amount,
  :remaining_amount,
  :estimated_amount,
  :applicable_product_names,
  :description,
  :start_date,
  :end_date,
  :exhaust_date,
  :application_type,
  :shareable_accounts,
  :account_has_credit_sharing_enabled,
  :credit_console_visibility,
  :credit_sharing_type,
  :cost_category_arn,
  :rule_name,
  :credit_status,
  :purchase_type_applications)
  SENSITIVE = []
  include Aws::Structure
end