/AWS1/CL_PTSGETRESRCSNAPJOBRSP¶
GetResourceSnapshotJobResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_catalog TYPE /AWS1/PTSCATALOGIDENTIFIER /AWS1/PTSCATALOGIDENTIFIER¶
The catalog in which the snapshot job was created. This will match the Catalog specified in the request.
Optional arguments:¶
iv_id TYPE /AWS1/PTSRESOURCESNAPSHOTJOBID /AWS1/PTSRESOURCESNAPSHOTJOBID¶
The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.
iv_arn TYPE /AWS1/PTSRESOURCESNAPJOBARN /AWS1/PTSRESOURCESNAPJOBARN¶
The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.
iv_engagementid TYPE /AWS1/PTSENGAGEMENTIDENTIFIER /AWS1/PTSENGAGEMENTIDENTIFIER¶
The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.
iv_resourcetype TYPE /AWS1/PTSRESOURCETYPE /AWS1/PTSRESOURCETYPE¶
The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.
iv_resourceid TYPE /AWS1/PTSRESOURCEIDENTIFIER /AWS1/PTSRESOURCEIDENTIFIER¶
The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.
iv_resourcearn TYPE /AWS1/PTSRESOURCEARN /AWS1/PTSRESOURCEARN¶
The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.
iv_resourcesnaptemplatename TYPE /AWS1/PTSRESOURCETEMPLATENAME /AWS1/PTSRESOURCETEMPLATENAME¶
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.
iv_createdat TYPE /AWS1/PTSDATETIME /AWS1/PTSDATETIME¶
The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"
iv_status TYPE /AWS1/PTSRESOURCESNAPJOBSTATUS /AWS1/PTSRESOURCESNAPJOBSTATUS¶
The current status of the snapshot job. Valid values:
STOPPED: The job is not currently running.
RUNNING: The job is actively executing.
iv_lastsuccessfulexecdate TYPE /AWS1/PTSDATETIME /AWS1/PTSDATETIME¶
The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"
iv_lastfailure TYPE /AWS1/PTSSTRING /AWS1/PTSSTRING¶
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.
Queryable Attributes¶
Catalog¶
The catalog in which the snapshot job was created. This will match the Catalog specified in the request.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CATALOG() |
Getter for CATALOG, with configurable default |
ASK_CATALOG() |
Getter for CATALOG w/ exceptions if field has no value |
HAS_CATALOG() |
Determine if CATALOG has a value |
Id¶
The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
Arn¶
The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
EngagementId¶
The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENGAGEMENTID() |
Getter for ENGAGEMENTID, with configurable default |
ASK_ENGAGEMENTID() |
Getter for ENGAGEMENTID w/ exceptions if field has no value |
HAS_ENGAGEMENTID() |
Determine if ENGAGEMENTID has a value |
ResourceType¶
The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCETYPE() |
Getter for RESOURCETYPE, with configurable default |
ASK_RESOURCETYPE() |
Getter for RESOURCETYPE w/ exceptions if field has no value |
HAS_RESOURCETYPE() |
Determine if RESOURCETYPE has a value |
ResourceId¶
The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCEID() |
Getter for RESOURCEID, with configurable default |
ASK_RESOURCEID() |
Getter for RESOURCEID w/ exceptions if field has no value |
HAS_RESOURCEID() |
Determine if RESOURCEID has a value |
ResourceArn¶
The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCEARN() |
Getter for RESOURCEARN, with configurable default |
ASK_RESOURCEARN() |
Getter for RESOURCEARN w/ exceptions if field has no value |
HAS_RESOURCEARN() |
Determine if RESOURCEARN has a value |
ResourceSnapshotTemplateName¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCESNAPTEMPLATENAME() |
Getter for RESOURCESNAPSHOTTEMPLATENAME, with configurable d |
ASK_RESOURCESNAPTEMPLATENAME() |
Getter for RESOURCESNAPSHOTTEMPLATENAME w/ exceptions if fie |
HAS_RESOURCESNAPTEMPLATENAME() |
Determine if RESOURCESNAPSHOTTEMPLATENAME has a value |
CreatedAt¶
The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
Status¶
The current status of the snapshot job. Valid values:
STOPPED: The job is not currently running.
RUNNING: The job is actively executing.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
LastSuccessfulExecutionDate¶
The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTSUCCESSFULEXECDATE() |
Getter for LASTSUCCESSFULEXECUTIONDATE, with configurable de |
ASK_LASTSUCCESSFULEXECDATE() |
Getter for LASTSUCCESSFULEXECUTIONDATE w/ exceptions if fiel |
HAS_LASTSUCCESSFULEXECDATE() |
Determine if LASTSUCCESSFULEXECUTIONDATE has a value |
LastFailure¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTFAILURE() |
Getter for LASTFAILURE, with configurable default |
ASK_LASTFAILURE() |
Getter for LASTFAILURE w/ exceptions if field has no value |
HAS_LASTFAILURE() |
Determine if LASTFAILURE has a value |