Amazon EventBridge Scheduler Schedule Groups API

openapi: 3.0.0
info:
  version: '2021-06-30'
  x-release: v4
  title: Amazon EventBridge Scheduler Schedule Groups API
  description: ' Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service. EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets. The following reference lists the available API actions, and data types for EventBridge Scheduler. '
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: scheduler
  x-aws-signingName: scheduler
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/scheduler-2021-06-30.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://scheduler.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon EventBridge Scheduler multi-region endpoint
- url: https://scheduler.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon EventBridge Scheduler multi-region endpoint
- url: http://scheduler.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon EventBridge Scheduler endpoint for China (Beijing) and China (Ningxia)
- url: https://scheduler.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon EventBridge Scheduler endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Schedule Groups
paths:
  /schedule-groups/{Name}:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateScheduleGroup
      description: Creates the specified schedule group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateScheduleGroupOutput'
              examples:
                CreateScheduleGroup200Example:
                  summary: Default CreateScheduleGroup 200 response
                  x-microcks-default: true
                  value:
                    ScheduleGroupArn: arn:aws:service:us-east-1:123456789012:resource/example
        '480':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
              examples:
                CreateScheduleGroup480Example:
                  summary: Default CreateScheduleGroup 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                CreateScheduleGroup481Example:
                  summary: Default CreateScheduleGroup 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                CreateScheduleGroup482Example:
                  summary: Default CreateScheduleGroup 482 response
                  x-microcks-default: true
                  value: {}
        '483':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                CreateScheduleGroup483Example:
                  summary: Default CreateScheduleGroup 483 response
                  x-microcks-default: true
                  value: {}
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                CreateScheduleGroup484Example:
                  summary: Default CreateScheduleGroup 484 response
                  x-microcks-default: true
                  value: {}
      parameters:
      - name: Name
        in: path
        required: true
        description: The name of the schedule group that you are creating.
        schema:
          type: string
          pattern: ^[0-9a-zA-Z-_.]+$
          minLength: 1
          maxLength: 64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ClientToken:
                  description: ' Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. '
                  type: string
                  pattern: ^[a-zA-Z0-9-_]+$
                  minLength: 1
                  maxLength: 64
                Tags:
                  description: The list of tags to associate with the schedule group.
                  type: array
                  items:
                    $ref: '#/components/schemas/Tag'
                  minItems: 0
                  maxItems: 200
            examples:
              CreateScheduleGroupRequestExample:
                summary: Default CreateScheduleGroup request
                x-microcks-default: true
                value:
                  ClientToken: example
                  Tags: []
      summary: Amazon EventBridge Scheduler CreateScheduleGroup
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Schedule Groups
    delete:
      operationId: DeleteScheduleGroup
      description: <p>Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group. When you delete a group, it remains in a <code>DELETING</code> state until all of its associated schedules are deleted. Schedules associated with the group that are set to run while the schedule group is in the process of being deleted might continue to invoke their targets until the schedule group and its associated schedules are deleted.</p> <note> <p> This operation is eventually consistent. </p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteScheduleGroupOutput'
              examples:
                DeleteScheduleGroup200Example:
                  summary: Default DeleteScheduleGroup 200 response
                  x-microcks-default: true
                  value: {}
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                DeleteScheduleGroup480Example:
                  summary: Default DeleteScheduleGroup 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                DeleteScheduleGroup481Example:
                  summary: Default DeleteScheduleGroup 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                DeleteScheduleGroup482Example:
                  summary: Default DeleteScheduleGroup 482 response
                  x-microcks-default: true
                  value: {}
        '483':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                DeleteScheduleGroup483Example:
                  summary: Default DeleteScheduleGroup 483 response
                  x-microcks-default: true
                  value: {}
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                DeleteScheduleGroup484Example:
                  summary: Default DeleteScheduleGroup 484 response
                  x-microcks-default: true
                  value: {}
      parameters:
      - name: clientToken
        in: query
        required: false
        description: ' Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. '
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-_]+$
          minLength: 1
          maxLength: 64
      - name: Name
        in: path
        required: true
        description: The name of the schedule group to delete.
        schema:
          type: string
          pattern: ^[0-9a-zA-Z-_.]+$
          minLength: 1
          maxLength: 64
      summary: Amazon EventBridge Scheduler DeleteScheduleGroup
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Schedule Groups
    get:
      operationId: GetScheduleGroup
      description: Retrieves the specified schedule group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetScheduleGroupOutput'
              examples:
                GetScheduleGroup200Example:
                  summary: Default GetScheduleGroup 200 response
                  x-microcks-default: true
                  value:
                    Arn: arn:aws:service:us-east-1:123456789012:resource/example
                    CreationDate: '2025-01-15T00:00:00Z'
                    LastModificationDate: '2025-01-15T00:00:00Z'
                    Name: example-name
                    State: example
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                GetScheduleGroup480Example:
                  summary: Default GetScheduleGroup 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                GetScheduleGroup481Example:
                  summary: Default GetScheduleGroup 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                GetScheduleGroup482Example:
                  summary: Default GetScheduleGroup 482 response
                  x-microcks-default: true
                  value: {}
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                GetScheduleGroup483Example:
                  summary: Default GetScheduleGroup 483 response
                  x-microcks-default: true
                  value: {}
      parameters:
      - name: Name
        in: path
        required: true
        description: The name of the schedule group to retrieve.
        schema:
          type: string
          pattern: ^[0-9a-zA-Z-_.]+$
          minLength: 1
          maxLength: 64
      summary: Amazon EventBridge Scheduler GetScheduleGroup
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Schedule Groups
  /schedule-groups:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      operationId: ListScheduleGroups
      description: Returns a paginated list of your schedule groups.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListScheduleGroupsOutput'
              examples:
                ListScheduleGroups200Example:
                  summary: Default ListScheduleGroups 200 response
                  x-microcks-default: true
                  value:
                    NextToken: example
                    ScheduleGroups: example
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                ListScheduleGroups480Example:
                  summary: Default ListScheduleGroups 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                ListScheduleGroups481Example:
                  summary: Default ListScheduleGroups 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                ListScheduleGroups482Example:
                  summary: Default ListScheduleGroups 482 response
                  x-microcks-default: true
                  value: {}
      parameters:
      - name: MaxResults
        in: query
        required: false
        description: If specified, limits the number of results returned by this operation. The operation also returns a <code>NextToken</code> which you can use in a subsequent operation to retrieve the next set of results.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: NamePrefix
        in: query
        required: false
        description: The name prefix that you can use to return a filtered list of your schedule groups.
        schema:
          type: string
          pattern: ^[0-9a-zA-Z-_.]+$
          minLength: 1
          maxLength: 64
      - name: NextToken
        in: query
        required: false
        description: The token returned by a previous call to retrieve the next set of results.
        schema:
          type: string
          minLength: 1
          maxLength: 2048
      summary: Amazon EventBridge Scheduler ListScheduleGroups
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Schedule Groups
components:
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  schemas:
    ScheduleGroupList:
      type: array
      items:
        $ref: '#/components/schemas/ScheduleGroupSummary'
    InternalServerException: {}
    ThrottlingException: {}
    TagValue:
      type: string
      minLength: 1
      maxLength: 256
    Tag:
      type: object
      required:
      - Key
      - Value
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/TagKey'
          - description: The key for the tag.
        Value:
          allOf:
          - $ref: '#/components/schemas/TagValue'
          - description: The value for the tag.
      description: Tag to associate with a schedule group.
    ConflictException: {}
    CreationDate:
      type: string
      format: date-time
    LastModificationDate:
      type: string
      format: date-time
    ScheduleGroupArn:
      type: string
      pattern: ^arn:aws(-[a-z]+)?:scheduler:[a-z0-9\-]+:\d{12}:schedule-group\/[0-9a-zA-Z-_.]+$
      minLength: 1
      maxLength: 1224
    ServiceQuotaExceededException: {}
    DeleteScheduleGroupOutput:
      type: object
      properties: {}
    ScheduleGroupSummary:
      type: object
      properties:
        Arn:
          allOf:
          - $ref: '#/components/schemas/ScheduleGroupArn'
          - description: The Amazon Resource Name (ARN) of the schedule group.
        CreationDate:
          allOf:
          - $ref: '#/components/schemas/CreationDate'
          - description: The time at which the schedule group was created.
        LastModificationDate:
          allOf:
          - $ref: '#/components/schemas/LastModificationDate'
          - description: The time at which the schedule group was last modified.
        Name:
          allOf:
          - $ref: '#/components/schemas/ScheduleGroupName'
          - description: The name of the schedule group.
        State:
          allOf:
          - $ref: '#/components/schemas/ScheduleGroupState'
          - description: Specifies the state of the schedule group.
      description: The details of a schedule group.
    ScheduleGroupState:
      type: string
      enum:
      - ACTIVE
      - DELETING
    ResourceNotFoundException: {}
    ListScheduleGroupsOutput:
      type: object
      required:
      - ScheduleGroups
      properties:
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: Indicates whether there are additional results to retrieve. If the value is null, there are no more results.
        ScheduleGroups:
          allOf:
          - $ref: '#/components/schemas/ScheduleGroupList'
          - description: The schedule groups that match the specified criteria.
    ScheduleGroupName:
      type: string
      pattern: ^[0-9a-zA-Z-_.]+$
      minLength: 1
      maxLength: 64
    NextToken:
      type: string
      minLength: 1
      maxLength: 2048
    GetScheduleGroupOutput:
      type: object
      properties:
        Arn:
          allOf:
          - $ref: '#/components/schemas/ScheduleGroupArn'
          - description: The Amazon Resource Name (ARN) of the schedule group.
        CreationDate:
          allOf:
          - $ref: '#/components/schemas/CreationDate'
          - description: The time at which the schedule group was created.
        LastModificationDate:
          allOf:
          - $ref: '#/components/schemas/LastModificationDate'
          - description: The time at which the schedule group was last modified.
        Name:
          allOf:
          - $ref: '#/components/schemas/ScheduleGroupName'
          - description: The name of the schedule group.
        State:
          allOf:
          - $ref: '#/components/schemas/ScheduleGroupState'
          - description: Specifies the state of the schedule group.
    ValidationException: {}
    TagKey:
      type: string
      minLength: 1
      maxLength: 128
    CreateScheduleGroupOutput:
      type: object
      required:
      - ScheduleGroupArn
      properties:
        ScheduleGroupArn:
          allOf:
          - $ref: '#/components/schemas/ScheduleGroupArn'
          - description: The Amazon Resource Name (ARN) of the schedule group.
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/scheduler/
x-hasEquivalentPaths: true