Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
When you send a message, you can optionally specify a single configuration set.
Parameters:
-
configuration_set_name
(ConfigurationSetName)
–
The name to use for the new configuration set.
-
tags
(Optional[TagList], default:
None
)
–
An array of key and value pair tags that's associated with the new configuration set.
-
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.
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_configuration_set(
self,
configuration_set_name: "capo_pinpoint_sms_voice_v2.types.configuration_set_name.ConfigurationSetName",
*,
config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
tags: Optional["capo_pinpoint_sms_voice_v2.types.tag_list.TagList"] = None,
client_token: Optional[
"capo_pinpoint_sms_voice_v2.types.client_token.ClientToken"
] = None,
) -> "capo_pinpoint_sms_voice_v2.types.create_configuration_set_result.CreateConfigurationSetResult":
"""<p>Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.</p> <p>A configuration set is a set of rules that you apply to the SMS and voice messages that you send.</p> <p>When you send a message, you can optionally specify a single configuration set.</p>
Args:
configuration_set_name: <p>The name to use for the new configuration set.</p>
tags: <p>An array of key and value pair tags that's associated with the new configuration set. </p>
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>
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_configuration_set_request.CreateConfigurationSetRequest]",
) -> OperationResponse[
"capo_pinpoint_sms_voice_v2.types.create_configuration_set_result.CreateConfigurationSetResult"
]:
import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.create_configuration_set
output, http_response = (
capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.create_configuration_set.create_configuration_set(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CreateConfigurationSet")
)
input_: capo_pinpoint_sms_voice_v2.types.create_configuration_set_request.CreateConfigurationSetRequest = {
"configuration_set_name": configuration_set_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 = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|