update_registrations_from_brand_profile ¶

def update_registrations_from_brand_profile(
    self,
    brand_profile_id: "capo_endusermessaging.types.brand_profile_id_or_arn.BrandProfileIdOrArn",
    registration_ids: "capo_endusermessaging.types.registration_id_list.RegistrationIdList",
    *,
    config_overrides: Optional[EndUserMessagingClientConfig] = None,
    smart_match: Optional[bool] = None,
    on_attribute_conflict: Optional[
        "capo_endusermessaging.types.on_attribute_conflict.OnAttributeConflict"
    ] = None,
    client_token: Optional[
        "capo_endusermessaging.types.client_token.ClientToken"
    ] = None,
) -> "capo_endusermessaging.types.update_registrations_from_brand_profile_output.UpdateRegistrationsFromBrandProfileOutput":
    """<p>Repushes the attributes of a brand profile into existing DRAFT registrations. 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_ids: <p>The identifiers of the registrations.</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>
        on_attribute_conflict: <p>Specifies how the service resolves an attribute that already exists. REPLACE overwrites the existing value with the incoming value. PRESERVE keeps the existing value.</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:
        Update registrations from a brand profile

        >>> client.update_registrations_from_brand_profile(brand_profile_id='bp-abc12345678901234', registration_ids=['reg-abc12345678901234'], smart_match=True, on_attribute_conflict='PRESERVE')
    """

    def _handler(
        req: "OperationRequest[capo_endusermessaging.types.update_registrations_from_brand_profile_input.UpdateRegistrationsFromBrandProfileInput]",
    ) -> OperationResponse[
        "capo_endusermessaging.types.update_registrations_from_brand_profile_output.UpdateRegistrationsFromBrandProfileOutput"
    ]:
        import capo_endusermessaging._operations.end_user_messaging.update_registrations_from_brand_profile

        output, http_response = (
            capo_endusermessaging._operations.end_user_messaging.update_registrations_from_brand_profile.update_registrations_from_brand_profile(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_endusermessaging.types.update_registrations_from_brand_profile_input.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateRegistrationsFromBrandProfile", redact_input=_redact_input
        ),
    )
    input_: capo_endusermessaging.types.update_registrations_from_brand_profile_input.UpdateRegistrationsFromBrandProfileInput = {
        "brand_profile_id": brand_profile_id,
        "registration_ids": registration_ids,
    }
    if smart_match is not None:
        input_["smart_match"] = smart_match
    if on_attribute_conflict is not None:
        input_["on_attribute_conflict"] = on_attribute_conflict
    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