Class: Aws::PartnerCentralSelling::Types::CreateEngagementContextRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog ⇒ String

Specifies the catalog associated with the engagement context request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is created in. Use AWS to create contexts in the production environment, and Sandbox for testing in secure, isolated environments.

Returns:

  • (String) 


924
925
926
927
928
929
930
931
932
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 924

class CreateEngagementContextRequest < Struct.new(
  :catalog,
  :engagement_identifier,
  :client_token,
  :type,
  :payload)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier provided by the client to ensure that the request is handled exactly once. This token helps prevent duplicate context creations and must not exceed sixty-four alphanumeric characters. Use a UUID or other unique string to ensure idempotency.

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

Returns:

  • (String) 


924
925
926
927
928
929
930
931
932
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 924

class CreateEngagementContextRequest < Struct.new(
  :catalog,
  :engagement_identifier,
  :client_token,
  :type,
  :payload)
  SENSITIVE = []
  include Aws::Structure
end

#engagement_identifier ⇒ String

The unique identifier of the Engagement for which the context is being created. This parameter ensures the context is associated with the correct engagement and provides the necessary linkage between the engagement and its contextual information.

Returns:

  • (String) 


924
925
926
927
928
929
930
931
932
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 924

class CreateEngagementContextRequest < Struct.new(
  :catalog,
  :engagement_identifier,
  :client_token,
  :type,
  :payload)
  SENSITIVE = []
  include Aws::Structure
end

#payload ⇒ Types::EngagementContextPayload

Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails.

Returns:



924
925
926
927
928
929
930
931
932
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 924

class CreateEngagementContextRequest < Struct.new(
  :catalog,
  :engagement_identifier,
  :client_token,
  :type,
  :payload)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

Specifies the type of context being created for the engagement. This field determines the structure and content of the context payload. Valid values include CustomerProject for customer project-related contexts. The type field ensures that the context is properly categorized and processed according to its intended purpose.

Returns:

  • (String) 


924
925
926
927
928
929
930
931
932
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 924

class CreateEngagementContextRequest < Struct.new(
  :catalog,
  :engagement_identifier,
  :client_token,
  :type,
  :payload)
  SENSITIVE = []
  include Aws::Structure
end