Skip to content

GetResourceSnapshotJobResponse

Source code in docs_src/capo_partnercentral_selling/types/get_resource_snapshot_job_response.py
class GetResourceSnapshotJobResponse(TypedDict, closed=True):
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier"
    """<p>The catalog in which the snapshot job was created. This will match the Catalog specified in the request. </p>"""
    id: NotRequired[
        "capo_partnercentral_selling.types.resource_snapshot_job_identifier.ResourceSnapshotJobIdentifier"
    ]
    """<p>The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request. </p>"""
    arn: NotRequired[
        "capo_partnercentral_selling.types.resource_snapshot_job_arn.ResourceSnapshotJobArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services. </p>"""
    engagement_id: NotRequired[
        "capo_partnercentral_selling.types.engagement_identifier.EngagementIdentifier"
    ]
    """<p>The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context. </p>"""
    resource_type: NotRequired[
        "capo_partnercentral_selling.types.resource_type.ResourceType"
    ]
    """<p>The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.</p>"""
    resource_id: NotRequired[
        "capo_partnercentral_selling.types.resource_identifier.ResourceIdentifier"
    ]
    """<p>The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType. </p>"""
    resource_arn: NotRequired[
        "capo_partnercentral_selling.types.resource_arn.ResourceArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS. </p>"""
    resource_snapshot_template_name: NotRequired[
        "capo_partnercentral_selling.types.resource_template_name.ResourceTemplateName"
    ]
    """<p>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.</p>"""
    created_at: NotRequired["capo_partnercentral_selling.types.date_time.DateTime"]
    """<p>The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z" </p>"""
    status: NotRequired[
        "capo_partnercentral_selling.types.resource_snapshot_job_status.ResourceSnapshotJobStatus"
    ]
    """<p>The current status of the snapshot job. Valid values:</p> <ul> <li> <p>STOPPED: The job is not currently running.</p> </li> <li> <p>RUNNING: The job is actively executing.</p> </li> </ul>"""
    last_successful_execution_date: NotRequired[
        "capo_partnercentral_selling.types.date_time.DateTime"
    ]
    """<p>The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z" </p>"""
    last_failure: NotRequired["str"]
    """<p>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. </p>"""

arn instance-attribute

arn: NotRequired[ResourceSnapshotJobArn]

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

catalog instance-attribute

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

created_at instance-attribute

created_at: NotRequired[DateTime]

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

engagement_id instance-attribute

engagement_id: NotRequired[EngagementIdentifier]

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

id instance-attribute

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

last_failure instance-attribute

last_failure: NotRequired[str]

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.

last_successful_execution_date instance-attribute

last_successful_execution_date: NotRequired[DateTime]

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

resource_arn instance-attribute

resource_arn: NotRequired[ResourceArn]

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

resource_id instance-attribute

resource_id: NotRequired[ResourceIdentifier]

The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.

resource_snapshot_template_name instance-attribute

resource_snapshot_template_name: NotRequired[ResourceTemplateName]

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.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

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

status instance-attribute

status: NotRequired[ResourceSnapshotJobStatus]

The current status of the snapshot job. Valid values:

  • STOPPED: The job is not currently running.

  • RUNNING: The job is actively executing.