Skip to content

update_lake_formation_identity_center_configuration async

update_lake_formation_identity_center_configuration(
    *,
    config_overrides: Optional[AsyncLakeFormationClientConfig] = None,
    catalog_id: Optional[CatalogIdString] = None,
    share_recipients: Optional[DataLakePrincipalList] = None,
    service_integrations: Optional[ServiceIntegrationList] = None,
    application_status: Optional[ApplicationStatus] = None,
    external_filtering: Optional[ExternalFilteringConfiguration] = None,
) -> UpdateLakeFormationIdentityCenterConfigurationResponse

Updates the IAM Identity Center connection parameters.

Parameters:

  • catalog_id (Optional[CatalogIdString], default: None ) –

    The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, view definitions, and other control information to manage your Lake Formation environment.

  • share_recipients (Optional[DataLakePrincipalList], default: None ) –

    A list of Amazon Web Services account IDs or Amazon Web Services organization/organizational unit ARNs that are allowed to access to access data managed by Lake Formation.

    If the ShareRecipients list includes valid values, then the resource share is updated with the principals you want to have access to the resources.

    If the ShareRecipients value is null, both the list of share recipients and the resource share remain unchanged.

    If the ShareRecipients value is an empty list, then the existing share recipients list will be cleared, and the resource share will be deleted.

  • service_integrations (Optional[ServiceIntegrationList], default: None ) –

    A list of service integrations for enabling trusted identity propagation with external services such as Redshift.

  • application_status (Optional[ApplicationStatus], default: None ) –

    Allows to enable or disable the IAM Identity Center connection.

  • external_filtering (Optional[ExternalFilteringConfiguration], default: None ) –

    A list of the account IDs of Amazon Web Services accounts of third-party applications that are allowed to access data managed by Lake Formation.

Raises:

Source code in docs_src/capo_lakeformation/_services/async_lake_formation.py
async def update_lake_formation_identity_center_configuration(
    self,
    *,
    config_overrides: Optional[AsyncLakeFormationClientConfig] = None,
    catalog_id: Optional[
        "capo_lakeformation.types.catalog_id_string.CatalogIdString"
    ] = None,
    share_recipients: Optional[
        "capo_lakeformation.types.data_lake_principal_list.DataLakePrincipalList"
    ] = None,
    service_integrations: Optional[
        "capo_lakeformation.types.service_integration_list.ServiceIntegrationList"
    ] = None,
    application_status: Optional[
        "capo_lakeformation.types.application_status.ApplicationStatus"
    ] = None,
    external_filtering: Optional[
        "capo_lakeformation.types.external_filtering_configuration.ExternalFilteringConfiguration"
    ] = None,
) -> "capo_lakeformation.types.update_lake_formation_identity_center_configuration_response.UpdateLakeFormationIdentityCenterConfigurationResponse":
    """<p>Updates the IAM Identity Center connection parameters.</p>

    Args:
        catalog_id: <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, view definitions, and other control information to manage your Lake Formation environment.</p>
        share_recipients: <p>A list of Amazon Web Services account IDs or Amazon Web Services organization/organizational unit ARNs that are allowed to access to access data managed by Lake Formation. </p> <p>If the <code>ShareRecipients</code> list includes valid values, then the resource share is updated with the principals you want to have access to the resources.</p> <p>If the <code>ShareRecipients</code> value is null, both the list of share recipients and the resource share remain unchanged.</p> <p>If the <code>ShareRecipients</code> value is an empty list, then the existing share recipients list will be cleared, and the resource share will be deleted.</p>
        service_integrations: <p>A list of service integrations for enabling trusted identity propagation with external services such as Redshift.</p>
        application_status: <p>Allows to enable or disable the IAM Identity Center connection.</p>
        external_filtering: <p>A list of the account IDs of Amazon Web Services accounts of third-party applications that are allowed to access data managed by Lake Formation.</p>

    Raises:
        capo_lakeformation.errors.access_denied_exception.AccessDeniedException: <p>Access to a resource was denied.</p>
        capo_lakeformation.errors.concurrent_modification_exception.ConcurrentModificationException: <p>Two processes are trying to modify a resource simultaneously.</p>
        capo_lakeformation.errors.entity_not_found_exception.EntityNotFoundException: <p>A specified entity does not exist.</p>
        capo_lakeformation.errors.internal_service_exception.InternalServiceException: <p>An internal service error occurred.</p>
        capo_lakeformation.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_lakeformation.errors.operation_timeout_exception.OperationTimeoutException: <p>The operation timed out.</p>
        capo_lakeformation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lakeformation.types.update_lake_formation_identity_center_configuration_request.UpdateLakeFormationIdentityCenterConfigurationRequest]",
    ) -> AsyncOperationResponse[
        "capo_lakeformation.types.update_lake_formation_identity_center_configuration_response.UpdateLakeFormationIdentityCenterConfigurationResponse"
    ]:
        import capo_lakeformation._operations.aws_lake_formation.update_lake_formation_identity_center_configuration

        (
            output,
            http_response,
        ) = await capo_lakeformation._operations.aws_lake_formation.update_lake_formation_identity_center_configuration.async_update_lake_formation_identity_center_configuration(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateLakeFormationIdentityCenterConfiguration"),
    )
    input_: capo_lakeformation.types.update_lake_formation_identity_center_configuration_request.UpdateLakeFormationIdentityCenterConfigurationRequest = {}
    if catalog_id is not None:
        input_["catalog_id"] = catalog_id
    if share_recipients is not None:
        input_["share_recipients"] = share_recipients
    if service_integrations is not None:
        input_["service_integrations"] = service_integrations
    if application_status is not None:
        input_["application_status"] = application_status
    if external_filtering is not None:
        input_["external_filtering"] = external_filtering

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