EventBridgeScheduler / Client / get_schedule_group

get_schedule_group#

EventBridgeScheduler.Client.get_schedule_group(**kwargs)#

Retrieves the specified schedule group.

Request Syntax

response = client.get_schedule_group(
    Name='string'
)

Parameters:

Name (string) –

[REQUIRED]

The name of the schedule group to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreationDate': datetime(2015, 1, 1),
    'LastModificationDate': datetime(2015, 1, 1),
    'Name': 'string',
    'State': 'ACTIVE'|'DELETING'
}

Response Structure

(dict) –
- Arn (string) –
  
  The Amazon Resource Name (ARN) of the schedule group.
- CreationDate (datetime) –
  
  The time at which the schedule group was created.
- LastModificationDate (datetime) –
  
  The time at which the schedule group was last modified.
- Name (string) –
  
  The name of the schedule group.
- State (string) –
  
  Specifies the state of the schedule group.

Exceptions

EventBridgeScheduler.Client.exceptions.ValidationException
EventBridgeScheduler.Client.exceptions.InternalServerException
EventBridgeScheduler.Client.exceptions.ResourceNotFoundException
EventBridgeScheduler.Client.exceptions.ThrottlingException