Skip to content

get_protect_configuration_country_rule_set

get_protect_configuration_country_rule_set(
    protect_configuration_id: ProtectConfigurationIdOrArn,
    number_capability: NumberCapability,
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
) -> GetProtectConfigurationCountryRuleSetResult

Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.

Parameters:

  • protect_configuration_id (ProtectConfigurationIdOrArn) –

    The unique identifier for the protect configuration.

  • number_capability (NumberCapability) –

    The capability type to return the CountryRuleSet for. Valid values are SMS, VOICE, or MMS.

Raises:

Source code in docs_src/capo_pinpoint_sms_voice_v2/_services/pinpoint_sms_voice_v2.py
def get_protect_configuration_country_rule_set(
    self,
    protect_configuration_id: "capo_pinpoint_sms_voice_v2.types.protect_configuration_id_or_arn.ProtectConfigurationIdOrArn",
    number_capability: "capo_pinpoint_sms_voice_v2.types.number_capability.NumberCapability",
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
) -> "capo_pinpoint_sms_voice_v2.types.get_protect_configuration_country_rule_set_result.GetProtectConfigurationCountryRuleSetResult":
    """<p>Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.</p>

    Args:
        protect_configuration_id: <p>The unique identifier for the protect configuration.</p>
        number_capability: <p>The capability type to return the CountryRuleSet for. Valid values are <code>SMS</code>, <code>VOICE</code>, or <code>MMS</code>.</p>

    Raises:
        capo_pinpoint_sms_voice_v2.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.internal_server_exception.InternalServerException: <p>The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.</p>
        capo_pinpoint_sms_voice_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>A requested resource couldn't be found.</p>
        capo_pinpoint_sms_voice_v2.errors.throttling_exception.ThrottlingException: <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_pinpoint_sms_voice_v2.errors.validation_exception.ValidationException: <p>A validation exception for a field.</p>
        capo_pinpoint_sms_voice_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_sms_voice_v2.types.get_protect_configuration_country_rule_set_request.GetProtectConfigurationCountryRuleSetRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.get_protect_configuration_country_rule_set_result.GetProtectConfigurationCountryRuleSetResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.get_protect_configuration_country_rule_set

        output, http_response = (
            capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.get_protect_configuration_country_rule_set.get_protect_configuration_country_rule_set(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetProtectConfigurationCountryRuleSet")
    )
    input_: capo_pinpoint_sms_voice_v2.types.get_protect_configuration_country_rule_set_request.GetProtectConfigurationCountryRuleSetRequest = {
        "protect_configuration_id": protect_configuration_id,
        "number_capability": number_capability,
    }

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