oracle / oracle.oci / 4.21.0 / module / oci_object_storage_object_facts Fetches details about one or multiple Object resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_object_storage_object_facts (4.21.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.21.0
collections: - name: oracle.oci version: 4.21.0
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 L(Getting Started with Policies,https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
If I(object_name) is specified, the details of a single Object will be returned.
- 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
end: description: - Object names returned by a list query must be strictly less than this parameter. type: str range: description: - Optional byte range to fetch, as described in L(RFC 7233,https://tools.ietf.org/html/rfc7233#section-2.1). Note that only a single range of bytes is supported. type: str start: description: - Object names returned by a list query must be greater or equal to this parameter. type: str fields: description: - 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'. type: str prefix: description: - The string to use for matching against the start of object names in a list query. type: str region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str delimiter: description: - 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. type: str version_id: description: - VersionId used to identify a particular version of the object type: str bucket_name: description: - 'The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1`' required: true type: str cert_bundle: description: - 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. type: str object_name: description: - 'The name of the object. Avoid entering confidential information. Example: `test/object1.log`' - Required to get a specific object. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str namespace_name: description: - The Object Storage namespace used for the request. required: true type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str opc_sse_customer_key: description: - The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data. For more information, see L(Using Your Own Keys for Server-Side Encryption,https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm). type: str http_response_expires: description: - Specify this query parameter to override the Expires response header in the GetObject response. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str http_response_content_type: description: - Specify this query parameter to override the Content-Type response header in the GetObject response. type: str opc_sse_customer_algorithm: description: - The optional header that specifies "AES256" as the encryption algorithm. For more information, see L(Using Your Own Keys for Server-Side Encryption,https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm). type: str http_response_cache_control: description: - Specify this query parameter to override the Cache-Control response header in the GetObject response. type: str opc_sse_customer_key_sha256: description: - 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 L(Using Your Own Keys for Server-Side Encryption,https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm). type: str http_response_content_encoding: description: - Specify this query parameter to override the Content-Encoding response header in the GetObject response. type: str http_response_content_language: description: - Specify this query parameter to override the Content-Language response header in the GetObject response. type: str http_response_content_disposition: description: - Specify this query parameter to override the value of the Content-Disposition response header in the GetObject response. type: str realm_specific_endpoint_template_enabled: description: - Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used. type: bool
objects: contains: archival_state: description: - Archival state of an object. This field is set only for objects in Archive tier. returned: on success sample: Archived type: str etag: description: - The current entity tag (ETag) for the object. returned: on success sample: etag_example type: str md5: description: - Base64-encoded MD5 hash of the object data. returned: on success sample: md5_example type: str name: description: - 'The name of the object. Avoid entering confidential information. Example: test/object1.log' returned: on success sample: name_example type: str size: description: - Size of the object in bytes. returned: on success sample: 56 type: int storage_tier: description: - The storage tier that the object is stored in. returned: on success sample: Standard type: str time_created: description: - The date and time the object was created, as described in L(RFC 2616,https://tools.ietf.org/html/rfc2616#section-14.29). returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_modified: description: - The date and time the object was modified, as described in L(RFC 2616,https://tools.ietf.org/rfc/rfc2616), section 14.29. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - List of Object resources returned: on success 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' type: complex