Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.
Parameters:
-
client_token
(Optional[ClientToken], default:
None
)
–
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
-
deletion_protection_enabled
(Optional[bool], default:
None
)
–
When set to true deletion protection is enabled. By default this is set to false.
-
tags
(Optional[TagList], default:
None
)
–
An array of key and value pair tags that are associated with the resource.
Raises:
-
AccessDeniedException
–
The request was denied because you don't have sufficient permissions to access the resource.
-
ConflictException
–
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
-
InternalServerException
–
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.
-
ServiceQuotaExceededException
–
The request would cause a service quota to be exceeded.
-
ThrottlingException
–
An error that occurred because too many requests were sent during a certain amount of time.
-
ValidationException
–
A validation exception for a field.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_pinpoint_sms_voice_v2/_services/pinpoint_sms_voice_v2.py
| def create_protect_configuration(
self,
*,
config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
client_token: Optional[
"capo_pinpoint_sms_voice_v2.types.client_token.ClientToken"
] = None,
deletion_protection_enabled: Optional[bool] = None,
tags: Optional["capo_pinpoint_sms_voice_v2.types.tag_list.TagList"] = None,
) -> "capo_pinpoint_sms_voice_v2.types.create_protect_configuration_result.CreateProtectConfigurationResult":
"""<p>Create a new protect configuration. By default all country rule sets for each capability are set to <code>ALLOW</code>. Update the country rule sets using <code>UpdateProtectConfigurationCountryRuleSet</code>. A protect configurations name is stored as a Tag with the key set to <code>Name</code> and value as the name of the protect configuration.</p>
Args:
client_token: <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
deletion_protection_enabled: <p>When set to true deletion protection is enabled. By default this is set to false. </p>
tags: <p>An array of key and value pair tags that are associated with the resource.</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.conflict_exception.ConflictException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of 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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would cause a service quota to be exceeded.</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.create_protect_configuration_request.CreateProtectConfigurationRequest]",
) -> OperationResponse[
"capo_pinpoint_sms_voice_v2.types.create_protect_configuration_result.CreateProtectConfigurationResult"
]:
import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.create_protect_configuration
output, http_response = (
capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.create_protect_configuration.create_protect_configuration(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CreateProtectConfiguration")
)
input_: capo_pinpoint_sms_voice_v2.types.create_protect_configuration_request.CreateProtectConfigurationRequest = {}
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
if deletion_protection_enabled is not None:
input_["deletion_protection_enabled"] = deletion_protection_enabled
if tags is not None:
input_["tags"] = tags
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|