Skip to content

UpdateJobRequest

Source code in docs_src/capo_snowball/types/update_job_request.py
class UpdateJobRequest(TypedDict, closed=True):
    job_id: "capo_snowball.types.job_id.JobId"
    """<p>The job ID of the job that you want to update, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>"""
    role_arn: NotRequired["capo_snowball.types.role_arn.RoleARN"]
    """<p>The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a>Identity and Access Management (IAM) API action.</p>"""
    notification: NotRequired["capo_snowball.types.notification.Notification"]
    """<p>The new or updated <a>Notification</a> object.</p>"""
    resources: NotRequired["capo_snowball.types.job_resource.JobResource"]
    """<p>The updated <code>JobResource</code> object, or the updated <a>JobResource</a> object. </p>"""
    on_device_service_configuration: NotRequired[
        "capo_snowball.types.on_device_service_configuration.OnDeviceServiceConfiguration"
    ]
    """<p>Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.</p>"""
    address_id: NotRequired["capo_snowball.types.address_id.AddressId"]
    """<p>The ID of the updated <a>Address</a> object.</p>"""
    shipping_option: NotRequired["capo_snowball.types.shipping_option.ShippingOption"]
    """<p>The updated shipping option value of this job's <a>ShippingDetails</a> object.</p>"""
    description: NotRequired["capo_snowball.types.string.String"]
    """<p>The updated description of this job's <a>JobMetadata</a> object.</p>"""
    snowball_capacity_preference: NotRequired[
        "capo_snowball.types.snowball_capacity.SnowballCapacity"
    ]
    """<p>The updated <code>SnowballCapacityPreference</code> of this job's <a>JobMetadata</a> object. The 50 TB Snowballs are only available in the US regions.</p> <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>"""
    forwarding_address_id: NotRequired["capo_snowball.types.address_id.AddressId"]
    """<p>The updated ID for the forwarding address for a job. This field is not supported in most regions.</p>"""
    pickup_details: NotRequired["capo_snowball.types.pickup_details.PickupDetails"]

address_id instance-attribute

address_id: NotRequired[AddressId]

The ID of the updated Address object.

description instance-attribute

description: NotRequired[String]

The updated description of this job's JobMetadata object.

forwarding_address_id instance-attribute

forwarding_address_id: NotRequired[AddressId]

The updated ID for the forwarding address for a job. This field is not supported in most regions.

job_id instance-attribute

job_id: JobId

The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

notification instance-attribute

notification: NotRequired[Notification]

The new or updated Notification object.

on_device_service_configuration instance-attribute

on_device_service_configuration: NotRequired[OnDeviceServiceConfiguration]

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.

pickup_details instance-attribute

pickup_details: NotRequired[PickupDetails]

resources instance-attribute

resources: NotRequired[JobResource]

The updated JobResource object, or the updated JobResource object.

role_arn instance-attribute

role_arn: NotRequired[RoleARN]

The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleIdentity and Access Management (IAM) API action.

shipping_option instance-attribute

shipping_option: NotRequired[ShippingOption]

The updated shipping option value of this job's ShippingDetails object.

snowball_capacity_preference instance-attribute

snowball_capacity_preference: NotRequired[SnowballCapacity]

The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.