Class: Aws::PartnerCentralSelling::Types::StartProspectingFromEngagementTaskRequest

Inherits:

Struct

• Object
• Struct
• Aws::PartnerCentralSelling::Types::StartProspectingFromEngagementTaskRequest

Includes:

Structure

Defined in:

lib/aws-sdk-partnercentralselling/types.rb

Overview

Represents the request structure for starting a prospecting task. Includes up to 100 engagement identifiers and a task name. Uses ‘ClientToken` to ensure idempotency.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #catalog ⇒ String

  Specifies the catalog in which the task is initiated.

• #client_token ⇒ String

  A unique, case-sensitive identifier provided by the client to ensure idempotency.

• #identifiers ⇒ Array<String>

  The list of engagement identifiers to include in this prospecting task.

• #task_name ⇒ String

  A descriptive name for the task.

Instance Attribute Details

#catalog ⇒ String

Specifies the catalog in which the task is initiated. Specify ‘AWS` for production environments and `Sandbox` for testing and development purposes.

Returns:

• (String)

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

class StartProspectingFromEngagementTaskRequest < Struct.new(
  :catalog,
  :identifiers,
  :task_name,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier provided by the client to ensure idempotency. Making the same request with the same ‘ClientToken` returns the same response without creating a duplicate task.

**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 6959

class StartProspectingFromEngagementTaskRequest < Struct.new(
  :catalog,
  :identifiers,
  :task_name,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#identifiers ⇒ Array<String>

The list of engagement identifiers to include in this prospecting task. Each identifier must correspond to an existing engagement in the specified catalog. Maximum of 100 identifiers per task.

Returns:

• (Array<String>)

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

class StartProspectingFromEngagementTaskRequest < Struct.new(
  :catalog,
  :identifiers,
  :task_name,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#task_name ⇒ String

A descriptive name for the task. This name helps identify the task in list and get operations. The name must contain 1 to 128 characters.

Returns:

• (String)

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

class StartProspectingFromEngagementTaskRequest < Struct.new(
  :catalog,
  :identifiers,
  :task_name,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end