types

package
v1.32.2 Latest Latest
Warning

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

Go to latest
Published: May 15, 2024 License: Apache-2.0 Imports: 4 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException added in v1.3.0

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Access to a resource was denied.

func (*AccessDeniedException) Error added in v1.3.0

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode added in v1.3.0

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault added in v1.3.0

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage added in v1.3.0

func (e *AccessDeniedException) ErrorMessage() string

type AddObjectInput added in v1.10.0

type AddObjectInput struct {

	// The Amazon S3 ETag of the object. Returned by GetTableObjects for validation
	// and used to identify changes to the underlying data.
	//
	// This member is required.
	ETag *string

	// The size of the Amazon S3 object in bytes.
	//
	// This member is required.
	Size int64

	// The Amazon S3 location of the object.
	//
	// This member is required.
	Uri *string

	// A list of partition values for the object. A value must be specified for each
	// partition key associated with the table.
	//
	// The supported data types are integer, long, date(yyyy-MM-dd),
	// timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal.
	PartitionValues []string
	// contains filtered or unexported fields
}

A new object to add to the governed table.

type AllRowsWildcard added in v1.10.0

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

A structure that you pass to indicate you want all rows in a filter.

type AlreadyExistsException

type AlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A resource to be created or added already exists.

func (*AlreadyExistsException) Error

func (e *AlreadyExistsException) Error() string

func (*AlreadyExistsException) ErrorCode

func (e *AlreadyExistsException) ErrorCode() string

func (*AlreadyExistsException) ErrorFault

func (e *AlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*AlreadyExistsException) ErrorMessage

func (e *AlreadyExistsException) ErrorMessage() string

type ApplicationStatus added in v1.27.0

type ApplicationStatus string
const (
	ApplicationStatusEnabled  ApplicationStatus = "ENABLED"
	ApplicationStatusDisabled ApplicationStatus = "DISABLED"
)

Enum values for ApplicationStatus

func (ApplicationStatus) Values added in v1.27.0

Values returns all known values for ApplicationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuditContext added in v1.12.0

type AuditContext struct {

	// The filter engine can populate the 'AdditionalAuditContext' information with
	// the request ID for you to track. This information will be displayed in
	// CloudTrail log in your account.
	AdditionalAuditContext *string
	// contains filtered or unexported fields
}

A structure used to include auditing information on the privileged API.

type BatchPermissionsFailureEntry

type BatchPermissionsFailureEntry struct {

	// An error message that applies to the failure of the entry.
	Error *ErrorDetail

	// An identifier for an entry of the batch request.
	RequestEntry *BatchPermissionsRequestEntry
	// contains filtered or unexported fields
}

A list of failures when performing a batch grant or batch revoke operation.

type BatchPermissionsRequestEntry

type BatchPermissionsRequestEntry struct {

	// A unique identifier for the batch permissions request entry.
	//
	// This member is required.
	Id *string

	// The permissions to be granted.
	Permissions []Permission

	// Indicates if the option to pass permissions is granted.
	PermissionsWithGrantOption []Permission

	// The principal to be granted a permission.
	Principal *DataLakePrincipal

	// The resource to which the principal is to be granted a permission.
	Resource *Resource
	// contains filtered or unexported fields
}

A permission to a resource granted by batch operation to the principal.

type CatalogResource

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

A structure for the catalog object.

type ColumnLFTag added in v1.3.0

type ColumnLFTag struct {

	// The LF-tags attached to a column resource.
	LFTags []LFTagPair

	// The name of a column resource.
	Name *string
	// contains filtered or unexported fields
}

A structure containing the name of a column resource and the LF-tags attached to it.

type ColumnWildcard

type ColumnWildcard struct {

	// Excludes column names. Any column with this name will be excluded.
	ExcludedColumnNames []string
	// contains filtered or unexported fields
}

A wildcard object, consisting of an optional list of excluded column names or indexes.

type ComparisonOperator

type ComparisonOperator string
const (
	ComparisonOperatorEq          ComparisonOperator = "EQ"
	ComparisonOperatorNe          ComparisonOperator = "NE"
	ComparisonOperatorLe          ComparisonOperator = "LE"
	ComparisonOperatorLt          ComparisonOperator = "LT"
	ComparisonOperatorGe          ComparisonOperator = "GE"
	ComparisonOperatorGt          ComparisonOperator = "GT"
	ComparisonOperatorContains    ComparisonOperator = "CONTAINS"
	ComparisonOperatorNotContains ComparisonOperator = "NOT_CONTAINS"
	ComparisonOperatorBeginsWith  ComparisonOperator = "BEGINS_WITH"
	ComparisonOperatorIn          ComparisonOperator = "IN"
	ComparisonOperatorBetween     ComparisonOperator = "BETWEEN"
)

Enum values for ComparisonOperator

func (ComparisonOperator) Values added in v0.29.0

Values returns all known values for ComparisonOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConcurrentModificationException

type ConcurrentModificationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Two processes are trying to modify a resource simultaneously.

