oci-cli 3.65.1__py3-none-any.whl → 3.66.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/add.txt

@@ -0,0 +1,150 @@
+"add"
+*****
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Adds a lock to a resource.
+
+
+Usage
+=====
+
+   oci email email-return-path add [OPTIONS]
+
+
+Required Parameters
+===================
+
+--email-return-path-id [text]
+
+The OCID of this email return path.
+
+--type [text]
+
+Lock type.
+
+Accepted values are:
+
+   DELETE, FULL
+
+
+Optional Parameters
+===================
+
+--compartment-id, -c [text]
+
+The lock compartment ID.
+
+--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]
+
+Used for optimistic concurrency control. In the update or delete call
+for a resource, set the *if-match* parameter to the value of the etag
+from a previous get, create, or update response for that resource.
+The resource will be updated or deleted only if the etag you provide
+matches the resource’s current etag value.
+
+--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.
+
+--message [text]
+
+A message added by the lock creator. The message typically gives an
+indication of why the resource is locked.
+
+--related-resource-id [text]
+
+The resource ID that is locking this resource. Indicates that deleting
+this resource removes the lock.
+
+--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, CREATING, DELETED, DELETING, FAILED, NEEDS_ATTENTION, UPDATING
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the resource has
+reached the lifecycle state defined by "--wait-for-state". Defaults to
+30 seconds.
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--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", "--proxy", "--query", "--raw-output", "--
+read-timeout", "--realm-specific-endpoint", "--region", "--release-
+info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+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 parent_resource_id=<substitute-value-of-parent_resource_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/email-return-path/create.html#cmdoption-parent-resource-id
+       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/email-return-path/add.html#cmdoption-type
+
+       email_return_path_id=$(oci email email-return-path create --parent-resource-id $parent_resource_id --query data.id --raw-output)
+
+       oci email email-return-path add --email-return-path-id $email_return_path_id --type $type

oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/delete.txt

@@ -71,6 +71,10 @@ from a previous get, create, or update response for that resource.
 The resource will be updated or deleted only if the etag you provide
 matches the resource’s current etag value.
 
+--is-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the work request to reach the state

oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/remove.txt

@@ -0,0 +1,140 @@
+"remove"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Remove a lock to a resource.
+
+
+Usage
+=====
+
+   oci email email-return-path remove [OPTIONS]
+
+
+Required Parameters
+===================
+
+--email-return-path-id [text]
+
+The OCID of this email return path.
+
+--type [text]
+
+Lock type.
+
+Accepted values are:
+
+   DELETE, FULL
+
+
+Optional Parameters
+===================
+
+--compartment-id, -c [text]
+
+The lock compartment ID.
+
+--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]
+
+Used for optimistic concurrency control. In the update or delete call
+for a resource, set the *if-match* parameter to the value of the etag
+from a previous get, create, or update response for that resource.
+The resource will be updated or deleted only if the etag you provide
+matches the resource’s current etag value.
+
+--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.
+
+--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, CREATING, DELETED, DELETING, FAILED, NEEDS_ATTENTION, UPDATING
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the resource has
+reached the lifecycle state defined by "--wait-for-state". Defaults to
+30 seconds.
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--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", "--proxy", "--query", "--raw-output", "--
+read-timeout", "--realm-specific-endpoint", "--region", "--release-
+info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+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 parent_resource_id=<substitute-value-of-parent_resource_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/email-return-path/create.html#cmdoption-parent-resource-id
+       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/email-return-path/remove.html#cmdoption-type
+
+       email_return_path_id=$(oci email email-return-path create --parent-resource-id $parent_resource_id --query data.id --raw-output)
+
+       oci email email-return-path remove --email-return-path-id $email_return_path_id --type $type

oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/update.txt

@@ -114,6 +114,10 @@ from a previous get, create, or update response for that resource.
 The resource will be updated or deleted only if the etag you provide
 matches the resource’s current etag value.
 
+--is-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the work request to reach the state

oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path.txt

@@ -11,6 +11,8 @@ The properties that define a Email Return Path
 Available Commands
 ==================
 
+* add
+
 * create
 
 * delete
@@ -19,4 +21,6 @@ Available Commands
 
 * list
 
+* remove
+
 * update

oci_cli/help_text_producer/data_files/text/cmdref/email/sender/add.txt

@@ -0,0 +1,151 @@
+"add"
+*****
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Adds a lock to a resource.
+
+
+Usage
+=====
+
+   oci email sender add [OPTIONS]
+
+
+Required Parameters
+===================
+
+--sender-id [text]
+
+The unique OCID of the sender.
+
+--type [text]
+
+Lock type.
+
+Accepted values are:
+
+   DELETE, FULL
+
+
+Optional Parameters
+===================
+
+--compartment-id, -c [text]
+
+The lock compartment ID.
+
+--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]
+
+Used for optimistic concurrency control. In the update or delete call
+for a resource, set the *if-match* parameter to the value of the etag
+from a previous get, create, or update response for that resource.
+The resource will be updated or deleted only if the etag you provide
+matches the resource’s current etag value.
+
+--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.
+
+--message [text]
+
+A message added by the lock creator. The message typically gives an
+indication of why the resource is locked.
+
+--related-resource-id [text]
+
+The resource ID that is locking this resource. Indicates that deleting
+this resource removes the lock.
+
+--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, CREATING, DELETED, DELETING, FAILED, INACTIVE, NEEDS_ATTENTION
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the resource has
+reached the lifecycle state defined by "--wait-for-state". Defaults to
+30 seconds.
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--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", "--proxy", "--query", "--raw-output", "--
+read-timeout", "--realm-specific-endpoint", "--region", "--release-
+info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/sender/create.html#cmdoption-compartment-id
+       export email_address=<substitute-value-of-email_address> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/sender/create.html#cmdoption-email-address
+       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/sender/add.html#cmdoption-type
+
+       sender_id=$(oci email sender create --compartment-id $compartment_id --email-address $email_address --query data.id --raw-output)
+
+       oci email sender add --sender-id $sender_id --type $type

oci_cli/help_text_producer/data_files/text/cmdref/email/sender/change-compartment.txt

@@ -72,6 +72,10 @@ from a previous get, create, or update response for that resource.
 The resource will be updated or deleted only if the etag you provide
 matches the resource’s current etag value.
 
+--is-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
 
 Global Parameters
 =================

oci_cli/help_text_producer/data_files/text/cmdref/email/sender/delete.txt

@@ -72,6 +72,10 @@ from a previous get, create, or update response for that resource.
 The resource will be updated or deleted only if the etag you provide
 matches the resource’s current etag value.
 
+--is-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the resource to reach the lifecycle state

oci_cli/help_text_producer/data_files/text/cmdref/email/sender/remove.txt

@@ -0,0 +1,141 @@
+"remove"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Remove a lock to a resource.
+
+
+Usage
+=====
+
+   oci email sender remove [OPTIONS]
+
+
+Required Parameters
+===================
+
+--sender-id [text]
+
+The unique OCID of the sender.
+
+--type [text]
+
+Lock type.
+
+Accepted values are:
+
+   DELETE, FULL
+
+
+Optional Parameters
+===================
+
+--compartment-id, -c [text]
+
+The lock compartment ID.
+
+--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]
+
+Used for optimistic concurrency control. In the update or delete call
+for a resource, set the *if-match* parameter to the value of the etag
+from a previous get, create, or update response for that resource.
+The resource will be updated or deleted only if the etag you provide
+matches the resource’s current etag value.
+
+--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.
+
+--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, CREATING, DELETED, DELETING, FAILED, INACTIVE, NEEDS_ATTENTION
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the resource has
+reached the lifecycle state defined by "--wait-for-state". Defaults to
+30 seconds.
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--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", "--proxy", "--query", "--raw-output", "--
+read-timeout", "--realm-specific-endpoint", "--region", "--release-
+info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/sender/create.html#cmdoption-compartment-id
+       export email_address=<substitute-value-of-email_address> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/sender/create.html#cmdoption-email-address
+       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/sender/remove.html#cmdoption-type
+
+       sender_id=$(oci email sender create --compartment-id $compartment_id --email-address $email_address --query data.id --raw-output)
+
+       oci email sender remove --sender-id $sender_id --type $type

oci_cli/help_text_producer/data_files/text/cmdref/email/sender/update.txt

@@ -112,6 +112,10 @@ from a previous get, create, or update response for that resource.
 The resource will be updated or deleted only if the etag you provide
 matches the resource’s current etag value.
 
+--is-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the resource to reach the lifecycle state

oci_cli/help_text_producer/data_files/text/cmdref/email/sender.txt

@@ -11,6 +11,8 @@ The full information representing an approved sender.
 Available Commands
 ==================
 
+* add
+
 * change-compartment
 
 * create
@@ -21,4 +23,6 @@ Available Commands
 
 * list
 
+* remove
+
 * update