GetScheduleGroup - EventBridge Scheduler

GetScheduleGroup

Retrieves the specified schedule group.

Request Syntax

GET /schedule-groups/Name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Name

The name of the schedule group to retrieve.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationDate": number, "LastModificationDate": number, "Name": "string", "State": "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.

Arn

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-_.]+$

CreationDate

The time at which the schedule group was created.

Type: Timestamp

LastModificationDate

The time at which the schedule group was last modified.

Type: Timestamp

Name

The name of the schedule group.

Type: String

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

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

State

Specifies the state of the schedule group.

Type: String

Valid Values: ACTIVE | DELETING

Errors

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

InternalServerException

Unexpected error encountered while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource which does not exist.

HTTP Status Code: 404

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: