Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key

строка

Идентификатор ключа доступа 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 в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.

aws_ca_bundle

путь

Путь к пакету центров сертификации (CA), используемому при проверке SSL-сертификатов.

Также можно использовать переменную среды AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры перечислены в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

bucket_name

строка / обязательно

Имя бакета, содержащего объект.

ceph

псевдонимы: rgw

логическое значение

Включить совместимость API с Ceph RGW.

Учитывается подмножество API S3, работающее с Ceph, чтобы обеспечить по возможности одинаковое поведение модуля.

Требуется endpoint_url, если ceph=true.

Варианты:

  • false ← (по умолчанию)
  • true

debug_botocore_endpoint_logs

логическое значение

Использовать регистратор botocore.endpoint для анализа уникальных (а не общего числа) вызовов API "resource:action", выполненных во время задачи, и выводить набор в ключ resource_actions результатов задачи. Используйте обработчик обратного вызова aws_resource_action, чтобы вывести общее число вызовов за плейбук.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

dualstack

логическое значение

Включает конечные точки Amazon S3 с поддержкой Dual-Stack, позволяя обмениваться данными с S3 по IPv4 и IPv6.

Взаимоисключающий с endpoint_url.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: aws_endpoint_url

строка

Конечная точка URL S3 для использования с Ceph, Eucalyptus, fakes3 и т. д. В остальных случаях предполагается использование AWS.

marker

строка

добавлено в amazon.aws 9.0.0

Указывает ключ объекта, с которого следует начать. Ключи объектов возвращаются в алфавитном порядке, начиная со следующего после маркера ключа.

max_keys

целое число

добавлено в amazon.aws 9.0.0

Максимальное число результатов для возврата. Укажите это значение, если нужно получить только часть результатов.

object_details

словарь

Получить запрошенные подробные сведения об объекте S3.

attributes_list

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

Поля/сведения, которые следует вернуть.

Обязательно, если object_details.object_attributes=true.

Варианты:

  • "ETag"
  • "Checksum"
  • "ObjectParts"
  • "StorageClass"
  • "ObjectSize"

object_acl

логическое значение

Получить ACL объекта S3.

Варианты:

  • false ← (по умолчанию)
  • true

object_attributes

логическое значение

Получить атрибуты объекта S3.

Варианты:

  • false ← (по умолчанию)
  • true

object_legal_hold

логическое значение

Получить сведения о юридическом запрете на удаление объекта S3.

Варианты:

  • false ← (по умолчанию)
  • true

object_lock_configuration

логическое значение

Получить конфигурацию блокировки объекта S3.

Варианты:

  • false ← (по умолчанию)
  • true

object_retention

логическое значение

Получить сведения о сроке хранения объекта S3.

Варианты:

  • false ← (по умолчанию)
  • true

object_tagging

логическое значение

Получить теги объекта S3.

Варианты:

  • false ← (по умолчанию)
  • true

object_name

строка

Имя объекта.

Если параметр не указан, будет возвращён список всех объектов в указанном бакете.

Взаимоисключающий с prefix.

prefix

строка

добавлено в amazon.aws 9.2.0

Ограничивает ответ ключами, начинающимися с указанного префикса.

Взаимоисключающий с object_name.

profile

псевдонимы: aws_profile

строка

Именованный профиль AWS для аутентификации.

Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную среды AWS_PROFILE.

Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.

region

псевдонимы: aws_region

строка

Регион AWS для использования.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную среды AWS_REGION.

Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

строка

Секретный ключ доступа 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 в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.

session_token

псевдонимы: aws_session_token

строка

Токен сеанса 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.

Параметры session_token и profile взаимоисключающие.

validate_certs

логическое значение

Если задано значение false, SSL-сертификаты при обмене данными с API AWS проверяться не будут.

