Skip to content

update_user_profile async

update_user_profile(
    domain_identifier: DomainId,
    user_identifier: UserIdentifier,
    status: UserProfileStatus,
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    type: Optional[UserProfileType] = None,
    session_name: Optional[str] = None,
) -> UpdateUserProfileOutput

Updates the specified user profile in Amazon DataZone.

Parameters:

  • domain_identifier (DomainId) –

    The identifier of the Amazon DataZone domain in which a user profile is updated.

  • user_identifier (UserIdentifier) –

    The identifier of the user whose user profile is to be updated.

  • type (Optional[UserProfileType], default: None ) –

    The type of the user profile that are to be updated.

  • status (UserProfileStatus) –

    The status of the user profile that are to be updated.

  • session_name (Optional[str], default: None ) –

    The session name for IAM role sessions.

Raises:

Source code in docs_src/capo_datazone/_services/async_data_zone.py
async def update_user_profile(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    user_identifier: "capo_datazone.types.user_identifier.UserIdentifier",
    status: "capo_datazone.types.user_profile_status.UserProfileStatus",
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    type: Optional["capo_datazone.types.user_profile_type.UserProfileType"] = None,
    session_name: Optional[str] = None,
) -> "capo_datazone.types.update_user_profile_output.UpdateUserProfileOutput":
    """<p>Updates the specified user profile in Amazon DataZone.</p>

    Args:
        domain_identifier: <p>The identifier of the Amazon DataZone domain in which a user profile is updated.</p>
        user_identifier: <p>The identifier of the user whose user profile is to be updated.</p>
        type: <p>The type of the user profile that are to be updated.</p>
        status: <p>The status of the user profile that are to be updated.</p>
        session_name: <p>The session name for IAM role sessions.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_datazone.types.update_user_profile_input.UpdateUserProfileInput]",
    ) -> AsyncOperationResponse[
        "capo_datazone.types.update_user_profile_output.UpdateUserProfileOutput"
    ]:
        import capo_datazone._operations.data_zone.update_user_profile

        (
            output,
            http_response,
        ) = await capo_datazone._operations.data_zone.update_user_profile.async_update_user_profile(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_datazone.types.update_user_profile_output.UpdateUserProfileOutput",
    ) -> dict[str, Any]:
        import capo_datazone.types.update_user_profile_output

        return capo_datazone.types.update_user_profile_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateUserProfile", redact_output=_redact_output),
    )
    input_: capo_datazone.types.update_user_profile_input.UpdateUserProfileInput = {
        "domain_identifier": domain_identifier,
        "user_identifier": user_identifier,
        "status": status,
    }
    if type is not None:
        input_["type"] = type
    if session_name is not None:
        input_["session_name"] = session_name

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