Skip to content

GetDeploymentResponse

Source code in docs_src/capo_greengrassv2/types/get_deployment_response.py
class GetDeploymentResponse(TypedDict, closed=True):
    target_arn: NotRequired["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>"""
    revision_id: NotRequired["capo_greengrassv2.types.non_empty_string.NonEmptyString"]
    """<p>The revision number of the deployment.</p>"""
    deployment_id: NotRequired[
        "capo_greengrassv2.types.non_empty_string.NonEmptyString"
    ]
    """<p>The ID of the deployment.</p>"""
    deployment_name: NotRequired[
        "capo_greengrassv2.types.nullable_string.NullableString"
    ]
    """<p>The name of the deployment.</p>"""
    deployment_status: NotRequired[
        "capo_greengrassv2.types.deployment_status.DeploymentStatus"
    ]
    """<p>The status of the deployment.</p>"""
    iot_job_id: NotRequired["capo_greengrassv2.types.nullable_string.NullableString"]
    """<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>"""
    components: NotRequired[
        "capo_greengrassv2.types.component_deployment_specifications.ComponentDeploymentSpecifications"
    ]
    """<p>The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.</p>"""
    deployment_policies: NotRequired[
        "capo_greengrassv2.types.deployment_policies.DeploymentPolicies"
    ]
    """<p>The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.</p>"""
    iot_job_configuration: NotRequired[
        "capo_greengrassv2.types.deployment_io_t_job_configuration.DeploymentIoTJobConfiguration"
    ]
    """<p>The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.</p>"""
    creation_timestamp: NotRequired["capo_greengrassv2.types.timestamp.Timestamp"]
    """<p>The time at which the deployment was created, expressed in ISO 8601 format.</p>"""
    is_latest_for_target: (
        "capo_greengrassv2.types.is_latest_for_target.IsLatestForTarget"
    )
    """<p>Whether or not the deployment is the latest revision for its target.</p>"""
    parent_target_arn: NotRequired[
        "capo_greengrassv2.types.thing_group_arn.ThingGroupARN"
    ]
    """<p>The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.</p>"""
    tags: NotRequired["capo_greengrassv2.types.tag_map.TagMap"]
    """<p>A list of key-value pairs that contain metadata for the resource. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>"""

components instance-attribute

components: NotRequired[ComponentDeploymentSpecifications]

The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

creation_timestamp instance-attribute

creation_timestamp: NotRequired[Timestamp]

The time at which the deployment was created, expressed in ISO 8601 format.

deployment_id instance-attribute

deployment_id: NotRequired[NonEmptyString]

The ID of the deployment.

deployment_name instance-attribute

deployment_name: NotRequired[NullableString]

The name of the deployment.

deployment_policies instance-attribute

deployment_policies: NotRequired[DeploymentPolicies]

The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

deployment_status instance-attribute

deployment_status: NotRequired[DeploymentStatus]

The status of the deployment.

iot_job_arn instance-attribute

iot_job_arn: NotRequired[IoTJobARN]

The ARN of the IoT job that applies the deployment to target devices.

iot_job_configuration instance-attribute

iot_job_configuration: NotRequired[DeploymentIoTJobConfiguration]

The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

iot_job_id instance-attribute

iot_job_id: NotRequired[NullableString]

The ID of the IoT job that applies the deployment to target devices.

is_latest_for_target instance-attribute

is_latest_for_target: IsLatestForTarget

Whether or not the deployment is the latest revision for its target.

parent_target_arn instance-attribute

parent_target_arn: NotRequired[ThingGroupARN]

The parent deployment's target ARN within a subdeployment.

revision_id instance-attribute

revision_id: NotRequired[NonEmptyString]

The revision number of the deployment.

tags instance-attribute

tags: NotRequired[TagMap]

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

target_arn instance-attribute

target_arn: NotRequired[TargetARN]

The ARN of the target IoT thing or thing group.