Настоятельно не рекомендуется устанавливать validate_certs=false; в качестве альтернативы рассмотрите настройку aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются в контексте «узла» Ansible, а не в контексте «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются в контексте «контроллера» Ansible, а не в контексте «узла».
  • Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учётных данных и других настроек, например региона, из файлов конфигурации в контексте «узла» 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

- name: Retrieve keys that begin with the prefix /my/desired/
  amazon.aws.s3_object_info:
    bucket: mybucket
    prefix: /my/desired/

Возвращаемые значения

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

Ключ

Описание

object_info

list / elements=dictionary

Сведения об объекте S3.

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

object_acl

complex

Список управления доступом (ACL) объекта.

Возвращается: если object_details.object_acl=true.

grants

complex

Список разрешений.

Возвращается: всегда

grantee

complex

Субъект, которому предоставляются разрешения.

Возвращается: всегда

id

string

Канонический идентификатор пользователя, которому предоставляются разрешения.

Возвращается: всегда

Пример: "xxxxxxxxxxxxxxxxxxx"

type

string

Тип субъекта, которому предоставляются разрешения.

Возвращается: всегда

Пример: "CanonicalUser"

permission

string

Указывает разрешение, предоставленное субъекту.

Возвращается: всегда

Пример: "FULL CONTROL"

owner

complex

Отображаемое имя и идентификатор владельца бакета.

Возвращается: всегда

display_name

string

Отображаемое имя владельца бакета.

Возвращается: всегда

Пример: "abcd"

id

string

Идентификатор владельца бакета.

Возвращается: всегда

Пример: "xxxxxxxxxxxxxxxxxxxxx"

object_attributes

complex

Атрибуты объекта.

Возвращается: если object_details.object_attributes=true.

checksum

complex

Контрольная сумма или дайджест объекта.

Возвращается: всегда

checksum_crc32

string

Контрольная сумма CRC32 объекта размером 32 бита, закодированная в base64.

Возвращается: если она была загружена вместе с объектом.

Пример: "xxxxxxxxxxxx"

checksum_crc32c

string

Контрольная сумма CRC32C объекта размером 32 бита, закодированная в base64.

Возвращается: если она была загружена вместе с объектом.

Пример: "xxxxxxxxxxxx"

checksum_sha1

string

Дайджест SHA-1 объекта размером 160 бит, закодированный в base64.

Возвращается: если он был загружен вместе с объектом.

Пример: "xxxxxxxxxxxx"

checksum_sha256

string

Дайджест SHA-256 объекта размером 256 бит, закодированный в base64.

Возвращается: если он был загружен вместе с объектом.

Пример: "xxxxxxxxxxxx"

etag

string

ETag — это непрозрачный идентификатор, присваиваемый веб-сервером определённой версии ресурса, доступного по URL-адресу.

Возвращается: всегда

Пример: "8fa34xxxxxxxxxxxxxxxxxxxxx35c6f3b"

last_modified

string

Дата создания объекта.

Возвращается: всегда

Пример: "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

Размер объекта в байтах.

Возвращается: всегда

Пример: 819

parts

complex

Контейнер для элементов, относящихся к отдельной части.

Возвращается: всегда

checksum_crc32

string

Контрольная сумма CRC32 объекта размером 32 бита, закодированная в base64.

Возвращается: если она была загружена вместе с объектом.

Пример: "xxxxxxxxxxxx"

checksum_crc32c

string

Контрольная сумма CRC32C объекта размером 32 бита, закодированная в base64.

Возвращается: если она была загружена вместе с объектом.

Пример: "xxxxxxxxxxxx"

checksum_sha1

string

Дайджест SHA-1 объекта размером 160 бит, закодированный в base64.

Возвращается: если он был загружен вместе с объектом.

Пример: "xxxxxxxxxxxx"

checksum_sha256

string

Дайджест SHA-256 объекта размером 256 бит, закодированный в base64.

Возвращается: если он был загружен вместе с объектом.

Пример: "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

list / elements=string

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

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

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

Авторы

  • Mandar Vijay Kulkarni (@mandar242)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API