# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Amazon S3 Control Batch Operations API
  version: 1.0.0
extends: openapi/amazon-s3-batch-operations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v20180820/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List Batch Operations jobs
      effect: read
      questions:
      - Which S3 Batch Operations jobs are running in my account?
      - Can I filter batch jobs by status, like only failed ones?
      - How far back does the batch job list go for finished jobs?
      instructions:
      - text: List Batch Operations jobs for account {account}.
        slots:
          account: header.x-amz-account-id
      - text: List batch jobs with status {statuses}.
        slots:
          statuses: query.jobStatuses
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Batch Operations job
      effect: write
      questions:
      - How do I run one action against millions of objects listed in a manifest?
      - Can a batch job copy, restore from Glacier, retag or delete objects?
      - Can I require confirmation before a batch job starts running?
      instructions:
      - text: Create a batch job that runs {operation} on every object in manifest {manifest} using role {role}.
        slots:
          operation: requestBody.Operation
          manifest: requestBody.Manifest
          role: requestBody.RoleArn
      - text: Start a batch job at priority {priority} with completion report {report}.
        slots:
          priority: requestBody.Priority
          report: requestBody.Report
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Batch Operations job's status
      effect: read
      questions:
      - What's the current status and progress of my batch job?
      - Can I see the configuration a batch job was created with?
      instructions:
      - text: Describe Batch Operations job {id}.
        slots:
          id: path.id
      - text: Show the status of batch job {id} in account {account}.
        slots:
          id: path.id
          account: header.x-amz-account-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/jobs/{id}/priority'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a batch job's priority
      effect: write
      questions:
      - How do I make a batch job run ahead of others?
      - Are higher priority numbers processed first for batch jobs?
      instructions:
      - text: Set the priority of batch job {id} to {priority}.
        slots:
          id: path.id
          priority: query.priority
      - text: Raise job {id} to priority {priority}.
        slots:
          id: path.id
          priority: query.priority
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v20180820/jobs/{id}/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm or cancel a batch job
      effect: destructive
      questions:
      - How do I confirm a batch job that is waiting before it runs?
      - Can I cancel a batch operations job that is already in progress?
      instructions:
      - text: Move batch job {id} to status {status}.
        slots:
          id: path.id
          status: query.requestedJobStatus
      - text: Cancel batch job {id} because {reason}.
        slots:
          id: path.id
          reason: query.statusUpdateReason
      method: generated
      generated: '2026-10-01'