Get Schedule

eventbridgescheduler_get_schedule

R Documentation

Retrieves the specified schedule

Description

Retrieves the specified schedule.

Usage

eventbridgescheduler_get_schedule(GroupName, Name)

Arguments

GroupName	The name of the schedule group associated with this schedule. If you omit this, EventBridge Scheduler assumes that the schedule is associated with the default group.
Name	[required] The name of the schedule to retrieve.

Value

A list with the following syntax:

list(
  ActionAfterCompletion = "NONE"|"DELETE",
  Arn = "string",
  CreationDate = as.POSIXct(
    "2015-01-01"
  ),
  Description = "string",
  EndDate = as.POSIXct(
    "2015-01-01"
  ),
  FlexibleTimeWindow = list(
    MaximumWindowInMinutes = 123,
    Mode = "OFF"|"FLEXIBLE"
  ),
  GroupName = "string",
  KmsKeyArn = "string",
  LastModificationDate = as.POSIXct(
    "2015-01-01"
  ),
  Name = "string",
  ScheduleExpression = "string",
  ScheduleExpressionTimezone = "string",
  StartDate = as.POSIXct(
    "2015-01-01"
  ),
  State = "ENABLED"|"DISABLED",
  Target = list(
    Arn = "string",
    DeadLetterConfig = list(
      Arn = "string"
    ),
    EcsParameters = list(
      CapacityProviderStrategy = list(
        list(
          base = 123,
          capacityProvider = "string",
          weight = 123
        )
      ),
      EnableECSManagedTags = TRUE|FALSE,
      EnableExecuteCommand = TRUE|FALSE,
      Group = "string",
      LaunchType = "EC2"|"FARGATE"|"EXTERNAL",
      NetworkConfiguration = list(
        awsvpcConfiguration = list(
          AssignPublicIp = "ENABLED"|"DISABLED",
          SecurityGroups = list(
            "string"
          ),
          Subnets = list(
            "string"
          )
        )
      ),
      PlacementConstraints = list(
        list(
          expression = "string",
          type = "distinctInstance"|"memberOf"
        )
      ),
      PlacementStrategy = list(
        list(
          field = "string",
          type = "random"|"spread"|"binpack"
        )
      ),
      PlatformVersion = "string",
      PropagateTags = "TASK_DEFINITION",
      ReferenceId = "string",
      Tags = list(
        list(
          "string"
        )
      ),
      TaskCount = 123,
      TaskDefinitionArn = "string"
    ),
    EventBridgeParameters = list(
      DetailType = "string",
      Source = "string"
    ),
    Input = "string",
    KinesisParameters = list(
      PartitionKey = "string"
    ),
    RetryPolicy = list(
      MaximumEventAgeInSeconds = 123,
      MaximumRetryAttempts = 123
    ),
    RoleArn = "string",
    SageMakerPipelineParameters = list(
      PipelineParameterList = list(
        list(
          Name = "string",
          Value = "string"
        )
      )
    ),
    SqsParameters = list(
      MessageGroupId = "string"
    )
  )
)

Request syntax

svc$get_schedule(
  GroupName = "string",
  Name = "string"
)