Class: Aws::PartnerCentralSelling::Types::GetResourceSnapshotJobResponse

Inherits:

Struct

• Object
• Struct
• Aws::PartnerCentralSelling::Types::GetResourceSnapshotJobResponse

Includes:

Structure

Defined in:

lib/aws-sdk-partnercentralselling/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  he Amazon Resource Name (ARN) of the snapshot job.

• #catalog ⇒ String

  The catalog in which the snapshot job was created.

• #created_at ⇒ Time

  The date and time when the snapshot job was created, in ISO 8601 format (UTC).

• #engagement_id ⇒ String

  The identifier of the engagement associated with this snapshot job.

• #id ⇒ String

  The unique identifier of the snapshot job.

• #last_failure ⇒ String

  If the job has encountered any failures, this field contains the error message from the most recent failure.

• #last_successful_execution_date ⇒ Time

  The date and time of the last successful execution of the job, in ISO 8601 format (UTC).

• #resource_arn ⇒ String

  The Amazon Resource Name (ARN) of the resource being snapshotted.

• #resource_id ⇒ String

  The identifier of the specific resource being snapshotted.

• #resource_snapshot_template_name ⇒ String

  The name of the template used for creating the snapshot.

• #resource_type ⇒ String

  The type of resource being snapshotted.

• #status ⇒ String

  The current status of the snapshot job.

Instance Attribute Details

#arn ⇒ String

he Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.

Returns:

• (String)

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

class GetResourceSnapshotJobResponse < Struct.new(
  :arn,
  :catalog,
  :created_at,
  :engagement_id,
  :id,
  :last_failure,
  :last_successful_execution_date,
  :resource_arn,
  :resource_id,
  :resource_snapshot_template_name,
  :resource_type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#catalog ⇒ String

The catalog in which the snapshot job was created. This will match the catalog specified in the request.

Returns:

• (String)

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

class GetResourceSnapshotJobResponse < Struct.new(
  :arn,
  :catalog,
  :created_at,
  :engagement_id,
  :id,
  :last_failure,
  :last_successful_execution_date,
  :resource_arn,
  :resource_id,
  :resource_snapshot_template_name,
  :resource_type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time when the snapshot job was created, in ISO 8601 format (UTC). Example: “2023-05-01T20:37:46Z”

Returns:

• (Time)

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

class GetResourceSnapshotJobResponse < Struct.new(
  :arn,
  :catalog,
  :created_at,
  :engagement_id,
  :id,
  :last_failure,
  :last_successful_execution_date,
  :resource_arn,
  :resource_id,
  :resource_snapshot_template_name,
  :resource_type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#engagement_id ⇒ String

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

Returns:

• (String)

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

class GetResourceSnapshotJobResponse < Struct.new(
  :arn,
  :catalog,
  :created_at,
  :engagement_id,
  :id,
  :last_failure,
  :last_successful_execution_date,
  :resource_arn,
  :resource_id,
  :resource_snapshot_template_name,
  :resource_type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier of the snapshot job. This matches the ‘ResourceSnapshotJobIdentifier` provided in the request.

Returns:

• (String)

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

class GetResourceSnapshotJobResponse < Struct.new(
  :arn,
  :catalog,
  :created_at,
  :engagement_id,
  :id,
  :last_failure,
  :last_successful_execution_date,
  :resource_arn,
  :resource_id,
  :resource_snapshot_template_name,
  :resource_type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#last_failure ⇒ String

If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.

Returns:

• (String)

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

class GetResourceSnapshotJobResponse < Struct.new(
  :arn,
  :catalog,
  :created_at,
  :engagement_id,
  :id,
  :last_failure,
  :last_successful_execution_date,
  :resource_arn,
  :resource_id,
  :resource_snapshot_template_name,
  :resource_type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#last_successful_execution_date ⇒ Time

The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: “2023-05-01T20:37:46Z”

Returns:

• (Time)

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

class GetResourceSnapshotJobResponse < Struct.new(
  :arn,
  :catalog,
  :created_at,
  :engagement_id,
  :id,
  :last_failure,
  :last_successful_execution_date,
  :resource_arn,
  :resource_id,
  :resource_snapshot_template_name,
  :resource_type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.

Returns:

• (String)

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

class GetResourceSnapshotJobResponse < Struct.new(
  :arn,
  :catalog,
  :created_at,
  :engagement_id,
  :id,
  :last_failure,
  :last_successful_execution_date,
  :resource_arn,
  :resource_id,
  :resource_snapshot_template_name,
  :resource_type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_id ⇒ String

The identifier of the specific resource being snapshotted. The format may vary depending on the ‘ResourceType`.

Returns:

• (String)

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

class GetResourceSnapshotJobResponse < Struct.new(
  :arn,
  :catalog,
  :created_at,
  :engagement_id,
  :id,
  :last_failure,
  :last_successful_execution_date,
  :resource_arn,
  :resource_id,
  :resource_snapshot_template_name,
  :resource_type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_snapshot_template_name ⇒ String

The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.

Returns:

• (String)

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

class GetResourceSnapshotJobResponse < Struct.new(
  :arn,
  :catalog,
  :created_at,
  :engagement_id,
  :id,
  :last_failure,
  :last_successful_execution_date,
  :resource_arn,
  :resource_id,
  :resource_snapshot_template_name,
  :resource_type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The type of resource being snapshotted. This would have ‘Opportunity` as a value as it is dependent on the supported resource type.

Returns:

• (String)

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

class GetResourceSnapshotJobResponse < Struct.new(
  :arn,
  :catalog,
  :created_at,
  :engagement_id,
  :id,
  :last_failure,
  :last_successful_execution_date,
  :resource_arn,
  :resource_id,
  :resource_snapshot_template_name,
  :resource_type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the snapshot job. Valid values:

• STOPPED: The job is not currently running.

• RUNNING: The job is actively executing.

Returns:

• (String)

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

class GetResourceSnapshotJobResponse < Struct.new(
  :arn,
  :catalog,
  :created_at,
  :engagement_id,
  :id,
  :last_failure,
  :last_successful_execution_date,
  :resource_arn,
  :resource_id,
  :resource_snapshot_template_name,
  :resource_type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end