create_registrations_from_brand_profile async ¶

async def create_registrations_from_brand_profile(
    self,
    brand_profile_id: "capo_endusermessaging.types.brand_profile_id_or_arn.BrandProfileIdOrArn",
    registration_types: "capo_endusermessaging.types.registration_type_list.RegistrationTypeList",
    *,
    config_overrides: Optional[AsyncEndUserMessagingClientConfig] = None,
    smart_match: Optional[bool] = None,
    client_token: Optional[
        "capo_endusermessaging.types.client_token.ClientToken"
    ] = None,
) -> "capo_endusermessaging.types.create_registrations_from_brand_profile_output.CreateRegistrationsFromBrandProfileOutput":
    """<p>Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile. This operation runs asynchronously. Use the GetJob operation to track its progress.</p>

    Args:
        brand_profile_id: <p>The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>
        registration_types: <p>The registration types to create, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.</p>
        smart_match: <p>Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.</p>

    Raises:
        capo_endusermessaging.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_endusermessaging.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource.</p>
        capo_endusermessaging.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request.</p>
        capo_endusermessaging.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
        capo_endusermessaging.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the allowed request rate.</p>
        capo_endusermessaging.errors.validation_exception.ValidationException: A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
        capo_endusermessaging.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Create draft registrations from a brand profile

        >>> await client.create_registrations_from_brand_profile(brand_profile_id='bp-abc12345678901234', registration_types=['US_TOLL_FREE_REGISTRATION'], smart_match=True)
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_endusermessaging.types.create_registrations_from_brand_profile_input.CreateRegistrationsFromBrandProfileInput]",
    ) -> AsyncOperationResponse[
        "capo_endusermessaging.types.create_registrations_from_brand_profile_output.CreateRegistrationsFromBrandProfileOutput"
    ]:
        import capo_endusermessaging._operations.end_user_messaging.create_registrations_from_brand_profile

        (
            output,
            http_response,
        ) = await capo_endusermessaging._operations.end_user_messaging.create_registrations_from_brand_profile.async_create_registrations_from_brand_profile(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_endusermessaging.types.create_registrations_from_brand_profile_input.CreateRegistrationsFromBrandProfileInput",
    ) -> dict[str, Any]:
        import capo_endusermessaging.types.create_registrations_from_brand_profile_input

        return capo_endusermessaging.types.create_registrations_from_brand_profile_input.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateRegistrationsFromBrandProfile", redact_input=_redact_input
        ),
    )
    input_: capo_endusermessaging.types.create_registrations_from_brand_profile_input.CreateRegistrationsFromBrandProfileInput = {
        "brand_profile_id": brand_profile_id,
        "registration_types": registration_types,
    }
    if smart_match is not None:
        input_["smart_match"] = smart_match
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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