Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlreadyExistsException

type AlreadyExistsException struct {
	Message *string
}

    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
    }

      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
      }

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

        type CatalogResource

        type CatalogResource struct {
        }

          A structure for the catalog object.

          type ColumnWildcard

          type ColumnWildcard struct {
          
          	// Excludes column names. Any column with this name will be excluded.
          	ExcludedColumnNames []string
          }

            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

                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
                }

                  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
                  }

                    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"
                    )

                      Enum values for DataLakeResourceType

                      func (DataLakeResourceType) Values

                        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
                        }

                          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
                          }

                            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
                            }

                              A structure for the database object.

                              type DetailsMap

                              type DetailsMap struct {
                              
                              	// A share resource ARN for a catalog resource shared through AWS Resource Access
                              	// Manager (AWS RAM).
                              	ResourceShare []string
                              }

                                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 share resource ARN.

                                type EntityNotFoundException

                                type EntityNotFoundException struct {
                                	Message *string
                                }

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

                                      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
                                        }

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

                                          type InternalServiceException

                                          type InternalServiceException struct {
                                          	Message *string
                                          }

                                            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
                                            }

                                              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 OperationTimeoutException

                                              type OperationTimeoutException struct {
                                              	Message *string
                                              }

                                                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"
                                                )

                                                  Enum values for Permission

                                                  func (Permission) Values

                                                  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
                                                    }

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

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

                                                          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
                                                          }

                                                            A structure containing information about an AWS Lake Formation resource.

                                                            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
                                                            }

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

                                                                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
                                                                }

                                                                  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.