Skip to content

get_schedule_group

get_schedule_group(
    name: ScheduleGroupName, *, config_overrides: Optional[SchedulerClientConfig] = None
) -> GetScheduleGroupOutput

Retrieves the specified schedule group.

Parameters:

Raises:

Source code in docs_src/capo_scheduler/_services/scheduler.py
def get_schedule_group(
    self,
    name: "capo_scheduler.types.schedule_group_name.ScheduleGroupName",
    *,
    config_overrides: Optional[SchedulerClientConfig] = None,
) -> "capo_scheduler.types.get_schedule_group_output.GetScheduleGroupOutput":
    """<p>Retrieves the specified schedule group.</p>

    Args:
        name: <p>The name of the schedule group to retrieve.</p>

    Raises:
        capo_scheduler.errors.internal_server_exception.InternalServerException: <p>Unexpected error encountered while processing the request.</p>
        capo_scheduler.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource which does not exist.</p>
        capo_scheduler.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_scheduler.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_scheduler.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_scheduler.types.get_schedule_group_input.GetScheduleGroupInput]",
    ) -> OperationResponse[
        "capo_scheduler.types.get_schedule_group_output.GetScheduleGroupOutput"
    ]:
        import capo_scheduler._operations.aws_chronos_service.get_schedule_group

        output, http_response = (
            capo_scheduler._operations.aws_chronos_service.get_schedule_group.get_schedule_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetScheduleGroup")
    )
    input_: capo_scheduler.types.get_schedule_group_input.GetScheduleGroupInput = {
        "name": name
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output