Class: Aws::PartnerCentralSelling::Types::GetEngagementResponse

Inherits:

Struct

• Object
• Struct
• Aws::PartnerCentralSelling::Types::GetEngagementResponse

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:created_by, :modified_by]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the engagement retrieved.

• #contexts ⇒ Array<Types::EngagementContextDetails>

  A list of context objects associated with the engagement.

• #created_at ⇒ Time

  The date and time when the Engagement was created, presented in ISO 8601 format (UTC).

• #created_by ⇒ String

  The AWS account ID of the user who originally created the engagement.

• #description ⇒ String

  A more detailed description of the engagement.

• #id ⇒ String

  The unique resource identifier of the engagement retrieved.

• #member_count ⇒ Integer

  Specifies the current count of members participating in the Engagement.

• #modified_at ⇒ Time

  The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC).

• #modified_by ⇒ String

  The AWS account ID of the user who last modified the engagement.

• #title ⇒ String

  The title of the engagement.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the engagement retrieved.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 2400

class GetEngagementResponse < Struct.new(
  :id,
  :arn,
  :title,
  :description,
  :created_at,
  :created_by,
  :member_count,
  :modified_at,
  :modified_by,
  :contexts)
  SENSITIVE = [:created_by, :modified_by]
  include Aws::Structure
end

#contexts ⇒ Array<Types::EngagementContextDetails>

A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

Returns:

• (Array<Types::EngagementContextDetails>)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 2400

class GetEngagementResponse < Struct.new(
  :id,
  :arn,
  :title,
  :description,
  :created_at,
  :created_by,
  :member_count,
  :modified_at,
  :modified_by,
  :contexts)
  SENSITIVE = [:created_by, :modified_by]
  include Aws::Structure
end

#created_at ⇒ Time

The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.

Returns:

• (Time)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 2400

class GetEngagementResponse < Struct.new(
  :id,
  :arn,
  :title,
  :description,
  :created_at,
  :created_by,
  :member_count,
  :modified_at,
  :modified_by,
  :contexts)
  SENSITIVE = [:created_by, :modified_by]
  include Aws::Structure
end

#created_by ⇒ String

The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 2400

class GetEngagementResponse < Struct.new(
  :id,
  :arn,
  :title,
  :description,
  :created_at,
  :created_by,
  :member_count,
  :modified_at,
  :modified_by,
  :contexts)
  SENSITIVE = [:created_by, :modified_by]
  include Aws::Structure
end

#description ⇒ String

A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 2400

class GetEngagementResponse < Struct.new(
  :id,
  :arn,
  :title,
  :description,
  :created_at,
  :created_by,
  :member_count,
  :modified_at,
  :modified_by,
  :contexts)
  SENSITIVE = [:created_by, :modified_by]
  include Aws::Structure
end

#id ⇒ String

The unique resource identifier of the engagement retrieved.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 2400

class GetEngagementResponse < Struct.new(
  :id,
  :arn,
  :title,
  :description,
  :created_at,
  :created_by,
  :member_count,
  :modified_at,
  :modified_by,
  :contexts)
  SENSITIVE = [:created_by, :modified_by]
  include Aws::Structure
end

#member_count ⇒ Integer

Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.

Returns:

• (Integer)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 2400

class GetEngagementResponse < Struct.new(
  :id,
  :arn,
  :title,
  :description,
  :created_at,
  :created_by,
  :member_count,
  :modified_at,
  :modified_by,
  :contexts)
  SENSITIVE = [:created_by, :modified_by]
  include Aws::Structure
end

#modified_at ⇒ Time

The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z". This helps track the most recent changes to the engagement.

Returns:

• (Time)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 2400

class GetEngagementResponse < Struct.new(
  :id,
  :arn,
  :title,
  :description,
  :created_at,
  :created_by,
  :member_count,
  :modified_at,
  :modified_by,
  :contexts)
  SENSITIVE = [:created_by, :modified_by]
  include Aws::Structure
end

#modified_by ⇒ String

The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 2400

class GetEngagementResponse < Struct.new(
  :id,
  :arn,
  :title,
  :description,
  :created_at,
  :created_by,
  :member_count,
  :modified_at,
  :modified_by,
  :contexts)
  SENSITIVE = [:created_by, :modified_by]
  include Aws::Structure
end

#title ⇒ String

The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 2400

class GetEngagementResponse < Struct.new(
  :id,
  :arn,
  :title,
  :description,
  :created_at,
  :created_by,
  :member_count,
  :modified_at,
  :modified_by,
  :contexts)
  SENSITIVE = [:created_by, :modified_by]
  include Aws::Structure
end