Class: Aws::PartnerCentralSelling::Types::CreateResourceSnapshotJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::PartnerCentralSelling::Types::CreateResourceSnapshotJobRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #catalog ⇒ String

  Specifies the catalog in which to create the snapshot job.

• #client_token ⇒ String

  A client-generated UUID used for idempotency check.

• #engagement_identifier ⇒ String

  Specifies the identifier of the engagement associated with the resource to be snapshotted.

• #resource_identifier ⇒ String

  Specifies the identifier of the specific resource to be snapshotted.

• #resource_snapshot_template_identifier ⇒ String

  Specifies the name of the template that defines the schema for the snapshot.

• #resource_type ⇒ String

  The type of resource for which the snapshot job is being created.

• #tags ⇒ Array<Types::Tag>

  A map of the key-value pairs of the tag or tags to assign.

Instance Attribute Details

#catalog ⇒ String

Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.

Returns:

• (String)

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

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

#client_token ⇒ String

A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.

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

Returns:

• (String)

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

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

#engagement_identifier ⇒ String

Specifies the identifier of the engagement associated with the resource to be snapshotted.

Returns:

• (String)

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

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

#resource_identifier ⇒ String

Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.

Returns:

• (String)

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

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

#resource_snapshot_template_identifier ⇒ String

Specifies the name of the template that defines the schema for the snapshot.

Returns:

• (String)

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

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

#resource_type ⇒ String

The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity

Returns:

• (String)

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

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

#tags ⇒ Array<Types::Tag>

A map of the key-value pairs of the tag or tags to assign.

Returns:

• (Array<Types::Tag>)

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

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