func (*ConcurrentModificationException) Error

func (*ConcurrentModificationException) ErrorCode

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault

func (*ConcurrentModificationException) ErrorMessage

func (e *ConcurrentModificationException) ErrorMessage() string

type DataCellsFilter added in v1.10.0

type DataCellsFilter 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

	// A list of column names and/or nested column attributes. When specifying nested
	// attributes, use a qualified dot (.) delimited format such as "address"."zip".
	// Nested attributes within this list may not exceed a depth of 5.
	ColumnNames []string

	// A wildcard with exclusions.
	//
	// You must specify either a ColumnNames list or the ColumnWildCard .
	ColumnWildcard *ColumnWildcard

	// A PartiQL predicate.
	RowFilter *RowFilter

	// The ID of the data cells filter version.
	VersionId *string
	// contains filtered or unexported fields
}

A structure that describes certain columns on certain rows.

type DataCellsFilterResource added in v1.10.0

type DataCellsFilterResource struct {

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

	// The name of the data cells filter.
	Name *string

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

	// The name of the table.
	TableName *string
	// contains filtered or unexported fields
}

A structure for a data cells filter resource.

type DataLakePrincipal

type DataLakePrincipal struct {

	// An identifier for the Lake Formation principal.
	DataLakePrincipalIdentifier *string
	// contains filtered or unexported fields
}

The Lake Formation principal. Supported principals are IAM users or IAM roles.

type DataLakeResourceType

type DataLakeResourceType string
const (
	DataLakeResourceTypeCatalog             DataLakeResourceType = "CATALOG"
	DataLakeResourceTypeDatabase            DataLakeResourceType = "DATABASE"
	DataLakeResourceTypeTable               DataLakeResourceType = "TABLE"
	DataLakeResourceTypeDataLocation        DataLakeResourceType = "DATA_LOCATION"
	DataLakeResourceTypeLfTag               DataLakeResourceType = "LF_TAG"
	DataLakeResourceTypeLfTagPolicy         DataLakeResourceType = "LF_TAG_POLICY"
	DataLakeResourceTypeLfTagPolicyDatabase DataLakeResourceType = "LF_TAG_POLICY_DATABASE"
	DataLakeResourceTypeLfTagPolicyTable    DataLakeResourceType = "LF_TAG_POLICY_TABLE"
)

Enum values for DataLakeResourceType

func (DataLakeResourceType) Values added in v0.29.0

Values returns all known values for DataLakeResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DataLakeSettings

type DataLakeSettings struct {

	// Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
	//
	// If true, you allow Amazon EMR clusters to access data in Amazon S3 locations
	// that are registered with Lake Formation.
	//
	// If false or null, no Amazon EMR clusters will be able to access data in Amazon
	// S3 locations that are registered with Lake Formation.
	//
	// For more information, see [(Optional) Allow external data filtering].
	//
	// [(Optional) Allow external data filtering]: https://docs.aws.amazon.com/lake-formation/latest/dg/initial-LF-setup.html#external-data-filter
	AllowExternalDataFiltering *bool

	// Whether to allow a third-party query engine to get data access credentials
	// without session tags when a caller has full data access permissions.
	AllowFullTableExternalDataAccess *bool

	// Lake Formation relies on a privileged process secured by Amazon EMR or the
	// third party integrator to tag the user's role while assuming it. Lake Formation
	// will publish the acceptable key-value pair, for example key =
	// "LakeFormationTrustedCaller" and value = "TRUE" and the third party integrator
	// must properly tag the temporary security credentials that will be used to call
	// Lake Formation's administrative APIs.
	AuthorizedSessionTagValueList []string

	// Specifies whether access control on newly created database is managed by Lake
	// Formation permissions or exclusively by IAM permissions.
	//
	// A null value indicates access control by Lake Formation permissions. A value
	// that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM
	// permissions. This is referred to as the setting "Use only IAM access control,"
	// and is for backward compatibility with the Glue permission model implemented by
	// IAM permissions.
	//
	// The only permitted values are an empty array or an array that contains a single
	// JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS.
	//
	// For more information, see [Changing the Default Security Settings for Your Data Lake].
	//
	// [Changing the Default Security Settings for Your Data Lake]: https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html
	CreateDatabaseDefaultPermissions []PrincipalPermissions

	// Specifies whether access control on newly created table is managed by Lake
	// Formation permissions or exclusively by IAM permissions.
	//
	// A null value indicates access control by Lake Formation permissions. A value
	// that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM
	// permissions. This is referred to as the setting "Use only IAM access control,"
	// and is for backward compatibility with the Glue permission model implemented by
	// IAM permissions.
	//
	// The only permitted values are an empty array or an array that contains a single
	// JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS.
	//
	// For more information, see [Changing the Default Security Settings for Your Data Lake].
	//
	// [Changing the Default Security Settings for Your Data Lake]: https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html
	CreateTableDefaultPermissions []PrincipalPermissions

	// A list of Lake Formation principals. Supported principals are IAM users or IAM
	// roles.
	DataLakeAdmins []DataLakePrincipal

	// A list of the account IDs of Amazon Web Services accounts with Amazon EMR
	// clusters that are to perform data filtering.>
	ExternalDataFilteringAllowList []DataLakePrincipal

	// A key-value map that provides an additional configuration on your data lake.
	// CROSS_ACCOUNT_VERSION is the key you can configure in the Parameters field.
	// Accepted values for the CrossAccountVersion key are 1, 2, 3, and 4.
	Parameters map[string]string

	// A list of Lake Formation principals with only view access to the resources,
	// without the ability to make changes. Supported principals are IAM users or IAM
	// roles.
	ReadOnlyAdmins []DataLakePrincipal

	// A list of the resource-owning account IDs that the caller's account can use to
	// share their user access details (user ARNs). The user ARNs can be logged in the
	// resource owner's CloudTrail log.
	//
	// You may want to specify this property when you are in a high-trust boundary,
	// such as the same team or company.
	TrustedResourceOwners []string
	// contains filtered or unexported fields
}

