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

DescribeSchedule

Returns the definition of a specific DataBrew schedule.

Request Syntax


GET /schedules/name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

The name of the schedule to be described.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreateDate": number,
   "CreatedBy": "string",
   "CronExpression": "string",
   "JobNames": [ "string" ],
   "LastModifiedBy": "string",
   "LastModifiedDate": number,
   "Name": "string",
   "ResourceArn": "string",
   "Tags": { 
      "string" : "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.

Name

The name of the schedule.

Type: String

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

CreateDate

The date and time that the schedule was created.

Type: Timestamp

CreatedBy

The identifier (user name) of the user who created the schedule.

Type: String

CronExpression

The date or dates and time or times when the jobs are to be run for the schedule. For more information, see Cron expressions in the AWS Glue DataBrew Developer Guide.

Type: String

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

JobNames

The name or names of one or more jobs to be run by using the schedule.

Type: Array of strings

Array Members: Maximum number of 50 items.

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

LastModifiedBy

The identifier (user name) of the user who last modified the schedule.

Type: String

LastModifiedDate

The date and time that the schedule was last modified.

Type: Timestamp

ResourceArn

The Amazon Resource Name (ARN) of the schedule.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Tags

Metadata tags associated with this schedule.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Errors

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

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ValidationException

The input parameters for this request failed validation.

HTTP Status Code: 400