update_environment async ¶

async def update_environment(
    self,
    environment_id: "capo_finspace.types.id_type.IdType",
    *,
    config_overrides: Optional[AsyncfinspaceClientConfig] = None,
    name: Optional["capo_finspace.types.environment_name.EnvironmentName"] = None,
    description: Optional["capo_finspace.types.description.Description"] = None,
    federation_mode: Optional[
        "capo_finspace.types.federation_mode.FederationMode"
    ] = None,
    federation_parameters: Optional[
        "capo_finspace.types.federation_parameters.FederationParameters"
    ] = None,
) -> "capo_finspace.types.update_environment_response.UpdateEnvironmentResponse":
    """<p>Update your FinSpace environment.</p>

    Args:
        environment_id: <p>The identifier of the FinSpace environment.</p>
        name: <p>The name of the environment.</p>
        description: <p>The description of the environment.</p>
        federation_mode: <p>Authentication mode for the environment.</p> <ul> <li> <p> <code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your Identity provider.</p> </li> <li> <p> <code>LOCAL</code> - Users access FinSpace via email and password managed within the FinSpace environment.</p> </li> </ul>

    Raises:
        capo_finspace.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_finspace.types.update_environment_request.UpdateEnvironmentRequest]",
    ) -> AsyncOperationResponse[
        "capo_finspace.types.update_environment_response.UpdateEnvironmentResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.update_environment

        (
            output,
            http_response,
        ) = await capo_finspace._operations.aws_habanero_management_service.update_environment.async_update_environment(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateEnvironment")
    )
    input_: capo_finspace.types.update_environment_request.UpdateEnvironmentRequest = {
        "environment_id": environment_id
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if federation_mode is not None:
        input_["federation_mode"] = federation_mode
    if federation_parameters is not None:
        input_["federation_parameters"] = federation_parameters

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