Модуль amazon.aws.s3_object_info – Сбор информации об объектах в S3

Примечание

Этот модуль является частью коллекции amazon.aws (версия 8.2.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: amazon.aws.s3_object_info.

Новый в amazon.aws 5.0.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Описывает объекты в S3.
Совместим с AWS, DigitalOcean, Ceph, Walrus, FakeS3 и StorageGRID (в настоящее время поддерживает только list_keys).
При использовании не-AWS сервисов необходимо указать endpoint_url.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` или `EC2_ACCESS_KEY` также могут использоваться в порядке убывания предпочтения. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в версии 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в выпуске после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в выпуске после 2024-12-01.
aws_ca_bundle path	Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды `AWS_CA_BUNDLE` также может использоваться.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
bucket_name string / required	Имя корзины, содержащей объект.
ceph aliases: rgw boolean	Включить совместимость API с Ceph RGW. Учитывает подмножество API S3, работающее с Ceph, чтобы обеспечить одинаковое поведение модуля, где это возможно. Требуется `endpoint_url`, если `ceph=true`. Варианты: `false` ← (по умолчанию) `true`
debug_botocore_endpoint_logs boolean	Использовать `botocore.endpoint` регистратор для анализа уникальных (а не общих) `"resource:action"` вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода в общий список, созданный во время выполнения playbook. Переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS` также может использоваться. Варианты: `false` ← (по умолчанию) `true`
dualstack boolean	Включает конечные точки Amazon S3 Dual-Stack, позволяя S3-связи использовать как IPv4, так и IPv6. Поддержка одновременной передачи `dualstack` и `endpoint_url` устарела, конечные точки dualstack автоматически настраиваются с использованием настроенного `region`. Поддержка будет удалена в выпуске после 2024-12-01. Варианты: `false` ← (по умолчанию) `true`
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	Конечная точка URL S3 для использования с Ceph, Eucalyptus и fakes3 и т.д. В противном случае предполагается AWS.
object_details dictionary	Получение запрошенной подробной информации о объекте S3.
attributes_list list / elements=string	Поля/детали, которые должны быть возвращены. Требуется, когда `object_details.object_attributes=true`. Варианты: `"ETag"` `"Checksum"` `"ObjectParts"` `"StorageClass"` `"ObjectSize"`
object_acl boolean	Получить ACL объекта S3. Варианты: `false` ← (по умолчанию) `true`
object_attributes boolean	Получить атрибуты объекта S3. Варианты: `false` ← (по умолчанию) `true`
object_legal_hold boolean	Получить legal_hold объекта S3. Варианты: `false` ← (по умолчанию) `true`
object_lock_configuration boolean	Получить lock_configuration объекта S3. Варианты: `false` ← (по умолчанию) `true`
object_retention boolean	Получить retention объекта S3. Варианты: `false` ← (по умолчанию) `true`

object_tagging boolean	Получить теги объекта S3. Варианты: `false` ← (по умолчанию) `true`
object_name string	Имя объекта. Если не указано, будет возвращён список всех объектов в указанном ведре.
profile aliases: aws_profile string	Используемый профиль AWS для аутентификации. См. документацию AWS для получения дополнительной информации о именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения `AWS_PROFILE`. Параметр profile исключает использование параметров aws_access_key, aws_secret_key и security_token.
region aliases: aws_region, ec2_region string	Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменные окружения `AWS_REGION` или `EC2_REGION`. См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удалён в релизе после 2024-12-01 Поддержка переменной окружения `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	Секретный ключ доступа AWS. См. документацию AWS для получения дополнительной информации об маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_SECRET_ACCESS_KEY`, `AWS_SECRET_KEY`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной окружения `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	AWS STS сессионный токен для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN`, или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token добавлены в релизе 3.2.0, с изменением параметра с security_token на session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных окружения `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
validate_certs boolean	При значении `false`, сертификаты SSL для связи с API AWS не будут проверены. Установка validate_certs=false категорически не рекомендуется, вместо этого рассмотрите установку aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Поддержка переменной окружения S3_URL устарела и будет удалена в релизе после 2024-12-01, пожалуйста, используйте параметр endpoint_url или переменную окружения AWS_URL.
Внимание: Для модулей переменные окружения и конфигурационные файлы считываются из контекста хоста Ansible, а не контекста контроллера. В связи с этим, файлы может потребоваться скопировать на хост. Для плагинов поиска и подключения переменные окружения и конфигурационные файлы считываются из контекста контроллера Ansible, а не контекста хоста.
AWS SDK (boto3), который используется Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из конфигурационных файлов в контексте хоста Ansible (обычно ~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Retrieve a list of objects in S3 bucket
  amazon.aws.s3_object_info:
    bucket_name: MyTestBucket

- name: Retrieve a list of objects in Ceph RGW S3
  amazon.aws.s3_object_info:
    bucket_name: MyTestBucket
    ceph: true
    endpoint_url: "http://localhost:8000"

- name: Retrieve object metadata without object itself
  amazon.aws.s3_object_info:
    bucket_name: MyTestBucket
    object_name: MyTestObjectKey

- name: Retrieve detailed S3 information for all objects in the bucket
  amazon.aws.s3_object_info:
    bucket_name: MyTestBucket
    object_details:
      object_acl: true
      object_attributes: true
      attributes_list:
        - ETag
        - ObjectSize
        - StorageClass

- name: Retrieve detailed S3 object information
  amazon.aws.s3_object_info:
    bucket_name: MyTestBucket
    object_name: MyTestObjectKey
    object_details:
      object_acl: true
      object_tagging: true
      object_legal_hold: true
      object_attributes: true
      attributes_list:
        - ETag
        - ObjectSize

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
object_info список / элементы=словарь	Подробная информация об объекте S3. Возвращается: когда `bucket_name` и `object_name` указаны.
object_acl сложный	Список управления доступом (ACL) объекта. Возвращается: когда `object_details.object_acl=true`.
grants сложный	Список разрешений. Возвращается: всегда
grantee сложный	Сущность, которой предоставляются разрешения. Возвращается: всегда
id строка	Канонический идентификатор пользователя получателя. Возвращается: всегда Пример: `"xxxxxxxxxxxxxxxxxxx"`
type строка	Тип получателя. Возвращается: всегда Пример: `"CanonicalUser"`
permission строка	Указывает разрешение, предоставленное получателю. Возвращается: всегда Пример: `"FULL CONTROL"`
owner сложный	Идентификатор и имя владельца ведра. Возвращается: всегда
display_name строка	Отображаемое имя владельца ведра. Возвращается: всегда Пример: `"abcd"`
id строка	Идентификатор владельца ведра. Возвращается: всегда Пример: `"xxxxxxxxxxxxxxxxxxxxx"`
object_attributes сложный	Атрибуты объекта. Возвращается: когда `object_details.object_attributes=true`.
checksum сложный	Контрольная сумма или дайджест объекта. Возвращается: всегда
checksum_crc32 строка	Контрольная сумма CRC32 объекта в кодировке base64, 32 бита. Возвращается: если объект был загружен с ней. Пример: `"xxxxxxxxxxxx"`
checksum_crc32c строка	Контрольная сумма CRC32C объекта в кодировке base64, 32 бита. Возвращается: если объект был загружен с ней. Пример: `"xxxxxxxxxxxx"`
checksum_sha1 строка	Дайджест SHA-1 объекта в кодировке base64, 160 бит. Возвращается: если объект был загружен с ней. Пример: `"xxxxxxxxxxxx"`
checksum_sha256 строка	Дайджест SHA-256 объекта в кодировке base64, 256 бит. Возвращается: если объект был загружен с ней. Пример: `"xxxxxxxxxxxx"`
etag строка	ETag — это непрозрачный идентификатор, назначенный веб-сервером определенной версии ресурса, найденного по URL. Возвращается: всегда Пример: `"8fa34xxxxxxxxxxxxxxxxxxxxx35c6f3b"`
last_modified строка	Дата создания объекта. Возвращается: всегда Пример: `"2022-08-10T01:11:03+00:00"`

object_parts complex	Коллекция частей, связанных с многочастной загрузкой. Возвращается: всегда
is_truncated boolean	Указывает, усечён ли возвращённый список частей. Возвращается: всегда
max_parts integer	Максимальное количество частей, разрешённых в ответе. Возвращается: всегда
next_part_number_marker integer	Когда список усечён, этот элемент указывает на последнюю часть в списке А также значение, которое нужно использовать для параметра запроса PartNumberMarker в последующем запросе. Возвращается: всегда
part_number_marker integer	Маркер для текущей части. Возвращается: всегда
total_parts_count integer	Общее количество частей. Возвращается: всегда
object_size integer	Размер объекта в байтах. Возвращается: alwayS Пример: `819`
parts complex	Контейнер для элементов, связанных с отдельной частью. Возвращается: всегда
checksum_crc32 string	Кодированная в base64, 32-битная контрольная сумма CRC32 объекта. Возвращается: если она была загружена с объектом. Пример: `"xxxxxxxxxxxx"`
checksum_crc32c string	Кодированная в base64, 32-битная контрольная сумма CRC32C объекта. Возвращается: если она была загружена с объектом. Пример: `"xxxxxxxxxxxx"`
checksum_sha1 string	Кодированный в base64, 160-битный дайджест SHA-1 объекта. Возвращается: если она была загружена с объектом. Пример: `"xxxxxxxxxxxx"`
checksum_sha256 string	Кодированный в base64, 256-битный дайджест SHA-256 объекта. Возвращается: если она была загружена с объектом. Пример: `"xxxxxxxxxxxx"`
part_number integer	Номер части, идентифицирующий часть. Это значение представляет собой положительное целое число от 1 до 10 000. Возвращается: всегда
size integer	Размер загруженной части в байтах. Возвращается: всегда
storage_class string	Информация о классе хранения объекта. Возвращается: всегда Пример: `"STANDARD"`
object_data dictionary	Словарь, содержащий метаданные объекта S3. Возвращается: когда `bucket_name` и `object_name` указаны, но `object_details` не указан.
accept_ranges string	Указывает, что был указан диапазон байтов. Возвращается: всегда
content_length integer	Размер тела (данных объекта) в байтах. Возвращается: всегда
content_type string	Стандартный тип MIME, описывающий формат данных объекта. Возвращается: всегда

e_tag string	Непрозрачный идентификатор, назначенный веб-сервером определенной версии ресурса, найденного по URL-адресу. Возвращается: всегда
last_modified string	Дата создания объекта. Возвращается: всегда
metadata dictionary	Карта метаданных для хранения с объектом в S3. Возвращается: всегда
server_side_encryption string	Алгоритм шифрования на стороне сервера, используемый при хранении этого объекта в Amazon S3. Возвращается: всегда
tag_count integer	Количество тегов, если таковые имеются, в объекте. Возвращается: всегда
object_legal_hold complex	Текущий статус юридической блокировки объекта Возвращается: когда `object_details.object_legal_hold=true` и юридическая блокировка объекта установлена в корзине.
legal_hold complex	Текущий статус юридической блокировки для указанного объекта. Возвращается: всегда
status string	Указывает, есть ли у указанного объекта юридическая блокировка. Возвращается: всегда Пример: `"ON"`
object_lock_configuration complex	Конфигурация блокировки объектов для корзины. Возвращается: когда `object_details.object_lock_configuration=true` и конфигурация блокировки объектов установлена в корзине.
object_lock_enabled string	Указывает, включена ли для этой корзины конфигурация блокировки объектов. Возвращается: всегда
rule complex	Указывает правило блокировки объектов для указанного объекта. Возвращается: всегда
default_retention complex	Режим и период хранения по умолчанию для блокировки объектов, которые вы хотите применить к новым объектам, размещенным в указанной корзине. Возвращается: всегда
days integer	Количество дней, которое вы хотите указать для периода хранения по умолчанию. Возвращается: всегда
mode string	Режим хранения по умолчанию для блокировки объектов, который вы хотите применить к новым объектам, размещенным в указанной корзине. Должен использоваться с Days или Years. Возвращается: всегда
years integer	Количество лет, которое вы хотите указать для периода хранения по умолчанию. Возвращается: всегда
object_retention complex	Параметры хранения объекта. Возвращается: когда `object_details.object_retention=true` и параметр хранения объекта установлен в корзине.
retention complex	Контейнерный элемент для параметров хранения объекта. Возвращается: всегда
mode string	Указывает режим хранения для указанного объекта. Возвращается: всегда
retain_until_date string	Дата истечения срока действия этого параметра хранения блокировки объектов. Возвращается: всегда
object_tagging dictionary	Набор тегов объекта Возвращается: когда `object_details.object_tagging=true`.

s3_keys

список / элементы=строка

Список ключей объектов.

Возвращается: когда указан только bucket_name, и object_name, object_details не указаны.

Пример: ["prefix1/", "prefix1/key1", "prefix1/key2"]

Авторы

Мандар Виджай Кулкарни (@mandar242)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/s3_object_info_module.html