Skip to content

disable_profile async

disable_profile(
    profile_id: Uuid,
    *,
    config_overrides: Optional[AsyncRolesAnywhereClientConfig] = None,
) -> ProfileDetailResponse

Disables a profile. When disabled, temporary credential requests with this profile fail.

Required permissions: rolesanywhere:DisableProfile.

Parameters:

  • profile_id (Uuid) –

    The unique identifier of the profile.

Raises:

Source code in docs_src/capo_rolesanywhere/_services/async_roles_anywhere.py
async def disable_profile(
    self,
    profile_id: "capo_rolesanywhere.types.uuid.Uuid",
    *,
    config_overrides: Optional[AsyncRolesAnywhereClientConfig] = None,
) -> "capo_rolesanywhere.types.profile_detail_response.ProfileDetailResponse":
    """<p>Disables a profile. When disabled, temporary credential requests with this profile fail.</p> <p> <b>Required permissions: </b> <code>rolesanywhere:DisableProfile</code>. </p>

    Args:
        profile_id: <p>The unique identifier of the profile.</p>

    Raises:
        capo_rolesanywhere.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_rolesanywhere.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_rolesanywhere.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rolesanywhere.types.scalar_profile_request.ScalarProfileRequest]",
    ) -> AsyncOperationResponse[
        "capo_rolesanywhere.types.profile_detail_response.ProfileDetailResponse"
    ]:
        import capo_rolesanywhere._operations.roles_anywhere.disable_profile

        (
            output,
            http_response,
        ) = await capo_rolesanywhere._operations.roles_anywhere.disable_profile.async_disable_profile(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisableProfile")
    )
    input_: capo_rolesanywhere.types.scalar_profile_request.ScalarProfileRequest = {
        "profile_id": profile_id
    }

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