batch_put_profile_object `async` ¶

batch_put_profile_object(
    domain_name: name,
    object_type_name: typeName,
    items: BatchPutProfileObjectRequestItemList,
    *,
    config_overrides: Optional[AsyncCustomerProfilesClientConfig] = None,
) -> BatchPutProfileObjectResponse

Adds multiple profile objects to a domain of a given ObjectType in a single API call.

When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.

When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.

BatchPutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.

Parameters:

domain_name (name) –

The unique name of the domain.
object_type_name (typeName) –

The name of the profile object type.
items (BatchPutProfileObjectRequestItemList) –

A list of items to add to the domain.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
BadRequestException –

The input you provided is invalid.
InternalServerException –

An internal service error occurred.
ResourceNotFoundException –

The requested resource does not exist, or access was denied.
ThrottlingException –

You exceeded the maximum number of requests.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_customer_profiles/_services/async_customer_profiles.py

async def batch_put_profile_object(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    object_type_name: "capo_customer_profiles.types.type_name.typeName",
    items: "capo_customer_profiles.types.batch_put_profile_object_request_item_list.BatchPutProfileObjectRequestItemList",
    *,
    config_overrides: Optional[AsyncCustomerProfilesClientConfig] = None,
) -> "capo_customer_profiles.types.batch_put_profile_object_response.BatchPutProfileObjectResponse":
    """<p>Adds multiple profile objects to a domain of a given ObjectType in a single API call.</p> <p>When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.</p> <p>When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.</p> <p>BatchPutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.</p>

    Args:
        domain_name: <p>The unique name of the domain.</p>
        object_type_name: <p>The name of the profile object type.</p>
        items: <p>A list of items to add to the domain.</p>

    Raises:
        capo_customer_profiles.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_customer_profiles.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_customer_profiles.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred.</p>
        capo_customer_profiles.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist, or access was denied.</p>
        capo_customer_profiles.errors.throttling_exception.ThrottlingException: <p>You exceeded the maximum number of requests.</p>
        capo_customer_profiles.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_customer_profiles.types.batch_put_profile_object_request.BatchPutProfileObjectRequest]",
    ) -> AsyncOperationResponse[
        "capo_customer_profiles.types.batch_put_profile_object_response.BatchPutProfileObjectResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.batch_put_profile_object

        (
            output,
            http_response,
        ) = await capo_customer_profiles._operations.customer_profiles_20200815.batch_put_profile_object.async_batch_put_profile_object(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_customer_profiles.types.batch_put_profile_object_request.BatchPutProfileObjectRequest",
    ) -> dict[str, Any]:
        import capo_customer_profiles.types.batch_put_profile_object_request

        return capo_customer_profiles.types.batch_put_profile_object_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("BatchPutProfileObject", redact_input=_redact_input),
    )
    input_: capo_customer_profiles.types.batch_put_profile_object_request.BatchPutProfileObjectRequest = {
        "domain_name": domain_name,
        "object_type_name": object_type_name,
        "items": items,
    }

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

batch_put_profile_object async ¶

batch_put_profile_object `async` ¶