Skip to content

create_schedule_group async

create_schedule_group(
    name: ScheduleGroupName,
    *,
    config_overrides: Optional[AsyncSchedulerClientConfig] = None,
    tags: Optional[TagList] = None,
    client_token: Optional[ClientToken] = None,
) -> CreateScheduleGroupOutput

Creates the specified schedule group.

Parameters:

  • name (ScheduleGroupName) –

    The name of the schedule group that you are creating.

  • tags (Optional[TagList], default: None ) –

    The list of tags to associate with the schedule group.

  • client_token (Optional[ClientToken], default: None ) –

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

Raises:

Source code in docs_src/capo_scheduler/_services/async_scheduler.py
async def create_schedule_group(
    self,
    name: "capo_scheduler.types.schedule_group_name.ScheduleGroupName",
    *,
    config_overrides: Optional[AsyncSchedulerClientConfig] = None,
    tags: Optional["capo_scheduler.types.tag_list.TagList"] = None,
    client_token: Optional["capo_scheduler.types.client_token.ClientToken"] = None,
) -> "capo_scheduler.types.create_schedule_group_output.CreateScheduleGroupOutput":
    """<p>Creates the specified schedule group.</p>

    Args:
        name: <p>The name of the schedule group that you are creating.</p>
        tags: <p>The list of tags to associate with the schedule group.</p>
        client_token: <p> Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. </p>

    Raises:
        capo_scheduler.errors.conflict_exception.ConflictException: <p>Updating or deleting the resource can cause an inconsistent state.</p>
        capo_scheduler.errors.internal_server_exception.InternalServerException: <p>Unexpected error encountered while processing the request.</p>
        capo_scheduler.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeds a service quota.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_scheduler.types.create_schedule_group_input.CreateScheduleGroupInput]",
    ) -> AsyncOperationResponse[
        "capo_scheduler.types.create_schedule_group_output.CreateScheduleGroupOutput"
    ]:
        import capo_scheduler._operations.aws_chronos_service.create_schedule_group

        (
            output,
            http_response,
        ) = await capo_scheduler._operations.aws_chronos_service.create_schedule_group.async_create_schedule_group(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateScheduleGroup")
    )
    input_: capo_scheduler.types.create_schedule_group_input.CreateScheduleGroupInput = {
        "name": name
    }
    if tags is not None:
        input_["tags"] = tags
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output