create-job

Описание

Эта операция создаёт задачу S3 Batch Operations.

Вы можете использовать S3 Batch Operations для выполнения масштабных пакетных действий над объектами Amazon S3. Batch Operations могут выполнить одно действие над списками объектов Amazon S3, которые вы указываете. Дополнительную информацию см. в разделе S3 Batch Operations в Руководстве пользователя Amazon S3.

Разрешения

Дополнительную информацию о разрешениях, необходимых для использования Batch Operations, см. в разделе Назначение разрешений для S3 Batch Operations в Руководстве пользователя Amazon S3.

Связанные действия включают:

DescribeJob
ListJobs
UpdateJobPriority
UpdateJobStatus
JobOperation

См. также: Документация AWS API

Синтаксис

  create-job
--account-id <value>
[--confirmation-required | --no-confirmation-required]
--operation <value>
--report <value>
[--client-request-token <value>]
[--manifest <value>]
[--description <value>]
--priority <value>
--role-arn <value>
[--tags <value>]
[--manifest-generator <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--account-id (строка)

Идентификатор учётной записи Amazon Web Services, которая создаёт задачу.

--confirmation-required | --no-confirmation-required (логическое значение)

Указывает, требуется ли подтверждение перед запуском задачи Amazon S3. Подтверждение требуется только для задач, созданных через консоль Amazon S3.

--operation (структура)

Действие, которое вы хотите, чтобы эта работа выполняла над каждым объектом, перечисленным в манифесте. Дополнительную информацию об доступных действиях см. в разделе «Операции» в руководстве Amazon S3 User Guide.

LambdaInvoke -> (структура)

Указывает указанной работе вызвать функцию Lambda для каждого объекта в манифесте.

FunctionArn -> (строка)

Идентификатор ресурса Amazon (ARN) функции Lambda, которую указанная работа будет вызывать для каждого объекта в манифесте.

InvocationSchemaVersion -> (строка)

Указывает версию схемы для полезной нагрузки, которую Batch Operations отправляет при вызове функции Lambda. Версия 1.0 является значением по умолчанию. Версия 2.0 требуется, когда вы используете Batch Operations для вызова функций Lambda, которые действуют над корзинами каталогов, или если вам нужно указать UserArguments. Дополнительную информацию см. в статье «Автоматизация обработки объектов в корзинах каталогов Amazon S3 с помощью S3 Batch Operations и Lambda» в блоге Amazon Web Services Storage.

Предупреждение

Убедитесь, что код вашей функции Lambda ожидает InvocationSchemaVersion 2.0 и использует имя корзины вместо ARN корзины. Если InvocationSchemaVersion не соответствует ожиданиям вашей функции Lambda, она может работать некорректно.

Примечание

Корзины каталогов - Чтобы запустить функцию Amazon Web Services Lambda для выполнения пользовательских действий над объектами в корзинах каталогов, вы должны указать 2.0.

UserArguments -> (массив)

Ключевые пары, которые передаются в полезную нагрузку, которую Batch Operations отправляет при вызове функции Lambda. Вы должны указать InvocationSchemaVersion 2.0 для операций LambdaInvoke, которые включают UserArguments. Дополнительную информацию см. в статье «Автоматизация обработки объектов в корзинах каталогов Amazon S3 с помощью S3 Batch Operations и Lambda» в блоге Amazon Web Services Storage.

key -> (строка)

value -> (строка)

S3PutObjectCopy -> (структура)

Указывает указанной работе выполнить вызов PUT Copy объекта для каждого объекта в манифесте.

TargetResource -> (строка)

Указывает идентификатор ресурса Amazon (ARN) целевой корзины для операции пакетной копии.

Корзины общего назначения - Например, чтобы скопировать объекты в корзину общего назначения с именем destinationBucket, задайте свойство TargetResource равным arn:aws:s3:::destinationBucket.
Корзины каталогов - Например, чтобы скопировать объекты в корзину каталогов с именем destinationBucket в зоне доступности, определенной идентификатором зоны usw2-az1, задайте свойство TargetResource равным arn:aws:s3express:*region* :*account_id* :/bucket/*destination_bucket_base_name* --*usw2-az1* --x-s3. Корзина каталогов в качестве целевой корзины может находиться в зоне доступности или локальной зоне.

Примечание

Копирование объектов между различными регионами Amazon Web Services не поддерживается, если исходная или целевая корзина находятся в локальных зонах Amazon Web Services. Исходная и целевая корзины должны находиться в одном регионе Amazon Web Services. В противном случае вы получите ошибку HTTP 400 Bad Request с кодом ошибки InvalidRequest.

CannedAccessControlList -> (строка)

Примечание

Эта функция не поддерживается корзинами каталогов.

AccessControlGrants -> (список)

Примечание

Эта функция не поддерживается корзинами каталогов.

(структура)

Grantee -> (структура)

TypeIdentifier -> (строка)

Identifier -> (строка)

DisplayName -> (строка)

Permission -> (строка)

MetadataDirective -> (строка)

ModifiedSinceConstraint -> (метка времени)

NewObjectMetadata -> (структура)

Если вы не предоставите этот параметр, Amazon S3 скопирует всю метаданные из исходных объектов. Если вы укажете пустой набор, новые объекты не будут иметь тегов. В противном случае Amazon S3 присвоит новые теги новым объектам.

CacheControl -> (строка)

ContentDisposition -> (строка)

ContentEncoding -> (строка)

ContentLanguage -> (строка)

UserMetadata -> (массив)

key -> (строка)

value -> (строка)

ContentLength -> (целое число)

Этот элемент устарел.

ContentMD5 -> (строка)

Этот элемент устарел.

ContentType -> (строка)

HttpExpiresDate -> (метка времени)

RequesterCharged -> (логическое значение)

Этот элемент устарел.

SSEAlgorithm -> (строка)

Алгоритм шифрования на стороне сервера, используемый при хранении объектов в Amazon S3.

Корзины каталогов - Для корзин каталогов доступны только два поддерживаемых варианта шифрования на стороне сервера: шифрование на стороне сервера с использованием управляемых Amazon S3 ключей (SSE-S3) (AES256 ) и шифрование на стороне сервера с использованием ключей KMS (SSE-KMS) (KMS). Дополнительную информацию см. в разделе «Защита данных с помощью шифрования на стороне сервера» в руководстве Amazon S3 User Guide. Для операции копии в Batch Operations см. S3CopyObjectOperation.

NewObjectTagging -> (список)

Указывает список тегов для добавления к целевым объектам после их копирования. Если NewObjectTagging не указан, теги исходных объектов копируются в целевые объекты по умолчанию.

Примечание

Корзины каталогов - Теги не поддерживаются корзинами каталогов. Если ваши исходные объекты имеют теги, а ваша целевая корзина — корзина каталогов, укажите пустой набор тегов в поле NewObjectTagging, чтобы предотвратить копирование тегов исходных объектов в корзину каталогов.

(структура)

Контейнер для пары ключ-значение.

Key -> (строка)

Ключ тега

Value -> (строка)

Значение тега

RedirectLocation -> (строка)

Если целевая корзина настроена как веб-сайт, указывает необязательное свойство метаданных для перенаправлений веб-сайта, x-amz-website-redirect-location. Разрешает перенаправления веб-страниц, если к копии объекта обращаются через веб-точку входа.

Примечание

Эта функция не поддерживается корзинами каталогов.

RequesterPays -> (логическое значение)

Примечание

Эта функция не поддерживается корзинами каталогов.

StorageClass -> (строка)

Укажите класс хранения для целевых объектов в операции Copy.

Примечание

Корзины каталогов - Эта функция не поддерживается корзинами каталогов.

UnModifiedSinceConstraint -> (метка времени)

SSEAwsKmsKeyId -> (строка)

Указывает идентификатор ключа KMS (идентификатор ключа, ARN ключа или псевдоним ключа) для использования при шифровании объекта. Если ключ KMS не существует в той же учетной записи, что и команда, вы должны использовать полный ARN ключа, а не идентификатор ключа.

Примечание

Корзины каталогов - Если вы укажете SSEAlgorithm с KMS, вы должны указать параметр SSEAwsKmsKeyId с идентификатором (идентификатором ключа или ARN ключа) управляемого пользователем симметричного ключа шифрования KMS для использования. В противном случае вы получите ошибку HTTP 400 Bad Request. Формат псевдонима ключа ключа KMS не поддерживается. Чтобы зашифровать новые копии объектов в корзине каталогов с SSE-KMS, вы должны указать SSE-KMS в качестве стандартной настройки шифрования корзины каталогов с использованием ключа KMS (а именно, управляемого пользователем ключа). Управляемый Amazon Web Services ключ (aws/s3) не поддерживается. Ваша настройка SSE-KMS может поддерживать только 1 управляемый пользователем ключ на одну корзину каталогов на протяжении всего срока службы корзины. После указания управляемого пользователем ключа для SSE-KMS в качестве стандартной настройки шифрования корзины вы не можете переопределить управляемый пользователем ключ для настройки SSE-KMS корзины. Затем, когда вы указываете параметры шифрования на стороне сервера для новых копий объектов с SSE-KMS, вы должны убедиться, что ключ шифрования — это тот же управляемый пользователем ключ, который вы указали для стандартной настройки шифрования корзины каталогов.

TargetKeyPrefix -> (строка)

Указывает префикс папки, в которую вы хотите скопировать объекты. Например, чтобы скопировать объекты в папку с именем Folder1 в целевой корзине, задайте свойство TargetKeyPrefix равным Folder1.

ObjectLockLegalHoldStatus -> (строка)

Статус юридического удержания, который будет применяться ко всем объектам в задаче Batch Operations.

Примечание

Эта функция не поддерживается корзинами каталогов.

ObjectLockMode -> (строка)

Режим удержания, который будет применяться ко всем объектам в задаче Batch Operations.

Примечание

Эта функция не поддерживается корзинами каталогов.

ObjectLockRetainUntilDate -> (метка времени)

Дата, когда истекает срок действия примененной конфигурации удержания объектов для всех объектов в задаче Batch Operations.

Примечание

Эта функция не поддерживается корзинами каталогов.

BucketKeyEnabled -> (логическое значение)

Указывает, следует ли Amazon S3 использовать ключ корзины S3 для шифрования объектов с использованием шифрования на стороне сервера с помощью Amazon Web Services KMS (SSE-KMS). Установка этого заголовка в значение true заставляет Amazon S3 использовать ключ корзины S3 для шифрования объектов с SSE-KMS.

Указание этого заголовка с действием копирования не влияет на установки на уровне корзины для ключа корзины S3.

Примечание

Корзины каталогов - Ключи корзины S3 не поддерживаются, когда вы копируете объекты, зашифрованные SSE-KMS, из корзин общего назначения в корзины каталогов, из корзин каталогов в корзины общего назначения или между корзинами каталогов с помощью операции копии в Batch Operations. В этом случае Amazon S3 выполняет вызов KMS каждый раз при выполнении запроса копии для объекта, зашифрованного KMS.

ChecksumAlgorithm -> (строка)

Указывает алгоритм, который вы хотите, чтобы Amazon S3 использовал для создания контрольной суммы. Дополнительную информацию см. в разделе «Проверка целостности объектов» в руководстве Amazon S3 User Guide.

S3PutObjectAcl -> (структура)

Указывает указанной работе выполнить вызов PutObjectAcl для каждого объекта в манифесте.

Примечание

Эта функция не поддерживается корзинами каталогов.

AccessControlPolicy -> (структура)

AccessControlList -> (структура)

Owner -> (структура)

ID -> (строка)

DisplayName -> (строка)

Grants -> (список)

(структура)

Grantee -> (структура)

TypeIdentifier -> (строка)

Identifier -> (строка)

DisplayName -> (строка)

Permission -> (строка)

CannedAccessControlList -> (строка)

S3PutObjectTagging -> (структура)

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

Примечание

Данная функциональность не поддерживается для ведер каталогов.

TagSet -> (список)

(структура)

Контейнер для пары имени-значения ключа.

Ключ -> (строка)

Ключ тега

Значение -> (строка)

Значение тега

S3DeleteObjectTagging -> (структура)

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

Примечание

Данная функциональность не поддерживается для ведер каталогов.

S3InitiateRestoreObject -> (структура)

Указывает заданному заданию инициировать запросы восстановления для каждого архивированного объекта в манифесте.

Примечание

Данная функциональность не поддерживается для ведер каталогов.

ExpirationInDays -> (целое число)

Этот аргумент определяет, как долго объект S3 Glacier или S3 Glacier Deep Archive остается доступным в Amazon S3. Задания S3 Initiate Restore Object, нацеленные на объекты S3 Glacier и S3 Glacier Deep Archive, требуют, чтобы ExpirationInDays было установлено в 1 или больше.

Напротив, не устанавливайте ExpirationInDays при создании заданий S3 Initiate Restore Object, нацеленных на объекты S3 Intelligent-Tiering Archive Access и Deep Archive Access. Объекты в архивных уровнях доступа S3 Intelligent-Tiering не подлежат истечению срока восстановления, поэтому указание ExpirationInDays приведет к ошибке запроса восстановления.

Задания S3 Batch Operations могут работать либо с объектами класса хранения S3 Glacier и S3 Glacier Deep Archive, либо с объектами уровня хранения S3 Intelligent-Tiering Archive Access и Deep Archive Access, но не с обоими типами в одном задании. Если вам нужно восстановить объекты обоих типов, вы должны создать отдельные задания Batch Operations.

GlacierJobTier -> (строка)

S3 Batch Operations поддерживает STANDARD и BULK уровни извлечения, но не EXPEDITED уровень извлечения.

S3PutObjectLegalHold -> (структура)

Содержит конфигурацию для операции с юридическим удержанием S3 Object Lock, которую задание S3 Batch Operations передает каждому объекту в базовую операцию API PutObjectLegalHold. Дополнительные сведения см. в разделе Использование юридического удержания S3 Object Lock с S3 Batch Operations в Руководстве пользователя Amazon S3.

Примечание

Данная функциональность не поддерживается для ведер каталогов.

LegalHold -> (структура)

Содержит статус юридического удержания Object Lock, который необходимо применить ко всем объектам в задании Batch Operations.

Status -> (строка)

Статус юридического удержания Object Lock, который необходимо применить ко всем объектам в задании Batch Operations.

S3PutObjectRetention -> (структура)

Содержит параметры конфигурации для действия удержания Object Lock для задания S3 Batch Operations. Batch Operations передает каждый объект в базовую операцию API PutObjectRetention. Дополнительные сведения см. в разделе Использование удержания S3 Object Lock с S3 Batch Operations в Руководстве пользователя Amazon S3.

Примечание

Данная функциональность не поддерживается для ведер каталогов.

BypassGovernanceRetention -> (булево)

Указывает, следует ли применять действие к объектам в задании Batch Operations, даже если для них установлен тип Object Lock GOVERNANCE.

Retention -> (структура)

Содержит режим удержания Object Lock, который должен быть применен ко всем объектам в задании Batch Operations. Дополнительные сведения см. в разделе Использование удержания S3 Object Lock с S3 Batch Operations в Руководстве пользователя Amazon S3.

RetainUntilDate -> (временная метка)

Дата истечения срока действия примененного удержания Object Lock для всех объектов, установленных заданием Batch Operations.

Mode -> (строка)

Режим удержания Object Lock, который должен быть применен ко всем объектам в задании Batch Operations.

S3ReplicateObject -> (структура)

Указывает заданному заданию вызвать ReplicateObject для каждого объекта в манифесте задания.

Примечание

Данная функциональность не поддерживается для ведер каталогов.

Синтаксис JSON:

{
  "LambdaInvoke": {
    "FunctionArn": "string",
    "InvocationSchemaVersion": "string",
    "UserArguments": {"string": "string"
      ...}
  },
  "S3PutObjectCopy": {
    "TargetResource": "string",
    "CannedAccessControlList": "private"|"public-read"|"public-read-write"|"aws-exec-read"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control",
    "AccessControlGrants": [
      {
        "Grantee": {
          "TypeIdentifier": "id"|"emailAddress"|"uri",
          "Identifier": "string",
          "DisplayName": "string"
        },
        "Permission": "FULL_CONTROL"|"READ"|"WRITE"|"READ_ACP"|"WRITE_ACP"
      }
      ...
    ],
    "MetadataDirective": "COPY"|"REPLACE",
    "ModifiedSinceConstraint": timestamp,
    "NewObjectMetadata": {
      "CacheControl": "string",
      "ContentDisposition": "string",
      "ContentEncoding": "string",
      "ContentLanguage": "string",
      "UserMetadata": {"string": "string"
        ...},
      "ContentLength": long,
      "ContentMD5": "string",
      "ContentType": "string",
      "HttpExpiresDate": timestamp,
      "RequesterCharged": true|false,
      "SSEAlgorithm": "AES256"|"KMS"
    },
    "NewObjectTagging": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ],
    "RedirectLocation": "string",
    "RequesterPays": true|false,
    "StorageClass": "STANDARD"|"STANDARD_IA"|"ONEZONE_IA"|"GLACIER"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|"GLACIER_IR",
    "UnModifiedSinceConstraint": timestamp,
    "SSEAwsKmsKeyId": "string",
    "TargetKeyPrefix": "string",
    "ObjectLockLegalHoldStatus": "OFF"|"ON",
    "ObjectLockMode": "COMPLIANCE"|"GOVERNANCE",
    "ObjectLockRetainUntilDate": timestamp,
    "BucketKeyEnabled": true|false,
    "ChecksumAlgorithm": "CRC32"|"CRC32C"|"SHA1"|"SHA256"|"CRC64NVME"
  },
  "S3PutObjectAcl": {
    "AccessControlPolicy": {
      "AccessControlList": {
        "Owner": {
          "ID": "string",
          "DisplayName": "string"
        },
        "Grants": [
          {
            "Grantee": {
              "TypeIdentifier": "id"|"emailAddress"|"uri",
              "Identifier": "string",
              "DisplayName": "string"
            },
            "Permission": "FULL_CONTROL"|"READ"|"WRITE"|"READ_ACP"|"WRITE_ACP"
          }
          ...
        ]
      },
      "CannedAccessControlList": "private"|"public-read"|"public-read-write"|"aws-exec-read"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"
    }
  },
  "S3PutObjectTagging": {
    "TagSet": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  },
  "S3DeleteObjectTagging": {

  },
  "S3InitiateRestoreObject": {
    "ExpirationInDays": integer,
    "GlacierJobTier": "BULK"|"STANDARD"
  },
  "S3PutObjectLegalHold": {
    "LegalHold": {
      "Status": "OFF"|"ON"
    }
  },
  "S3PutObjectRetention": {
    "BypassGovernanceRetention": true|false,
    "Retention": {
      "RetainUntilDate": timestamp,
      "Mode": "COMPLIANCE"|"GOVERNANCE"
    }
  },
  "S3ReplicateObject": {

  }
}

--report (структура)

Параметры конфигурации для необязательного отчета о завершении задания.

Bucket -> (строка)

Amazon Resource Name (ARN) для ведра, в котором будет храниться указанный отчет о завершении задания.

Примечание

Ведра каталогов - Ведра каталогов не поддерживаются как место для хранения отчетов о завершении заданий Batch Operations.

Format -> (строка)

Формат указанного отчета о завершении задания.

Enabled -> (булево)

Указывает, будет ли генерироваться отчет о завершении указанного задания.

Prefix -> (строка)

Необязательный префикс, описывающий место в указанном ведре, где будет храниться отчет о завершении задания. Amazon S3 сохраняет отчет о завершении задания в <prefix>/job-<job-id>/report.json.

ReportScope -> (строка)

Указывает, будет ли отчет о завершении задания содержать подробности всех задач или только не удавшихся задач.

Краткая форма синтаксиса:

Bucket=string,Format=string,Enabled=boolean,Prefix=string,ReportScope=string

Синтаксис JSON:

{
  "Bucket": "string",
  "Format": "Report_CSV_20180820",
  "Enabled": true|false,
  "Prefix": "string",
  "ReportScope": "AllTasks"|"FailedTasksOnly"
}

--client-request-token (строка)

Маркер идемпотентности для предотвращения случайного повторного отправления одного и того же запроса. Вы можете использовать любую строку до максимальной длины.

--manifest (структура)

Параметры конфигурации для манифеста.

Spec -> (структура)

Описание формата манифеста указанного задания. Если манифест в формате CSV, также описывает столбцы, содержащиеся в манифесте.

Format -> (строка)

Указывает, какой из доступных форматов используется в указанном манифесте.

Fields -> (список)

Если указанный объект манифеста находится в формате S3BatchOperations_CSV_20180820, этот элемент описывает, какие столбцы содержат необходимые данные.

(строка)

Location -> (структура)

Содержит информацию, необходимую для определения местоположения манифеста указанного задания. Манифесты не могут быть импортированы из ведер каталогов. Дополнительные сведения см. в разделе Ведра каталогов.

ObjectArn -> (строка)

Amazon Resource Name (ARN) для объекта манифеста.

Предупреждение

При использовании XML-запросов необходимо заменить специальные символы (например, возвраты каретки) в ключах объектов их эквивалентами XML-сущностей. Дополнительные сведения см. в разделе Ограничения ключей объектов, связанных с XML, в Руководстве пользователя Amazon S3.

ObjectVersionId -> (строка)

Необязательный идентификатор версии для идентификации конкретной версии объекта манифеста.

ETag -> (строка)

ETag для указанного объекта манифеста.

Краткая форма синтаксиса:

Spec={Format=string,Fields=[string,string]},Location={ObjectArn=string,ObjectVersionId=string,ETag=string}

Синтаксис JSON:

{
  "Spec": {
    "Format": "S3BatchOperations_CSV_20180820"|"S3InventoryReport_CSV_20161130",
    "Fields": ["Ignore"|"Bucket"|"Key"|"VersionId", ...]
  },
  "Location": {
    "ObjectArn": "string",
    "ObjectVersionId": "string",
    "ETag": "string"
  }
}

--description (строка)

Описание этого задания. Вы можете использовать любую строку в пределах разрешенной длины. Описания не должны быть уникальными и могут использоваться для нескольких заданий.

--priority (целое число)

Числовой приоритет этого задания. Более высокие числа указывают более высокий приоритет.

--role-arn (строка)

Amazon Resource Name (ARN) для роли Identity and Access Management (IAM), которую Batch Operations будет использовать для выполнения действия этого задания для каждого объекта в манифесте.

--tags (список)

Набор тегов для ассоциации с заданием S3 Batch Operations. Это необязательный параметр.

(структура)

Контейнер для пары имени-значения ключа.

Ключ -> (строка)

Ключ тега

Значение -> (строка)

Значение тега

Краткая форма синтаксиса:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--manifest-generator (структура помеченных объединений)

Контейнер атрибутов для деталей ManifestGenerator. Задачи должны создаваться либо с файлом манифеста, либо с ManifestGenerator, но не с обоими.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: S3JobManifestGenerator.

S3JobManifestGenerator -> (структура)

Детали конфигурации ManifestGenerator для задачи S3.

ExpectedBucketOwner -> (строка)

Идентификатор учетной записи Amazon Web Services, владеющей ведром, в которое записывается сгенерированный манифест. Если указано, идентификатор учетной записи Amazon Web Services владельца ведра сгенерированного манифеста должен совпадать с этим значением, в противном случае задача завершается ошибкой.

SourceBucket -> (строка)

ARN исходного ведра, используемого ManifestGenerator.

Примечание

Ведра каталогов - Ведра каталогов не поддерживаются в качестве исходных ведер, используемых S3JobManifestGenerator для генерации манифеста задачи.

ManifestOutputLocation -> (структура)

Указывает местоположение, в которое будет записан сгенерированный манифест. Манифесты не могут быть записаны в ведра каталогов. Дополнительную информацию см. в разделе Ведра каталогов.

ExpectedManifestBucketOwner -> (строка)

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

Bucket -> (строка)

ARN ведра, в которое должен быть записан сгенерированный манифест.

Примечание

Ведра каталогов - Ведра каталогов не поддерживаются в качестве ведер для хранения сгенерированного манифеста.

ManifestPrefix -> (строка)

Префикс, идентифицирующий один или несколько объектов, на которые распространяется манифест.

ManifestEncryption -> (структура)

Указывает, какой шифрование должен быть использован при записи сгенерированных объектов манифеста.

SSES3 -> (структура)

Указывает использование SSE-S3 для шифрования сгенерированных объектов манифеста.

SSEKMS -> (структура)

Детали конфигурации использования SSE-KMS для шифрования сгенерированных объектов манифеста.

KeyId -> (строка)

Указывает идентификатор симметричного ключа шифрования управляемого клиентом Amazon Web Services Key Management Service (Amazon Web Services KMS), который будет использоваться для шифрования сгенерированных объектов манифеста.

ManifestFormat -> (строка)

Формат сгенерированного манифеста.

Filter -> (структура)

Указывает правила, которые S3JobManifestGenerator должен использовать для определения, должен ли объект в исходном ведре включаться или не включаться в сгенерированный манифест задачи.

EligibleForReplication -> (булево)

Включать объекты в сгенерированный манифест только в том случае, если они подходят для репликации в соответствии с конфигурацией репликации в исходном ведре.

CreatedAfter -> (метка времени)

Если указано, сгенерированный манифест включает только объекты исходного ведра, созданные после этого времени.

CreatedBefore -> (метка времени)

Если указано, сгенерированный манифест включает только объекты исходного ведра, созданные до этого времени.

ObjectReplicationStatuses -> (список)

Если указано, сгенерированный манифест включает только объекты исходного ведра, которые имеют один из указанных статусов репликации.

(строка)

KeyNameConstraint -> (структура)

Если указано, сгенерированный манифест включает только объекты исходного ведра, ключи объектов которых соответствуют строковым ограничениям, указанным для MatchAnyPrefix , MatchAnySuffix и MatchAnySubstring .

MatchAnyPrefix -> (список)

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

(строка)

MatchAnySuffix -> (список)

Если указано, сгенерированный манифест включает объекты, где указанная строка появляется в конце строки ключа объекта. Каждый фильтр KeyNameConstraint принимает массив строк длиной 1 строка.

(строка)

MatchAnySubstring -> (список)

Если указано, сгенерированный манифест включает объекты, где указанная строка появляется где-либо внутри строки ключа объекта. Каждый фильтр KeyNameConstraint принимает массив строк длиной 1 строка.

(строка)

ObjectSizeGreaterThanBytes -> (целое число)

Если указано, сгенерированный манифест включает только объекты исходного ведра, размер файла которых больше указанного числа байтов.

ObjectSizeLessThanBytes -> (целое число)

Если указано, сгенерированный манифест включает только объекты исходного ведра, размер файла которых меньше указанного числа байтов.

MatchAnyStorageClass -> (список)

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

(строка)

EnableManifestOutput -> (булево)

Определяет, записывать ли сгенерированный манифест задачи в ведро.

Синтаксис JSON:

{
  "S3JobManifestGenerator": {
    "ExpectedBucketOwner": "string",
    "SourceBucket": "string",
    "ManifestOutputLocation": {
      "ExpectedManifestBucketOwner": "string",
      "Bucket": "string",
      "ManifestPrefix": "string",
      "ManifestEncryption": {
        "SSES3": {

        },
        "SSEKMS": {
          "KeyId": "string"
        }
      },
      "ManifestFormat": "S3InventoryReport_CSV_20211130"
    },
    "Filter": {
      "EligibleForReplication": true|false,
      "CreatedAfter": timestamp,
      "CreatedBefore": timestamp,
      "ObjectReplicationStatuses": ["COMPLETED"|"FAILED"|"REPLICA"|"NONE", ...],
      "KeyNameConstraint": {
        "MatchAnyPrefix": ["string", ...],
        "MatchAnySuffix": ["string", ...],
        "MatchAnySubstring": ["string", ...]
      },
      "ObjectSizeGreaterThanBytes": long,
      "ObjectSizeLessThanBytes": long,
      "MatchAnyStorageClass": ["STANDARD"|"STANDARD_IA"|"ONEZONE_IA"|"GLACIER"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|"GLACIER_IR", ...]
    },
    "EnableManifestOutput": true|false
  }
}

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса к API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, валидирует входные данные команд и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Общие параметры

--debug (булево)

Включить отладовую запись журнала.

--endpoint-url (строка)

Переопределить стандартную URL-адрес команды на заданный URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (булево)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

json
текст
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

вкл
выкл
авто

--no-sign-request (булево)

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

--ca-bundle (строка)

Сборник сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, который следует использовать для двоичных блоков. Формат по умолчанию - base64. Формат base64 ожидает, что двоичные блоки будут представлены как строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (булево)

Отключить пейджер cli для вывода.

--cli-auto-prompt (булево)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила кавычек, подобные unix-like. Эти примеры необходимо адаптировать к правилам кавычек вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Для создания задачи Amazon S3 для пакетных операций

Следующий create-job пример создает задачу Amazon S3 для пакетных операций для маркировки объектов как confidential` in the bucket ``employee-records.

aws s3control create-job \
    --account-id 123456789012 \
    --operation '{"S3PutObjectTagging": { "TagSet": [{"Key":"confidential", "Value":"true"}] }}' \
    --report '{"Bucket":"arn:aws:s3:::employee-records-logs","Prefix":"batch-op-create-job", "Format":"Report_CSV_20180820","Enabled":true,"ReportScope":"AllTasks"}' \
    --manifest '{"Spec":{"Format":"S3BatchOperations_CSV_20180820","Fields":["Bucket","Key"]},"Location":{"ObjectArn":"arn:aws:s3:::employee-records-logs/inv-report/7a6a9be4-072c-407e-85a2-ec3e982f773e.csv","ETag":"69f52a4e9f797e987155d9c8f5880897"}}' \
    --priority 42 \
    --role-arn arn:aws:iam::123456789012:role/S3BatchJobRole

Вывод:

{
    "JobId": "93735294-df46-44d5-8638-6356f335324e"
}

Вывод

JobId -> (строка)

Идентификатор этой задачи. Amazon S3 автоматически генерирует этот идентификатор и возвращает его после успешного запроса Create Job.