Class: Aws::PartnerCentralBenefits::Types::GetBenefitOutput

Inherits:

Struct

• Object
• Struct
• Aws::PartnerCentralBenefits::Types::GetBenefitOutput

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the benefit.

• #benefit_request_schema ⇒ Hash, ...

  The schema definition that describes the required fields for requesting this benefit.

• #catalog ⇒ String

  The catalog identifier that the benefit belongs to.

• #description ⇒ String

  A detailed description of the benefit and its purpose.

• #fulfillment_types ⇒ Array<String>

  The available fulfillment types for this benefit (e.g., credits, access, disbursement).

• #id ⇒ String

  The unique identifier of the benefit.

• #name ⇒ String

  The human-readable name of the benefit.

• #programs ⇒ Array<String>

  The AWS partner programs that this benefit is associated with.

• #status ⇒ String

  The current status of the benefit (e.g., active, inactive, deprecated).

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the benefit.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 1159

class GetBenefitOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :programs,
  :fulfillment_types,
  :benefit_request_schema,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#benefit_request_schema ⇒ Hash, ...

The schema definition that describes the required fields for requesting this benefit.

Returns:

• (Hash, Array, String, Numeric, Boolean)

# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 1159

class GetBenefitOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :programs,
  :fulfillment_types,
  :benefit_request_schema,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#catalog ⇒ String

The catalog identifier that the benefit belongs to.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 1159

class GetBenefitOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :programs,
  :fulfillment_types,
  :benefit_request_schema,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A detailed description of the benefit and its purpose.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 1159

class GetBenefitOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :programs,
  :fulfillment_types,
  :benefit_request_schema,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#fulfillment_types ⇒ Array<String>

The available fulfillment types for this benefit (e.g., credits, access, disbursement).

Returns:

• (Array<String>)

# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 1159

class GetBenefitOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :programs,
  :fulfillment_types,
  :benefit_request_schema,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier of the benefit.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 1159

class GetBenefitOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :programs,
  :fulfillment_types,
  :benefit_request_schema,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The human-readable name of the benefit.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 1159

class GetBenefitOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :programs,
  :fulfillment_types,
  :benefit_request_schema,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#programs ⇒ Array<String>

The AWS partner programs that this benefit is associated with.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 1159

class GetBenefitOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :programs,
  :fulfillment_types,
  :benefit_request_schema,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the benefit (e.g., active, inactive, deprecated).

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralbenefits/lib/aws-sdk-partnercentralbenefits/types.rb', line 1159

class GetBenefitOutput < Struct.new(
  :id,
  :catalog,
  :arn,
  :name,
  :description,
  :programs,
  :fulfillment_types,
  :benefit_request_schema,
  :status)
  SENSITIVE = []
  include Aws::Structure
end