update_profile async ¶

async def update_profile(
    self,
    profile_id: "capo_b2bi.types.profile_id.ProfileId",
    *,
    config_overrides: Optional[Asyncb2biClientConfig] = None,
    name: Optional["capo_b2bi.types.profile_name.ProfileName"] = None,
    email: Optional["capo_b2bi.types.email.Email"] = None,
    phone: Optional["capo_b2bi.types.phone.Phone"] = None,
    business_name: Optional["capo_b2bi.types.business_name.BusinessName"] = None,
) -> "capo_b2bi.types.update_profile_response.UpdateProfileResponse":
    """<p>Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.</p>

    Args:
        profile_id: <p>Specifies the unique, system-generated identifier for the profile.</p>
        name: <p>The name of the profile, used to identify it.</p>
        email: <p>Specifies the email address associated with this customer profile.</p>
        phone: <p>Specifies the phone number associated with the profile.</p>
        business_name: <p>Specifies the name for the business associated with this profile.</p>

    Raises:
        capo_b2bi.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_b2bi.errors.conflict_exception.ConflictException: <p>A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.</p>
        capo_b2bi.errors.internal_server_exception.InternalServerException: <p>This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.</p>
        capo_b2bi.errors.resource_not_found_exception.ResourceNotFoundException: <p>Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.</p>
        capo_b2bi.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.</p>
        capo_b2bi.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.</p>
        capo_b2bi.errors.validation_exception.ValidationException: <p>Occurs when a B2BI object cannot be validated against a request from another object. This exception can be thrown during standard EDI validation or when custom validation rules fail, such as when element length constraints are violated, invalid codes are used in code list validations, or required elements are missing based on configured element requirement rules.</p>
        capo_b2bi.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Sample UpdateProfile call

        >>> await client.update_profile(business_name="John's Shipping", email='[email protected]', name='Shipping Profile', phone='5555555555', profile_id='p-60fbc37c87f04fce9')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_b2bi.types.update_profile_request.UpdateProfileRequest]",
    ) -> AsyncOperationResponse[
        "capo_b2bi.types.update_profile_response.UpdateProfileResponse"
    ]:
        import capo_b2bi._operations.b2_bi.update_profile

        (
            output,
            http_response,
        ) = await capo_b2bi._operations.b2_bi.update_profile.async_update_profile(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_b2bi.types.update_profile_request.UpdateProfileRequest",
    ) -> dict[str, Any]:
        import capo_b2bi.types.update_profile_request

        return capo_b2bi.types.update_profile_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_b2bi.types.update_profile_response.UpdateProfileResponse",
    ) -> dict[str, Any]:
        import capo_b2bi.types.update_profile_response

        return capo_b2bi.types.update_profile_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateProfile",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_b2bi.types.update_profile_request.UpdateProfileRequest = {
        "profile_id": profile_id
    }
    if name is not None:
        input_["name"] = name
    if email is not None:
        input_["email"] = email
    if phone is not None:
        input_["phone"] = phone
    if business_name is not None:
        input_["business_name"] = business_name

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