oracle.oci.oci_object_storage_object_facts – Fetches details about one or multiple Object resources in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 4.13.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_object_storage_object_facts.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Fetches details about one or multiple Object resources in Oracle Cloud Infrastructure
Lists the objects in a bucket. By default, ListObjects returns object names only. See the fields parameter for other fields that you can optionally include in ListObjects response.
ListObjects returns at most 1000 objects. To paginate through more objects, use the returned ‘nextStartWith’ value with the ‘start’ parameter. To filter which objects ListObjects returns, use the ‘start’ and ‘end’ parameters.
To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
If object_name is specified, the details of a single Object will be returned.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter	Choices/Defaults	Comments
api_user string		The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See `config_file_location`). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint string		Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See `config_file_location`). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file string		Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See `config_file_location`). If the key is encrypted with a pass-phrase, the `api_user_key_pass_phrase` option must also be provided.
api_user_key_pass_phrase string		Passphrase used by the key referenced in `api_user_key_file`, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See `config_file_location`).
auth_purpose string	Choices: service_principal	The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type string	Choices: api_key ← instance_principal instance_obo_user resource_principal	The type of authentication to use for making API requests. By default `auth_type="api_key"` based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use `auth_type="instance_principal"` to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
bucket_name string / required		The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1`
cert_bundle string		The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
config_file_location string		Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name string		The profile to load from the config file referenced by `config_file_location`. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in `config_file_location`.
delimiter string		When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only '/' is a supported delimiter character at this time.
end string		Object names returned by a list query must be strictly less than this parameter.
fields string		Object summary by default includes only the 'name' field. Use this parameter to also include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time), 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields. Specify the value of this parameter as a comma-separated, case-insensitive list of those field names. For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.
http_response_cache_control string		Specify this query parameter to override the Cache-Control response header in the GetObject response.
http_response_content_disposition string		Specify this query parameter to override the value of the Content-Disposition response header in the GetObject response.
http_response_content_encoding string		Specify this query parameter to override the Content-Encoding response header in the GetObject response.
http_response_content_language string		Specify this query parameter to override the Content-Language response header in the GetObject response.
http_response_content_type string		Specify this query parameter to override the Content-Type response header in the GetObject response.
http_response_expires string		Specify this query parameter to override the Expires response header in the GetObject response.
namespace_name string / required		The Object Storage namespace used for the request.
object_name string		The name of the object. Avoid entering confidential information. Example: `test/object1.log` Required to get a specific object.
opc_sse_customer_algorithm string		The optional header that specifies "AES256" as the encryption algorithm. For more information, see Using Your Own Keys for Server-Side Encryption.
opc_sse_customer_key string		The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data. For more information, see Using Your Own Keys for Server-Side Encryption.
opc_sse_customer_key_sha256 string		The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This value is used to check the integrity of the encryption key. For more information, see Using Your Own Keys for Server-Side Encryption.
prefix string		The string to use for matching against the start of object names in a list query.
range string		Optional byte range to fetch, as described in RFC 7233. Note that only a single range of bytes is supported.
region string		The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See `config_file_location`). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
start string		Object names returned by a list query must be greater or equal to this parameter.
tenancy string		OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See `config_file_location`). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
version_id string		VersionId used to identify a particular version of the object

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Get a specific object
  oci_object_storage_object_facts:
    # required
    object_name: object_name_example
    namespace_name: namespace_name_example
    bucket_name: bucket_name_example

    # optional
    version_id: "ocid1.version.oc1..xxxxxxEXAMPLExxxxxx"
    range: range_example
    opc_sse_customer_algorithm: opc_sse_customer_algorithm_example
    opc_sse_customer_key: opc_sse_customer_key_example
    opc_sse_customer_key_sha256: opc_sse_customer_key_sha256_example
    http_response_content_disposition: http_response_content_disposition_example
    http_response_cache_control: http_response_cache_control_example
    http_response_content_type: http_response_content_type_example
    http_response_content_language: http_response_content_language_example
    http_response_content_encoding: http_response_content_encoding_example
    http_response_expires: http_response_expires_example

- name: List objects
  oci_object_storage_object_facts:
    # required
    namespace_name: namespace_name_example
    bucket_name: bucket_name_example

    # optional
    prefix: prefix_example
    start: start_example
    end: end_example
    delimiter: delimiter_example
    fields: fields_example

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
objects complex		on success	List of Object resources Sample: [{'archival_state': 'Archived', 'etag': 'etag_example', 'md5': 'md5_example', 'name': 'name_example', 'size': 56, 'storage_tier': 'Standard', 'time_created': '2013-10-20T19:20:30+01:00', 'time_modified': '2013-10-20T19:20:30+01:00'}]
	archival_state string	on success	Archival state of an object. This field is set only for objects in Archive tier. Sample: Archived
	etag string	on success	The current entity tag (ETag) for the object. Sample: etag_example
	md5 string	on success	Base64-encoded MD5 hash of the object data. Sample: md5_example
	name string	on success	The name of the object. Avoid entering confidential information. Example: test/object1.log Sample: name_example
	size integer	on success	Size of the object in bytes. Sample: 56
	storage_tier string	on success	The storage tier that the object is stored in. Sample: Standard
	time_created string	on success	The date and time the object was created, as described in RFC 2616. Sample: 2013-10-20T19:20:30+01:00
	time_modified string	on success	The date and time the object was modified, as described in RFC 2616, section 14.29. Sample: 2013-10-20T19:20:30+01:00

Authors¶

Oracle (@oracle)

oracle.oci.oci_object_storage_object_facts – Fetches details about one or multiple Object resources in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