Skip to content

create_lake_formation_identity_center_configuration

create_lake_formation_identity_center_configuration(
    *,
    config_overrides: Optional[LakeFormationClientConfig] = None,
    catalog_id: Optional[CatalogIdString] = None,
    instance_arn: Optional[IdentityCenterInstanceArn] = None,
    external_filtering: Optional[ExternalFilteringConfiguration] = None,
    share_recipients: Optional[DataLakePrincipalList] = None,
    service_integrations: Optional[ServiceIntegrationList] = None,
) -> CreateLakeFormationIdentityCenterConfigurationResponse

Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.

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.

  • instance_arn (Optional[IdentityCenterInstanceArn], default: None ) –

    The ARN of the IAM Identity Center instance for which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • 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.

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

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

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

    If the ShareRecipients value is null or the list is empty, no resource share is created.

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

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

Raises:

Source code in docs_src/capo_lakeformation/_services/lake_formation.py
def create_lake_formation_identity_center_configuration(
    self,
    *,
    config_overrides: Optional[LakeFormationClientConfig] = None,
    catalog_id: Optional[
        "capo_lakeformation.types.catalog_id_string.CatalogIdString"
    ] = None,
    instance_arn: Optional[
        "capo_lakeformation.types.identity_center_instance_arn.IdentityCenterInstanceArn"
    ] = None,
    external_filtering: Optional[
        "capo_lakeformation.types.external_filtering_configuration.ExternalFilteringConfiguration"
    ] = None,
    share_recipients: Optional[
        "capo_lakeformation.types.data_lake_principal_list.DataLakePrincipalList"
    ] = None,
    service_integrations: Optional[
        "capo_lakeformation.types.service_integration_list.ServiceIntegrationList"
    ] = None,
) -> "capo_lakeformation.types.create_lake_formation_identity_center_configuration_response.CreateLakeFormationIdentityCenterConfigurationResponse":
    """<p>Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.</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>
        instance_arn: <p>The ARN of the IAM Identity Center instance for which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.</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>
        share_recipients: <p>A list of Amazon Web Services account IDs and/or Amazon Web Services organization/organizational unit ARNs that are allowed to access data managed by Lake Formation. </p> <p>If the <code>ShareRecipients</code> list includes valid values, a resource share is created with the principals you want to have access to the resources.</p> <p>If the <code>ShareRecipients</code> value is null or the list is empty, no resource share is created.</p>
        service_integrations: <p>A list of service integrations for enabling trusted identity propagation with external services such as Redshift.</p>

    Raises:
        capo_lakeformation.errors.access_denied_exception.AccessDeniedException: <p>Access to a resource was denied.</p>
        capo_lakeformation.errors.already_exists_exception.AlreadyExistsException: <p>A resource to be created or added already exists.</p>
        capo_lakeformation.errors.concurrent_modification_exception.ConcurrentModificationException: <p>Two processes are trying to modify a resource simultaneously.</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.
    """

    def _handler(
        req: "OperationRequest[capo_lakeformation.types.create_lake_formation_identity_center_configuration_request.CreateLakeFormationIdentityCenterConfigurationRequest]",
    ) -> OperationResponse[
        "capo_lakeformation.types.create_lake_formation_identity_center_configuration_response.CreateLakeFormationIdentityCenterConfigurationResponse"
    ]:
        import capo_lakeformation._operations.aws_lake_formation.create_lake_formation_identity_center_configuration

        output, http_response = (
            capo_lakeformation._operations.aws_lake_formation.create_lake_formation_identity_center_configuration.create_lake_formation_identity_center_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateLakeFormationIdentityCenterConfiguration"),
    )
    input_: capo_lakeformation.types.create_lake_formation_identity_center_configuration_request.CreateLakeFormationIdentityCenterConfigurationRequest = {}
    if catalog_id is not None:
        input_["catalog_id"] = catalog_id
    if instance_arn is not None:
        input_["instance_arn"] = instance_arn
    if external_filtering is not None:
        input_["external_filtering"] = external_filtering
    if share_recipients is not None:
        input_["share_recipients"] = share_recipients
    if service_integrations is not None:
        input_["service_integrations"] = service_integrations

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output