Class: Aws::PartnerCentralSelling::Types::CreateEngagementRequest

Inherits:

Struct

• Object
• Struct
• Aws::PartnerCentralSelling::Types::CreateEngagementRequest

Includes:

Structure

Defined in:

lib/aws-sdk-partnercentralselling/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #catalog ⇒ String

  The ‘CreateEngagementRequest$Catalog` parameter specifies the catalog related to the engagement.

• #client_token ⇒ String

  The ‘CreateEngagementRequest$ClientToken` parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once.

• #contexts ⇒ Array<Types::EngagementContextDetails>

  The ‘Contexts` field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement.

• #description ⇒ String

  Provides a description of the ‘Engagement`.

• #title ⇒ String

  Specifies the title of the ‘Engagement`.

Instance Attribute Details

#catalog ⇒ String

The ‘CreateEngagementRequest$Catalog` parameter specifies the catalog related to the engagement. Accepted values are `AWS` and `Sandbox`, which determine the environment in which the engagement is managed.

Returns:

• (String)

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

class CreateEngagementRequest < Struct.new(
  :catalog,
  :client_token,
  :title,
  :description,
  :contexts)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

The ‘CreateEngagementRequest$ClientToken` parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

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

class CreateEngagementRequest < Struct.new(
  :catalog,
  :client_token,
  :title,
  :description,
  :contexts)
  SENSITIVE = []
  include Aws::Structure
end

#contexts ⇒ Array<Types::EngagementContextDetails>

The ‘Contexts` field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a `Type` field indicating the context type, which must be `CustomerProject` in this version, and a `Payload` field containing the `CustomerProject` details. The `CustomerProject` object is composed of two main components: `Customer` and `Project`. The `Customer` object includes information such as `CompanyName`, `WebsiteUrl`, `Industry`, and `CountryCode`, providing essential details about the customer. The `Project` object contains `Title`, `BusinessProblem`, and `TargetCompletionDate`, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.

Returns:

• (Array<Types::EngagementContextDetails>)

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

class CreateEngagementRequest < Struct.new(
  :catalog,
  :client_token,
  :title,
  :description,
  :contexts)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Provides a description of the ‘Engagement`.

Returns:

• (String)

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

class CreateEngagementRequest < Struct.new(
  :catalog,
  :client_token,
  :title,
  :description,
  :contexts)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

Specifies the title of the ‘Engagement`.

Returns:

• (String)

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

class CreateEngagementRequest < Struct.new(
  :catalog,
  :client_token,
  :title,
  :description,
  :contexts)
  SENSITIVE = []
  include Aws::Structure
end