Skip to content

put_account_dedicated_ip_warmup_attributes

put_account_dedicated_ip_warmup_attributes(
    *,
    config_overrides: Optional[PinpointEmailClientConfig] = None,
    auto_warmup_enabled: Optional[Enabled] = None,
) -> PutAccountDedicatedIpWarmupAttributesResponse

Enable or disable the automatic warm-up feature for dedicated IP addresses.

Parameters:

  • auto_warmup_enabled (Optional[Enabled], default: None ) –

    Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon Pinpoint account in the current AWS Region. Set to true to enable the automatic warm-up feature, or set to false to disable it.

Raises:

Source code in docs_src/capo_pinpoint_email/_services/pinpoint_email.py
def put_account_dedicated_ip_warmup_attributes(
    self,
    *,
    config_overrides: Optional[PinpointEmailClientConfig] = None,
    auto_warmup_enabled: Optional[
        "capo_pinpoint_email.types.enabled.Enabled"
    ] = None,
) -> "capo_pinpoint_email.types.put_account_dedicated_ip_warmup_attributes_response.PutAccountDedicatedIpWarmupAttributesResponse":
    """<p>Enable or disable the automatic warm-up feature for dedicated IP addresses.</p>

    Args:
        auto_warmup_enabled: <p>Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon Pinpoint account in the current AWS Region. Set to <code>true</code> to enable the automatic warm-up feature, or set to <code>false</code> to disable it.</p>

    Raises:
        capo_pinpoint_email.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_pinpoint_email.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
        capo_pinpoint_email.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_email.types.put_account_dedicated_ip_warmup_attributes_request.PutAccountDedicatedIpWarmupAttributesRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_email.types.put_account_dedicated_ip_warmup_attributes_response.PutAccountDedicatedIpWarmupAttributesResponse"
    ]:
        import capo_pinpoint_email._operations.amazon_pinpoint_email_service.put_account_dedicated_ip_warmup_attributes

        output, http_response = (
            capo_pinpoint_email._operations.amazon_pinpoint_email_service.put_account_dedicated_ip_warmup_attributes.put_account_dedicated_ip_warmup_attributes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutAccountDedicatedIpWarmupAttributes")
    )
    input_: capo_pinpoint_email.types.put_account_dedicated_ip_warmup_attributes_request.PutAccountDedicatedIpWarmupAttributesRequest = {}
    if auto_warmup_enabled is not None:
        input_["auto_warmup_enabled"] = auto_warmup_enabled

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