Class: Aws::PartnerCentralSelling::Types::CreateResourceSnapshotRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalogString

Specifies the catalog where the snapshot is created. Valid values are ‘AWS` and `Sandbox`.

Returns:

  • (String)


1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-partnercentralselling/types.rb', line 1080

class CreateResourceSnapshotRequest < Struct.new(
  :catalog,
  :client_token,
  :engagement_identifier,
  :resource_identifier,
  :resource_snapshot_template_identifier,
  :resource_type)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations.

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

Returns:

  • (String)


1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-partnercentralselling/types.rb', line 1080

class CreateResourceSnapshotRequest < Struct.new(
  :catalog,
  :client_token,
  :engagement_identifier,
  :resource_identifier,
  :resource_snapshot_template_identifier,
  :resource_type)
  SENSITIVE = []
  include Aws::Structure
end

#engagement_identifierString

The unique identifier of the engagement associated with this snapshot. This field links the snapshot to a specific engagement context.

Returns:

  • (String)


1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-partnercentralselling/types.rb', line 1080

class CreateResourceSnapshotRequest < Struct.new(
  :catalog,
  :client_token,
  :engagement_identifier,
  :resource_identifier,
  :resource_snapshot_template_identifier,
  :resource_type)
  SENSITIVE = []
  include Aws::Structure
end

#resource_identifierString

The unique identifier of the specific resource to be snapshotted. The format and constraints of this identifier depend on the ‘ResourceType` specified. For example: For `Opportunity` type, it will be an opportunity ID.

Returns:

  • (String)


1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-partnercentralselling/types.rb', line 1080

class CreateResourceSnapshotRequest < Struct.new(
  :catalog,
  :client_token,
  :engagement_identifier,
  :resource_identifier,
  :resource_snapshot_template_identifier,
  :resource_type)
  SENSITIVE = []
  include Aws::Structure
end

#resource_snapshot_template_identifierString

The name of the template that defines the schema for the snapshot. This template determines which subset of the resource data will be included in the snapshot. Must correspond to an existing and valid template for the specified ‘ResourceType`.

Returns:

  • (String)


1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-partnercentralselling/types.rb', line 1080

class CreateResourceSnapshotRequest < Struct.new(
  :catalog,
  :client_token,
  :engagement_identifier,
  :resource_identifier,
  :resource_snapshot_template_identifier,
  :resource_type)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

Specifies the type of resource for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: ‘Opportunity`.

Returns:

  • (String)


1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/aws-sdk-partnercentralselling/types.rb', line 1080

class CreateResourceSnapshotRequest < Struct.new(
  :catalog,
  :client_token,
  :engagement_identifier,
  :resource_identifier,
  :resource_snapshot_template_identifier,
  :resource_type)
  SENSITIVE = []
  include Aws::Structure
end