Spec-Zone.ru › AWS CLI v2

[ aws . cur ]

put-report-definition

Описание

Создает новый отчет, используя предоставленное описание.

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

Синтаксис

  put-report-definition
--report-definition <value>
[--tags <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]

Параметры

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

Представляет результат операции PutReportDefinition. Содержимое включает подробные метаданные и информацию о файлах данных.

ReportName -> (строка)

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

TimeUnit -> (строка)

Продолжительность периода, охватываемого отчетом.

Format -> (строка)

Формат, в котором Amazon Web Services сохраняет отчет.

Compression -> (строка)

Формат сжатия, используемый Amazon Web Services для отчета.

AdditionalSchemaElements -> (список)

Список строк, указывающих дополнительное содержимое, которое Amazon Web Services включает в отчет, например, отдельные идентификаторы ресурсов.

(строка)

Включает ли Amazon Web Services идентификаторы ресурсов в отчет.

S3Bucket -> (строка)

Ведро S3, в которое Amazon Web Services предоставляет отчет.

S3Prefix -> (строка)

Префикс, который Amazon Web Services добавляет к имени отчета при предоставлении отчета. Префикс не может содержать пробелы.

S3Region -> (строка)

Регион ведра S3, в который Amazon Web Services предоставляет отчет.

AdditionalArtifacts -> (список)

Список манифестов, которые вы хотите, чтобы Amazon Web Services создал для этого отчета.

(строка)

Типы манифестов, которые вы хотите, чтобы Amazon Web Services создал для этого отчета.

RefreshClosedReports -> (булево)

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

ReportVersioning -> (строка)

Перезаписывать ли Amazon Web Services предыдущую версию каждого отчета или предоставлять отчет дополнительно к предыдущим версиям.

BillingViewArn -> (строка)

Идентификатор ресурса Amazon для представления счета. BillingViewArn требуется для создания отчета о затратах и использовании Amazon Web Services для каждой группы счетов, поддерживаемой службой Amazon Web Services Billing Conductor. BillingViewArn для группы счетов можно сформировать следующим образом: arn:aws:billing::payer-account-id:billingview/billing-group-primary-account-id

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

Статус отчета.

lastDelivery -> (строка)

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

lastStatus -> (строка)

Перечисление, указывающее статус предоставления отчета.

Сокращенный синтаксис:

ReportName=string,TimeUnit=string,Format=string,Compression=string,AdditionalSchemaElements=string,string,S3Bucket=string,S3Prefix=string,S3Region=string,AdditionalArtifacts=string,string,RefreshClosedReports=boolean,ReportVersioning=string,BillingViewArn=string,ReportStatus={lastDelivery=string,lastStatus=string}

Синтаксис JSON:

{
  "ReportName": "string",
  "TimeUnit": "HOURLY"|"DAILY"|"MONTHLY",
  "Format": "textORcsv"|"Parquet",
  "Compression": "ZIP"|"GZIP"|"Parquet",
  "AdditionalSchemaElements": ["RESOURCES"|"SPLIT_COST_ALLOCATION_DATA"|"MANUAL_DISCOUNT_COMPATIBILITY", ...],
  "S3Bucket": "string",
  "S3Prefix": "string",
  "S3Region": "af-south-1"|"ap-east-1"|"ap-south-1"|"ap-south-2"|"ap-southeast-1"|"ap-southeast-2"|"ap-southeast-3"|"ap-northeast-1"|"ap-northeast-2"|"ap-northeast-3"|"ca-central-1"|"eu-central-1"|"eu-central-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-north-1"|"eu-south-1"|"eu-south-2"|"me-central-1"|"me-south-1"|"sa-east-1"|"us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"cn-north-1"|"cn-northwest-1",
  "AdditionalArtifacts": ["REDSHIFT"|"QUICKSIGHT"|"ATHENA", ...],
  "RefreshClosedReports": true|false,
  "ReportVersioning": "CREATE_NEW_REPORT"|"OVERWRITE_REPORT",
  "BillingViewArn": "string",
  "ReportStatus": {
    "lastDelivery": "string",
    "lastStatus": "SUCCESS"|"ERROR_PERMISSIONS"|"ERROR_NO_BUCKET"
  }
}

--tags (список)

Теги, которые необходимо назначить ресурсу определения отчета.

(структура)

Описывает тег. Тег — это пара «ключ-значение». Вы можете добавить до 50 тегов к определению отчета.

Key -> (строка)

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

Value -> (строка)

Значение тега. Значения тегов регистрозависимы. Это может быть пустая строка.

Сокращенный синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

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

--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-auto-prompt (булево)

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

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

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

Примеры

Примечание

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

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

Создание отчетов AWS Cost and Usage

Следующий put-report-definition пример создает ежедневный отчет AWS Cost and Usage, который можно загрузить в Amazon Redshift или Amazon QuickSight.

aws cur put-report-definition --report-definition file://report-definition.json

Содержимое report-definition.json:

{
    "ReportName": "ExampleReport",
    "TimeUnit": "DAILY",
    "Format": "textORcsv",
    "Compression": "ZIP",
    "AdditionalSchemaElements": [
        "RESOURCES"
    ],
    "S3Bucket": "example-s3-bucket",
    "S3Prefix": "exampleprefix",
    "S3Region": "us-east-1",
    "AdditionalArtifacts": [
        "REDSHIFT",
        "QUICKSIGHT"
    ]
}

Вывод

Нет

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

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