create_schedule_group

EventBridgeScheduler.Client.create_schedule_group(**kwargs)

Creates the specified schedule group.

See also: AWS API Documentation

Request Syntax

response = client.create_schedule_group(
    ClientToken='string',
    Name='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ClientToken (string) --

    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.

    This field is autopopulated if not provided.

  • Name (string) --

    [REQUIRED]

    The name of the schedule group that you are creating.

  • Tags (list) --

    The list of tags to associate with the schedule group.

    • (dict) --

      Tag to associate with a schedule group.

      • Key (string) -- [REQUIRED]

        The key for the tag.

      • Value (string) -- [REQUIRED]

        The value for the tag.

Return type

dict

Returns

Response Syntax

{
    'ScheduleGroupArn': 'string'
}

Response Structure

  • (dict) --

    • ScheduleGroupArn (string) --

      The Amazon Resource Name (ARN) of the schedule group.

Exceptions

  • EventBridgeScheduler.Client.exceptions.ServiceQuotaExceededException
  • EventBridgeScheduler.Client.exceptions.ValidationException
  • EventBridgeScheduler.Client.exceptions.InternalServerException
  • EventBridgeScheduler.Client.exceptions.ConflictException
  • EventBridgeScheduler.Client.exceptions.ThrottlingException