Skip to content

start_auto_management async

start_auto_management(
    opt_in_level: OptInLevel,
    opt_in_type: OptInType,
    *,
    config_overrides: Optional[AsyncServiceQuotasClientConfig] = None,
    notification_arn: Optional[AmazonResourceName] = None,
    exclusion_list: Optional[ExclusionList] = None,
) -> StartAutoManagementResponse

Starts Service Quotas Automatic Management for an Amazon Web Services account, including notification preferences and excluded quotas configurations. Automatic Management monitors your Service Quotas utilization and notifies you before you run out of your allocated quotas.

Parameters:

  • opt_in_level (OptInLevel) –

    Sets the opt-in level for Automatic Management. Only Amazon Web Services account level is supported.

  • opt_in_type (OptInType) –

    Sets the opt-in type for Automatic Management. There are two modes: Notify only and Notify and Auto-Adjust. Currently, only NotifyOnly is available.

  • notification_arn (Optional[AmazonResourceName], default: None ) –

    The User Notifications Amazon Resource Name (ARN) for Automatic Management notifications.

  • exclusion_list (Optional[ExclusionList], default: None ) –

    List of Amazon Web Services services excluded from Automatic Management. You won't be notified of Service Quotas utilization for Amazon Web Services services added to the Automatic Management exclusion list.

Raises:

Source code in docs_src/capo_service_quotas/_services/async_service_quotas.py
async def start_auto_management(
    self,
    opt_in_level: "capo_service_quotas.types.opt_in_level.OptInLevel",
    opt_in_type: "capo_service_quotas.types.opt_in_type.OptInType",
    *,
    config_overrides: Optional[AsyncServiceQuotasClientConfig] = None,
    notification_arn: Optional[
        "capo_service_quotas.types.amazon_resource_name.AmazonResourceName"
    ] = None,
    exclusion_list: Optional[
        "capo_service_quotas.types.exclusion_list.ExclusionList"
    ] = None,
) -> "capo_service_quotas.types.start_auto_management_response.StartAutoManagementResponse":
    """<p>Starts <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/automatic-management.html">Service Quotas Automatic Management</a> for an Amazon Web Services account, including notification preferences and excluded quotas configurations. Automatic Management monitors your Service Quotas utilization and notifies you before you run out of your allocated quotas.</p>

    Args:
        opt_in_level: <p>Sets the opt-in level for Automatic Management. Only Amazon Web Services account level is supported.</p>
        opt_in_type: <p>Sets the opt-in type for Automatic Management. There are two modes: Notify only and Notify and Auto-Adjust. Currently, only NotifyOnly is available.</p>
        notification_arn: <p>The <a href="https://docs.aws.amazon.com/notifications/latest/userguide/resource-level-permissions.html#rlp-table">User Notifications</a> Amazon Resource Name (ARN) for Automatic Management notifications.</p>
        exclusion_list: <p>List of Amazon Web Services services excluded from Automatic Management. You won't be notified of Service Quotas utilization for Amazon Web Services services added to the Automatic Management exclusion list. </p>

    Raises:
        capo_service_quotas.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permission to perform this action.</p>
        capo_service_quotas.errors.illegal_argument_exception.IllegalArgumentException: <p>Invalid input was provided.</p>
        capo_service_quotas.errors.no_such_resource_exception.NoSuchResourceException: <p>The specified resource does not exist.</p>
        capo_service_quotas.errors.service_exception.ServiceException: <p>Something went wrong.</p>
        capo_service_quotas.errors.too_many_requests_exception.TooManyRequestsException: <p>Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.</p>
        capo_service_quotas.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_service_quotas.types.start_auto_management_request.StartAutoManagementRequest]",
    ) -> AsyncOperationResponse[
        "capo_service_quotas.types.start_auto_management_response.StartAutoManagementResponse"
    ]:
        import capo_service_quotas._operations.service_quotas_v20190624.start_auto_management

        (
            output,
            http_response,
        ) = await capo_service_quotas._operations.service_quotas_v20190624.start_auto_management.async_start_auto_management(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartAutoManagement")
    )
    input_: capo_service_quotas.types.start_auto_management_request.StartAutoManagementRequest = {
        "opt_in_level": opt_in_level,
        "opt_in_type": opt_in_type,
    }
    if notification_arn is not None:
        input_["notification_arn"] = notification_arn
    if exclusion_list is not None:
        input_["exclusion_list"] = exclusion_list

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