Class: Aws::Snowball::Types::UpdateJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb

Overview

Note:

When making an API call, you may pass UpdateJobRequest data as a hash:

{
  job_id: "JobId", # required
  role_arn: "RoleARN",
  notification: {
    sns_topic_arn: "SnsTopicARN",
    job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWSSortingFacility, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
    notify_all: false,
  },
  resources: {
    s3_resources: [
      {
        bucket_arn: "ResourceARN",
        key_range: {
          begin_marker: "String",
          end_marker: "String",
        },
        target_on_device_services: [
          {
            service_name: "NFS_ON_DEVICE_SERVICE", # accepts NFS_ON_DEVICE_SERVICE, S3_ON_DEVICE_SERVICE
            transfer_option: "IMPORT", # accepts IMPORT, EXPORT, LOCAL_USE
          },
        ],
      },
    ],
    lambda_resources: [
      {
        lambda_arn: "ResourceARN",
        event_triggers: [
          {
            event_resource_arn: "ResourceARN",
          },
        ],
      },
    ],
    ec2_ami_resources: [
      {
        ami_id: "AmiId", # required
        snowball_ami_id: "String",
      },
    ],
  },
  on_device_service_configuration: {
    nfs_on_device_service: {
      storage_limit: 1,
      storage_unit: "TB", # accepts TB
    },
    tgw_on_device_service: {
      storage_limit: 1,
      storage_unit: "TB", # accepts TB
    },
  },
  address_id: "AddressId",
  shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
  description: "String",
  snowball_capacity_preference: "T50", # accepts T50, T80, T100, T42, T98, T8, T14, NoPreference
  forwarding_address_id: "AddressId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address_idString

The ID of the updated Address object.

Returns:

  • (String)


2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2916

class UpdateJobRequest < Struct.new(
  :job_id,
  :role_arn,
  :notification,
  :resources,
  :on_device_service_configuration,
  :address_id,
  :shipping_option,
  :description,
  :snowball_capacity_preference,
  :forwarding_address_id)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The updated description of this job's JobMetadata object.

Returns:

  • (String)


2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2916

class UpdateJobRequest < Struct.new(
  :job_id,
  :role_arn,
  :notification,
  :resources,
  :on_device_service_configuration,
  :address_id,
  :shipping_option,
  :description,
  :snowball_capacity_preference,
  :forwarding_address_id)
  SENSITIVE = []
  include Aws::Structure
end

#forwarding_address_idString

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

Returns:

  • (String)


2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2916

class UpdateJobRequest < Struct.new(
  :job_id,
  :role_arn,
  :notification,
  :resources,
  :on_device_service_configuration,
  :address_id,
  :shipping_option,
  :description,
  :snowball_capacity_preference,
  :forwarding_address_id)
  SENSITIVE = []
  include Aws::Structure
end

#job_idString

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

Returns:

  • (String)


2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2916

class UpdateJobRequest < Struct.new(
  :job_id,
  :role_arn,
  :notification,
  :resources,
  :on_device_service_configuration,
  :address_id,
  :shipping_option,
  :description,
  :snowball_capacity_preference,
  :forwarding_address_id)
  SENSITIVE = []
  include Aws::Structure
end

#notificationTypes::Notification

The new or updated Notification object.

Returns:



2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2916

class UpdateJobRequest < Struct.new(
  :job_id,
  :role_arn,
  :notification,
  :resources,
  :on_device_service_configuration,
  :address_id,
  :shipping_option,
  :description,
  :snowball_capacity_preference,
  :forwarding_address_id)
  SENSITIVE = []
  include Aws::Structure
end

#on_device_service_configurationTypes::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.



2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2916

class UpdateJobRequest < Struct.new(
  :job_id,
  :role_arn,
  :notification,
  :resources,
  :on_device_service_configuration,
  :address_id,
  :shipping_option,
  :description,
  :snowball_capacity_preference,
  :forwarding_address_id)
  SENSITIVE = []
  include Aws::Structure
end

#resourcesTypes::JobResource

The updated JobResource object, or the updated JobResource object.

Returns:



2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2916

class UpdateJobRequest < Struct.new(
  :job_id,
  :role_arn,
  :notification,
  :resources,
  :on_device_service_configuration,
  :address_id,
  :shipping_option,
  :description,
  :snowball_capacity_preference,
  :forwarding_address_id)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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.

Returns:

  • (String)


2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2916

class UpdateJobRequest < Struct.new(
  :job_id,
  :role_arn,
  :notification,
  :resources,
  :on_device_service_configuration,
  :address_id,
  :shipping_option,
  :description,
  :snowball_capacity_preference,
  :forwarding_address_id)
  SENSITIVE = []
  include Aws::Structure
end

#shipping_optionString

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

Returns:

  • (String)


2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2916

class UpdateJobRequest < Struct.new(
  :job_id,
  :role_arn,
  :notification,
  :resources,
  :on_device_service_configuration,
  :address_id,
  :shipping_option,
  :description,
  :snowball_capacity_preference,
  :forwarding_address_id)
  SENSITIVE = []
  include Aws::Structure
end

#snowball_capacity_preferenceString

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.

Returns:

  • (String)


2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2916

class UpdateJobRequest < Struct.new(
  :job_id,
  :role_arn,
  :notification,
  :resources,
  :on_device_service_configuration,
  :address_id,
  :shipping_option,
  :description,
  :snowball_capacity_preference,
  :forwarding_address_id)
  SENSITIVE = []
  include Aws::Structure
end