EffectiveDeployment ¶

class EffectiveDeployment(TypedDict, closed=True):
    deployment_id: "capo_greengrassv2.types.deployment_id.DeploymentID"
    """<p>The ID of the deployment.</p>"""
    deployment_name: "capo_greengrassv2.types.deployment_name.DeploymentName"
    """<p>The name of the deployment.</p>"""
    iot_job_id: NotRequired["capo_greengrassv2.types.io_t_job_id.IoTJobId"]
    """<p>The ID of the IoT job that applies the deployment to target devices.</p>"""
    iot_job_arn: NotRequired["capo_greengrassv2.types.io_t_job_arn.IoTJobARN"]
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT job that applies the deployment to target devices.</p>"""
    description: NotRequired["capo_greengrassv2.types.description.Description"]
    """<p>The description of the deployment job.</p>"""
    target_arn: "capo_greengrassv2.types.target_arn.TargetARN"
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>"""
    core_device_execution_status: "capo_greengrassv2.types.effective_deployment_execution_status.EffectiveDeploymentExecutionStatus"
    """<p>The status of the deployment job on the Greengrass core device.</p> <ul> <li> <p> <code>IN_PROGRESS</code> – The deployment job is running.</p> </li> <li> <p> <code>QUEUED</code> – The deployment job is in the job queue and waiting to run.</p> </li> <li> <p> <code>FAILED</code> – The deployment failed. For more information, see the <code>statusDetails</code> field.</p> </li> <li> <p> <code>COMPLETED</code> – The deployment to an IoT thing was completed successfully.</p> </li> <li> <p> <code>TIMED_OUT</code> – The deployment didn't complete in the allotted time. </p> </li> <li> <p> <code>CANCELED</code> – The deployment was canceled by the user.</p> </li> <li> <p> <code>REJECTED</code> – The deployment was rejected. For more information, see the <code>statusDetails</code> field.</p> </li> <li> <p> <code>SUCCEEDED</code> – The deployment to an IoT thing group was completed successfully.</p> </li> </ul>"""
    reason: NotRequired["capo_greengrassv2.types.reason.Reason"]
    """<p>The reason code for the update, if the job was updated.</p>"""
    creation_timestamp: "capo_greengrassv2.types.timestamp.Timestamp"
    """<p>The time at which the deployment was created, expressed in ISO 8601 format.</p>"""
    modified_timestamp: "capo_greengrassv2.types.timestamp.Timestamp"
    """<p>The time at which the deployment job was last modified, expressed in ISO 8601 format.</p>"""
    status_details: NotRequired[
        "capo_greengrassv2.types.effective_deployment_status_details.EffectiveDeploymentStatusDetails"
    ]
    """<p>The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.</p>"""