types

package
Version: v1.6.0 Latest Latest
Warning

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

Go to latest
Published: Sep 24, 2021 License: Apache-2.0 Imports: 4 Imported by: 0

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

type AlreadyExistsException struct {
	Message *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 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 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 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
	// 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 DataLakePrincipal

type DataLakePrincipal struct {

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

The AWS 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 {

	// A structure representing a list of up to three principal permissions entries for
	// default create database permissions.
	CreateDatabaseDefaultPermissions []PrincipalPermissions

	// A structure representing a list of up to three principal permissions entries for
	// default create table permissions.
	CreateTableDefaultPermissions []PrincipalPermissions

	// A list of AWS Lake Formation principals. Supported principals are IAM users or
	// IAM roles.
	DataLakeAdmins []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 AWS 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 AWS 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 AWS
	// 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 DetailsMap added in v0.29.0

type DetailsMap struct {

	// A resource share ARN for a catalog resource shared through AWS Resource Access
	// Manager (AWS 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 AWS Resource Access Manager (AWS RAM), then there will exist a corresponding RAM resource share ARN.

type EntityNotFoundException

type EntityNotFoundException struct {
	Message *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 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
	// 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
	// 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
	// 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 tag.
	//
	// This member is required.
	TagKey *string

	// A list of possible values an attribute can take.
	//
	// 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 not tagged 'PII' of tables tagged 'Prod'.

type LFTagError added in v1.3.0

type LFTagError struct {

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

	// The key-name of the 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 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 AWS Lake
	// Formation environment.
	CatalogId *string
	// contains filtered or unexported fields
}

A structure containing a tag key and values for a resource.

type LFTagPair added in v1.3.0

type LFTagPair struct {

	// The key-name for the 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 AWS Lake
	// Formation environment.
	CatalogId *string
	// contains filtered or unexported fields
}

A structure containing a tag key-value pair.

type LFTagPolicyResource added in v1.3.0

type LFTagPolicyResource struct {

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

	// The resource type for which the 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 AWS Lake
	// Formation environment.
	CatalogId *string
	// contains filtered or unexported fields
}

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

type OperationTimeoutException

type OperationTimeoutException struct {
	Message *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 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"
	PermissionCreateTag          Permission = "CREATE_TAG"
	PermissionAlterTag           Permission = "ALTER_TAG"
	PermissionDeleteTag          Permission = "DELETE_TAG"
	PermissionDescribeTag        Permission = "DESCRIBE_TAG"
	PermissionAssociateTag       Permission = "ASSOCIATE_TAG"
)

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 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 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 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 AWS Lake
	// Formation environment.
	Catalog *CatalogResource

	// 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 tag key and values attached to a resource.
	LFTag *LFTagKeyResource

	// A list of tag conditions that define a resource's 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 {

	// 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
	// contains filtered or unexported fields
}

A structure containing information about an AWS Lake Formation resource.

type ResourceNumberLimitExceededException added in v1.3.0

type ResourceNumberLimitExceededException struct {
	Message *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 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 tags attached to it.
	Database *DatabaseResource

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

A structure describing a database resource with tags.

type TaggedTable added in v1.3.0

type TaggedTable struct {

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

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

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

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

A structure describing a table resource with tags.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL