"update"
********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Examples


Description
===========

Updates a Appliance Export Job that corresponds with customer’s
logical dataset.


Usage
=====

   oci dts export update [OPTIONS]


Required Parameters
===================

--job-id [text]

OCID of the Export Job


Optional Parameters
===================

--address1 [text]

Address line 1.

--address2 [text]

Optional address line 2.

--address3 [text]

Optional address line 3.

--address4 [text]

Optional address line 4.

--addressee [text]

Company or person to send the appliance to

--bucket-name [text]

--care-of [text]

Place/person to direct the package to.

--city-or-locality [text]

City or Locality.

--country [text]

Country.

--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see Resource Tags.

Example:

   {"Operations": {"CostCenter": "42"}}

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--display-name [text]

--email [text]

Email address.

--first-object [text]

First object in the list of objects that are exported in this job.

--force

Perform update without prompting for confirmation.

--freeform-tags [complex type]

Free-form tags for this resource. Each tag is a simple key-value pair
with no predefined name, type, or namespace. For more information, see
Resource Tags.

Example:

   {"Department": "Finance"}

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--if-match [text]

The entity tag to match. Optional, if set, the update will be
successful only if the object’s tag matches the tag specified in the
request.

--last-object [text]

Last object in the list of objects that are exported in this job.

--manifest-file [text]

Manifest File associated with this export job.

--manifest-md5 [text]

md5 digest of the manifest file.

--max-wait-seconds [integer]

The maximum time to wait for the resource to reach the lifecycle state
defined by "--wait-for-state". Defaults to 1200 seconds.

--next-object [text]

First object from which the next potential export job could start.

--number-of-objects [text]

Total number of objects that are exported in this job.

--phone-number [text]

Phone number.

--prefix [text]

List of objects with names matching this prefix would be part of this
export job.

--range-end [text]

Object names returned by a list query must be strictly less than this
parameter.

--range-start [text]

Object names returned by a list query must be greater or equal to this
parameter.

--state-province-region [text]

State or Province or Region.

--total-size-in-bytes [text]

Total size of objects in Bytes that are exported in this job.

--wait-for-state [text]

This operation creates, modifies or deletes a resource that has a
defined lifecycle state. Specify this option to perform the action and
then wait until the resource reaches a given lifecycle state. Multiple
states can be specified, returning on the first state. For example, "
--wait-for-state" SUCCEEDED "--wait-for-state" FAILED would return on
whichever lifecycle state is reached first. If timeout is reached, a
return code of 2 is returned. For any other error, a return code of 1
is returned.

Accepted values are:

   ACTIVE, CANCELLED, CREATING, DELETED, FAILED, INPROGRESS, SUCCEEDED

--wait-interval-seconds [integer]

Check every "--wait-interval-seconds" to see whether the resource to
see if it has reached the lifecycle state defined by "--wait-for-
state". Defaults to 30 seconds.

--zip-postal-code [text]

Zip or Postal Code


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--debug", "--defaults-file", "--
endpoint", "--generate-full-command-json-input", "--generate-param-
json-input", "--help", "--latest-version", "--max-retries", "--no-
retry", "--opc-client-request-id", "--opc-request-id", "--output", "--
profile", "--query", "--raw-output", "--region", "--release-info", "--
request-id", "--version", "-?", "-d", "-h", "-i", "-v"


Examples
========

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export bucket=<substitute-value-of-bucket> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-bucket
       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-compartment-id
       export device_type=<substitute-value-of-device_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-device-type
       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-display-name

       job_id=$(oci dts job create --bucket $bucket --compartment-id $compartment_id --device-type $device_type --display-name $display_name --query data.id --raw-output)

       oci dts export update --job-id $job_id