A structure representing a list of Lake Formation principals designated as data lake administrators and lists of principal permission entries for default create database and default create table permissions.

type DataLocationResource

type DataLocationResource struct {

	// The Amazon Resource Name (ARN) that uniquely identifies the data location
	// resource.
	//
	// This member is required.
	ResourceArn *string

	// The identifier for the Data Catalog where the location is registered with Lake
	// Formation. By default, it is the account ID of the caller.
	CatalogId *string
	// contains filtered or unexported fields
}

A structure for a data location object where permissions are granted or revoked.

type DatabaseResource

type DatabaseResource struct {

	// The name of the database resource. Unique to the Data Catalog.
	//
	// This member is required.
	Name *string

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

A structure for the database object.

type DeleteObjectInput added in v1.10.0

type DeleteObjectInput struct {

	// The Amazon S3 location of the object to delete.
	//
	// This member is required.
	Uri *string

	// The Amazon S3 ETag of the object. Returned by GetTableObjects for validation
	// and used to identify changes to the underlying data.
	ETag *string

	// A list of partition values for the object. A value must be specified for each
	// partition key associated with the governed table.
	PartitionValues []string
	// contains filtered or unexported fields
}

An object to delete from the governed table.

type DetailsMap added in v0.29.0

type DetailsMap struct {

	// A resource share ARN for a catalog resource shared through RAM.
	ResourceShare []string
	// contains filtered or unexported fields
}

A structure containing the additional details to be returned in the AdditionalDetails attribute of PrincipalResourcePermissions .

If a catalog resource is shared through Resource Access Manager (RAM), then there will exist a corresponding RAM resource share ARN.

type EnableStatus added in v1.27.0

type EnableStatus string
const (
	EnableStatusEnabled  EnableStatus = "ENABLED"
	EnableStatusDisabled EnableStatus = "DISABLED"
)

Enum values for EnableStatus

func (EnableStatus) Values added in v1.27.0

func (EnableStatus) Values() []EnableStatus

Values returns all known values for EnableStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EntityNotFoundException

type EntityNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A specified entity does not exist.

func (*EntityNotFoundException) Error

func (e *EntityNotFoundException) Error() string

func (*EntityNotFoundException) ErrorCode

func (e *EntityNotFoundException) ErrorCode() string

func (*EntityNotFoundException) ErrorFault

func (e *EntityNotFoundException) ErrorFault() smithy.ErrorFault

func (*EntityNotFoundException) ErrorMessage

func (e *EntityNotFoundException) ErrorMessage() string

type ErrorDetail

type ErrorDetail struct {

	// The code associated with this error.
	ErrorCode *string

	// A message describing the error.
	ErrorMessage *string
	// contains filtered or unexported fields
}

Contains details about an error.

type ExecutionStatistics added in v1.10.0

type ExecutionStatistics struct {

	// The average time the request took to be executed.
	AverageExecutionTimeMillis int64

	// The amount of data that was scanned in bytes.
	DataScannedBytes int64

	// The number of work units executed.
	WorkUnitsExecutedCount int64
	// contains filtered or unexported fields
}

Statistics related to the processing of a query statement.

type ExpiredException added in v1.10.0

type ExpiredException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Contains details about an error where the query request expired.

func (*ExpiredException) Error added in v1.10.0

func (e *ExpiredException) Error() string

func (*ExpiredException) ErrorCode added in v1.10.0

func (e *ExpiredException) ErrorCode() string

func (*ExpiredException) ErrorFault added in v1.10.0

func (e *ExpiredException) ErrorFault() smithy.ErrorFault

func (*ExpiredException) ErrorMessage added in v1.10.0

func (e *ExpiredException) ErrorMessage() string

type ExternalFilteringConfiguration added in v1.27.0

type ExternalFilteringConfiguration struct {

	// List of third-party application ARNs integrated with Lake Formation.
	//
	// This member is required.
	AuthorizedTargets []string

	// Allows to enable or disable the third-party applications that are allowed to
	// access data managed by Lake Formation.
	//
	// This member is required.
	Status EnableStatus
	// contains filtered or unexported fields
}

Configuration for enabling external data filtering for third-party applications to access data managed by Lake Formation .

type FieldNameString

type FieldNameString string
const (
	FieldNameStringResourceArn  FieldNameString = "RESOURCE_ARN"
	FieldNameStringRoleArn      FieldNameString = "ROLE_ARN"
	FieldNameStringLastModified FieldNameString = "LAST_MODIFIED"
)

Enum values for FieldNameString

func (FieldNameString) Values added in v0.29.0

func (FieldNameString) Values() []FieldNameString

Values returns all known values for FieldNameString. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FilterCondition

type FilterCondition struct {

	// The comparison operator used in the filter condition.
	ComparisonOperator ComparisonOperator

	// The field to filter in the filter condition.
	Field FieldNameString

	// A string with values used in evaluating the filter condition.
	StringValueList []string
	// contains filtered or unexported fields
}

This structure describes the filtering of columns in a table based on a filter condition.

type GlueEncryptionException added in v1.3.0

type GlueEncryptionException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An encryption operation failed.

func (*GlueEncryptionException) Error added in v1.3.0

func (e *GlueEncryptionException) Error() string

func (*GlueEncryptionException) ErrorCode added in v1.3.0

func (e *GlueEncryptionException) ErrorCode() string

func (*GlueEncryptionException) ErrorFault added in v1.3.0

func (e *GlueEncryptionException) ErrorFault() smithy.ErrorFault

func (*GlueEncryptionException) ErrorMessage added in v1.3.0

func (e *GlueEncryptionException) ErrorMessage() string

type InternalServiceException

type InternalServiceException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An internal service error occurred.

func (*InternalServiceException) Error

func (e *InternalServiceException) Error() string

func (*InternalServiceException) ErrorCode

func (e *InternalServiceException) ErrorCode() string

func (*InternalServiceException) ErrorFault

func (e *InternalServiceException) ErrorFault() smithy.ErrorFault

func (*InternalServiceException) ErrorMessage

func (e *InternalServiceException) ErrorMessage() string

type InvalidInputException

type InvalidInputException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The input provided was not valid.

func (*InvalidInputException) Error

func (e *InvalidInputException) Error() string

func (*InvalidInputException) ErrorCode

func (e *InvalidInputException) ErrorCode() string

func (*InvalidInputException) ErrorFault

func (e *InvalidInputException) ErrorFault() smithy.ErrorFault

func (*InvalidInputException) ErrorMessage

func (e *InvalidInputException) ErrorMessage() string

type LFTag added in v1.3.0

type LFTag struct {

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

	// A list of possible values an attribute can take.
	//
	// The maximum number of values that can be defined for a LF-Tag is 1000. A single
	// API call supports 50 values. You can use multiple API calls to add more values.
	//
	// This member is required.
	TagValues []string
	// contains filtered or unexported fields
}

A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

type LFTagError added in v1.3.0

type LFTagError struct {

	// An error that occurred with the attachment or detachment of the LF-tag.
	Error *ErrorDetail

	// The key-name of the LF-tag.
	LFTag *LFTagPair
	// contains filtered or unexported fields
}

A structure containing an error related to a TagResource or UnTagResource operation.

type LFTagKeyResource added in v1.3.0

type LFTagKeyResource 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
}

