lakeformation

package module
v1.39.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 42 Imported by: 12

Documentation

Overview

Package lakeformation provides the API client, operations, and parameter types for AWS Lake Formation.

Lake Formation

Defines the public endpoint for the Lake Formation service.

Index

Constants

View Source 
const ServiceAPIVersion = "2017-03-31"
View Source 
const ServiceID = "LakeFormation"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.23.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.26.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.26.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AddLFTagsToResourceInput added in v1.3.0 

type AddLFTagsToResourceInput struct {

	// The LF-tags to attach to the resource.
	//
	// This member is required.
	LFTags []types.LFTagPair

	// The database, table, or column resource to which to attach an LF-tag.
	//
	// This member is required.
	Resource *types.Resource

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string
	// contains filtered or unexported fields
}

type AddLFTagsToResourceOutput added in v1.3.0 

type AddLFTagsToResourceOutput struct {

	// A list of failures to tag the resource.
	Failures []types.LFTagError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssumeDecoratedRoleWithSAMLInput added in v1.17.0 

type AssumeDecoratedRoleWithSAMLInput struct {

	// The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the
	// IdP.
	//
	// This member is required.
	PrincipalArn *string

	// The role that represents an IAM principal whose scope down policy allows it to
	// call credential vending APIs such as GetTemporaryTableCredentials . The caller
	// must also have iam:PassRole permission on this role.
	//
	// This member is required.
	RoleArn *string

	// A SAML assertion consisting of an assertion statement for the user who needs
	// temporary credentials. This must match the SAML assertion that was issued to
	// IAM. This must be Base64 encoded.
	//
	// This member is required.
	SAMLAssertion *string

	// The time period, between 900 and 43,200 seconds, for the timeout of the
	// temporary credentials.
	DurationSeconds *int32
	// contains filtered or unexported fields
}

type AssumeDecoratedRoleWithSAMLOutput added in v1.17.0 

type AssumeDecoratedRoleWithSAMLOutput struct {

	// The access key ID for the temporary credentials. (The access key consists of an
	// access key ID and a secret key).
	AccessKeyId *string

	// The date and time when the temporary credentials expire.
	Expiration *time.Time

	// The secret key for the temporary credentials. (The access key consists of an
	// access key ID and a secret key).
	SecretAccessKey *string

	// The session token for the temporary credentials.
	SessionToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.26.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.26.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchGrantPermissionsInput 

type BatchGrantPermissionsInput struct {

	// A list of up to 20 entries for resource permissions to be granted by batch
	// operation to the principal.
	//
	// This member is required.
	Entries []types.BatchPermissionsRequestEntry

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string
	// contains filtered or unexported fields
}

type BatchGrantPermissionsOutput 

type BatchGrantPermissionsOutput struct {

	// A list of failures to grant permissions to the resources.
	Failures []types.BatchPermissionsFailureEntry

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchRevokePermissionsInput 

type BatchRevokePermissionsInput struct {

	// A list of up to 20 entries for resource permissions to be revoked by batch
	// operation to the principal.
	//
	// This member is required.
	Entries []types.BatchPermissionsRequestEntry

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string
	// contains filtered or unexported fields
}

type BatchRevokePermissionsOutput 

type BatchRevokePermissionsOutput struct {

	// A list of failures to revoke permissions to the resources.
	Failures []types.BatchPermissionsFailureEntry

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelTransactionInput added in v1.10.0 

type CancelTransactionInput struct {

	// The transaction to cancel.
	//
	// This member is required.
	TransactionId *string
	// contains filtered or unexported fields
}

type CancelTransactionOutput added in v1.10.0 

type CancelTransactionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS Lake Formation.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AddLFTagsToResource added in v1.3.0 

func (c *Client) AddLFTagsToResource(ctx context.Context, params *AddLFTagsToResourceInput, optFns ...func(*Options)) (*AddLFTagsToResourceOutput, error)

Attaches one or more LF-tags to an existing resource.

func (*Client) AssumeDecoratedRoleWithSAML added in v1.17.0 

func (c *Client) AssumeDecoratedRoleWithSAML(ctx context.Context, params *AssumeDecoratedRoleWithSAMLInput, optFns ...func(*Options)) (*AssumeDecoratedRoleWithSAMLOutput, error)

Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.

This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API GetDataAccess . Therefore, all SAML roles that can be assumed via AssumeDecoratedRoleWithSAML must at a minimum include lakeformation:GetDataAccess in their role policies. A typical IAM policy attached to such a role would look as follows:

func (*Client) BatchGrantPermissions 

func (c *Client) BatchGrantPermissions(ctx context.Context, params *BatchGrantPermissionsInput, optFns ...func(*Options)) (*BatchGrantPermissionsOutput, error)

Batch operation to grant permissions to the principal.

func (*Client) BatchRevokePermissions 

func (c *Client) BatchRevokePermissions(ctx context.Context, params *BatchRevokePermissionsInput, optFns ...func(*Options)) (*BatchRevokePermissionsOutput, error)

Batch operation to revoke permissions from the principal.

func (*Client) CancelTransaction added in v1.10.0 

func (c *Client) CancelTransaction(ctx context.Context, params *CancelTransactionInput, optFns ...func(*Options)) (*CancelTransactionOutput, error)

Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.

func (*Client) CommitTransaction added in v1.10.0 

func (c *Client) CommitTransaction(ctx context.Context, params *CommitTransactionInput, optFns ...func(*Options)) (*CommitTransactionOutput, error)

Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.

func (*Client) CreateDataCellsFilter added in v1.10.0 

func (c *Client) CreateDataCellsFilter(ctx context.Context, params *CreateDataCellsFilterInput, optFns ...func(*Options)) (*CreateDataCellsFilterOutput, error)

Creates a data cell filter to allow one to grant access to certain columns on certain rows.

func (*Client) CreateLFTag added in v1.3.0 

func (c *Client) CreateLFTag(ctx context.Context, params *CreateLFTagInput, optFns ...func(*Options)) (*CreateLFTagOutput, error)

Creates an LF-tag with the specified name and values.

func (*Client) CreateLFTagExpression added in v1.38.0 

func (c *Client) CreateLFTagExpression(ctx context.Context, params *CreateLFTagExpressionInput, optFns ...func(*Options)) (*CreateLFTagExpressionOutput, error)

Creates a new LF-Tag expression with the provided name, description, catalog ID, and expression body. This call fails if a LF-Tag expression with the same name already exists in the caller’s account or if the underlying LF-Tags don't exist. To call this API operation, caller needs the following Lake Formation permissions:

CREATE_LF_TAG_EXPRESSION on the root catalog resource.

GRANT_WITH_LF_TAG_EXPRESSION on all underlying LF-Tag key:value pairs included in the expression.

func (*Client) CreateLakeFormationIdentityCenterConfiguration added in v1.27.0 

func (c *Client) CreateLakeFormationIdentityCenterConfiguration(ctx context.Context, params *CreateLakeFormationIdentityCenterConfigurationInput, optFns ...func(*Options)) (*CreateLakeFormationIdentityCenterConfigurationOutput, error)

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

func (*Client) CreateLakeFormationOptIn added in v1.24.0 

func (c *Client) CreateLakeFormationOptIn(ctx context.Context, params *CreateLakeFormationOptInInput, optFns ...func(*Options)) (*CreateLakeFormationOptInOutput, error)

Enforce Lake Formation permissions for the given databases, tables, and principals.

func (*Client) DeleteDataCellsFilter added in v1.10.0 

func (c *Client) DeleteDataCellsFilter(ctx context.Context, params *DeleteDataCellsFilterInput, optFns ...func(*Options)) (*DeleteDataCellsFilterOutput, error)

Deletes a data cell filter.

func (*Client) DeleteLFTag added in v1.3.0 

func (c *Client) DeleteLFTag(ctx context.Context, params *DeleteLFTagInput, optFns ...func(*Options)) (*DeleteLFTagOutput, error)

Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the LFTagPolicy attached to the LF-tag becomes invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag will no longer be applied to the resource.

func (*Client) DeleteLFTagExpression added in v1.38.0 

func (c *Client) DeleteLFTagExpression(ctx context.Context, params *DeleteLFTagExpressionInput, optFns ...func(*Options)) (*DeleteLFTagExpressionOutput, error)

Deletes the LF-Tag expression. The caller must be a data lake admin or have DROP permissions on the LF-Tag expression. Deleting a LF-Tag expression will also delete all LFTagPolicy permissions referencing the LF-Tag expression.

func (*Client) DeleteLakeFormationIdentityCenterConfiguration added in v1.27.0 

func (c *Client) DeleteLakeFormationIdentityCenterConfiguration(ctx context.Context, params *DeleteLakeFormationIdentityCenterConfigurationInput, optFns ...func(*Options)) (*DeleteLakeFormationIdentityCenterConfigurationOutput, error)

Deletes an IAM Identity Center connection with Lake Formation.

func (*Client) DeleteLakeFormationOptIn added in v1.24.0 

func (c *Client) DeleteLakeFormationOptIn(ctx context.Context, params *DeleteLakeFormationOptInInput, optFns ...func(*Options)) (*DeleteLakeFormationOptInOutput, error)

Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.

func (*Client) DeleteObjectsOnCancel added in v1.10.0 

func (c *Client) DeleteObjectsOnCancel(ctx context.Context, params *DeleteObjectsOnCancelInput, optFns ...func(*Options)) (*DeleteObjectsOnCancelOutput, error)

For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.

The Glue ETL library function write_dynamic_frame.from_catalog() includes an option to automatically call DeleteObjectsOnCancel before writes. For more information, see Rolling Back Amazon S3 Writes.

func (*Client) DeregisterResource 

func (c *Client) DeregisterResource(ctx context.Context, params *DeregisterResourceInput, optFns ...func(*Options)) (*DeregisterResourceOutput, error)

Deregisters the resource as managed by the Data Catalog.

When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.

func (*Client) DescribeLakeFormationIdentityCenterConfiguration added in v1.27.0 

func (c *Client) DescribeLakeFormationIdentityCenterConfiguration(ctx context.Context, params *DescribeLakeFormationIdentityCenterConfigurationInput, optFns ...func(*Options)) (*DescribeLakeFormationIdentityCenterConfigurationOutput, error)

Retrieves the instance ARN and application ARN for the connection.

func (*Client) DescribeResource 

func (c *Client) DescribeResource(ctx context.Context, params *DescribeResourceInput, optFns ...func(*Options)) (*DescribeResourceOutput, error)

Retrieves the current data access role for the given resource registered in Lake Formation.

func (*Client) DescribeTransaction added in v1.10.0 

func (c *Client) DescribeTransaction(ctx context.Context, params *DescribeTransactionInput, optFns ...func(*Options)) (*DescribeTransactionOutput, error)

Returns the details of a single transaction.

func (*Client) ExtendTransaction added in v1.10.0 

func (c *Client) ExtendTransaction(ctx context.Context, params *ExtendTransactionInput, optFns ...func(*Options)) (*ExtendTransactionOutput, error)

Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.

Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.

func (*Client) GetDataCellsFilter added in v1.20.0 

func (c *Client) GetDataCellsFilter(ctx context.Context, params *GetDataCellsFilterInput, optFns ...func(*Options)) (*GetDataCellsFilterOutput, error)

Returns a data cells filter.

func (*Client) GetDataLakePrincipal added in v1.33.0 

func (c *Client) GetDataLakePrincipal(ctx context.Context, params *GetDataLakePrincipalInput, optFns ...func(*Options)) (*GetDataLakePrincipalOutput, error)

Returns the identity of the invoking principal.

func (*Client) GetDataLakeSettings 

func (c *Client) GetDataLakeSettings(ctx context.Context, params *GetDataLakeSettingsInput, optFns ...func(*Options)) (*GetDataLakeSettingsOutput, error)

Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.

func (*Client) GetEffectivePermissionsForPath 

func (c *Client) GetEffectivePermissionsForPath(ctx context.Context, params *GetEffectivePermissionsForPathInput, optFns ...func(*Options)) (*GetEffectivePermissionsForPathOutput, error)

Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.

func (*Client) GetLFTag added in v1.3.0 

func (c *Client) GetLFTag(ctx context.Context, params *GetLFTagInput, optFns ...func(*Options)) (*GetLFTagOutput, error)

Returns an LF-tag definition.

func (*Client) GetLFTagExpression added in v1.38.0 

func (c *Client) GetLFTagExpression(ctx context.Context, params *GetLFTagExpressionInput, optFns ...func(*Options)) (*GetLFTagExpressionOutput, error)

Returns the details about the LF-Tag expression. The caller must be a data lake admin or must have DESCRIBE permission on the LF-Tag expression resource.

func (*Client) GetQueryState added in v1.10.0 

func (c *Client) GetQueryState(ctx context.Context, params *GetQueryStateInput, optFns ...func(*Options)) (*GetQueryStateOutput, error)

Returns the state of a query previously submitted. Clients are expected to poll GetQueryState to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to StartQueryPlanning .

func (*Client) GetQueryStatistics added in v1.10.0 

func (c *Client) GetQueryStatistics(ctx context.Context, params *GetQueryStatisticsInput, optFns ...func(*Options)) (*GetQueryStatisticsOutput, error)

Retrieves statistics on the planning and execution of a query.

func (*Client) GetResourceLFTags added in v1.3.0 

func (c *Client) GetResourceLFTags(ctx context.Context, params *GetResourceLFTagsInput, optFns ...func(*Options)) (*GetResourceLFTagsOutput, error)

Returns the LF-tags applied to a resource.

func (*Client) GetTableObjects added in v1.10.0 

func (c *Client) GetTableObjects(ctx context.Context, params *GetTableObjectsInput, optFns ...func(*Options)) (*GetTableObjectsOutput, error)

Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.

func (*Client) GetTemporaryGluePartitionCredentials added in v1.12.0 

func (c *Client) GetTemporaryGluePartitionCredentials(ctx context.Context, params *GetTemporaryGluePartitionCredentialsInput, optFns ...func(*Options)) (*GetTemporaryGluePartitionCredentialsOutput, error)

This API is identical to GetTemporaryTableCredentials except that this is used when the target Data Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the same scope down policy which restricts access to a single Amazon S3 prefix.

func (*Client) GetTemporaryGlueTableCredentials added in v1.12.0 

func (c *Client) GetTemporaryGlueTableCredentials(ctx context.Context, params *GetTemporaryGlueTableCredentialsInput, optFns ...func(*Options)) (*GetTemporaryGlueTableCredentialsOutput, error)

Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.

To call this API, the role that the service assumes must have lakeformation:GetDataAccess permission on the resource.

func (*Client) GetWorkUnitResults added in v1.10.0 

func (c *Client) GetWorkUnitResults(ctx context.Context, params *GetWorkUnitResultsInput, optFns ...func(*Options)) (*GetWorkUnitResultsOutput, error)

Returns the work units resulting from the query. Work units can be executed in any order and in parallel.

func (*Client) GetWorkUnits added in v1.10.0 

func (c *Client) GetWorkUnits(ctx context.Context, params *GetWorkUnitsInput, optFns ...func(*Options)) (*GetWorkUnitsOutput, error)

Retrieves the work units generated by the StartQueryPlanning operation.

func (*Client) GrantPermissions 

func (c *Client) GrantPermissions(ctx context.Context, params *GrantPermissionsInput, optFns ...func(*Options)) (*GrantPermissionsOutput, error)

Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

For information about permissions, see Security and Access Control to Metadata and Data.

func (*Client) ListDataCellsFilter added in v1.10.0 

func (c *Client) ListDataCellsFilter(ctx context.Context, params *ListDataCellsFilterInput, optFns ...func(*Options)) (*ListDataCellsFilterOutput, error)

Lists all the data cell filters on a table.

func (*Client) ListLFTagExpressions added in v1.38.0 

func (c *Client) ListLFTagExpressions(ctx context.Context, params *ListLFTagExpressionsInput, optFns ...func(*Options)) (*ListLFTagExpressionsOutput, error)

Returns the LF-Tag expressions in caller’s account filtered based on caller's permissions. Data Lake and read only admins implicitly can see all tag expressions in their account, else caller needs DESCRIBE permissions on tag expression.

func (*Client) ListLFTags added in v1.3.0 

func (c *Client) ListLFTags(ctx context.Context, params *ListLFTagsInput, optFns ...func(*Options)) (*ListLFTagsOutput, error)

Lists LF-tags that the requester has permission to view.

func (*Client) ListLakeFormationOptIns added in v1.24.0 

func (c *Client) ListLakeFormationOptIns(ctx context.Context, params *ListLakeFormationOptInsInput, optFns ...func(*Options)) (*ListLakeFormationOptInsOutput, error)

Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.

func (*Client) ListPermissions 

func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInput, optFns ...func(*Options)) (*ListPermissionsOutput, error)

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.

This operation returns only those permissions that have been explicitly granted.

For information about permissions, see Security and Access Control to Metadata and Data.

func (*Client) ListResources 

func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, optFns ...func(*Options)) (*ListResourcesOutput, error)

Lists the resources registered to be managed by the Data Catalog.

func (*Client) ListTableStorageOptimizers added in v1.10.0 

func (c *Client) ListTableStorageOptimizers(ctx context.Context, params *ListTableStorageOptimizersInput, optFns ...func(*Options)) (*ListTableStorageOptimizersOutput, error)

Returns the configuration of all storage optimizers associated with a specified table.

func (*Client) ListTransactions added in v1.10.0 

func (c *Client) ListTransactions(ctx context.Context, params *ListTransactionsInput, optFns ...func(*Options)) (*ListTransactionsOutput, error)

Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.

This operation can help you identify uncommitted transactions or to get information about transactions.

func (*Client) Options added in v1.28.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutDataLakeSettings 

func (c *Client) PutDataLakeSettings(ctx context.Context, params *PutDataLakeSettingsInput, optFns ...func(*Options)) (*PutDataLakeSettingsOutput, error)

Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.

This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.

func (*Client) RegisterResource 

func (c *Client) RegisterResource(ctx context.Context, params *RegisterResourceInput, optFns ...func(*Options)) (*RegisterResourceOutput, error)

Registers the resource as managed by the Data Catalog.

To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.

The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location. 

ResourceArn = arn:aws:s3:::my-bucket/ UseServiceLinkedRole = true

If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn : 

arn:aws:iam::12345:role/my-data-access-role

func (*Client) RemoveLFTagsFromResource added in v1.3.0 

func (c *Client) RemoveLFTagsFromResource(ctx context.Context, params *RemoveLFTagsFromResourceInput, optFns ...func(*Options)) (*RemoveLFTagsFromResourceOutput, error)

Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in tableWithColumns to specify column input.

func (*Client) RevokePermissions 

func (c *Client) RevokePermissions(ctx context.Context, params *RevokePermissionsInput, optFns ...func(*Options)) (*RevokePermissionsOutput, error)

Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

func (*Client) SearchDatabasesByLFTags added in v1.3.0 

func (c *Client) SearchDatabasesByLFTags(ctx context.Context, params *SearchDatabasesByLFTagsInput, optFns ...func(*Options)) (*SearchDatabasesByLFTagsOutput, error)

This operation allows a search on DATABASE resources by TagCondition . This operation is used by admins who want to grant user permissions on certain TagConditions . Before making a grant, the admin can use SearchDatabasesByTags to find all resources where the given TagConditions are valid to verify whether the returned resources can be shared.

func (*Client) SearchTablesByLFTags added in v1.3.0 

func (c *Client) SearchTablesByLFTags(ctx context.Context, params *SearchTablesByLFTagsInput, optFns ...func(*Options)) (*SearchTablesByLFTagsOutput, error)

This operation allows a search on TABLE resources by LFTag s. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTag s are valid to verify whether the returned resources can be shared.

func (*Client) StartQueryPlanning added in v1.10.0 

func (c *Client) StartQueryPlanning(ctx context.Context, params *StartQueryPlanningInput, optFns ...func(*Options)) (*StartQueryPlanningOutput, error)

Submits a request to process a query statement.

This operation generates work units that can be retrieved with the GetWorkUnits operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.

func (*Client) StartTransaction added in v1.10.0 

func (c *Client) StartTransaction(ctx context.Context, params *StartTransactionInput, optFns ...func(*Options)) (*StartTransactionOutput, error)

Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.

func (*Client) UpdateDataCellsFilter added in v1.20.0 

func (c *Client) UpdateDataCellsFilter(ctx context.Context, params *UpdateDataCellsFilterInput, optFns ...func(*Options)) (*UpdateDataCellsFilterOutput, error)

Updates a data cell filter.

func (*Client) UpdateLFTag added in v1.3.0 

func (c *Client) UpdateLFTag(ctx context.Context, params *UpdateLFTagInput, optFns ...func(*Options)) (*UpdateLFTagOutput, error)

Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value.

func (*Client) UpdateLFTagExpression added in v1.38.0 

func (c *Client) UpdateLFTagExpression(ctx context.Context, params *UpdateLFTagExpressionInput, optFns ...func(*Options)) (*UpdateLFTagExpressionOutput, error)

Updates the name of the LF-Tag expression to the new description and expression body provided. Updating a LF-Tag expression immediately changes the permission boundaries of all existing LFTagPolicy permission grants that reference the given LF-Tag expression.

func (*Client) UpdateLakeFormationIdentityCenterConfiguration added in v1.27.0 

func (c *Client) UpdateLakeFormationIdentityCenterConfiguration(ctx context.Context, params *UpdateLakeFormationIdentityCenterConfigurationInput, optFns ...func(*Options)) (*UpdateLakeFormationIdentityCenterConfigurationOutput, error)

Updates the IAM Identity Center connection parameters.

func (*Client) UpdateResource 

func (c *Client) UpdateResource(ctx context.Context, params *UpdateResourceInput, optFns ...func(*Options)) (*UpdateResourceOutput, error)

Updates the data access role used for vending access to the given (registered) resource in Lake Formation.

func (*Client) UpdateTableObjects added in v1.10.0 

func (c *Client) UpdateTableObjects(ctx context.Context, params *UpdateTableObjectsInput, optFns ...func(*Options)) (*UpdateTableObjectsOutput, error)

Updates the manifest of Amazon S3 objects that make up the specified governed table.

func (*Client) UpdateTableStorageOptimizer added in v1.10.0 

func (c *Client) UpdateTableStorageOptimizer(ctx context.Context, params *UpdateTableStorageOptimizerInput, optFns ...func(*Options)) (*UpdateTableStorageOptimizerOutput, error)

Updates the configuration of the storage optimizers for a table.

type CommitTransactionInput added in v1.10.0 

type CommitTransactionInput struct {

	// The transaction to commit.
	//
	// This member is required.
	TransactionId *string
	// contains filtered or unexported fields
}

type CommitTransactionOutput added in v1.10.0 

type CommitTransactionOutput struct {

	// The status of the transaction.
	TransactionStatus types.TransactionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDataCellsFilterInput added in v1.10.0 

type CreateDataCellsFilterInput struct {

	// A DataCellsFilter structure containing information about the data cells filter.
	//
	// This member is required.
	TableData *types.DataCellsFilter
	// contains filtered or unexported fields
}

type CreateDataCellsFilterOutput added in v1.10.0 

type CreateDataCellsFilterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLFTagExpressionInput added in v1.38.0 

type CreateLFTagExpressionInput struct {

	// A list of LF-Tag conditions (key-value pairs).
	//
	// This member is required.
	Expression []types.LFTag

	// A name for the expression.
	//
	// This member is required.
	Name *string

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string

	// A description with information about the LF-Tag expression.
	Description *string
	// contains filtered or unexported fields
}

type CreateLFTagExpressionOutput added in v1.38.0 

type CreateLFTagExpressionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLFTagInput added in v1.3.0 

type CreateLFTagInput struct {

	// The key-name for the LF-tag.
	//
	// This member is required.
	TagKey *string

	// A list of possible values an attribute can take.
	//
	// This member is required.
	TagValues []string

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string
	// contains filtered or unexported fields
}

type CreateLFTagOutput added in v1.3.0 

type CreateLFTagOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLakeFormationIdentityCenterConfigurationInput added in v1.27.0 

type CreateLakeFormationIdentityCenterConfigurationInput struct {

	// 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.
	CatalogId *string

	// 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.
	ExternalFiltering *types.ExternalFilteringConfiguration

	// 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.
	InstanceArn *string

	// 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.
	ShareRecipients []types.DataLakePrincipal
	// contains filtered or unexported fields
}

type CreateLakeFormationIdentityCenterConfigurationOutput added in v1.27.0 

type CreateLakeFormationIdentityCenterConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the Lake Formation application integrated
	// with IAM Identity Center.
	ApplicationArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLakeFormationOptInInput added in v1.24.0 

type CreateLakeFormationOptInInput struct {

	// The Lake Formation principal. Supported principals are IAM users or IAM roles.
	//
	// This member is required.
	Principal *types.DataLakePrincipal

	// A structure for the resource.
	//
	// This member is required.
	Resource *types.Resource
	// contains filtered or unexported fields
}

type CreateLakeFormationOptInOutput added in v1.24.0 

type CreateLakeFormationOptInOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDataCellsFilterInput added in v1.10.0 

type DeleteDataCellsFilterInput struct {

	// A database in the Glue Data Catalog.
	DatabaseName *string

	// The name given by the user to the data filter cell.
	Name *string

	// The ID of the catalog to which the table belongs.
	TableCatalogId *string

	// A table in the database.
	TableName *string
	// contains filtered or unexported fields
}

type DeleteDataCellsFilterOutput added in v1.10.0 

type DeleteDataCellsFilterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLFTagExpressionInput added in v1.38.0 

type DeleteLFTagExpressionInput struct {

	// The name for the LF-Tag expression.
	//
	// This member is required.
	Name *string

	// The identifier for the Data Catalog. By default, the account ID in which the
	// LF-Tag expression is saved.
	CatalogId *string
	// contains filtered or unexported fields
}

type DeleteLFTagExpressionOutput added in v1.38.0 

type DeleteLFTagExpressionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLFTagInput added in v1.3.0 

type DeleteLFTagInput struct {

	// The key-name for the LF-tag to delete.
	//
	// This member is required.
	TagKey *string

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string
	// contains filtered or unexported fields
}

type DeleteLFTagOutput added in v1.3.0 

type DeleteLFTagOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLakeFormationIdentityCenterConfigurationInput added in v1.27.0 

type DeleteLakeFormationIdentityCenterConfigurationInput struct {

	// 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 definition, and other control information to manage your
	// Lake Formation environment.
	CatalogId *string
	// contains filtered or unexported fields
}

type DeleteLakeFormationIdentityCenterConfigurationOutput added in v1.27.0 

type DeleteLakeFormationIdentityCenterConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLakeFormationOptInInput added in v1.24.0 

type DeleteLakeFormationOptInInput struct {

	// The Lake Formation principal. Supported principals are IAM users or IAM roles.
	//
	// This member is required.
	Principal *types.DataLakePrincipal

	// A structure for the resource.
	//
	// This member is required.
	Resource *types.Resource
	// contains filtered or unexported fields
}

type DeleteLakeFormationOptInOutput added in v1.24.0 

type DeleteLakeFormationOptInOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteObjectsOnCancelInput added in v1.10.0 

type DeleteObjectsOnCancelInput struct {

	// The database that contains the governed table.
	//
	// This member is required.
	DatabaseName *string

	// A list of VirtualObject structures, which indicates the Amazon S3 objects to be
	// deleted if the transaction cancels.
	//
	// This member is required.
	Objects []types.VirtualObject

	// The name of the governed table.
	//
	// This member is required.
	TableName *string

	// ID of the transaction that the writes occur in.
	//
	// This member is required.
	TransactionId *string

	// The Glue data catalog that contains the governed table. Defaults to the current
	// account ID.
	CatalogId *string
	// contains filtered or unexported fields
}

type DeleteObjectsOnCancelOutput added in v1.10.0 

type DeleteObjectsOnCancelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeregisterResourceInput 

type DeregisterResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to deregister.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type DeregisterResourceOutput 

type DeregisterResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeLakeFormationIdentityCenterConfigurationInput added in v1.27.0 

type DescribeLakeFormationIdentityCenterConfigurationInput struct {

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string
	// contains filtered or unexported fields
}

type DescribeLakeFormationIdentityCenterConfigurationOutput added in v1.27.0 

type DescribeLakeFormationIdentityCenterConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the Lake Formation application integrated
	// with IAM Identity Center.
	ApplicationArn *string

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string

	// Indicates if external filtering is enabled.
	ExternalFiltering *types.ExternalFilteringConfiguration

	// The Amazon Resource Name (ARN) of the connection.
	InstanceArn *string

	// The Amazon Resource Name (ARN) of the RAM share.
	ResourceShare *string

	// A list of Amazon Web Services account IDs 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 as the
	// ShareRecipients .
	//
	// If the ShareRecipients value is null or the list is empty, no resource share is
	// created.
	ShareRecipients []types.DataLakePrincipal

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeResourceInput 

type DescribeResourceInput struct {

	// The resource ARN.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type DescribeResourceOutput 

type DescribeResourceOutput struct {

	// A structure containing information about an Lake Formation resource.
	ResourceInfo *types.ResourceInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeTransactionInput added in v1.10.0 

type DescribeTransactionInput struct {

	// The transaction for which to return status.
	//
	// This member is required.
	TransactionId *string
	// contains filtered or unexported fields
}

type DescribeTransactionOutput added in v1.10.0 

type DescribeTransactionOutput struct {

	// Returns a TransactionDescription object containing information about the
	// transaction.
	TransactionDescription *types.TransactionDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.23.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.23.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.23.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.23.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.23.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type ExtendTransactionInput added in v1.10.0 

type ExtendTransactionInput struct {

	// The transaction to extend.
	TransactionId *string
	// contains filtered or unexported fields
}

type ExtendTransactionOutput added in v1.10.0 

type ExtendTransactionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDataCellsFilterInput added in v1.20.0 

type GetDataCellsFilterInput struct {

	// A database in the Glue Data Catalog.
	//
	// This member is required.
	DatabaseName *string

	// The name given by the user to the data filter cell.
	//
	// This member is required.
	Name *string

	// The ID of the catalog to which the table belongs.
	//
	// This member is required.
	TableCatalogId *string

	// A table in the database.
	//
	// This member is required.
	TableName *string
	// contains filtered or unexported fields
}

type GetDataCellsFilterOutput added in v1.20.0 

type GetDataCellsFilterOutput struct {

	// A structure that describes certain columns on certain rows.
	DataCellsFilter *types.DataCellsFilter

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDataLakePrincipalInput added in v1.33.0 

type GetDataLakePrincipalInput struct {
	// contains filtered or unexported fields
}

type GetDataLakePrincipalOutput added in v1.33.0 

type GetDataLakePrincipalOutput struct {

	// A unique identifier of the invoking principal.
	Identity *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDataLakeSettingsInput 

type GetDataLakeSettingsInput struct {

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string
	// contains filtered or unexported fields
}

type GetDataLakeSettingsOutput 

type GetDataLakeSettingsOutput struct {

	// A structure representing a list of Lake Formation principals designated as data
	// lake administrators.
	DataLakeSettings *types.DataLakeSettings

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetEffectivePermissionsForPathAPIClient added in v0.30.0 

type GetEffectivePermissionsForPathAPIClient interface {
	GetEffectivePermissionsForPath(context.Context, *GetEffectivePermissionsForPathInput, ...func(*Options)) (*GetEffectivePermissionsForPathOutput, error)
}

GetEffectivePermissionsForPathAPIClient is a client that implements the GetEffectivePermissionsForPath operation.

type GetEffectivePermissionsForPathInput 

type GetEffectivePermissionsForPathInput struct {

	// The Amazon Resource Name (ARN) of the resource for which you want to get
	// permissions.
	//
	// This member is required.
	ResourceArn *string

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string

	// The maximum number of results to return.
	MaxResults *int32

	// A continuation token, if this is not the first call to retrieve this list.
	NextToken *string
	// contains filtered or unexported fields
}

type GetEffectivePermissionsForPathOutput 

type GetEffectivePermissionsForPathOutput struct {

	// A continuation token, if this is not the first call to retrieve this list.
	NextToken *string

	// A list of the permissions for the specified table or database resource located
	// at the path in Amazon S3.
	Permissions []types.PrincipalResourcePermissions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetEffectivePermissionsForPathPaginator added in v0.30.0 

type GetEffectivePermissionsForPathPaginator struct {
	// contains filtered or unexported fields
}

GetEffectivePermissionsForPathPaginator is a paginator for GetEffectivePermissionsForPath

func NewGetEffectivePermissionsForPathPaginator added in v0.30.0 

func NewGetEffectivePermissionsForPathPaginator(client GetEffectivePermissionsForPathAPIClient, params *GetEffectivePermissionsForPathInput, optFns ...func(*GetEffectivePermissionsForPathPaginatorOptions)) *GetEffectivePermissionsForPathPaginator

NewGetEffectivePermissionsForPathPaginator returns a new GetEffectivePermissionsForPathPaginator

func (*GetEffectivePermissionsForPathPaginator) HasMorePages added in v0.30.0 

func (p *GetEffectivePermissionsForPathPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetEffectivePermissionsForPathPaginator) NextPage added in v0.30.0 

func (p *GetEffectivePermissionsForPathPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetEffectivePermissionsForPathOutput, error)

NextPage retrieves the next GetEffectivePermissionsForPath page.

type GetEffectivePermissionsForPathPaginatorOptions added in v0.30.0 

type GetEffectivePermissionsForPathPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetEffectivePermissionsForPathPaginatorOptions is the paginator options for GetEffectivePermissionsForPath

type GetLFTagExpressionInput added in v1.38.0 

type GetLFTagExpressionInput struct {

	// The name for the LF-Tag expression
	//
	// This member is required.
	Name *string

	// The identifier for the Data Catalog. By default, the account ID.
	CatalogId *string
	// contains filtered or unexported fields
}

type GetLFTagExpressionOutput added in v1.38.0 

type GetLFTagExpressionOutput struct {

	// The identifier for the Data Catalog. By default, the account ID in which the
	// LF-Tag expression is saved.
	CatalogId *string

	// The description with information about the LF-Tag expression.
	Description *string

	// The body of the LF-Tag expression. It is composed of one or more LF-Tag
	// key-value pairs.
	Expression []types.LFTag

	// The name for the LF-Tag expression.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLFTagInput added in v1.3.0 

type GetLFTagInput struct {

	// The key-name for the LF-tag.
	//
	// This member is required.
	TagKey *string

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string
	// contains filtered or unexported fields
}

type GetLFTagOutput added in v1.3.0 

type GetLFTagOutput struct {

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string

	// The key-name for the LF-tag.
	TagKey *string

	// A list of possible values an attribute can take.
	TagValues []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetQueryStateInput added in v1.10.0 

type GetQueryStateInput struct {

	// The ID of the plan query operation.
	//
	// This member is required.
	QueryId *string
	// contains filtered or unexported fields
}

type GetQueryStateOutput added in v1.10.0 

type GetQueryStateOutput struct {

	// The state of a query previously submitted. The possible states are:
	//
	//   - PENDING: the query is pending.
	//
	//   - WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.
	//
	//   - FINISHED: the query planning finished successfully, and all work units are
	//   ready for retrieval and execution.
	//
	//   - ERROR: an error occurred with the query, such as an invalid query ID or a
	//   backend error.
	//
	// This member is required.
	State types.QueryStateString

	// An error message when the operation fails.
	Error *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A structure for the output.

type GetQueryStatisticsInput added in v1.10.0 

type GetQueryStatisticsInput struct {

	// The ID of the plan query operation.
	//
	// This member is required.
	QueryId *string
	// contains filtered or unexported fields
}

type GetQueryStatisticsOutput added in v1.10.0 

type GetQueryStatisticsOutput struct {

	// An ExecutionStatistics structure containing execution statistics.
	ExecutionStatistics *types.ExecutionStatistics

	// A PlanningStatistics structure containing query planning statistics.
	PlanningStatistics *types.PlanningStatistics

	// The time that the query was submitted.
	QuerySubmissionTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetResourceLFTagsInput added in v1.3.0 

type GetResourceLFTagsInput struct {

	// The database, table, or column resource for which you want to return LF-tags.
	//
	// This member is required.
	Resource *types.Resource

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string

	// Indicates whether to show the assigned LF-tags.
	ShowAssignedLFTags *bool
	// contains filtered or unexported fields
}

type GetResourceLFTagsOutput added in v1.3.0 

type GetResourceLFTagsOutput struct {

	// A list of LF-tags applied to a database resource.
	LFTagOnDatabase []types.LFTagPair

	// A list of LF-tags applied to a column resource.
	LFTagsOnColumns []types.ColumnLFTag

	// A list of LF-tags applied to a table resource.
	LFTagsOnTable []types.LFTagPair

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTableObjectsAPIClient added in v1.10.0 

type GetTableObjectsAPIClient interface {
	GetTableObjects(context.Context, *GetTableObjectsInput, ...func(*Options)) (*GetTableObjectsOutput, error)
}

GetTableObjectsAPIClient is a client that implements the GetTableObjects operation.

type GetTableObjectsInput added in v1.10.0 

type GetTableObjectsInput struct {

	// The database containing the governed table.
	//
	// This member is required.
	DatabaseName *string

	// The governed table for which to retrieve objects.
	//
	// This member is required.
	TableName *string

	// The catalog containing the governed table. Defaults to the caller’s account.
	CatalogId *string

	// Specifies how many values to return in a page.
	MaxResults *int32

	// A continuation token if this is not the first call to retrieve these objects.
	NextToken *string

	// A predicate to filter the objects returned based on the partition keys defined
	// in the governed table.
	//
	//   - The comparison operators supported are: =, >, <, >=, <=
	//
	//   - The logical operators supported are: AND
	//
	//   - The data types supported are integer, long, date(yyyy-MM-dd),
	//   timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal.
	PartitionPredicate *string

	// The time as of when to read the governed table contents. If not set, the most
	// recent transaction commit time is used. Cannot be specified along with
	// TransactionId .
	QueryAsOfTime *time.Time

	// The transaction ID at which to read the governed table contents. If this
	// transaction has aborted, an error is returned. If not set, defaults to the most
	// recent committed transaction. Cannot be specified along with QueryAsOfTime .
	TransactionId *string
	// contains filtered or unexported fields
}

type GetTableObjectsOutput added in v1.10.0 

type GetTableObjectsOutput struct {

	// A continuation token indicating whether additional data is available.
	NextToken *string

	// A list of objects organized by partition keys.
	Objects []types.PartitionObjects

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTableObjectsPaginator added in v1.10.0 

type GetTableObjectsPaginator struct {
	// contains filtered or unexported fields
}

GetTableObjectsPaginator is a paginator for GetTableObjects

func NewGetTableObjectsPaginator added in v1.10.0 

func NewGetTableObjectsPaginator(client GetTableObjectsAPIClient, params *GetTableObjectsInput, optFns ...func(*GetTableObjectsPaginatorOptions)) *GetTableObjectsPaginator

NewGetTableObjectsPaginator returns a new GetTableObjectsPaginator

func (*GetTableObjectsPaginator) HasMorePages added in v1.10.0 

func (p *GetTableObjectsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetTableObjectsPaginator) NextPage added in v1.10.0 

func (p *GetTableObjectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetTableObjectsOutput, error)

NextPage retrieves the next GetTableObjects page.

type GetTableObjectsPaginatorOptions added in v1.10.0 

type GetTableObjectsPaginatorOptions struct {
	// Specifies how many values to return in a page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetTableObjectsPaginatorOptions is the paginator options for GetTableObjects

type GetTemporaryGluePartitionCredentialsInput added in v1.12.0 

type GetTemporaryGluePartitionCredentialsInput struct {

	// A list of partition values identifying a single partition.
	//
	// This member is required.
	Partition *types.PartitionValueList

	// The ARN of the partitions' table.
	//
	// This member is required.
	TableArn *string

	// A structure representing context to access a resource (column names, query ID,
	// etc).
	AuditContext *types.AuditContext

	// The time period, between 900 and 21,600 seconds, for the timeout of the
	// temporary credentials.
	DurationSeconds *int32

	// Filters the request based on the user having been granted a list of specified
	// permissions on the requested resource(s).
	Permissions []types.Permission

	// A list of supported permission types for the partition. Valid values are
	// COLUMN_PERMISSION and CELL_FILTER_PERMISSION .
	SupportedPermissionTypes []types.PermissionType
	// contains filtered or unexported fields
}

type GetTemporaryGluePartitionCredentialsOutput added in v1.12.0 

type GetTemporaryGluePartitionCredentialsOutput struct {

	// The access key ID for the temporary credentials.
	AccessKeyId *string

	// The date and time when the temporary credentials expire.
	Expiration *time.Time

	// The secret key for the temporary credentials.
	SecretAccessKey *string

	// The session token for the temporary credentials.
	SessionToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTemporaryGlueTableCredentialsInput added in v1.12.0 

type GetTemporaryGlueTableCredentialsInput struct {

	// The ARN identifying a table in the Data Catalog for the temporary credentials
	// request.
	//
	// This member is required.
	TableArn *string

	// A structure representing context to access a resource (column names, query ID,
	// etc).
	AuditContext *types.AuditContext

	// The time period, between 900 and 21,600 seconds, for the timeout of the
	// temporary credentials.
	DurationSeconds *int32

	// Filters the request based on the user having been granted a list of specified
	// permissions on the requested resource(s).
	Permissions []types.Permission

	// A structure used as a protocol between query engines and Lake Formation or
	// Glue. Contains both a Lake Formation generated authorization identifier and
	// information from the request's authorization context.
	QuerySessionContext *types.QuerySessionContext

	// The Amazon S3 path for the table.
	S3Path *string

	// A list of supported permission types for the table. Valid values are
	// COLUMN_PERMISSION and CELL_FILTER_PERMISSION .
	SupportedPermissionTypes []types.PermissionType
	// contains filtered or unexported fields
}

type GetTemporaryGlueTableCredentialsOutput added in v1.12.0 

type GetTemporaryGlueTableCredentialsOutput struct {

	// The access key ID for the temporary credentials.
	AccessKeyId *string

	// The date and time when the temporary credentials expire.
	Expiration *time.Time

	// The secret key for the temporary credentials.
	SecretAccessKey *string

	// The session token for the temporary credentials.
	SessionToken *string

	// The Amazon S3 path for the temporary credentials.
	VendedS3Path []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWorkUnitResultsInput added in v1.10.0 

type GetWorkUnitResultsInput struct {

	// The ID of the plan query operation for which to get results.
	//
	// This member is required.
	QueryId *string

	// The work unit ID for which to get results. Value generated by enumerating
	// WorkUnitIdMin to WorkUnitIdMax (inclusive) from the WorkUnitRange in the output
	// of GetWorkUnits .
	//
	// This member is required.
	WorkUnitId int64

	// A work token used to query the execution service. Token output from GetWorkUnits
	// .
	//
	// This member is required.
	WorkUnitToken *string
	// contains filtered or unexported fields
}

type GetWorkUnitResultsOutput added in v1.10.0 

type GetWorkUnitResultsOutput struct {

	// Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow
	// v1.0 messages.
	ResultStream io.ReadCloser

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A structure for the output.

type GetWorkUnitsAPIClient added in v1.10.0 

type GetWorkUnitsAPIClient interface {
	GetWorkUnits(context.Context, *GetWorkUnitsInput, ...func(*Options)) (*GetWorkUnitsOutput, error)
}

GetWorkUnitsAPIClient is a client that implements the GetWorkUnits operation.

type GetWorkUnitsInput added in v1.10.0 

type GetWorkUnitsInput struct {

	// The ID of the plan query operation.
	//
	// This member is required.
	QueryId *string

	// A continuation token, if this is a continuation call.
	NextToken *string

	// The size of each page to get in the Amazon Web Services service call. This does
	// not affect the number of items returned in the command's output. Setting a
	// smaller page size results in more calls to the Amazon Web Services service,
	// retrieving fewer items in each call. This can help prevent the Amazon Web
	// Services service calls from timing out.
	PageSize *int32
	// contains filtered or unexported fields
}

type GetWorkUnitsOutput added in v1.10.0 

type GetWorkUnitsOutput struct {

	// The ID of the plan query operation.
	//
	// This member is required.
	QueryId *string

	// A WorkUnitRangeList object that specifies the valid range of work unit IDs for
	// querying the execution service.
	//
	// This member is required.
	WorkUnitRanges []types.WorkUnitRange

	// A continuation token for paginating the returned list of tokens, returned if
	// the current segment of the list is not the last.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A structure for the output.

type GetWorkUnitsPaginator added in v1.10.0 

type GetWorkUnitsPaginator struct {
	// contains filtered or unexported fields
}

GetWorkUnitsPaginator is a paginator for GetWorkUnits

func NewGetWorkUnitsPaginator added in v1.10.0 

func NewGetWorkUnitsPaginator(client GetWorkUnitsAPIClient, params *GetWorkUnitsInput, optFns ...func(*GetWorkUnitsPaginatorOptions)) *GetWorkUnitsPaginator

NewGetWorkUnitsPaginator returns a new GetWorkUnitsPaginator

func (*GetWorkUnitsPaginator) HasMorePages added in v1.10.0 

func (p *GetWorkUnitsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetWorkUnitsPaginator) NextPage added in v1.10.0 

func (p *GetWorkUnitsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetWorkUnitsOutput, error)

NextPage retrieves the next GetWorkUnits page.

type GetWorkUnitsPaginatorOptions added in v1.10.0 

type GetWorkUnitsPaginatorOptions struct {
	// The size of each page to get in the Amazon Web Services service call. This does
	// not affect the number of items returned in the command's output. Setting a
	// smaller page size results in more calls to the Amazon Web Services service,
	// retrieving fewer items in each call. This can help prevent the Amazon Web
	// Services service calls from timing out.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetWorkUnitsPaginatorOptions is the paginator options for GetWorkUnits

type GrantPermissionsInput 

type GrantPermissionsInput struct {

	// The permissions granted to the principal on the resource. Lake Formation
	// defines privileges to grant and revoke access to metadata in the Data Catalog
	// and data organized in underlying data storage such as Amazon S3. Lake Formation
	// requires that each principal be authorized to perform a specific task on Lake
	// Formation resources.
	//
	// This member is required.
	Permissions []types.Permission

	// The principal to be granted the permissions on the resource. Supported
	// principals are IAM users or IAM roles, and they are defined by their principal
	// type and their ARN.
	//
	// Note that if you define a resource with a particular ARN, then later delete,
	// and recreate a resource with that same ARN, the resource maintains the
	// permissions already granted.
	//
	// This member is required.
	Principal *types.DataLakePrincipal

	// The resource to which permissions are to be granted. Resources in Lake
	// Formation are the Data Catalog, databases, and tables.
	//
	// This member is required.
	Resource *types.Resource

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string

	// Indicates a list of the granted permissions that the principal may pass to
	// other users. These permissions may only be a subset of the permissions granted
	// in the Privileges .
	PermissionsWithGrantOption []types.Permission
	// contains filtered or unexported fields
}

type GrantPermissionsOutput 

type GrantPermissionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListDataCellsFilterAPIClient added in v1.10.0 

type ListDataCellsFilterAPIClient interface {
	ListDataCellsFilter(context.Context, *ListDataCellsFilterInput, ...func(*Options)) (*ListDataCellsFilterOutput, error)
}

ListDataCellsFilterAPIClient is a client that implements the ListDataCellsFilter operation.

type ListDataCellsFilterInput added in v1.10.0 

type ListDataCellsFilterInput struct {

	// The maximum size of the response.
	MaxResults *int32

	// A continuation token, if this is a continuation call.
	NextToken *string

	// A table in the Glue Data Catalog.
	Table *types.TableResource
	// contains filtered or unexported fields
}

type ListDataCellsFilterOutput added in v1.10.0 

type ListDataCellsFilterOutput struct {

	// A list of DataCellFilter structures.
	DataCellsFilters []types.DataCellsFilter

	// A continuation token, if not all requested data cell filters have been returned.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDataCellsFilterPaginator added in v1.10.0 

type ListDataCellsFilterPaginator struct {
	// contains filtered or unexported fields
}

ListDataCellsFilterPaginator is a paginator for ListDataCellsFilter

func NewListDataCellsFilterPaginator added in v1.10.0 

func NewListDataCellsFilterPaginator(client ListDataCellsFilterAPIClient, params *ListDataCellsFilterInput, optFns ...func(*ListDataCellsFilterPaginatorOptions)) *ListDataCellsFilterPaginator

NewListDataCellsFilterPaginator returns a new ListDataCellsFilterPaginator

func (*ListDataCellsFilterPaginator) HasMorePages added in v1.10.0 

func (p *ListDataCellsFilterPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataCellsFilterPaginator) NextPage added in v1.10.0 

func (p *ListDataCellsFilterPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataCellsFilterOutput, error)

NextPage retrieves the next ListDataCellsFilter page.

type ListDataCellsFilterPaginatorOptions added in v1.10.0 

type ListDataCellsFilterPaginatorOptions struct {
	// The maximum size of the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDataCellsFilterPaginatorOptions is the paginator options for ListDataCellsFilter

type ListLFTagExpressionsAPIClient added in v1.38.0 

type ListLFTagExpressionsAPIClient interface {
	ListLFTagExpressions(context.Context, *ListLFTagExpressionsInput, ...func(*Options)) (*ListLFTagExpressionsOutput, error)
}

ListLFTagExpressionsAPIClient is a client that implements the ListLFTagExpressions operation.

type ListLFTagExpressionsInput added in v1.38.0 

type ListLFTagExpressionsInput struct {

	// The identifier for the Data Catalog. By default, the account ID.
	CatalogId *string

	// The maximum number of results to return.
	MaxResults *int32

	// A continuation token, if this is not the first call to retrieve this list.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLFTagExpressionsOutput added in v1.38.0 

type ListLFTagExpressionsOutput struct {

	// Logical expressions composed of one more LF-Tag key-value pairs.
	LFTagExpressions []types.LFTagExpression

	// A continuation token, if this is not the first call to retrieve this list.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLFTagExpressionsPaginator added in v1.38.0 

type ListLFTagExpressionsPaginator struct {
	// contains filtered or unexported fields
}

ListLFTagExpressionsPaginator is a paginator for ListLFTagExpressions

func NewListLFTagExpressionsPaginator added in v1.38.0 

func NewListLFTagExpressionsPaginator(client ListLFTagExpressionsAPIClient, params *ListLFTagExpressionsInput, optFns ...func(*ListLFTagExpressionsPaginatorOptions)) *ListLFTagExpressionsPaginator

NewListLFTagExpressionsPaginator returns a new ListLFTagExpressionsPaginator

func (*ListLFTagExpressionsPaginator) HasMorePages added in v1.38.0 

func (p *ListLFTagExpressionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLFTagExpressionsPaginator) NextPage added in v1.38.0 

func (p *ListLFTagExpressionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLFTagExpressionsOutput, error)

NextPage retrieves the next ListLFTagExpressions page.

type ListLFTagExpressionsPaginatorOptions added in v1.38.0 

type ListLFTagExpressionsPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLFTagExpressionsPaginatorOptions is the paginator options for ListLFTagExpressions

type ListLFTagsAPIClient added in v1.10.0 

type ListLFTagsAPIClient interface {
	ListLFTags(context.Context, *ListLFTagsInput, ...func(*Options)) (*ListLFTagsOutput, error)
}

ListLFTagsAPIClient is a client that implements the ListLFTags operation.

type ListLFTagsInput added in v1.3.0 

type ListLFTagsInput struct {

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string

	// The maximum number of results to return.
	MaxResults *int32

	// A continuation token, if this is not the first call to retrieve this list.
	NextToken *string

	// If resource share type is ALL , returns both in-account LF-tags and shared
	// LF-tags that the requester has permission to view. If resource share type is
	// FOREIGN , returns all share LF-tags that the requester can view. If no resource
	// share type is passed, lists LF-tags in the given catalog ID that the requester
	// has permission to view.
	ResourceShareType types.ResourceShareType
	// contains filtered or unexported fields
}

type ListLFTagsOutput added in v1.3.0 

type ListLFTagsOutput struct {

	// A list of LF-tags that the requested has permission to view.
	LFTags []types.LFTagPair

	// A continuation token, present if the current list segment is not the last.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLFTagsPaginator added in v1.10.0 

type ListLFTagsPaginator struct {
	// contains filtered or unexported fields
}

ListLFTagsPaginator is a paginator for ListLFTags

func NewListLFTagsPaginator added in v1.10.0 

func NewListLFTagsPaginator(client ListLFTagsAPIClient, params *ListLFTagsInput, optFns ...func(*ListLFTagsPaginatorOptions)) *ListLFTagsPaginator

NewListLFTagsPaginator returns a new ListLFTagsPaginator

func (*ListLFTagsPaginator) HasMorePages added in v1.10.0 

func (p *ListLFTagsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLFTagsPaginator) NextPage added in v1.10.0 

func (p *ListLFTagsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLFTagsOutput, error)

NextPage retrieves the next ListLFTags page.

type ListLFTagsPaginatorOptions added in v1.10.0 

type ListLFTagsPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLFTagsPaginatorOptions is the paginator options for ListLFTags

type ListLakeFormationOptInsAPIClient added in v1.24.0 

type ListLakeFormationOptInsAPIClient interface {
	ListLakeFormationOptIns(context.Context, *ListLakeFormationOptInsInput, ...func(*Options)) (*ListLakeFormationOptInsOutput, error)
}

ListLakeFormationOptInsAPIClient is a client that implements the ListLakeFormationOptIns operation.

type ListLakeFormationOptInsInput added in v1.24.0 

type ListLakeFormationOptInsInput struct {

	// The maximum number of results to return.
	MaxResults *int32

	// A continuation token, if this is not the first call to retrieve this list.
	NextToken *string

	// The Lake Formation principal. Supported principals are IAM users or IAM roles.
	Principal *types.DataLakePrincipal

	// A structure for the resource.
	Resource *types.Resource
	// contains filtered or unexported fields
}

type ListLakeFormationOptInsOutput added in v1.24.0 

type ListLakeFormationOptInsOutput struct {

	// A list of principal-resource pairs that have Lake Formation permissins enforced.
	LakeFormationOptInsInfoList []types.LakeFormationOptInsInfo

	// A continuation token, if this is not the first call to retrieve this list.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLakeFormationOptInsPaginator added in v1.24.0 

type ListLakeFormationOptInsPaginator struct {
	// contains filtered or unexported fields
}

ListLakeFormationOptInsPaginator is a paginator for ListLakeFormationOptIns

func NewListLakeFormationOptInsPaginator added in v1.24.0 

func NewListLakeFormationOptInsPaginator(client ListLakeFormationOptInsAPIClient, params *ListLakeFormationOptInsInput, optFns ...func(*ListLakeFormationOptInsPaginatorOptions)) *ListLakeFormationOptInsPaginator

NewListLakeFormationOptInsPaginator returns a new ListLakeFormationOptInsPaginator

func (*ListLakeFormationOptInsPaginator) HasMorePages added in v1.24.0 

func (p *ListLakeFormationOptInsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLakeFormationOptInsPaginator) NextPage added in v1.24.0 

func (p *ListLakeFormationOptInsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLakeFormationOptInsOutput, error)

NextPage retrieves the next ListLakeFormationOptIns page.

type ListLakeFormationOptInsPaginatorOptions added in v1.24.0 

type ListLakeFormationOptInsPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLakeFormationOptInsPaginatorOptions is the paginator options for ListLakeFormationOptIns

type ListPermissionsAPIClient added in v0.30.0 

type ListPermissionsAPIClient interface {
	ListPermissions(context.Context, *ListPermissionsInput, ...func(*Options)) (*ListPermissionsOutput, error)
}

ListPermissionsAPIClient is a client that implements the ListPermissions operation.

type ListPermissionsInput 

type ListPermissionsInput struct {

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string

	// Indicates that related permissions should be included in the results.
	IncludeRelated *string

	// The maximum number of results to return.
	MaxResults *int32

	// A continuation token, if this is not the first call to retrieve this list.
	NextToken *string

	// Specifies a principal to filter the permissions returned.
	Principal *types.DataLakePrincipal

	// A resource where you will get a list of the principal permissions.
	//
	// This operation does not support getting privileges on a table with columns.
	// Instead, call this operation on the table, and the operation returns the table
	// and the table w columns.
	Resource *types.Resource

	// Specifies a resource type to filter the permissions returned.
	ResourceType types.DataLakeResourceType
	// contains filtered or unexported fields
}

type ListPermissionsOutput 

type ListPermissionsOutput struct {

	// A continuation token, if this is not the first call to retrieve this list.
	NextToken *string

	// A list of principals and their permissions on the resource for the specified
	// principal and resource types.
	PrincipalResourcePermissions []types.PrincipalResourcePermissions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPermissionsPaginator added in v0.30.0 

type ListPermissionsPaginator struct {
	// contains filtered or unexported fields
}

ListPermissionsPaginator is a paginator for ListPermissions

func NewListPermissionsPaginator added in v0.30.0 

func NewListPermissionsPaginator(client ListPermissionsAPIClient, params *ListPermissionsInput, optFns ...func(*ListPermissionsPaginatorOptions)) *ListPermissionsPaginator

NewListPermissionsPaginator returns a new ListPermissionsPaginator

func (*ListPermissionsPaginator) HasMorePages added in v0.30.0 

func (p *ListPermissionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPermissionsPaginator) NextPage added in v0.30.0 

func (p *ListPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPermissionsOutput, error)

NextPage retrieves the next ListPermissions page.

type ListPermissionsPaginatorOptions added in v0.30.0 

type ListPermissionsPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPermissionsPaginatorOptions is the paginator options for ListPermissions

type ListResourcesAPIClient added in v0.30.0 

type ListResourcesAPIClient interface {
	ListResources(context.Context, *ListResourcesInput, ...func(*Options)) (*ListResourcesOutput, error)
}

ListResourcesAPIClient is a client that implements the ListResources operation.

type ListResourcesInput 

type ListResourcesInput struct {

	// Any applicable row-level and/or column-level filtering conditions for the
	// resources.
	FilterConditionList []types.FilterCondition

	// The maximum number of resource results.
	MaxResults *int32

	// A continuation token, if this is not the first call to retrieve these resources.
	NextToken *string
	// contains filtered or unexported fields
}

type ListResourcesOutput 

type ListResourcesOutput struct {

	// A continuation token, if this is not the first call to retrieve these resources.
	NextToken *string

	// A summary of the data lake resources.
	ResourceInfoList []types.ResourceInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListResourcesPaginator added in v0.30.0 

type ListResourcesPaginator struct {
	// contains filtered or unexported fields
}

ListResourcesPaginator is a paginator for ListResources

func NewListResourcesPaginator added in v0.30.0 

func NewListResourcesPaginator(client ListResourcesAPIClient, params *ListResourcesInput, optFns ...func(*ListResourcesPaginatorOptions)) *ListResourcesPaginator

NewListResourcesPaginator returns a new ListResourcesPaginator

func (*ListResourcesPaginator) HasMorePages added in v0.30.0 

func (p *ListResourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourcesPaginator) NextPage added in v0.30.0 

func (p *ListResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourcesOutput, error)

NextPage retrieves the next ListResources page.

type ListResourcesPaginatorOptions added in v0.30.0 

type ListResourcesPaginatorOptions struct {
	// The maximum number of resource results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListResourcesPaginatorOptions is the paginator options for ListResources

type ListTableStorageOptimizersAPIClient added in v1.10.0 

type ListTableStorageOptimizersAPIClient interface {
	ListTableStorageOptimizers(context.Context, *ListTableStorageOptimizersInput, ...func(*Options)) (*ListTableStorageOptimizersOutput, error)
}

ListTableStorageOptimizersAPIClient is a client that implements the ListTableStorageOptimizers operation.

type ListTableStorageOptimizersInput added in v1.10.0 

type ListTableStorageOptimizersInput struct {

	// Name of the database where the table is present.
	//
	// This member is required.
	DatabaseName *string

	// Name of the table.
	//
	// This member is required.
	TableName *string

	// The Catalog ID of the table.
	CatalogId *string

	// The number of storage optimizers to return on each call.
	MaxResults *int32

	// A continuation token, if this is a continuation call.
	NextToken *string

	// The specific type of storage optimizers to list. The supported value is
	// compaction .
	StorageOptimizerType types.OptimizerType
	// contains filtered or unexported fields
}

type ListTableStorageOptimizersOutput added in v1.10.0 

type ListTableStorageOptimizersOutput struct {

	// A continuation token for paginating the returned list of tokens, returned if
	// the current segment of the list is not the last.
	NextToken *string

	// A list of the storage optimizers associated with a table.
	StorageOptimizerList []types.StorageOptimizer

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTableStorageOptimizersPaginator added in v1.10.0 

type ListTableStorageOptimizersPaginator struct {
	// contains filtered or unexported fields
}

ListTableStorageOptimizersPaginator is a paginator for ListTableStorageOptimizers

func NewListTableStorageOptimizersPaginator added in v1.10.0 

func NewListTableStorageOptimizersPaginator(client ListTableStorageOptimizersAPIClient, params *ListTableStorageOptimizersInput, optFns ...func(*ListTableStorageOptimizersPaginatorOptions)) *ListTableStorageOptimizersPaginator

NewListTableStorageOptimizersPaginator returns a new ListTableStorageOptimizersPaginator

func (*ListTableStorageOptimizersPaginator) HasMorePages added in v1.10.0 

func (p *ListTableStorageOptimizersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTableStorageOptimizersPaginator) NextPage added in v1.10.0 

func (p *ListTableStorageOptimizersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTableStorageOptimizersOutput, error)

NextPage retrieves the next ListTableStorageOptimizers page.

type ListTableStorageOptimizersPaginatorOptions added in v1.10.0 

type ListTableStorageOptimizersPaginatorOptions struct {
	// The number of storage optimizers to return on each call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTableStorageOptimizersPaginatorOptions is the paginator options for ListTableStorageOptimizers

type ListTransactionsAPIClient added in v1.10.0 

type ListTransactionsAPIClient interface {
	ListTransactions(context.Context, *ListTransactionsInput, ...func(*Options)) (*ListTransactionsOutput, error)
}

ListTransactionsAPIClient is a client that implements the ListTransactions operation.

type ListTransactionsInput added in v1.10.0 

type ListTransactionsInput struct {

	// The catalog for which to list transactions. Defaults to the account ID of the
	// caller.
	CatalogId *string

	// The maximum number of transactions to return in a single call.
	MaxResults *int32

	// A continuation token if this is not the first call to retrieve transactions.
	NextToken *string

	//  A filter indicating the status of transactions to return. Options are ALL |
	// COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is ALL .
	StatusFilter types.TransactionStatusFilter
	// contains filtered or unexported fields
}

type ListTransactionsOutput added in v1.10.0 

type ListTransactionsOutput struct {

	// A continuation token indicating whether additional data is available.
	NextToken *string

	// A list of transactions. The record for each transaction is a
	// TransactionDescription object.
	Transactions []types.TransactionDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTransactionsPaginator added in v1.10.0 

type ListTransactionsPaginator struct {
	// contains filtered or unexported fields
}

ListTransactionsPaginator is a paginator for ListTransactions

func NewListTransactionsPaginator added in v1.10.0 

func NewListTransactionsPaginator(client ListTransactionsAPIClient, params *ListTransactionsInput, optFns ...func(*ListTransactionsPaginatorOptions)) *ListTransactionsPaginator

NewListTransactionsPaginator returns a new ListTransactionsPaginator

func (*ListTransactionsPaginator) HasMorePages added in v1.10.0 

func (p *ListTransactionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTransactionsPaginator) NextPage added in v1.10.0 

func (p *ListTransactionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTransactionsOutput, error)

NextPage retrieves the next ListTransactions page.

type ListTransactionsPaginatorOptions added in v1.10.0 

type ListTransactionsPaginatorOptions struct {
	// The maximum number of transactions to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTransactionsPaginatorOptions is the paginator options for ListTransactions

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.26.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutDataLakeSettingsInput 

type PutDataLakeSettingsInput struct {

	// A structure representing a list of Lake Formation principals designated as data
	// lake administrators.
	//
	// This member is required.
	DataLakeSettings *types.DataLakeSettings

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string
	// contains filtered or unexported fields
}

type PutDataLakeSettingsOutput 

type PutDataLakeSettingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RegisterResourceInput 

type RegisterResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to register.
	//
	// This member is required.
	ResourceArn *string

	//  Specifies whether the data access of tables pointing to the location can be
	// managed by both Lake Formation permissions as well as Amazon S3 bucket policies.
	HybridAccessEnabled *bool

	// The identifier for the role that registers the resource.
	RoleArn *string

	// Designates an Identity and Access Management (IAM) service-linked role by
	// registering this role with the Data Catalog. A service-linked role is a unique
	// type of IAM role that is linked directly to Lake Formation.
	//
	// For more information, see [Using Service-Linked Roles for Lake Formation].
	//
	// [Using Service-Linked Roles for Lake Formation]: https://docs.aws.amazon.com/lake-formation/latest/dg/service-linked-roles.html
	UseServiceLinkedRole *bool

	// Whether or not the resource is a federated resource.
	WithFederation *bool
	// contains filtered or unexported fields
}

type RegisterResourceOutput 

type RegisterResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RemoveLFTagsFromResourceInput added in v1.3.0 

type RemoveLFTagsFromResourceInput struct {

	// The LF-tags to be removed from the resource.
	//
	// This member is required.
	LFTags []types.LFTagPair

	// The database, table, or column resource where you want to remove an LF-tag.
	//
	// This member is required.
	Resource *types.Resource

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string
	// contains filtered or unexported fields
}

type RemoveLFTagsFromResourceOutput added in v1.3.0 

type RemoveLFTagsFromResourceOutput struct {

	// A list of failures to untag a resource.
	Failures []types.LFTagError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type RevokePermissionsInput 

type RevokePermissionsInput struct {

	// The permissions revoked to the principal on the resource. For information about
	// permissions, see [Security and Access Control to Metadata and Data].
	//
	// [Security and Access Control to Metadata and Data]: https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html
	//
	// This member is required.
	Permissions []types.Permission

	// The principal to be revoked permissions on the resource.
	//
	// This member is required.
	Principal *types.DataLakePrincipal

	// The resource to which permissions are to be revoked.
	//
	// This member is required.
	Resource *types.Resource

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string

	// Indicates a list of permissions for which to revoke the grant option allowing
	// the principal to pass permissions to other principals.
	PermissionsWithGrantOption []types.Permission
	// contains filtered or unexported fields
}

type RevokePermissionsOutput 

type RevokePermissionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchDatabasesByLFTagsAPIClient added in v1.10.0 

type SearchDatabasesByLFTagsAPIClient interface {
	SearchDatabasesByLFTags(context.Context, *SearchDatabasesByLFTagsInput, ...func(*Options)) (*SearchDatabasesByLFTagsOutput, error)
}

SearchDatabasesByLFTagsAPIClient is a client that implements the SearchDatabasesByLFTags operation.

type SearchDatabasesByLFTagsInput added in v1.3.0 

type SearchDatabasesByLFTagsInput struct {

	// A list of conditions ( LFTag structures) to search for in database resources.
	//
	// This member is required.
	Expression []types.LFTag

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string

	// The maximum number of results to return.
	MaxResults *int32

	// A continuation token, if this is not the first call to retrieve this list.
	NextToken *string
	// contains filtered or unexported fields
}

type SearchDatabasesByLFTagsOutput added in v1.3.0 

type SearchDatabasesByLFTagsOutput struct {

	// A list of databases that meet the LF-tag conditions.
	DatabaseList []types.TaggedDatabase

	// A continuation token, present if the current list segment is not the last.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchDatabasesByLFTagsPaginator added in v1.10.0 

type SearchDatabasesByLFTagsPaginator struct {
	// contains filtered or unexported fields
}

SearchDatabasesByLFTagsPaginator is a paginator for SearchDatabasesByLFTags

func NewSearchDatabasesByLFTagsPaginator added in v1.10.0 

func NewSearchDatabasesByLFTagsPaginator(client SearchDatabasesByLFTagsAPIClient, params *SearchDatabasesByLFTagsInput, optFns ...func(*SearchDatabasesByLFTagsPaginatorOptions)) *SearchDatabasesByLFTagsPaginator

NewSearchDatabasesByLFTagsPaginator returns a new SearchDatabasesByLFTagsPaginator

func (*SearchDatabasesByLFTagsPaginator) HasMorePages added in v1.10.0 

func (p *SearchDatabasesByLFTagsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchDatabasesByLFTagsPaginator) NextPage added in v1.10.0 

func (p *SearchDatabasesByLFTagsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchDatabasesByLFTagsOutput, error)

NextPage retrieves the next SearchDatabasesByLFTags page.

type SearchDatabasesByLFTagsPaginatorOptions added in v1.10.0 

type SearchDatabasesByLFTagsPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchDatabasesByLFTagsPaginatorOptions is the paginator options for SearchDatabasesByLFTags

type SearchTablesByLFTagsAPIClient added in v1.10.0 

type SearchTablesByLFTagsAPIClient interface {
	SearchTablesByLFTags(context.Context, *SearchTablesByLFTagsInput, ...func(*Options)) (*SearchTablesByLFTagsOutput, error)
}

SearchTablesByLFTagsAPIClient is a client that implements the SearchTablesByLFTags operation.

type SearchTablesByLFTagsInput added in v1.3.0 

type SearchTablesByLFTagsInput struct {

	// A list of conditions ( LFTag structures) to search for in table resources.
	//
	// This member is required.
	Expression []types.LFTag

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string

	// The maximum number of results to return.
	MaxResults *int32

	// A continuation token, if this is not the first call to retrieve this list.
	NextToken *string
	// contains filtered or unexported fields
}

type SearchTablesByLFTagsOutput added in v1.3.0 

type SearchTablesByLFTagsOutput struct {

	// A continuation token, present if the current list segment is not the last. On
	// the first run, if you include a not null (a value) token you can get empty
	// pages.
	NextToken *string

	// A list of tables that meet the LF-tag conditions.
	TableList []types.TaggedTable

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchTablesByLFTagsPaginator added in v1.10.0 

type SearchTablesByLFTagsPaginator struct {
	// contains filtered or unexported fields
}

SearchTablesByLFTagsPaginator is a paginator for SearchTablesByLFTags

func NewSearchTablesByLFTagsPaginator added in v1.10.0 

func NewSearchTablesByLFTagsPaginator(client SearchTablesByLFTagsAPIClient, params *SearchTablesByLFTagsInput, optFns ...func(*SearchTablesByLFTagsPaginatorOptions)) *SearchTablesByLFTagsPaginator

NewSearchTablesByLFTagsPaginator returns a new SearchTablesByLFTagsPaginator

func (*SearchTablesByLFTagsPaginator) HasMorePages added in v1.10.0 

func (p *SearchTablesByLFTagsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchTablesByLFTagsPaginator) NextPage added in v1.10.0 

func (p *SearchTablesByLFTagsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchTablesByLFTagsOutput, error)

NextPage retrieves the next SearchTablesByLFTags page.

type SearchTablesByLFTagsPaginatorOptions added in v1.10.0 

type SearchTablesByLFTagsPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchTablesByLFTagsPaginatorOptions is the paginator options for SearchTablesByLFTags

type StartQueryPlanningInput added in v1.10.0 

type StartQueryPlanningInput struct {

	// A structure containing information about the query plan.
	//
	// This member is required.
	QueryPlanningContext *types.QueryPlanningContext

	// A PartiQL query statement used as an input to the planner service.
	//
	// This member is required.
	QueryString *string
	// contains filtered or unexported fields
}

type StartQueryPlanningOutput added in v1.10.0 

type StartQueryPlanningOutput struct {

	// The ID of the plan query operation can be used to fetch the actual work unit
	// descriptors that are produced as the result of the operation. The ID is also
	// used to get the query state and as an input to the Execute operation.
	//
	// This member is required.
	QueryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

A structure for the output.

type StartTransactionInput added in v1.10.0 

type StartTransactionInput struct {

	// Indicates whether this transaction should be read only or read and write.
	// Writes made using a read-only transaction ID will be rejected. Read-only
	// transactions do not need to be committed.
	TransactionType types.TransactionType
	// contains filtered or unexported fields
}

type StartTransactionOutput added in v1.10.0 

type StartTransactionOutput struct {

	// An opaque identifier for the transaction.
	TransactionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDataCellsFilterInput added in v1.20.0 

type UpdateDataCellsFilterInput struct {

	// A DataCellsFilter structure containing information about the data cells filter.
	//
	// This member is required.
	TableData *types.DataCellsFilter
	// contains filtered or unexported fields
}

type UpdateDataCellsFilterOutput added in v1.20.0 

type UpdateDataCellsFilterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateLFTagExpressionInput added in v1.38.0 

type UpdateLFTagExpressionInput struct {

	// The LF-Tag expression body composed of one more LF-Tag key-value pairs.
	//
	// This member is required.
	Expression []types.LFTag

	// The name for the LF-Tag expression.
	//
	// This member is required.
	Name *string

	// The identifier for the Data Catalog. By default, the account ID.
	CatalogId *string

	// The description with information about the saved LF-Tag expression.
	Description *string
	// contains filtered or unexported fields
}

type UpdateLFTagExpressionOutput added in v1.38.0 

type UpdateLFTagExpressionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateLFTagInput added in v1.3.0 

type UpdateLFTagInput struct {

	// The key-name for the LF-tag for which to add or delete values.
	//
	// This member is required.
	TagKey *string

	// 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, and other control information to manage your Lake Formation
	// environment.
	CatalogId *string

	// A list of LF-tag values to add from the LF-tag.
	TagValuesToAdd []string

	// A list of LF-tag values to delete from the LF-tag.
	TagValuesToDelete []string
	// contains filtered or unexported fields
}

type UpdateLFTagOutput added in v1.3.0 

type UpdateLFTagOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateLakeFormationIdentityCenterConfigurationInput added in v1.27.0 

type UpdateLakeFormationIdentityCenterConfigurationInput struct {

	// Allows to enable or disable the IAM Identity Center connection.
	ApplicationStatus types.ApplicationStatus

	// 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.
	CatalogId *string

	// 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.
	ExternalFiltering *types.ExternalFilteringConfiguration

	// 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.
	ShareRecipients []types.DataLakePrincipal
	// contains filtered or unexported fields
}

type UpdateLakeFormationIdentityCenterConfigurationOutput added in v1.27.0 

type UpdateLakeFormationIdentityCenterConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateResourceInput 

type UpdateResourceInput struct {

	// The resource ARN.
	//
	// This member is required.
	ResourceArn *string

	// The new role to use for the given resource registered in Lake Formation.
	//
	// This member is required.
	RoleArn *string

	//  Specifies whether the data access of tables pointing to the location can be
	// managed by both Lake Formation permissions as well as Amazon S3 bucket policies.
	HybridAccessEnabled *bool

	// Whether or not the resource is a federated resource.
	WithFederation *bool
	// contains filtered or unexported fields
}

type UpdateResourceOutput 

type UpdateResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateTableObjectsInput added in v1.10.0 

type UpdateTableObjectsInput struct {

	// The database containing the governed table to update.
	//
	// This member is required.
	DatabaseName *string

	// The governed table to update.
	//
	// This member is required.
	TableName *string

	// A list of WriteOperation objects that define an object to add to or delete from
	// the manifest for a governed table.
	//
	// This member is required.
	WriteOperations []types.WriteOperation

	// The catalog containing the governed table to update. Defaults to the caller’s
	// account ID.
	CatalogId *string

	// The transaction at which to do the write.
	TransactionId *string
	// contains filtered or unexported fields
}

type UpdateTableObjectsOutput added in v1.10.0 

type UpdateTableObjectsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateTableStorageOptimizerInput added in v1.10.0 

type UpdateTableStorageOptimizerInput struct {

	// Name of the database where the table is present.
	//
	// This member is required.
	DatabaseName *string

	// Name of the configuration for the storage optimizer.
	//
	// This member is required.
	StorageOptimizerConfig map[string]map[string]string

	// Name of the table for which to enable the storage optimizer.
	//
	// This member is required.
	TableName *string

	// The Catalog ID of the table.
	CatalogId *string
	// contains filtered or unexported fields
}

type UpdateTableStorageOptimizerOutput added in v1.10.0 

type UpdateTableStorageOptimizerOutput struct {

	// A response indicating the success of failure of the operation.
	Result *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.