Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateScheduleGroup

Creates the specified schedule group.

Request Syntax


POST /schedule-groups/Name HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

Name

The name of the schedule group that you are creating.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[0-9a-zA-Z-_.]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientToken

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

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9-_]+$

Required: No

Tags

The list of tags to associate with the schedule group.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ScheduleGroupArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ScheduleGroupArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: ^arn:aws(-[a-z]+)?:scheduler:[a-z0-9\-]+:\d{12}:schedule-group\/[0-9a-zA-Z-_.]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

Updating or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

Unexpected error encountered while processing the request.

HTTP Status Code: 500

ServiceQuotaExceededException

The request exceeds a service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400