Class: Aws::PartnerCentralBenefits::Types::GetBenefitAllocationOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#applicable_benefit_ids ⇒ Array<String>

A list of benefit identifiers that this allocation can be applied to.

Returns:

  • (Array<String>) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the benefit allocation.

Returns:

  • (String) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#benefit_application_id ⇒ String

The identifier of the benefit application that resulted in this allocation.

Returns:

  • (String) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#benefit_id ⇒ String

The identifier of the benefit that this allocation is based on.

Returns:

  • (String) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#catalog ⇒ String

The catalog identifier that the benefit allocation belongs to.

Returns:

  • (String) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp when the benefit allocation was created.

Returns:

  • (Time) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A detailed description of the benefit allocation.

Returns:

  • (String) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#expires_at ⇒ Time

The timestamp when the benefit allocation expires and is no longer usable.

Returns:

  • (Time) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#fulfillment_detail ⇒ Types::FulfillmentDetails

Detailed information about how the benefit allocation is fulfilled.

Returns:



950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#fulfillment_type ⇒ String

The fulfillment type used for this benefit allocation.

Returns:

  • (String) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier of the benefit allocation.

Returns:

  • (String) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The human-readable name of the benefit allocation.

Returns:

  • (String) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#starts_at ⇒ Time

The timestamp when the benefit allocation becomes active and usable.

Returns:

  • (Time) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the benefit allocation (e.g., active, expired, consumed).

Returns:

  • (String) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

Additional information explaining the current status of the benefit allocation.

Returns:

  • (String) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The timestamp when the benefit allocation was last updated.

Returns:

  • (Time) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 950

class GetBenefitAllocationOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :status,
  :status_reason,
  :benefit_application_id,
  :benefit_id,
  :fulfillment_type,
  :applicable_benefit_ids,
  :fulfillment_detail,
  :created_at,
  :updated_at,
  :starts_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end