You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Snowball::Types::CreateJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateJobRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  job_type: "IMPORT", # accepts IMPORT, EXPORT, LOCAL_USE
  resources: {
    s3_resources: [
      {
        bucket_arn: "ResourceARN",
        key_range: {
          begin_marker: "String",
          end_marker: "String",
        },
      },
    ],
    lambda_resources: [
      {
        lambda_arn: "ResourceARN",
        event_triggers: [
          {
            event_resource_arn: "ResourceARN",
          },
        ],
      },
    ],
  },
  description: "String",
  address_id: "AddressId",
  kms_key_arn: "KmsKeyARN",
  role_arn: "RoleARN",
  snowball_capacity_preference: "T50", # accepts T50, T80, T100, NoPreference
  shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
  notification: {
    sns_topic_arn: "SnsTopicARN",
    job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
    notify_all: false,
  },
  cluster_id: "ClusterId",
  snowball_type: "STANDARD", # accepts STANDARD, EDGE
  forwarding_address_id: "AddressId",
}

Instance Attribute Summary collapse

Instance Attribute Details

#address_idString

The ID for the address that you want the Snowball shipped to.

Returns:

  • (String)

    The ID for the address that you want the Snowball shipped to.

#cluster_idString

The ID of a cluster. If you\'re creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

Returns:

  • (String)

    The ID of a cluster.

#descriptionString

Defines an optional description of this specific job, for example Important Photos 2016-08-11.

Returns:

  • (String)

    Defines an optional description of this specific job, for example Important Photos 2016-08-11.

#forwarding_address_idString

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

Returns:

  • (String)

    The forwarding address ID for a job.

#job_typeString

Defines the type of job that you\'re creating.

Possible values:

  • IMPORT
  • EXPORT
  • LOCAL_USE

Returns:

  • (String)

    Defines the type of job that you\'re creating.

#kms_key_arnString

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

Returns:

  • (String)

    The KmsKeyARN that you want to associate with this job.

#notificationTypes::Notification

Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

Returns:

  • (Types::Notification)

    Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

#resourcesTypes::JobResource

Defines the Amazon S3 buckets associated with this job.

With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

Returns:

#role_arnString

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

Returns:

  • (String)

    The RoleARN that you want to associate with this job.

#shipping_optionString

The shipping speed for this job. This speed doesn\'t dictate how soon you\'ll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snowballs are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

    Possible values:

    • SECOND_DAY
    • NEXT_DAY
    • EXPRESS
    • STANDARD

Returns:

  • (String)

    The shipping speed for this job.

#snowball_capacity_preferenceString

If your job is being created in one of the US regions, you have the option of specifying what size Snowball you\'d like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

Possible values:

  • T50
  • T80
  • T100
  • NoPreference

Returns:

  • (String)

    If your job is being created in one of the US regions, you have the option of specifying what size Snowball you\'d like for this job.

#snowball_typeString

The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster jobs is EDGE.

Possible values:

  • STANDARD
  • EDGE

Returns:

  • (String)

    The type of AWS Snowball appliance to use for this job.