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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. oci_cli/bin/email.psm1 +23 -11
  2. oci_cli/cli_root.py +2 -2
  3. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/ai-data-platform/change-compartment.txt +133 -0
  4. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/ai-data-platform/create.txt +185 -0
  5. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/ai-data-platform/delete.txt +135 -0
  6. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/ai-data-platform/get.txt +93 -0
  7. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/ai-data-platform/update.txt +195 -0
  8. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/ai-data-platform-collection/list-ai-data-platforms.txt +155 -0
  9. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/ai-data-platform-collection.txt +15 -0
  10. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/ai-data-platform.txt +28 -0
  11. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request/cancel.txt +103 -0
  12. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request/get.txt +91 -0
  13. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request/list.txt +140 -0
  14. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request-error/list.txt +131 -0
  15. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request-error.txt +15 -0
  16. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request-log-entry/list-work-request-logs.txt +131 -0
  17. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request-log-entry.txt +15 -0
  18. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request.txt +23 -0
  19. oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform.txt +44 -0
  20. oci_cli/help_text_producer/data_files/text/cmdref/db/autonomous-database/create-refreshable-clone.txt +8 -0
  21. oci_cli/help_text_producer/data_files/text/cmdref/db/autonomous-database/delete.txt +5 -0
  22. oci_cli/help_text_producer/data_files/text/cmdref/db/autonomous-database-backup/list.txt +18 -0
  23. oci_cli/help_text_producer/data_files/text/cmdref/db/cloud-exa-infra/create.txt +2 -1
  24. oci_cli/help_text_producer/data_files/text/cmdref/db/exascale-db-storage-vault/create.txt +2 -1
  25. oci_cli/help_text_producer/data_files/text/cmdref/db/system/change-cloud-db-system-subscription.txt +134 -0
  26. oci_cli/help_text_producer/data_files/text/cmdref/db/system/launch-from-backup.txt +16 -0
  27. oci_cli/help_text_producer/data_files/text/cmdref/db/system/launch-from-database.txt +16 -0
  28. oci_cli/help_text_producer/data_files/text/cmdref/db/system/launch-from-db-system.txt +16 -0
  29. oci_cli/help_text_producer/data_files/text/cmdref/db/system/launch.txt +16 -0
  30. oci_cli/help_text_producer/data_files/text/cmdref/db/system/list-db-system-storage-performances.txt +3 -3
  31. oci_cli/help_text_producer/data_files/text/cmdref/db/system/update.txt +6 -0
  32. oci_cli/help_text_producer/data_files/text/cmdref/db/system.txt +2 -0
  33. oci_cli/help_text_producer/data_files/text/cmdref/db.txt +2 -0
  34. oci_cli/help_text_producer/data_files/text/cmdref/email/domain/add.txt +148 -0
  35. oci_cli/help_text_producer/data_files/text/cmdref/email/domain/change-compartment.txt +4 -0
  36. oci_cli/help_text_producer/data_files/text/cmdref/email/domain/delete.txt +4 -0
  37. oci_cli/help_text_producer/data_files/text/cmdref/email/domain/remove.txt +138 -0
  38. oci_cli/help_text_producer/data_files/text/cmdref/email/domain/update.txt +4 -0
  39. oci_cli/help_text_producer/data_files/text/cmdref/email/domain.txt +4 -0
  40. oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/add.txt +150 -0
  41. oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/delete.txt +4 -0
  42. oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/remove.txt +140 -0
  43. oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/update.txt +4 -0
  44. oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path.txt +4 -0
  45. oci_cli/help_text_producer/data_files/text/cmdref/email/sender/add.txt +151 -0
  46. oci_cli/help_text_producer/data_files/text/cmdref/email/sender/change-compartment.txt +4 -0
  47. oci_cli/help_text_producer/data_files/text/cmdref/email/sender/delete.txt +4 -0
  48. oci_cli/help_text_producer/data_files/text/cmdref/email/sender/remove.txt +141 -0
  49. oci_cli/help_text_producer/data_files/text/cmdref/email/sender/update.txt +4 -0
  50. oci_cli/help_text_producer/data_files/text/cmdref/email/sender.txt +4 -0
  51. oci_cli/help_text_producer/data_files/text/cmdref/email.txt +12 -0
  52. oci_cli/help_text_producer/data_files/text/cmdref/fs/mount-target/create.txt +6 -5
  53. oci_cli/help_text_producer/data_files/text/cmdref/ocvs/work-request-error/{list-errors.txt → list.txt} +5 -5
  54. oci_cli/help_text_producer/data_files/text/cmdref/ocvs/work-request-error.txt +1 -1
  55. oci_cli/help_text_producer/data_files/text/cmdref/ocvs.txt +1 -1
  56. oci_cli/help_text_producer/data_files/text/cmdref/organizations/work-request-error/{list.txt → list-errors.txt} +5 -5
  57. oci_cli/help_text_producer/data_files/text/cmdref/organizations/work-request-error.txt +1 -1
  58. oci_cli/help_text_producer/data_files/text/cmdref/organizations/{work-request-log-entry → work-request-log}/list.txt +19 -1
  59. oci_cli/help_text_producer/data_files/text/cmdref/organizations/{work-request-log-entry.txt → work-request-log.txt} +2 -2
  60. oci_cli/help_text_producer/data_files/text/cmdref/organizations.txt +2 -2
  61. oci_cli/help_text_producer/data_files/text/index.txt +2 -0
  62. oci_cli/help_text_producer/data_files/text/oci.txt +1 -1
  63. oci_cli/service_mapping.py +5 -0
  64. oci_cli/version.py +1 -1
  65. {oci_cli-3.65.1.dist-info → oci_cli-3.66.1.dist-info}/METADATA +2 -2
  66. {oci_cli-3.65.1.dist-info → oci_cli-3.66.1.dist-info}/RECORD +83 -51
  67. services/ai_data_platform/__init__.py +4 -0
  68. services/ai_data_platform/src/__init__.py +4 -0
  69. services/ai_data_platform/src/oci_cli_ai_data_platform/__init__.py +4 -0
  70. services/ai_data_platform/src/oci_cli_ai_data_platform/generated/__init__.py +4 -0
  71. services/ai_data_platform/src/oci_cli_ai_data_platform/generated/ai_data_platform_service_cli.py +14 -0
  72. services/ai_data_platform/src/oci_cli_ai_data_platform/generated/aidataplatform_cli.py +676 -0
  73. services/ai_data_platform/src/oci_cli_ai_data_platform/generated/client_mappings.py +14 -0
  74. services/ai_data_platform/tests/__init__.py +4 -0
  75. services/database/src/oci_cli_database/database_cli_extended.py +3 -1
  76. services/database/src/oci_cli_database/generated/database_cli.py +170 -13
  77. services/email/src/oci_cli_email/generated/email_cli.py +422 -8
  78. services/file_storage/src/oci_cli_file_storage/generated/filestorage_cli.py +2 -2
  79. {oci_cli-3.65.1.dist-info → oci_cli-3.66.1.dist-info}/LICENSE.txt +0 -0
  80. {oci_cli-3.65.1.dist-info → oci_cli-3.66.1.dist-info}/THIRD_PARTY_LICENSES.txt +0 -0
  81. {oci_cli-3.65.1.dist-info → oci_cli-3.66.1.dist-info}/WHEEL +0 -0
  82. {oci_cli-3.65.1.dist-info → oci_cli-3.66.1.dist-info}/entry_points.txt +0 -0
  83. {oci_cli-3.65.1.dist-info → oci_cli-3.66.1.dist-info}/top_level.txt +0 -0