A structure containing an LF-tag key and values for a resource.

type LFTagPair added in v1.3.0

type LFTagPair 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
}

A structure containing an LF-tag key-value pair.

type LFTagPolicyResource added in v1.3.0

type LFTagPolicyResource struct {

	// A list of LF-tag conditions that apply to the resource's LF-tag policy.
	//
	// This member is required.
	Expression []LFTag

	// The resource type for which the LF-tag policy applies.
	//
	// This member is required.
	ResourceType ResourceType

	// 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
}

A structure containing a list of LF-tag conditions that apply to a resource's LF-tag policy.

type LakeFormationOptInsInfo added in v1.24.0

type LakeFormationOptInsInfo struct {

	// The last modified date and time of the record.
	LastModified *time.Time

	// The user who updated the record.
	LastUpdatedBy *string

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

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

A single principal-resource pair that has Lake Formation permissins enforced.

type OperationTimeoutException

type OperationTimeoutException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation timed out.

func (*OperationTimeoutException) Error

func (e *OperationTimeoutException) Error() string

func (*OperationTimeoutException) ErrorCode

func (e *OperationTimeoutException) ErrorCode() string

func (*OperationTimeoutException) ErrorFault

func (*OperationTimeoutException) ErrorMessage

func (e *OperationTimeoutException) ErrorMessage() string

type OptimizerType added in v1.10.0

type OptimizerType string
const (
	OptimizerTypeCompaction        OptimizerType = "COMPACTION"
	OptimizerTypeGarbageCollection OptimizerType = "GARBAGE_COLLECTION"
	OptimizerTypeGeneric           OptimizerType = "ALL"
)

Enum values for OptimizerType

func (OptimizerType) Values added in v1.10.0

func (OptimizerType) Values() []OptimizerType

Values returns all known values for OptimizerType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PartitionObjects added in v1.10.0

type PartitionObjects struct {

	// A list of table objects
	Objects []TableObject

	// A list of partition values.
	PartitionValues []string
	// contains filtered or unexported fields
}

A structure containing a list of partition values and table objects.

type PartitionValueList added in v1.12.0

type PartitionValueList struct {

	// The list of partition values.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Contains a list of values defining partitions.

type Permission

type Permission string
const (
	PermissionAll                      Permission = "ALL"
	PermissionSelect                   Permission = "SELECT"
	PermissionAlter                    Permission = "ALTER"
	PermissionDrop                     Permission = "DROP"
	PermissionDelete                   Permission = "DELETE"
	PermissionInsert                   Permission = "INSERT"
	PermissionDescribe                 Permission = "DESCRIBE"
	PermissionCreateDatabase           Permission = "CREATE_DATABASE"
	PermissionCreateTable              Permission = "CREATE_TABLE"
	PermissionDataLocationAccess       Permission = "DATA_LOCATION_ACCESS"
	PermissionCreateLfTag              Permission = "CREATE_LF_TAG"
	PermissionAssociate                Permission = "ASSOCIATE"
	PermissionGrantWithLfTagExpression Permission = "GRANT_WITH_LF_TAG_EXPRESSION"
)

Enum values for Permission

func (Permission) Values added in v0.29.0

func (Permission) Values() []Permission

Values returns all known values for Permission. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PermissionType added in v1.12.0

type PermissionType string
const (
	PermissionTypeColumnPermission     PermissionType = "COLUMN_PERMISSION"
	PermissionTypeCellFilterPermission PermissionType = "CELL_FILTER_PERMISSION"
	PermissionTypeNestedPermission     PermissionType = "NESTED_PERMISSION"
	PermissionTypeNestedCellPermission PermissionType = "NESTED_CELL_PERMISSION"
)

Enum values for PermissionType

func (PermissionType) Values added in v1.12.0

func (PermissionType) Values() []PermissionType

Values returns all known values for PermissionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PermissionTypeMismatchException added in v1.12.0

type PermissionTypeMismatchException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The engine does not support filtering data based on the enforced permissions. For example, if you call the GetTemporaryGlueTableCredentials operation with SupportedPermissionType equal to ColumnPermission , but cell-level permissions exist on the table, this exception is thrown.

func (*PermissionTypeMismatchException) Error added in v1.12.0

func (*PermissionTypeMismatchException) ErrorCode added in v1.12.0

func (e *PermissionTypeMismatchException) ErrorCode() string

func (*PermissionTypeMismatchException) ErrorFault added in v1.12.0

func (*PermissionTypeMismatchException) ErrorMessage added in v1.12.0

func (e *PermissionTypeMismatchException) ErrorMessage() string

type PlanningStatistics added in v1.10.0

type PlanningStatistics struct {

	// An estimate of the data that was scanned in bytes.
	EstimatedDataToScanBytes int64

	// The time that it took to process the request.
	PlanningTimeMillis int64

	// The time the request was in queue to be processed.
	QueueTimeMillis int64

	// The number of work units generated.
	WorkUnitsGeneratedCount int64
	// contains filtered or unexported fields
}

Statistics related to the processing of a query statement.

type PrincipalPermissions

type PrincipalPermissions struct {

	// The permissions that are granted to the principal.
	Permissions []Permission

	// The principal who is granted permissions.
	Principal *DataLakePrincipal
	// contains filtered or unexported fields
}

Permissions granted to a principal.

type PrincipalResourcePermissions

type PrincipalResourcePermissions struct {

	// This attribute can be used to return any additional details of
	// PrincipalResourcePermissions . Currently returns only as a RAM resource share
	// ARN.
	AdditionalDetails *DetailsMap

	// The date and time when the resource was last updated.
	LastUpdated *time.Time

	// The user who updated the record.
	LastUpdatedBy *string

	// The permissions to be granted or revoked on the resource.
	Permissions []Permission

	// Indicates whether to grant the ability to grant permissions (as a subset of
	// permissions granted).
	PermissionsWithGrantOption []Permission

	// The Data Lake principal to be granted or revoked permissions.
	Principal *DataLakePrincipal

	// The resource where permissions are to be granted or revoked.
	Resource *Resource
	// contains filtered or unexported fields
}

The permissions granted or revoked on a resource.

type QueryPlanningContext added in v1.10.0

type QueryPlanningContext struct {

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

	// The ID of the Data Catalog where the partition in question resides. If none is
	// provided, the Amazon Web Services account ID is used by default.
	CatalogId *string

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

	// A map consisting of key-value pairs.
	QueryParameters map[string]string

	// The transaction ID at which to read the table contents. If this transaction is
	// not committed, the read will be treated as part of that transaction and will see
	// its writes. If this transaction has aborted, an error will be returned. If not
	// set, defaults to the most recent committed transaction. Cannot be specified
	// along with QueryAsOfTime .
	TransactionId *string
	// contains filtered or unexported fields
}

A structure containing information about the query plan.

type QuerySessionContext added in v1.29.0

type QuerySessionContext struct {

	// An opaque string-string map passed by the query engine.
	AdditionalContext map[string]string

	// An identifier string for the consumer cluster.
	ClusterId *string

	// A cryptographically generated query identifier generated by Glue or Lake
	// Formation.
	QueryAuthorizationId *string

	// A unique identifier generated by the query engine for the query.
	QueryId *string

	// A timestamp provided by the query engine for when the query started.
	QueryStartTime *time.Time
	// contains filtered or unexported fields
}

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.

type QueryStateString added in v1.10.0

type QueryStateString string
const (
	QueryStateStringPending            QueryStateString = "PENDING"
	QueryStateStringWorkunitsAvailable QueryStateString = "WORKUNITS_AVAILABLE"
	QueryStateStringError              QueryStateString = "ERROR"
	QueryStateStringFinished           QueryStateString = "FINISHED"
	QueryStateStringExpired            QueryStateString = "EXPIRED"
)

Enum values for QueryStateString

func (QueryStateString) Values added in v1.10.0

Values returns all known values for QueryStateString. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Resource

type Resource 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.
	Catalog *CatalogResource

	// A data cell filter.
	DataCellsFilter *DataCellsFilterResource

	// The location of an Amazon S3 path where permissions are granted or revoked.
	DataLocation *DataLocationResource

	// The database for the resource. Unique to the Data Catalog. A database is a set
	// of associated table definitions organized into a logical group. You can Grant
	// and Revoke database permissions to a principal.
	Database *DatabaseResource

	// The LF-tag key and values attached to a resource.
	LFTag *LFTagKeyResource

	// A list of LF-tag conditions that define a resource's LF-tag policy.
	LFTagPolicy *LFTagPolicyResource

	// The table for the resource. A table is a metadata definition that represents
	// your data. You can Grant and Revoke table privileges to a principal.
	Table *TableResource

	// The table with columns for the resource. A principal with permissions to this
	// resource can select metadata from the columns of a table in the Data Catalog and
	// the underlying data in Amazon S3.
	TableWithColumns *TableWithColumnsResource
	// contains filtered or unexported fields
}

A structure for the resource.

type ResourceInfo

type ResourceInfo struct {

	//  Indicates 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 date and time the resource was last modified.
	LastModified *time.Time

	// The Amazon Resource Name (ARN) of the resource.
	ResourceArn *string

	// The IAM role that registered a resource.
	RoleArn *string

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

A structure containing information about an Lake Formation resource.

type ResourceNotReadyException added in v1.10.0

type ResourceNotReadyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Contains details about an error related to a resource which is not ready for a transaction.

func (*ResourceNotReadyException) Error added in v1.10.0

func (e *ResourceNotReadyException) Error() string

func (*ResourceNotReadyException) ErrorCode added in v1.10.0

func (e *ResourceNotReadyException) ErrorCode() string

func (*ResourceNotReadyException) ErrorFault added in v1.10.0

func (*ResourceNotReadyException) ErrorMessage added in v1.10.0

func (e *ResourceNotReadyException) ErrorMessage() string

type ResourceNumberLimitExceededException added in v1.3.0

type ResourceNumberLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A resource numerical limit was exceeded.

func (*ResourceNumberLimitExceededException) Error added in v1.3.0

func (*ResourceNumberLimitExceededException) ErrorCode added in v1.3.0

func (*ResourceNumberLimitExceededException) ErrorFault added in v1.3.0

func (*ResourceNumberLimitExceededException) ErrorMessage added in v1.3.0

func (e *ResourceNumberLimitExceededException) ErrorMessage() string

type ResourceShareType added in v1.3.0

type ResourceShareType string
const (
	ResourceShareTypeForeign ResourceShareType = "FOREIGN"
	ResourceShareTypeAll     ResourceShareType = "ALL"
)

Enum values for ResourceShareType

func (ResourceShareType) Values added in v1.3.0

Values returns all known values for ResourceShareType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceType added in v1.3.0

type ResourceType string
const (
	ResourceTypeDatabase ResourceType = "DATABASE"
	ResourceTypeTable    ResourceType = "TABLE"
)

Enum values for ResourceType

func (ResourceType) Values added in v1.3.0

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RowFilter added in v1.10.0

type RowFilter struct {

	// A wildcard for all rows.
	AllRowsWildcard *AllRowsWildcard

	// A filter expression.
	FilterExpression *string
	// contains filtered or unexported fields
}

A PartiQL predicate.

type StatisticsNotReadyYetException added in v1.10.0

type StatisticsNotReadyYetException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Contains details about an error related to statistics not being ready.

func (*StatisticsNotReadyYetException) Error added in v1.10.0

func (*StatisticsNotReadyYetException) ErrorCode added in v1.10.0

func (e *StatisticsNotReadyYetException) ErrorCode() string

func (*StatisticsNotReadyYetException) ErrorFault added in v1.10.0

func (*StatisticsNotReadyYetException) ErrorMessage added in v1.10.0

func (e *StatisticsNotReadyYetException) ErrorMessage() string

type StorageOptimizer added in v1.10.0

type StorageOptimizer struct {

	// A map of the storage optimizer configuration. Currently contains only one
	// key-value pair: is_enabled indicates true or false for acceleration.
	Config map[string]string

	// A message that contains information about any error (if present).
	//
	// When an acceleration result has an enabled status, the error message is empty.
	//
	// When an acceleration result has a disabled status, the message describes an
	// error or simply indicates "disabled by the user".
	ErrorMessage *string

	// When an acceleration result has an enabled status, contains the details of the
	// last job run.
	LastRunDetails *string

	// The specific type of storage optimizer. The supported value is compaction .
	StorageOptimizerType OptimizerType

	// A message that contains information about any warnings (if present).
	Warnings *string
	// contains filtered or unexported fields
}

A structure describing the configuration and details of a storage optimizer.

type TableObject added in v1.10.0

type TableObject struct {

	// The Amazon S3 ETag of the object. Returned by GetTableObjects for validation
	// and used to identify changes to the underlying data.
	ETag *string

	// The size of the Amazon S3 object in bytes.
	Size int64

	// The Amazon S3 location of the object.
	Uri *string
	// contains filtered or unexported fields
}

Specifies the details of a governed table.

type TableResource

type TableResource struct {

	// The name of the database for the table. Unique to a Data Catalog. A database is
	// a set of associated table definitions organized into a logical group. You can
	// Grant and Revoke database privileges to a principal.
	//
	// This member is required.
	DatabaseName *string

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

	// The name of the table.
	Name *string

	// A wildcard object representing every table under a database.
	//
	// At least one of TableResource$Name or TableResource$TableWildcard is required.
	TableWildcard *TableWildcard
	// contains filtered or unexported fields
}

A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

type TableWildcard

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

A wildcard object representing every table under a database.

type TableWithColumnsResource

type TableWithColumnsResource struct {

	// The name of the database for the table with columns resource. Unique to the
	// Data Catalog. A database is a set of associated table definitions organized into
	// a logical group. You can Grant and Revoke database privileges to a principal.
	//
	// This member is required.
	DatabaseName *string

	// The name of the table resource. A table is a metadata definition that
	// represents your data. You can Grant and Revoke table privileges to a principal.
	//
	// This member is required.
	Name *string

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

	// The list of column names for the table. At least one of ColumnNames or
	// ColumnWildcard is required.
	ColumnNames []string

	// A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or
	// ColumnWildcard is required.
	ColumnWildcard *ColumnWildcard
	// contains filtered or unexported fields
}

A structure for a table with columns object. This object is only used when granting a SELECT permission.

This object must take a value for at least one of ColumnsNames , ColumnsIndexes , or ColumnsWildcard .

type TaggedDatabase added in v1.3.0

type TaggedDatabase struct {

	// A database that has LF-tags attached to it.
	Database *DatabaseResource

	// A list of LF-tags attached to the database.
	LFTags []LFTagPair
	// contains filtered or unexported fields
}

A structure describing a database resource with LF-tags.

type TaggedTable added in v1.3.0

type TaggedTable struct {

	// A list of LF-tags attached to the database where the table resides.
	LFTagOnDatabase []LFTagPair

	// A list of LF-tags attached to columns in the table.
	LFTagsOnColumns []ColumnLFTag

	// A list of LF-tags attached to the table.
	LFTagsOnTable []LFTagPair

	// A table that has LF-tags attached to it.
	Table *TableResource
	// contains filtered or unexported fields
}

A structure describing a table resource with LF-tags.

type ThrottledException added in v1.10.0

type ThrottledException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Contains details about an error where the query request was throttled.

func (*ThrottledException) Error added in v1.10.0

func (e *ThrottledException) Error() string

func (*ThrottledException) ErrorCode added in v1.10.0

func (e *ThrottledException) ErrorCode() string

func (*ThrottledException) ErrorFault added in v1.10.0

func (e *ThrottledException) ErrorFault() smithy.ErrorFault

func (*ThrottledException) ErrorMessage added in v1.10.0

func (e *ThrottledException) ErrorMessage() string

type TransactionCanceledException added in v1.10.0

type TransactionCanceledException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Contains details about an error related to a transaction that was cancelled.

func (*TransactionCanceledException) Error added in v1.10.0

func (*TransactionCanceledException) ErrorCode added in v1.10.0

func (e *TransactionCanceledException) ErrorCode() string

func (*TransactionCanceledException) ErrorFault added in v1.10.0

func (*TransactionCanceledException) ErrorMessage added in v1.10.0

func (e *TransactionCanceledException) ErrorMessage() string

type TransactionCommitInProgressException added in v1.10.0

type TransactionCommitInProgressException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Contains details about an error related to a transaction commit that was in progress.

func (*TransactionCommitInProgressException) Error added in v1.10.0

func (*TransactionCommitInProgressException) ErrorCode added in v1.10.0

func (*TransactionCommitInProgressException) ErrorFault added in v1.10.0

func (*TransactionCommitInProgressException) ErrorMessage added in v1.10.0

func (e *TransactionCommitInProgressException) ErrorMessage() string

type TransactionCommittedException added in v1.10.0

type TransactionCommittedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects .

func (*TransactionCommittedException) Error added in v1.10.0

func (*TransactionCommittedException) ErrorCode added in v1.10.0

func (e *TransactionCommittedException) ErrorCode() string

func (*TransactionCommittedException) ErrorFault added in v1.10.0

func (*TransactionCommittedException) ErrorMessage added in v1.10.0

func (e *TransactionCommittedException) ErrorMessage() string

type TransactionDescription added in v1.10.0

type TransactionDescription struct {

	// The time when the transaction committed or aborted, if it is not currently
	// active.
	TransactionEndTime *time.Time

	// The ID of the transaction.
	TransactionId *string

	// The time when the transaction started.
	TransactionStartTime *time.Time

	// A status of ACTIVE, COMMITTED, or ABORTED.
	TransactionStatus TransactionStatus
	// contains filtered or unexported fields
}

A structure that contains information about a transaction.

type TransactionStatus added in v1.10.0

type TransactionStatus string
const (
	TransactionStatusActive           TransactionStatus = "ACTIVE"
	TransactionStatusCommitted        TransactionStatus = "COMMITTED"
	TransactionStatusAborted          TransactionStatus = "ABORTED"
	TransactionStatusCommitInProgress TransactionStatus = "COMMIT_IN_PROGRESS"
)

Enum values for TransactionStatus

func (TransactionStatus) Values added in v1.10.0

Values returns all known values for TransactionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TransactionStatusFilter added in v1.10.0

type TransactionStatusFilter string
const (
	TransactionStatusFilterAll       TransactionStatusFilter = "ALL"
	TransactionStatusFilterCompleted TransactionStatusFilter = "COMPLETED"
	TransactionStatusFilterActive    TransactionStatusFilter = "ACTIVE"
	TransactionStatusFilterCommitted TransactionStatusFilter = "COMMITTED"
	TransactionStatusFilterAborted   TransactionStatusFilter = "ABORTED"
)

Enum values for TransactionStatusFilter

func (TransactionStatusFilter) Values added in v1.10.0

Values returns all known values for TransactionStatusFilter. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TransactionType added in v1.10.0

type TransactionType string
const (
	TransactionTypeReadAndWrite TransactionType = "READ_AND_WRITE"
	TransactionTypeReadOnly     TransactionType = "READ_ONLY"
)

Enum values for TransactionType

func (TransactionType) Values added in v1.10.0

func (TransactionType) Values() []TransactionType

Values returns all known values for TransactionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VirtualObject added in v1.10.0

type VirtualObject struct {

	// The path to the Amazon S3 object. Must start with s3://
	//
	// This member is required.
	Uri *string

	// The ETag of the Amazon S3 object.
	ETag *string
	// contains filtered or unexported fields
}

An object that defines an Amazon S3 object to be deleted if a transaction cancels, provided that VirtualPut was called before writing the object.

type WorkUnitRange added in v1.10.0

type WorkUnitRange struct {

	// Defines the maximum work unit ID in the range. The maximum value is inclusive.
	//
	// This member is required.
	WorkUnitIdMax int64

	// Defines the minimum work unit ID in the range.
	//
	// This member is required.
	WorkUnitIdMin int64

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

Defines the valid range of work unit IDs for querying the execution service.

type WorkUnitsNotReadyYetException added in v1.10.0

type WorkUnitsNotReadyYetException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Contains details about an error related to work units not being ready.

func (*WorkUnitsNotReadyYetException) Error added in v1.10.0

func (*WorkUnitsNotReadyYetException) ErrorCode added in v1.10.0

func (e *WorkUnitsNotReadyYetException) ErrorCode() string

func (*WorkUnitsNotReadyYetException) ErrorFault added in v1.10.0

func (*WorkUnitsNotReadyYetException) ErrorMessage added in v1.10.0

func (e *WorkUnitsNotReadyYetException) ErrorMessage() string

type WriteOperation added in v1.10.0

type WriteOperation struct {

	// A new object to add to the governed table.
	AddObject *AddObjectInput

	// An object to delete from the governed table.
	DeleteObject *DeleteObjectInput
	// contains filtered or unexported fields
}

Defines an object to add to or delete from a governed table.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL