us

Creates, updates, deletes, gets or lists a us resource.

Overview

Name	us
Type	Resource
Id	oci.object_storage.us

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
abort_multipart_upload	exec	namespaceName, bucketName, objectName, uploadId, region	opc-client-request-id	Aborts an in-progress multipart upload and deletes all parts that have been uploaded.<br />
commit_multipart_upload	exec	namespaceName, bucketName, objectName, uploadId, region, partsToCommit	if-match, if-none-match, opc-client-request-id	Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bucketName	string	The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1
namespaceName	string	The Object Storage namespace used for the request.
objectName	string	The name of the object. Avoid entering confidential information. Example: test/object1.log
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
uploadId	string	The upload ID for a multipart upload.
if-match	string	The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload the resource.
if-none-match	string	The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should fail if the resource already exists.
opc-client-request-id	string	The client request ID for tracing.

Lifecycle Methods

abort_multipart_upload

Aborts an in-progress multipart upload and deletes all parts that have been uploaded.<br />

EXEC oci.object_storage.us.abort_multipart_upload 
@namespaceName='{{ namespaceName }}' --required, 
@bucketName='{{ bucketName }}' --required, 
@objectName='{{ objectName }}' --required, 
@uploadId='{{ uploadId }}' --required, 
@region='{{ region }}' --required, 
@opc-client-request-id='{{ opc-client-request-id }}'
;

commit_multipart_upload

Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.<br />

EXEC oci.object_storage.us.commit_multipart_upload 
@namespaceName='{{ namespaceName }}' --required, 
@bucketName='{{ bucketName }}' --required, 
@objectName='{{ objectName }}' --required, 
@uploadId='{{ uploadId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@if-none-match='{{ if-none-match }}', 
@opc-client-request-id='{{ opc-client-request-id }}' 
@@json=
'{
"partsToCommit": "{{ partsToCommit }}", 
"partsToExclude": "{{ partsToExclude }}"
}'
;