oci_cli/bin/email.psm1 CHANGED
@@ -7,9 +7,9 @@ function GetOciSubcommands_email() {
7
7
  'email' = 'configuration dkim domain email-return-path sender suppression work-request work-request-error work-request-log'
8
8
  'email configuration' = 'get-email'
9
9
  'email dkim' = 'create delete get list update'
10
- 'email domain' = 'change-compartment create delete get list update'
11
- 'email email-return-path' = 'create delete get list update'
12
- 'email sender' = 'change-compartment create delete get list update'
10
+ 'email domain' = 'add change-compartment create delete get list remove update'
11
+ 'email email-return-path' = 'add create delete get list remove update'
12
+ 'email sender' = 'add change-compartment create delete get list remove update'
13
13
  'email suppression' = 'create delete get list'
14
14
  'email work-request' = 'get list'
15
15
  'email work-request-error' = 'list'
@@ -26,23 +26,29 @@ function GetOciCommandsToLongParams_email() {
26
26
  'email dkim get' = 'dkim-id from-json help'
27
27
  'email dkim list' = 'all email-domain-id from-json help id lifecycle-state limit name page page-size sort-by sort-order'
28
28
  'email dkim update' = 'defined-tags description dkim-id force freeform-tags from-json help if-match max-wait-seconds wait-for-state wait-interval-seconds'
29
- 'email domain change-compartment' = 'compartment-id email-domain-id from-json help if-match max-wait-seconds wait-for-state wait-interval-seconds'
29
+ 'email domain add' = 'compartment-id email-domain-id from-json help if-match max-wait-seconds message related-resource-id type wait-for-state wait-interval-seconds'
30
+ 'email domain change-compartment' = 'compartment-id email-domain-id from-json help if-match is-lock-override max-wait-seconds wait-for-state wait-interval-seconds'
30
31
  'email domain create' = 'compartment-id defined-tags description domain-verification-id freeform-tags from-json help max-wait-seconds name wait-for-state wait-interval-seconds'
31
- 'email domain delete' = 'email-domain-id force from-json help if-match max-wait-seconds wait-for-state wait-interval-seconds'
32
+ 'email domain delete' = 'email-domain-id force from-json help if-match is-lock-override max-wait-seconds wait-for-state wait-interval-seconds'
32
33
  'email domain get' = 'email-domain-id from-json help'
33
34
  'email domain list' = 'all compartment-id from-json help id lifecycle-state limit name page page-size sort-by sort-order'
34
- 'email domain update' = 'defined-tags description domain-verification-id email-domain-id force freeform-tags from-json help if-match max-wait-seconds wait-for-state wait-interval-seconds'
35
+ 'email domain remove' = 'compartment-id email-domain-id from-json help if-match max-wait-seconds type wait-for-state wait-interval-seconds'
36
+ 'email domain update' = 'defined-tags description domain-verification-id email-domain-id force freeform-tags from-json help if-match is-lock-override max-wait-seconds wait-for-state wait-interval-seconds'
37
+ 'email email-return-path add' = 'compartment-id email-return-path-id from-json help if-match max-wait-seconds message related-resource-id type wait-for-state wait-interval-seconds'
35
38
  'email email-return-path create' = 'defined-tags description freeform-tags from-json help max-wait-seconds name parent-resource-id wait-for-state wait-interval-seconds'
36
- 'email email-return-path delete' = 'email-return-path-id force from-json help if-match max-wait-seconds wait-for-state wait-interval-seconds'
39
+ 'email email-return-path delete' = 'email-return-path-id force from-json help if-match is-lock-override max-wait-seconds wait-for-state wait-interval-seconds'
37
40
  'email email-return-path get' = 'email-return-path-id from-json help'
38
41
  'email email-return-path list' = 'all compartment-id from-json help id lifecycle-state limit name page page-size parent-resource-id sort-by sort-order'
39
- 'email email-return-path update' = 'defined-tags description email-return-path-id force freeform-tags from-json help if-match max-wait-seconds wait-for-state wait-interval-seconds'
40
- 'email sender change-compartment' = 'compartment-id from-json help if-match sender-id'
42
+ 'email email-return-path remove' = 'compartment-id email-return-path-id from-json help if-match max-wait-seconds type wait-for-state wait-interval-seconds'
43
+ 'email email-return-path update' = 'defined-tags description email-return-path-id force freeform-tags from-json help if-match is-lock-override max-wait-seconds wait-for-state wait-interval-seconds'
44
+ 'email sender add' = 'compartment-id from-json help if-match max-wait-seconds message related-resource-id sender-id type wait-for-state wait-interval-seconds'
45
+ 'email sender change-compartment' = 'compartment-id from-json help if-match is-lock-override sender-id'
41
46
  'email sender create' = 'compartment-id defined-tags email-address freeform-tags from-json help max-wait-seconds wait-for-state wait-interval-seconds'
42
- 'email sender delete' = 'force from-json help if-match max-wait-seconds sender-id wait-for-state wait-interval-seconds'
47
+ 'email sender delete' = 'force from-json help if-match is-lock-override max-wait-seconds sender-id wait-for-state wait-interval-seconds'
43
48
  'email sender get' = 'from-json help sender-id'
44
49
  'email sender list' = 'all compartment-id domain email-address from-json help lifecycle-state limit page page-size sort-by sort-order'
45
- 'email sender update' = 'defined-tags force freeform-tags from-json help if-match max-wait-seconds sender-id wait-for-state wait-interval-seconds'
50
+ 'email sender remove' = 'compartment-id from-json help if-match max-wait-seconds sender-id type wait-for-state wait-interval-seconds'
51
+ 'email sender update' = 'defined-tags force freeform-tags from-json help if-match is-lock-override max-wait-seconds sender-id wait-for-state wait-interval-seconds'
46
52
  'email suppression create' = 'compartment-id email-address from-json help'
47
53
  'email suppression delete' = 'force from-json help suppression-id'
48
54
  'email suppression get' = 'from-json help suppression-id'
@@ -63,22 +69,28 @@ function GetOciCommandsToShortParams_email() {
63
69
  'email dkim get' = '? h'
64
70
  'email dkim list' = '? h'
65
71
  'email dkim update' = '? h'
72
+ 'email domain add' = '? c h'
66
73
  'email domain change-compartment' = '? c h'
67
74
  'email domain create' = '? c h'
68
75
  'email domain delete' = '? h'
69
76
  'email domain get' = '? h'
70
77
  'email domain list' = '? c h'
78
+ 'email domain remove' = '? c h'
71
79
  'email domain update' = '? h'
80
+ 'email email-return-path add' = '? c h'
72
81
  'email email-return-path create' = '? h'
73
82
  'email email-return-path delete' = '? h'
74
83
  'email email-return-path get' = '? h'
75
84
  'email email-return-path list' = '? c h'
85
+ 'email email-return-path remove' = '? c h'
76
86
  'email email-return-path update' = '? h'
87
+ 'email sender add' = '? c h'
77
88
  'email sender change-compartment' = '? c h'
78
89
  'email sender create' = '? c h'
79
90
  'email sender delete' = '? h'
80
91
  'email sender get' = '? h'
81
92
  'email sender list' = '? c h'
93
+ 'email sender remove' = '? c h'
82
94
  'email sender update' = '? h'
83
95
  'email suppression create' = '? c h'
84
96
  'email suppression delete' = '? h'
oci_cli/cli_root.py CHANGED
@@ -427,13 +427,13 @@ For more information, see the Using Queries section at {cli_constants.INPUT_OUTP
427
427
  @click.option('--auth-purpose', help='The The auth purpose which can be used in conjunction with --auth.')
428
428
  @click.option('--generate-full-command-json-input', is_flag=True, is_eager=True, help=GENERATE_FULL_COMMAND_JSON_HELP)
429
429
  @click.option('--generate-param-json-input', is_eager=True, help=GENERATE_PARAM_JSON_HELP)
430
- @click.option('--no-retry', is_flag=True, help='Disable retry logic for calls to services.')
431
- @click.option('--max-retries', type=click.INT, help='Maximum number of retry calls to be made to the service. For most commands, 5 attempts will be made. For operations with binary bodies, retries are disabled')
432
430
  @click.option('--proxy', help="""If the environment the CLI runs in requires use of a proxy server for HTTP requests, the details of the proxy server to use. Examples:
433
431
 
434
432
  http://proxy.example.org:3128/ (uses proxy.example.org on port 3128)
435
433
  \b
436
434
  http://user:pass@proxy.example.org:3128/ (if your proxy requires a username and password to authenticate)""")
435
+ @click.option('--no-retry', is_flag=True, help='Disable retry logic for calls to services.')
436
+ @click.option('--max-retries', type=click.INT, help='Maximum number of retry calls to be made to the service. For most commands, 7 attempts will be made. For operations with binary bodies, retries are disabled')
437
437
  @click.option('-d', '--debug', is_flag=True, help='Show additional debug information.')
438
438
  @click.option('-i', '--cli-auto-prompt', is_flag=True, help=f'''Use the interactive features for autocompletion and quick view of command reference.
439
439
 
@@ -0,0 +1,133 @@
1
+ "change-compartment"
2
+ ********************
3
+
4
+ * Description
5
+
6
+ * Usage
7
+
8
+ * Required Parameters
9
+
10
+ * Optional Parameters
11
+
12
+ * Global Parameters
13
+
14
+ * Example using required parameter
15
+
16
+
17
+ Description
18
+ ===========
19
+
20
+ Moves a AiDataPlatform into a different compartment within the same
21
+ tenancy. For information about moving resources between compartments,
22
+ see Moving Resources to a Different Compartment.
23
+
24
+
25
+ Usage
26
+ =====
27
+
28
+ oci ai-data-platform ai-data-platform change-compartment [OPTIONS]
29
+
30
+
31
+ Required Parameters
32
+ ===================
33
+
34
+ --ai-data-platform-id [text]
35
+
36
+ The OCID of the AiDataPlatform.
37
+
38
+ --compartment-id, -c [text]
39
+
40
+ The OCID of the compartment to move the AiDataPlatform to.
41
+
42
+
43
+ Optional Parameters
44
+ ===================
45
+
46
+ --from-json [text]
47
+
48
+ Provide input to this command as a JSON document from a file using the
49
+ file://path-to/file syntax.
50
+
51
+ The "--generate-full-command-json-input" option can be used to
52
+ generate a sample json file to be used with this command option. The
53
+ key names are pre-populated and match the command option names
54
+ (converted to camelCase format, e.g. compartment-id –> compartmentId),
55
+ while the values of the keys need to be populated by the user before
56
+ using the sample file as an input to this command. For any command
57
+ option that accepts multiple values, the value of the key can be a
58
+ JSON array.
59
+
60
+ Options can still be provided on the command line. If an option exists
61
+ in both the JSON document and the command line then the command line
62
+ specified value will be used.
63
+
64
+ For examples on usage of this option, please see our “using CLI with
65
+ advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
66
+ nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
67
+
68
+ --if-match [text]
69
+
70
+ For optimistic concurrency control. In the PUT or DELETE call for a
71
+ resource, set the *if-match* parameter to the value of the etag from a
72
+ previous GET or POST response for that resource. The resource will be
73
+ updated or deleted only if the etag you provide matches the resource’s
74
+ current etag value.
75
+
76
+ --max-wait-seconds [integer]
77
+
78
+ The maximum time to wait for the work request to reach the state
79
+ defined by "--wait-for-state". Defaults to 1200 seconds.
80
+
81
+ --wait-for-state [text]
82
+
83
+ This operation asynchronously creates, modifies or deletes a resource
84
+ and uses a work request to track the progress of the operation.
85
+ Specify this option to perform the action and then wait until the work
86
+ request reaches a certain state. Multiple states can be specified,
87
+ returning on the first state. For example, "--wait-for-state"
88
+ SUCCEEDED "--wait-for-state" FAILED would return on whichever
89
+ lifecycle state is reached first. If timeout is reached, a return code
90
+ of 2 is returned. For any other error, a return code of 1 is returned.
91
+
92
+ Accepted values are:
93
+
94
+ ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
95
+
96
+ --wait-interval-seconds [integer]
97
+
98
+ Check every "--wait-interval-seconds" to see whether the work request
99
+ has reached the state defined by "--wait-for-state". Defaults to 30
100
+ seconds.
101
+
102
+
103
+ Global Parameters
104
+ =================
105
+
106
+ Use "oci --help" for help on global parameters.
107
+
108
+ "--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
109
+ cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
110
+ defaults-file", "--endpoint", "--generate-full-command-json-input", "
111
+ --generate-param-json-input", "--help", "--latest-version", "--max-
112
+ retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
113
+ "--output", "--profile", "--proxy", "--query", "--raw-output", "--
114
+ read-timeout", "--realm-specific-endpoint", "--region", "--release-
115
+ info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
116
+
117
+
118
+ Example using required parameter
119
+ ================================
120
+
121
+ Copy the following CLI commands into a file named example.sh. Run the
122
+ command by typing “bash example.sh” and replacing the example
123
+ parameters with your own.
124
+
125
+ Please note this sample will only work in the POSIX-compliant bash-
126
+ like shell. You need to set up the OCI configuration and appropriate
127
+ security policies before trying the examples.
128
+
129
+ export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ai-data-platform/ai-data-platform/create.html#cmdoption-compartment-id
130
+
131
+ ai_data_platform_id=$(oci ai-data-platform ai-data-platform create --compartment-id $compartment_id --query data.id --raw-output)
132
+
133
+ oci ai-data-platform ai-data-platform change-compartment --ai-data-platform-id $ai_data_platform_id --compartment-id $compartment_id
@@ -0,0 +1,185 @@
1
+ "create"
2
+ ********
3
+
4
+ * Description
5
+
6
+ * Usage
7
+
8
+ * Required Parameters
9
+
10
+ * Optional Parameters
11
+
12
+ * Global Parameters
13
+
14
+ * Example using required parameter
15
+
16
+
17
+ Description
18
+ ===========
19
+
20
+ Creates a AiDataPlatform.
21
+
22
+
23
+ Usage
24
+ =====
25
+
26
+ oci ai-data-platform ai-data-platform create [OPTIONS]
27
+
28
+
29
+ Required Parameters
30
+ ===================
31
+
32
+ --compartment-id, -c [text]
33
+
34
+ The OCID of the compartment to create the AiDataPlatform in.
35
+
36
+
37
+ Optional Parameters
38
+ ===================
39
+
40
+ --ai-data-platform-type [text]
41
+
42
+ The AiDataPlatform type.
43
+
44
+ --default-workspace-name [text]
45
+
46
+ The name for the default workspace for the AiDataPlatform
47
+
48
+ --defined-tags [complex type]
49
+
50
+ Defined tags for this resource. Each key is predefined and scoped to a
51
+ namespace. For more information, see Resource Tags.
52
+
53
+ Example:
54
+
55
+ {"Operations": {"CostCenter": "42"}}
56
+
57
+ This is a complex type whose value must be valid JSON. The value can
58
+ be provided as a string on the command line or passed in as a file
59
+ using the file://path/to/file syntax.
60
+
61
+ The "--generate-param-json-input" option can be used to generate an
62
+ example of the JSON which must be provided. We recommend storing this
63
+ example in a file, modifying it as needed and then passing it back in
64
+ via the file:// syntax.
65
+
66
+ --display-name [text]
67
+
68
+ A user-friendly name. Does not have to be unique, and it’s changeable.
69
+ Avoid entering confidential information.
70
+
71
+ --freeform-tags [complex type]
72
+
73
+ Free-form tags for this resource. Each tag is a simple key-value pair
74
+ with no predefined name, type, or namespace. For more information, see
75
+ Resource Tags.
76
+
77
+ Example:
78
+
79
+ {"Department": "Finance"}
80
+
81
+ This is a complex type whose value must be valid JSON. The value can
82
+ be provided as a string on the command line or passed in as a file
83
+ using the file://path/to/file syntax.
84
+
85
+ The "--generate-param-json-input" option can be used to generate an
86
+ example of the JSON which must be provided. We recommend storing this
87
+ example in a file, modifying it as needed and then passing it back in
88
+ via the file:// syntax.
89
+
90
+ --from-json [text]
91
+
92
+ Provide input to this command as a JSON document from a file using the
93
+ file://path-to/file syntax.
94
+
95
+ The "--generate-full-command-json-input" option can be used to
96
+ generate a sample json file to be used with this command option. The
97
+ key names are pre-populated and match the command option names
98
+ (converted to camelCase format, e.g. compartment-id –> compartmentId),
99
+ while the values of the keys need to be populated by the user before
100
+ using the sample file as an input to this command. For any command
101
+ option that accepts multiple values, the value of the key can be a
102
+ JSON array.
103
+
104
+ Options can still be provided on the command line. If an option exists
105
+ in both the JSON document and the command line then the command line
106
+ specified value will be used.
107
+
108
+ For examples on usage of this option, please see our “using CLI with
109
+ advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
110
+ nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
111
+
112
+ --max-wait-seconds [integer]
113
+
114
+ The maximum time to wait for the work request to reach the state
115
+ defined by "--wait-for-state". Defaults to 1200 seconds.
116
+
117
+ --system-tags [complex type]
118
+
119
+ System tags for this resource. Each key is predefined and scoped to a
120
+ namespace.
121
+
122
+ Example:
123
+
124
+ {"orcl-cloud": {"free-tier-retained": "true"}}
125
+
126
+ This is a complex type whose value must be valid JSON. The value can
127
+ be provided as a string on the command line or passed in as a file
128
+ using the file://path/to/file syntax.
129
+
130
+ The "--generate-param-json-input" option can be used to generate an
131
+ example of the JSON which must be provided. We recommend storing this
132
+ example in a file, modifying it as needed and then passing it back in
133
+ via the file:// syntax.
134
+
135
+ --wait-for-state [text]
136
+
137
+ This operation asynchronously creates, modifies or deletes a resource
138
+ and uses a work request to track the progress of the operation.
139
+ Specify this option to perform the action and then wait until the work
140
+ request reaches a certain state. Multiple states can be specified,
141
+ returning on the first state. For example, "--wait-for-state"
142
+ SUCCEEDED "--wait-for-state" FAILED would return on whichever
143
+ lifecycle state is reached first. If timeout is reached, a return code
144
+ of 2 is returned. For any other error, a return code of 1 is returned.
145
+
146
+ Accepted values are:
147
+
148
+ ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
149
+
150
+ --wait-interval-seconds [integer]
151
+
152
+ Check every "--wait-interval-seconds" to see whether the work request
153
+ has reached the state defined by "--wait-for-state". Defaults to 30
154
+ seconds.
155
+
156
+
157
+ Global Parameters
158
+ =================
159
+
160
+ Use "oci --help" for help on global parameters.
161
+
162
+ "--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
163
+ cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
164
+ defaults-file", "--endpoint", "--generate-full-command-json-input", "
165
+ --generate-param-json-input", "--help", "--latest-version", "--max-
166
+ retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
167
+ "--output", "--profile", "--proxy", "--query", "--raw-output", "--
168
+ read-timeout", "--realm-specific-endpoint", "--region", "--release-
169
+ info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
170
+
171
+
172
+ Example using required parameter
173
+ ================================
174
+
175
+ Copy the following CLI commands into a file named example.sh. Run the
176
+ command by typing “bash example.sh” and replacing the example
177
+ parameters with your own.
178
+
179
+ Please note this sample will only work in the POSIX-compliant bash-
180
+ like shell. You need to set up the OCI configuration and appropriate
181
+ security policies before trying the examples.
182
+
183
+ export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ai-data-platform/ai-data-platform/create.html#cmdoption-compartment-id
184
+
185
+ oci ai-data-platform ai-data-platform create --compartment-id $compartment_id
@@ -0,0 +1,135 @@
1
+ "delete"
2
+ ********
3
+
4
+ * Description
5
+
6
+ * Usage
7
+
8
+ * Required Parameters
9
+
10
+ * Optional Parameters
11
+
12
+ * Global Parameters
13
+
14
+ * Example using required parameter
15
+
16
+
17
+ Description
18
+ ===========
19
+
20
+ Deletes a AiDataPlatform.
21
+
22
+
23
+ Usage
24
+ =====
25
+
26
+ oci ai-data-platform ai-data-platform delete [OPTIONS]
27
+
28
+
29
+ Required Parameters
30
+ ===================
31
+
32
+ --ai-data-platform-id [text]
33
+
34
+ The OCID of the AiDataPlatform.
35
+
36
+
37
+ Optional Parameters
38
+ ===================
39
+
40
+ --force
41
+
42
+ Perform deletion without prompting for confirmation.
43
+
44
+ --from-json [text]
45
+
46
+ Provide input to this command as a JSON document from a file using the
47
+ file://path-to/file syntax.
48
+
49
+ The "--generate-full-command-json-input" option can be used to
50
+ generate a sample json file to be used with this command option. The
51
+ key names are pre-populated and match the command option names
52
+ (converted to camelCase format, e.g. compartment-id –> compartmentId),
53
+ while the values of the keys need to be populated by the user before
54
+ using the sample file as an input to this command. For any command
55
+ option that accepts multiple values, the value of the key can be a
56
+ JSON array.
57
+
58
+ Options can still be provided on the command line. If an option exists
59
+ in both the JSON document and the command line then the command line
60
+ specified value will be used.
61
+
62
+ For examples on usage of this option, please see our “using CLI with
63
+ advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
64
+ nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
65
+
66
+ --if-match [text]
67
+
68
+ For optimistic concurrency control. In the PUT or DELETE call for a
69
+ resource, set the *if-match* parameter to the value of the etag from a
70
+ previous GET or POST response for that resource. The resource will be
71
+ updated or deleted only if the etag you provide matches the resource’s
72
+ current etag value.
73
+
74
+ --is-force-delete [boolean]
75
+
76
+ A flag to enable force deletion of the AiDataPlatform.
77
+
78
+ --max-wait-seconds [integer]
79
+
80
+ The maximum time to wait for the work request to reach the state
81
+ defined by "--wait-for-state". Defaults to 1200 seconds.
82
+
83
+ --wait-for-state [text]
84
+
85
+ This operation asynchronously creates, modifies or deletes a resource
86
+ and uses a work request to track the progress of the operation.
87
+ Specify this option to perform the action and then wait until the work
88
+ request reaches a certain state. Multiple states can be specified,
89
+ returning on the first state. For example, "--wait-for-state"
90
+ SUCCEEDED "--wait-for-state" FAILED would return on whichever
91
+ lifecycle state is reached first. If timeout is reached, a return code
92
+ of 2 is returned. For any other error, a return code of 1 is returned.
93
+
94
+ Accepted values are:
95
+
96
+ ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
97
+
98
+ --wait-interval-seconds [integer]
99
+
100
+ Check every "--wait-interval-seconds" to see whether the work request
101
+ has reached the state defined by "--wait-for-state". Defaults to 30
102
+ seconds.
103
+
104
+
105
+ Global Parameters
106
+ =================
107
+
108
+ Use "oci --help" for help on global parameters.
109
+
110
+ "--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
111
+ cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
112
+ defaults-file", "--endpoint", "--generate-full-command-json-input", "
113
+ --generate-param-json-input", "--help", "--latest-version", "--max-
114
+ retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
115
+ "--output", "--profile", "--proxy", "--query", "--raw-output", "--
116
+ read-timeout", "--realm-specific-endpoint", "--region", "--release-
117
+ info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
118
+
119
+
120
+ Example using required parameter
121
+ ================================
122
+
123
+ Copy the following CLI commands into a file named example.sh. Run the
124
+ command by typing “bash example.sh” and replacing the example
125
+ parameters with your own.
126
+
127
+ Please note this sample will only work in the POSIX-compliant bash-
128
+ like shell. You need to set up the OCI configuration and appropriate
129
+ security policies before trying the examples.
130
+
131
+ export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ai-data-platform/ai-data-platform/create.html#cmdoption-compartment-id
132
+
133
+ ai_data_platform_id=$(oci ai-data-platform ai-data-platform create --compartment-id $compartment_id --query data.id --raw-output)
134
+
135
+ oci ai-data-platform ai-data-platform delete --ai-data-platform-id $ai_data_platform_id
@@ -0,0 +1,93 @@
1
+ "get"
2
+ *****
3
+
4
+ * Description
5
+
6
+ * Usage
7
+
8
+ * Required Parameters
9
+
10
+ * Optional Parameters
11
+
12
+ * Global Parameters
13
+
14
+ * Example using required parameter
15
+
16
+
17
+ Description
18
+ ===========
19
+
20
+ Gets information about a AiDataPlatform.
21
+
22
+
23
+ Usage
24
+ =====
25
+
26
+ oci ai-data-platform ai-data-platform get [OPTIONS]
27
+
28
+
29
+ Required Parameters
30
+ ===================
31
+
32
+ --ai-data-platform-id [text]
33
+
34
+ The OCID of the AiDataPlatform.
35
+
36
+
37
+ Optional Parameters
38
+ ===================
39
+
40
+ --from-json [text]
41
+
42
+ Provide input to this command as a JSON document from a file using the
43
+ file://path-to/file syntax.
44
+
45
+ The "--generate-full-command-json-input" option can be used to
46
+ generate a sample json file to be used with this command option. The
47
+ key names are pre-populated and match the command option names
48
+ (converted to camelCase format, e.g. compartment-id –> compartmentId),
49
+ while the values of the keys need to be populated by the user before
50
+ using the sample file as an input to this command. For any command
51
+ option that accepts multiple values, the value of the key can be a
52
+ JSON array.
53
+
54
+ Options can still be provided on the command line. If an option exists
55
+ in both the JSON document and the command line then the command line
56
+ specified value will be used.
57
+
58
+ For examples on usage of this option, please see our “using CLI with
59
+ advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
60
+ nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
61
+
62
+
63
+ Global Parameters
64
+ =================
65
+
66
+ Use "oci --help" for help on global parameters.
67
+
68
+ "--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
69
+ cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
70
+ defaults-file", "--endpoint", "--generate-full-command-json-input", "
71
+ --generate-param-json-input", "--help", "--latest-version", "--max-
72
+ retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
73
+ "--output", "--profile", "--proxy", "--query", "--raw-output", "--
74
+ read-timeout", "--realm-specific-endpoint", "--region", "--release-
75
+ info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
76
+
77
+
78
+ Example using required parameter
79
+ ================================
80
+
81
+ Copy the following CLI commands into a file named example.sh. Run the
82
+ command by typing “bash example.sh” and replacing the example
83
+ parameters with your own.
84
+
85
+ Please note this sample will only work in the POSIX-compliant bash-
86
+ like shell. You need to set up the OCI configuration and appropriate
87
+ security policies before trying the examples.
88
+
89
+ export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ai-data-platform/ai-data-platform/create.html#cmdoption-compartment-id
90
+
91
+ ai_data_platform_id=$(oci ai-data-platform ai-data-platform create --compartment-id $compartment_id --query data.id --raw-output)
92
+
93
+ oci ai-data-platform ai-data-platform get --ai-data-platform-id $ai_data_platform_id