lakeformation

package
v1.38.21 Latest Latest
Warning

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

Go to latest
Published: Apr 15, 2021 License: Apache-2.0 Imports: 10 Imported by: 34

Documentation

Overview

Package lakeformation provides the client and types for making API requests to AWS Lake Formation.

Defines the public endpoint for the AWS Lake Formation service.

See https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31 for more information on this service.

See lakeformation package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/lakeformation/

Using the Client

To contact AWS Lake Formation with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Lake Formation client LakeFormation for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/lakeformation/#New

Index

Constants

View Source
const (
	// ComparisonOperatorEq is a ComparisonOperator enum value
	ComparisonOperatorEq = "EQ"

	// ComparisonOperatorNe is a ComparisonOperator enum value
	ComparisonOperatorNe = "NE"

	// ComparisonOperatorLe is a ComparisonOperator enum value
	ComparisonOperatorLe = "LE"

	// ComparisonOperatorLt is a ComparisonOperator enum value
	ComparisonOperatorLt = "LT"

	// ComparisonOperatorGe is a ComparisonOperator enum value
	ComparisonOperatorGe = "GE"

	// ComparisonOperatorGt is a ComparisonOperator enum value
	ComparisonOperatorGt = "GT"

	// ComparisonOperatorContains is a ComparisonOperator enum value
	ComparisonOperatorContains = "CONTAINS"

	// ComparisonOperatorNotContains is a ComparisonOperator enum value
	ComparisonOperatorNotContains = "NOT_CONTAINS"

	// ComparisonOperatorBeginsWith is a ComparisonOperator enum value
	ComparisonOperatorBeginsWith = "BEGINS_WITH"

	// ComparisonOperatorIn is a ComparisonOperator enum value
	ComparisonOperatorIn = "IN"

	// ComparisonOperatorBetween is a ComparisonOperator enum value
	ComparisonOperatorBetween = "BETWEEN"
)
View Source
const (
	// DataLakeResourceTypeCatalog is a DataLakeResourceType enum value
	DataLakeResourceTypeCatalog = "CATALOG"

	// DataLakeResourceTypeDatabase is a DataLakeResourceType enum value
	DataLakeResourceTypeDatabase = "DATABASE"

	// DataLakeResourceTypeTable is a DataLakeResourceType enum value
	DataLakeResourceTypeTable = "TABLE"

	// DataLakeResourceTypeDataLocation is a DataLakeResourceType enum value
	DataLakeResourceTypeDataLocation = "DATA_LOCATION"
)
View Source
const (
	// FieldNameStringResourceArn is a FieldNameString enum value
	FieldNameStringResourceArn = "RESOURCE_ARN"

	// FieldNameStringRoleArn is a FieldNameString enum value
	FieldNameStringRoleArn = "ROLE_ARN"

	// FieldNameStringLastModified is a FieldNameString enum value
	FieldNameStringLastModified = "LAST_MODIFIED"
)
View Source
const (
	// PermissionAll is a Permission enum value
	PermissionAll = "ALL"

	// PermissionSelect is a Permission enum value
	PermissionSelect = "SELECT"

	// PermissionAlter is a Permission enum value
	PermissionAlter = "ALTER"

	// PermissionDrop is a Permission enum value
	PermissionDrop = "DROP"

	// PermissionDelete is a Permission enum value
	PermissionDelete = "DELETE"

	// PermissionInsert is a Permission enum value
	PermissionInsert = "INSERT"

	// PermissionDescribe is a Permission enum value
	PermissionDescribe = "DESCRIBE"

	// PermissionCreateDatabase is a Permission enum value
	PermissionCreateDatabase = "CREATE_DATABASE"

	// PermissionCreateTable is a Permission enum value
	PermissionCreateTable = "CREATE_TABLE"

	// PermissionDataLocationAccess is a Permission enum value
	PermissionDataLocationAccess = "DATA_LOCATION_ACCESS"
)
View Source
const (

	// ErrCodeAlreadyExistsException for service response error code
	// "AlreadyExistsException".
	//
	// A resource to be created or added already exists.
	ErrCodeAlreadyExistsException = "AlreadyExistsException"

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// Two processes are trying to modify a resource simultaneously.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeEntityNotFoundException for service response error code
	// "EntityNotFoundException".
	//
	// A specified entity does not exist
	ErrCodeEntityNotFoundException = "EntityNotFoundException"

	// ErrCodeInternalServiceException for service response error code
	// "InternalServiceException".
	//
	// An internal service error occurred.
	ErrCodeInternalServiceException = "InternalServiceException"

	// ErrCodeInvalidInputException for service response error code
	// "InvalidInputException".
	//
	// The input provided was not valid.
	ErrCodeInvalidInputException = "InvalidInputException"

	// ErrCodeOperationTimeoutException for service response error code
	// "OperationTimeoutException".
	//
	// The operation timed out.
	ErrCodeOperationTimeoutException = "OperationTimeoutException"
)
View Source
const (
	ServiceName = "LakeFormation" // Name of service.
	EndpointsID = "lakeformation" // ID to lookup a service endpoint with.
	ServiceID   = "LakeFormation" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ComparisonOperator_Values added in v1.34.3

func ComparisonOperator_Values() []string

ComparisonOperator_Values returns all elements of the ComparisonOperator enum

func DataLakeResourceType_Values added in v1.34.3

func DataLakeResourceType_Values() []string

DataLakeResourceType_Values returns all elements of the DataLakeResourceType enum

func FieldNameString_Values added in v1.34.3

func FieldNameString_Values() []string

FieldNameString_Values returns all elements of the FieldNameString enum

func Permission_Values added in v1.34.3

func Permission_Values() []string

Permission_Values returns all elements of the Permission enum

Types

type AlreadyExistsException added in v1.28.0

type AlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message describing the problem.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

A resource to be created or added already exists.

func (*AlreadyExistsException) Code added in v1.28.0

func (s *AlreadyExistsException) Code() string

Code returns the exception type name.

func (*AlreadyExistsException) Error added in v1.28.0

func (s *AlreadyExistsException) Error() string

func (AlreadyExistsException) GoString added in v1.28.0

func (s AlreadyExistsException) GoString() string

GoString returns the string representation

func (*AlreadyExistsException) Message added in v1.28.0

func (s *AlreadyExistsException) Message() string

Message returns the exception's message.

func (*AlreadyExistsException) OrigErr added in v1.28.0

func (s *AlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AlreadyExistsException) RequestID added in v1.28.0

func (s *AlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AlreadyExistsException) StatusCode added in v1.28.0

func (s *AlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AlreadyExistsException) String added in v1.28.0

func (s AlreadyExistsException) String() string

String returns the string representation

type BatchGrantPermissionsInput

type BatchGrantPermissionsInput 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.
	CatalogId *string `min:"1" type:"string"`

	// A list of up to 20 entries for resource permissions to be granted by batch
	// operation to the principal.
	//
	// Entries is a required field
	Entries []*BatchPermissionsRequestEntry `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGrantPermissionsInput) GoString

func (s BatchGrantPermissionsInput) GoString() string

GoString returns the string representation

func (*BatchGrantPermissionsInput) SetCatalogId

SetCatalogId sets the CatalogId field's value.

func (*BatchGrantPermissionsInput) SetEntries

SetEntries sets the Entries field's value.

func (BatchGrantPermissionsInput) String

String returns the string representation

func (*BatchGrantPermissionsInput) Validate

func (s *BatchGrantPermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGrantPermissionsOutput

type BatchGrantPermissionsOutput struct {

	// A list of failures to grant permissions to the resources.
	Failures []*BatchPermissionsFailureEntry `type:"list"`
	// contains filtered or unexported fields
}

func (BatchGrantPermissionsOutput) GoString

func (s BatchGrantPermissionsOutput) GoString() string

GoString returns the string representation

func (*BatchGrantPermissionsOutput) SetFailures

SetFailures sets the Failures field's value.

func (BatchGrantPermissionsOutput) String

String returns the string representation

type BatchPermissionsFailureEntry

type BatchPermissionsFailureEntry struct {

	// An error message that applies to the failure of the entry.
	Error *ErrorDetail `type:"structure"`

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

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

func (BatchPermissionsFailureEntry) GoString

func (s BatchPermissionsFailureEntry) GoString() string

GoString returns the string representation

func (*BatchPermissionsFailureEntry) SetError

SetError sets the Error field's value.

func (*BatchPermissionsFailureEntry) SetRequestEntry

SetRequestEntry sets the RequestEntry field's value.

func (BatchPermissionsFailureEntry) String

String returns the string representation

type BatchPermissionsRequestEntry

type BatchPermissionsRequestEntry struct {

	// A unique identifier for the batch permissions request entry.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The permissions to be granted.
	Permissions []*string `type:"list"`

	// Indicates if the option to pass permissions is granted.
	PermissionsWithGrantOption []*string `type:"list"`

	// The principal to be granted a permission.
	Principal *DataLakePrincipal `type:"structure"`

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

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

func (BatchPermissionsRequestEntry) GoString

func (s BatchPermissionsRequestEntry) GoString() string

GoString returns the string representation

func (*BatchPermissionsRequestEntry) SetId

SetId sets the Id field's value.

func (*BatchPermissionsRequestEntry) SetPermissions

SetPermissions sets the Permissions field's value.

func (*BatchPermissionsRequestEntry) SetPermissionsWithGrantOption

func (s *BatchPermissionsRequestEntry) SetPermissionsWithGrantOption(v []*string) *BatchPermissionsRequestEntry

SetPermissionsWithGrantOption sets the PermissionsWithGrantOption field's value.

func (*BatchPermissionsRequestEntry) SetPrincipal

SetPrincipal sets the Principal field's value.

func (*BatchPermissionsRequestEntry) SetResource

SetResource sets the Resource field's value.

func (BatchPermissionsRequestEntry) String

String returns the string representation

func (*BatchPermissionsRequestEntry) Validate

func (s *BatchPermissionsRequestEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchRevokePermissionsInput

type BatchRevokePermissionsInput 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.
	CatalogId *string `min:"1" type:"string"`

	// A list of up to 20 entries for resource permissions to be revoked by batch
	// operation to the principal.
	//
	// Entries is a required field
	Entries []*BatchPermissionsRequestEntry `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchRevokePermissionsInput) GoString

func (s BatchRevokePermissionsInput) GoString() string

GoString returns the string representation

func (*BatchRevokePermissionsInput) SetCatalogId

SetCatalogId sets the CatalogId field's value.

func (*BatchRevokePermissionsInput) SetEntries

SetEntries sets the Entries field's value.

func (BatchRevokePermissionsInput) String

String returns the string representation

func (*BatchRevokePermissionsInput) Validate

func (s *BatchRevokePermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchRevokePermissionsOutput

type BatchRevokePermissionsOutput struct {

	// A list of failures to revoke permissions to the resources.
	Failures []*BatchPermissionsFailureEntry `type:"list"`
	// contains filtered or unexported fields
}

func (BatchRevokePermissionsOutput) GoString

func (s BatchRevokePermissionsOutput) GoString() string

GoString returns the string representation

func (*BatchRevokePermissionsOutput) SetFailures

SetFailures sets the Failures field's value.

func (BatchRevokePermissionsOutput) String

String returns the string representation

type CatalogResource

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

A structure for the catalog object.

func (CatalogResource) GoString

func (s CatalogResource) GoString() string

GoString returns the string representation

func (CatalogResource) String

func (s CatalogResource) String() string

String returns the string representation

type ColumnWildcard

type ColumnWildcard struct {

	// Excludes column names. Any column with this name will be excluded.
	ExcludedColumnNames []*string `type:"list"`
	// contains filtered or unexported fields
}

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

func (ColumnWildcard) GoString

func (s ColumnWildcard) GoString() string

GoString returns the string representation

func (*ColumnWildcard) SetExcludedColumnNames

func (s *ColumnWildcard) SetExcludedColumnNames(v []*string) *ColumnWildcard

SetExcludedColumnNames sets the ExcludedColumnNames field's value.

func (ColumnWildcard) String

func (s ColumnWildcard) String() string

String returns the string representation

type ConcurrentModificationException added in v1.28.0

type ConcurrentModificationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message describing the problem.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Two processes are trying to modify a resource simultaneously.

func (*ConcurrentModificationException) Code added in v1.28.0

Code returns the exception type name.

func (*ConcurrentModificationException) Error added in v1.28.0

func (ConcurrentModificationException) GoString added in v1.28.0

GoString returns the string representation

func (*ConcurrentModificationException) Message added in v1.28.0

Message returns the exception's message.

func (*ConcurrentModificationException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentModificationException) RequestID added in v1.28.0

func (s *ConcurrentModificationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentModificationException) StatusCode added in v1.28.0

func (s *ConcurrentModificationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentModificationException) String added in v1.28.0

String returns the string representation

type DataLakePrincipal

type DataLakePrincipal struct {

	// An identifier for the AWS Lake Formation principal.
	DataLakePrincipalIdentifier *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (DataLakePrincipal) GoString

func (s DataLakePrincipal) GoString() string

GoString returns the string representation

func (*DataLakePrincipal) SetDataLakePrincipalIdentifier

func (s *DataLakePrincipal) SetDataLakePrincipalIdentifier(v string) *DataLakePrincipal

SetDataLakePrincipalIdentifier sets the DataLakePrincipalIdentifier field's value.

func (DataLakePrincipal) String

func (s DataLakePrincipal) String() string

String returns the string representation

func (*DataLakePrincipal) Validate

func (s *DataLakePrincipal) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataLakeSettings

type DataLakeSettings struct {

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

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

	// A list of AWS Lake Formation principals. Supported principals are IAM users
	// or IAM roles.
	DataLakeAdmins []*DataLakePrincipal `type:"list"`

	// 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 `type:"list"`
	// 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.

func (DataLakeSettings) GoString

func (s DataLakeSettings) GoString() string

GoString returns the string representation

func (*DataLakeSettings) SetCreateDatabaseDefaultPermissions

func (s *DataLakeSettings) SetCreateDatabaseDefaultPermissions(v []*PrincipalPermissions) *DataLakeSettings

SetCreateDatabaseDefaultPermissions sets the CreateDatabaseDefaultPermissions field's value.

func (*DataLakeSettings) SetCreateTableDefaultPermissions

func (s *DataLakeSettings) SetCreateTableDefaultPermissions(v []*PrincipalPermissions) *DataLakeSettings

SetCreateTableDefaultPermissions sets the CreateTableDefaultPermissions field's value.

func (*DataLakeSettings) SetDataLakeAdmins

func (s *DataLakeSettings) SetDataLakeAdmins(v []*DataLakePrincipal) *DataLakeSettings

SetDataLakeAdmins sets the DataLakeAdmins field's value.

func (*DataLakeSettings) SetTrustedResourceOwners added in v1.33.3

func (s *DataLakeSettings) SetTrustedResourceOwners(v []*string) *DataLakeSettings

SetTrustedResourceOwners sets the TrustedResourceOwners field's value.

func (DataLakeSettings) String

func (s DataLakeSettings) String() string

String returns the string representation

func (*DataLakeSettings) Validate

func (s *DataLakeSettings) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataLocationResource

type DataLocationResource struct {

	// 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 `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) that uniquely identifies the data location
	// resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (DataLocationResource) GoString

func (s DataLocationResource) GoString() string

GoString returns the string representation

func (*DataLocationResource) SetCatalogId added in v1.33.3

func (s *DataLocationResource) SetCatalogId(v string) *DataLocationResource

SetCatalogId sets the CatalogId field's value.

func (*DataLocationResource) SetResourceArn

func (s *DataLocationResource) SetResourceArn(v string) *DataLocationResource

SetResourceArn sets the ResourceArn field's value.

func (DataLocationResource) String

func (s DataLocationResource) String() string

String returns the string representation

func (*DataLocationResource) Validate

func (s *DataLocationResource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatabaseResource

type DatabaseResource struct {

	// The identifier for the Data Catalog. By default, it is the account ID of
	// the caller.
	CatalogId *string `min:"1" type:"string"`

	// The name of the database resource. Unique to the Data Catalog.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A structure for the database object.

func (DatabaseResource) GoString

func (s DatabaseResource) GoString() string

GoString returns the string representation

func (*DatabaseResource) SetCatalogId added in v1.33.3

func (s *DatabaseResource) SetCatalogId(v string) *DatabaseResource

SetCatalogId sets the CatalogId field's value.

func (*DatabaseResource) SetName

func (s *DatabaseResource) SetName(v string) *DatabaseResource

SetName sets the Name field's value.

func (DatabaseResource) String

func (s DatabaseResource) String() string

String returns the string representation

func (*DatabaseResource) Validate

func (s *DatabaseResource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterResourceInput

type DeregisterResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to deregister.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeregisterResourceInput) GoString

func (s DeregisterResourceInput) GoString() string

GoString returns the string representation

func (*DeregisterResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (DeregisterResourceInput) String

func (s DeregisterResourceInput) String() string

String returns the string representation

func (*DeregisterResourceInput) Validate

func (s *DeregisterResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterResourceOutput

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

func (DeregisterResourceOutput) GoString

func (s DeregisterResourceOutput) GoString() string

GoString returns the string representation

func (DeregisterResourceOutput) String

func (s DeregisterResourceOutput) String() string

String returns the string representation

type DescribeResourceInput

type DescribeResourceInput struct {

	// The resource ARN.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeResourceInput) GoString

func (s DescribeResourceInput) GoString() string

GoString returns the string representation

func (*DescribeResourceInput) SetResourceArn

func (s *DescribeResourceInput) SetResourceArn(v string) *DescribeResourceInput

SetResourceArn sets the ResourceArn field's value.

func (DescribeResourceInput) String

func (s DescribeResourceInput) String() string

String returns the string representation

func (*DescribeResourceInput) Validate

func (s *DescribeResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeResourceOutput

type DescribeResourceOutput struct {

	// A structure containing information about an AWS Lake Formation resource.
	ResourceInfo *ResourceInfo `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeResourceOutput) GoString

func (s DescribeResourceOutput) GoString() string

GoString returns the string representation

func (*DescribeResourceOutput) SetResourceInfo

SetResourceInfo sets the ResourceInfo field's value.

func (DescribeResourceOutput) String

func (s DescribeResourceOutput) String() string

String returns the string representation

type DetailsMap added in v1.34.8

type DetailsMap struct {

	// A share resource ARN for a catalog resource shared through AWS Resource Access
	// Manager (AWS RAM).
	ResourceShare []*string `type:"list"`
	// 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 share resource ARN.

func (DetailsMap) GoString added in v1.34.8

func (s DetailsMap) GoString() string

GoString returns the string representation

func (*DetailsMap) SetResourceShare added in v1.34.8

func (s *DetailsMap) SetResourceShare(v []*string) *DetailsMap

SetResourceShare sets the ResourceShare field's value.

func (DetailsMap) String added in v1.34.8

func (s DetailsMap) String() string

String returns the string representation

type EntityNotFoundException added in v1.28.0

type EntityNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message describing the problem.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

A specified entity does not exist

func (*EntityNotFoundException) Code added in v1.28.0

func (s *EntityNotFoundException) Code() string

Code returns the exception type name.

func (*EntityNotFoundException) Error added in v1.28.0

func (s *EntityNotFoundException) Error() string

func (EntityNotFoundException) GoString added in v1.28.0

func (s EntityNotFoundException) GoString() string

GoString returns the string representation

func (*EntityNotFoundException) Message added in v1.28.0

func (s *EntityNotFoundException) Message() string

Message returns the exception's message.

func (*EntityNotFoundException) OrigErr added in v1.28.0

func (s *EntityNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EntityNotFoundException) RequestID added in v1.28.0

func (s *EntityNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EntityNotFoundException) StatusCode added in v1.28.0

func (s *EntityNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (EntityNotFoundException) String added in v1.28.0

func (s EntityNotFoundException) String() string

String returns the string representation

type ErrorDetail

type ErrorDetail struct {

	// The code associated with this error.
	ErrorCode *string `min:"1" type:"string"`

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

Contains details about an error.

func (ErrorDetail) GoString

func (s ErrorDetail) GoString() string

GoString returns the string representation

func (*ErrorDetail) SetErrorCode

func (s *ErrorDetail) SetErrorCode(v string) *ErrorDetail

SetErrorCode sets the ErrorCode field's value.

func (*ErrorDetail) SetErrorMessage

func (s *ErrorDetail) SetErrorMessage(v string) *ErrorDetail

SetErrorMessage sets the ErrorMessage field's value.

func (ErrorDetail) String

func (s ErrorDetail) String() string

String returns the string representation

type FilterCondition

type FilterCondition struct {

	// The comparison operator used in the filter condition.
	ComparisonOperator *string `type:"string" enum:"ComparisonOperator"`

	// The field to filter in the filter condition.
	Field *string `type:"string" enum:"FieldNameString"`

	// A string with values used in evaluating the filter condition.
	StringValueList []*string `type:"list"`
	// contains filtered or unexported fields
}

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

func (FilterCondition) GoString

func (s FilterCondition) GoString() string

GoString returns the string representation

func (*FilterCondition) SetComparisonOperator

func (s *FilterCondition) SetComparisonOperator(v string) *FilterCondition

SetComparisonOperator sets the ComparisonOperator field's value.

func (*FilterCondition) SetField

func (s *FilterCondition) SetField(v string) *FilterCondition

SetField sets the Field field's value.

func (*FilterCondition) SetStringValueList

func (s *FilterCondition) SetStringValueList(v []*string) *FilterCondition

SetStringValueList sets the StringValueList field's value.

func (FilterCondition) String

func (s FilterCondition) String() string

String returns the string representation

type GetDataLakeSettingsInput

type GetDataLakeSettingsInput struct {

	// The identifier for the Data Catalog. By default, the account ID. The Data
	// Catalog is the persistent metadata store. It contains database definitions,
	// table definitions, and other control information to manage your AWS Lake
	// Formation environment.
	CatalogId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetDataLakeSettingsInput) GoString

func (s GetDataLakeSettingsInput) GoString() string

GoString returns the string representation

func (*GetDataLakeSettingsInput) SetCatalogId

SetCatalogId sets the CatalogId field's value.

func (GetDataLakeSettingsInput) String

func (s GetDataLakeSettingsInput) String() string

String returns the string representation

func (*GetDataLakeSettingsInput) Validate

func (s *GetDataLakeSettingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDataLakeSettingsOutput

type GetDataLakeSettingsOutput struct {

	// A structure representing a list of AWS Lake Formation principals designated
	// as data lake administrators.
	DataLakeSettings *DataLakeSettings `type:"structure"`
	// contains filtered or unexported fields
}

func (GetDataLakeSettingsOutput) GoString

func (s GetDataLakeSettingsOutput) GoString() string

GoString returns the string representation

func (*GetDataLakeSettingsOutput) SetDataLakeSettings

SetDataLakeSettings sets the DataLakeSettings field's value.

func (GetDataLakeSettingsOutput) String

func (s GetDataLakeSettingsOutput) String() string

String returns the string representation

type GetEffectivePermissionsForPathInput

type GetEffectivePermissionsForPathInput 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.
	CatalogId *string `min:"1" type:"string"`

	// The maximum number of results to return.
	MaxResults *int64 `min:"1" type:"integer"`

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

	// The Amazon Resource Name (ARN) of the resource for which you want to get
	// permissions.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetEffectivePermissionsForPathInput) GoString

GoString returns the string representation

func (*GetEffectivePermissionsForPathInput) SetCatalogId

SetCatalogId sets the CatalogId field's value.

func (*GetEffectivePermissionsForPathInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*GetEffectivePermissionsForPathInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*GetEffectivePermissionsForPathInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (GetEffectivePermissionsForPathInput) String

String returns the string representation

func (*GetEffectivePermissionsForPathInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type GetEffectivePermissionsForPathOutput

type GetEffectivePermissionsForPathOutput struct {

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

	// A list of the permissions for the specified table or database resource located
	// at the path in Amazon S3.
	Permissions []*PrincipalResourcePermissions `type:"list"`
	// contains filtered or unexported fields
}

func (GetEffectivePermissionsForPathOutput) GoString

GoString returns the string representation

func (*GetEffectivePermissionsForPathOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*GetEffectivePermissionsForPathOutput) SetPermissions

SetPermissions sets the Permissions field's value.

func (GetEffectivePermissionsForPathOutput) String

String returns the string representation

type GrantPermissionsInput

type GrantPermissionsInput 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.
	CatalogId *string `min:"1" type:"string"`

	// The permissions granted to the principal on the resource. AWS Lake Formation
	// defines privileges to grant and revoke access to metadata in the Data Catalog
	// and data organized in underlying data storage such as Amazon S3. AWS Lake
	// Formation requires that each principal be authorized to perform a specific
	// task on AWS Lake Formation resources.
	//
	// Permissions is a required field
	Permissions []*string `type:"list" required:"true"`

	// Indicates a list of the granted permissions that the principal may pass to
	// other users. These permissions may only be a subset of the permissions granted
	// in the Privileges.
	PermissionsWithGrantOption []*string `type:"list"`

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

	// The resource to which permissions are to be granted. Resources in AWS Lake
	// Formation are the Data Catalog, databases, and tables.
	//
	// Resource is a required field
	Resource *Resource `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GrantPermissionsInput) GoString

func (s GrantPermissionsInput) GoString() string

GoString returns the string representation

func (*GrantPermissionsInput) SetCatalogId

SetCatalogId sets the CatalogId field's value.

func (*GrantPermissionsInput) SetPermissions

func (s *GrantPermissionsInput) SetPermissions(v []*string) *GrantPermissionsInput

SetPermissions sets the Permissions field's value.

func (*GrantPermissionsInput) SetPermissionsWithGrantOption

func (s *GrantPermissionsInput) SetPermissionsWithGrantOption(v []*string) *GrantPermissionsInput

SetPermissionsWithGrantOption sets the PermissionsWithGrantOption field's value.

func (*GrantPermissionsInput) SetPrincipal

SetPrincipal sets the Principal field's value.

func (*GrantPermissionsInput) SetResource

SetResource sets the Resource field's value.

func (GrantPermissionsInput) String

func (s GrantPermissionsInput) String() string

String returns the string representation

func (*GrantPermissionsInput) Validate

func (s *GrantPermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GrantPermissionsOutput

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

func (GrantPermissionsOutput) GoString

func (s GrantPermissionsOutput) GoString() string

GoString returns the string representation

func (GrantPermissionsOutput) String

func (s GrantPermissionsOutput) String() string

String returns the string representation

type InternalServiceException added in v1.28.0

type InternalServiceException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message describing the problem.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

An internal service error occurred.

func (*InternalServiceException) Code added in v1.28.0

func (s *InternalServiceException) Code() string

Code returns the exception type name.

func (*InternalServiceException) Error added in v1.28.0

func (s *InternalServiceException) Error() string

func (InternalServiceException) GoString added in v1.28.0

func (s InternalServiceException) GoString() string

GoString returns the string representation

func (*InternalServiceException) Message added in v1.28.0

func (s *InternalServiceException) Message() string

Message returns the exception's message.

func (*InternalServiceException) OrigErr added in v1.28.0

func (s *InternalServiceException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceException) RequestID added in v1.28.0

func (s *InternalServiceException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceException) StatusCode added in v1.28.0

func (s *InternalServiceException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServiceException) String added in v1.28.0

func (s InternalServiceException) String() string

String returns the string representation

type InvalidInputException added in v1.28.0

type InvalidInputException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message describing the problem.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The input provided was not valid.

func (*InvalidInputException) Code added in v1.28.0

func (s *InvalidInputException) Code() string

Code returns the exception type name.

func (*InvalidInputException) Error added in v1.28.0

func (s *InvalidInputException) Error() string

func (InvalidInputException) GoString added in v1.28.0

func (s InvalidInputException) GoString() string

GoString returns the string representation

func (*InvalidInputException) Message added in v1.28.0

func (s *InvalidInputException) Message() string

Message returns the exception's message.

func (*InvalidInputException) OrigErr added in v1.28.0

func (s *InvalidInputException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidInputException) RequestID added in v1.28.0

func (s *InvalidInputException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidInputException) StatusCode added in v1.28.0

func (s *InvalidInputException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidInputException) String added in v1.28.0

func (s InvalidInputException) String() string

String returns the string representation

type LakeFormation

type LakeFormation struct {
	*client.Client
}

LakeFormation provides the API operation methods for making requests to AWS Lake Formation. See this package's package overview docs for details on the service.

LakeFormation methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *LakeFormation

New creates a new instance of the LakeFormation client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a LakeFormation client from just a session.
svc := lakeformation.New(mySession)

// Create a LakeFormation client with additional configuration
svc := lakeformation.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*LakeFormation) BatchGrantPermissions

func (c *LakeFormation) BatchGrantPermissions(input *BatchGrantPermissionsInput) (*BatchGrantPermissionsOutput, error)

BatchGrantPermissions API operation for AWS Lake Formation.

Batch operation to grant permissions to the principal.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation BatchGrantPermissions for usage and error information.

Returned Error Types:

  • InvalidInputException The input provided was not valid.

  • OperationTimeoutException The operation timed out.

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/BatchGrantPermissions

func (*LakeFormation) BatchGrantPermissionsRequest

func (c *LakeFormation) BatchGrantPermissionsRequest(input *BatchGrantPermissionsInput) (req *request.Request, output *BatchGrantPermissionsOutput)

BatchGrantPermissionsRequest generates a "aws/request.Request" representing the client's request for the BatchGrantPermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGrantPermissions for more information on using the BatchGrantPermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchGrantPermissionsRequest method.
req, resp := client.BatchGrantPermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/BatchGrantPermissions

func (*LakeFormation) BatchGrantPermissionsWithContext

func (c *LakeFormation) BatchGrantPermissionsWithContext(ctx aws.Context, input *BatchGrantPermissionsInput, opts ...request.Option) (*BatchGrantPermissionsOutput, error)

BatchGrantPermissionsWithContext is the same as BatchGrantPermissions with the addition of the ability to pass a context and additional request options.

See BatchGrantPermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) BatchRevokePermissions

func (c *LakeFormation) BatchRevokePermissions(input *BatchRevokePermissionsInput) (*BatchRevokePermissionsOutput, error)

BatchRevokePermissions API operation for AWS Lake Formation.

Batch operation to revoke permissions from the principal.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation BatchRevokePermissions for usage and error information.

Returned Error Types:

  • InvalidInputException The input provided was not valid.

  • OperationTimeoutException The operation timed out.

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/BatchRevokePermissions

func (*LakeFormation) BatchRevokePermissionsRequest

func (c *LakeFormation) BatchRevokePermissionsRequest(input *BatchRevokePermissionsInput) (req *request.Request, output *BatchRevokePermissionsOutput)

BatchRevokePermissionsRequest generates a "aws/request.Request" representing the client's request for the BatchRevokePermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchRevokePermissions for more information on using the BatchRevokePermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchRevokePermissionsRequest method.
req, resp := client.BatchRevokePermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/BatchRevokePermissions

func (*LakeFormation) BatchRevokePermissionsWithContext

func (c *LakeFormation) BatchRevokePermissionsWithContext(ctx aws.Context, input *BatchRevokePermissionsInput, opts ...request.Option) (*BatchRevokePermissionsOutput, error)

BatchRevokePermissionsWithContext is the same as BatchRevokePermissions with the addition of the ability to pass a context and additional request options.

See BatchRevokePermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) DeregisterResource

func (c *LakeFormation) DeregisterResource(input *DeregisterResourceInput) (*DeregisterResourceOutput, error)

DeregisterResource API operation for AWS Lake Formation.

Deregisters the resource as managed by the Data Catalog.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation DeregisterResource for usage and error information.

Returned Error Types:

  • InvalidInputException The input provided was not valid.

  • InternalServiceException An internal service error occurred.

  • OperationTimeoutException The operation timed out.

  • EntityNotFoundException A specified entity does not exist

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/DeregisterResource

func (*LakeFormation) DeregisterResourceRequest

func (c *LakeFormation) DeregisterResourceRequest(input *DeregisterResourceInput) (req *request.Request, output *DeregisterResourceOutput)

DeregisterResourceRequest generates a "aws/request.Request" representing the client's request for the DeregisterResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterResource for more information on using the DeregisterResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeregisterResourceRequest method.
req, resp := client.DeregisterResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/DeregisterResource

func (*LakeFormation) DeregisterResourceWithContext

func (c *LakeFormation) DeregisterResourceWithContext(ctx aws.Context, input *DeregisterResourceInput, opts ...request.Option) (*DeregisterResourceOutput, error)

DeregisterResourceWithContext is the same as DeregisterResource with the addition of the ability to pass a context and additional request options.

See DeregisterResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) DescribeResource

func (c *LakeFormation) DescribeResource(input *DescribeResourceInput) (*DescribeResourceOutput, error)

DescribeResource API operation for AWS Lake Formation.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation DescribeResource for usage and error information.

Returned Error Types:

  • InvalidInputException The input provided was not valid.

  • InternalServiceException An internal service error occurred.

  • OperationTimeoutException The operation timed out.

  • EntityNotFoundException A specified entity does not exist

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/DescribeResource

func (*LakeFormation) DescribeResourceRequest

func (c *LakeFormation) DescribeResourceRequest(input *DescribeResourceInput) (req *request.Request, output *DescribeResourceOutput)

DescribeResourceRequest generates a "aws/request.Request" representing the client's request for the DescribeResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeResource for more information on using the DescribeResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeResourceRequest method.
req, resp := client.DescribeResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/DescribeResource

func (*LakeFormation) DescribeResourceWithContext

func (c *LakeFormation) DescribeResourceWithContext(ctx aws.Context, input *DescribeResourceInput, opts ...request.Option) (*DescribeResourceOutput, error)

DescribeResourceWithContext is the same as DescribeResource with the addition of the ability to pass a context and additional request options.

See DescribeResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) GetDataLakeSettings

func (c *LakeFormation) GetDataLakeSettings(input *GetDataLakeSettingsInput) (*GetDataLakeSettingsOutput, error)

GetDataLakeSettings API operation for AWS Lake Formation.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation GetDataLakeSettings for usage and error information.

Returned Error Types:

  • InternalServiceException An internal service error occurred.

  • InvalidInputException The input provided was not valid.

  • EntityNotFoundException A specified entity does not exist

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/GetDataLakeSettings

func (*LakeFormation) GetDataLakeSettingsRequest

func (c *LakeFormation) GetDataLakeSettingsRequest(input *GetDataLakeSettingsInput) (req *request.Request, output *GetDataLakeSettingsOutput)

GetDataLakeSettingsRequest generates a "aws/request.Request" representing the client's request for the GetDataLakeSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDataLakeSettings for more information on using the GetDataLakeSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDataLakeSettingsRequest method.
req, resp := client.GetDataLakeSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/GetDataLakeSettings

func (*LakeFormation) GetDataLakeSettingsWithContext

func (c *LakeFormation) GetDataLakeSettingsWithContext(ctx aws.Context, input *GetDataLakeSettingsInput, opts ...request.Option) (*GetDataLakeSettingsOutput, error)

GetDataLakeSettingsWithContext is the same as GetDataLakeSettings with the addition of the ability to pass a context and additional request options.

See GetDataLakeSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) GetEffectivePermissionsForPath

GetEffectivePermissionsForPath API operation for AWS Lake Formation.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation GetEffectivePermissionsForPath for usage and error information.

Returned Error Types:

  • InvalidInputException The input provided was not valid.

  • EntityNotFoundException A specified entity does not exist

  • OperationTimeoutException The operation timed out.

  • InternalServiceException An internal service error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/GetEffectivePermissionsForPath

func (*LakeFormation) GetEffectivePermissionsForPathPages

func (c *LakeFormation) GetEffectivePermissionsForPathPages(input *GetEffectivePermissionsForPathInput, fn func(*GetEffectivePermissionsForPathOutput, bool) bool) error

GetEffectivePermissionsForPathPages iterates over the pages of a GetEffectivePermissionsForPath operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetEffectivePermissionsForPath method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetEffectivePermissionsForPath operation.
pageNum := 0
err := client.GetEffectivePermissionsForPathPages(params,
    func(page *lakeformation.GetEffectivePermissionsForPathOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LakeFormation) GetEffectivePermissionsForPathPagesWithContext

func (c *LakeFormation) GetEffectivePermissionsForPathPagesWithContext(ctx aws.Context, input *GetEffectivePermissionsForPathInput, fn func(*GetEffectivePermissionsForPathOutput, bool) bool, opts ...request.Option) error

GetEffectivePermissionsForPathPagesWithContext same as GetEffectivePermissionsForPathPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) GetEffectivePermissionsForPathRequest

func (c *LakeFormation) GetEffectivePermissionsForPathRequest(input *GetEffectivePermissionsForPathInput) (req *request.Request, output *GetEffectivePermissionsForPathOutput)

GetEffectivePermissionsForPathRequest generates a "aws/request.Request" representing the client's request for the GetEffectivePermissionsForPath operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEffectivePermissionsForPath for more information on using the GetEffectivePermissionsForPath API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetEffectivePermissionsForPathRequest method.
req, resp := client.GetEffectivePermissionsForPathRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/GetEffectivePermissionsForPath

func (*LakeFormation) GetEffectivePermissionsForPathWithContext

func (c *LakeFormation) GetEffectivePermissionsForPathWithContext(ctx aws.Context, input *GetEffectivePermissionsForPathInput, opts ...request.Option) (*GetEffectivePermissionsForPathOutput, error)

GetEffectivePermissionsForPathWithContext is the same as GetEffectivePermissionsForPath with the addition of the ability to pass a context and additional request options.

See GetEffectivePermissionsForPath for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) GrantPermissions

func (c *LakeFormation) GrantPermissions(input *GrantPermissionsInput) (*GrantPermissionsOutput, error)

GrantPermissions API operation for AWS Lake Formation.

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

For information about permissions, see Security and Access Control to Metadata and Data (https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation GrantPermissions for usage and error information.

Returned Error Types:

  • ConcurrentModificationException Two processes are trying to modify a resource simultaneously.

  • EntityNotFoundException A specified entity does not exist

  • InvalidInputException The input provided was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/GrantPermissions

func (*LakeFormation) GrantPermissionsRequest

func (c *LakeFormation) GrantPermissionsRequest(input *GrantPermissionsInput) (req *request.Request, output *GrantPermissionsOutput)

GrantPermissionsRequest generates a "aws/request.Request" representing the client's request for the GrantPermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GrantPermissions for more information on using the GrantPermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GrantPermissionsRequest method.
req, resp := client.GrantPermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/GrantPermissions

func (*LakeFormation) GrantPermissionsWithContext

func (c *LakeFormation) GrantPermissionsWithContext(ctx aws.Context, input *GrantPermissionsInput, opts ...request.Option) (*GrantPermissionsOutput, error)

GrantPermissionsWithContext is the same as GrantPermissions with the addition of the ability to pass a context and additional request options.

See GrantPermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) ListPermissions

func (c *LakeFormation) ListPermissions(input *ListPermissionsInput) (*ListPermissionsOutput, error)

ListPermissions API operation for AWS Lake Formation.

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

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

For information about permissions, see Security and Access Control to Metadata and Data (https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation ListPermissions for usage and error information.

Returned Error Types:

  • InvalidInputException The input provided was not valid.

  • OperationTimeoutException The operation timed out.

  • InternalServiceException An internal service error occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/ListPermissions

func (*LakeFormation) ListPermissionsPages

func (c *LakeFormation) ListPermissionsPages(input *ListPermissionsInput, fn func(*ListPermissionsOutput, bool) bool) error

ListPermissionsPages iterates over the pages of a ListPermissions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPermissions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListPermissions operation.
pageNum := 0
err := client.ListPermissionsPages(params,
    func(page *lakeformation.ListPermissionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LakeFormation) ListPermissionsPagesWithContext

func (c *LakeFormation) ListPermissionsPagesWithContext(ctx aws.Context, input *ListPermissionsInput, fn func(*ListPermissionsOutput, bool) bool, opts ...request.Option) error

ListPermissionsPagesWithContext same as ListPermissionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) ListPermissionsRequest

func (c *LakeFormation) ListPermissionsRequest(input *ListPermissionsInput) (req *request.Request, output *ListPermissionsOutput)

ListPermissionsRequest generates a "aws/request.Request" representing the client's request for the ListPermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPermissions for more information on using the ListPermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListPermissionsRequest method.
req, resp := client.ListPermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/ListPermissions

func (*LakeFormation) ListPermissionsWithContext

func (c *LakeFormation) ListPermissionsWithContext(ctx aws.Context, input *ListPermissionsInput, opts ...request.Option) (*ListPermissionsOutput, error)

ListPermissionsWithContext is the same as ListPermissions with the addition of the ability to pass a context and additional request options.

See ListPermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) ListResources

func (c *LakeFormation) ListResources(input *ListResourcesInput) (*ListResourcesOutput, error)

ListResources API operation for AWS Lake Formation.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation ListResources for usage and error information.

Returned Error Types:

  • InvalidInputException The input provided was not valid.

  • InternalServiceException An internal service error occurred.

  • OperationTimeoutException The operation timed out.

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/ListResources

func (*LakeFormation) ListResourcesPages

func (c *LakeFormation) ListResourcesPages(input *ListResourcesInput, fn func(*ListResourcesOutput, bool) bool) error

ListResourcesPages iterates over the pages of a ListResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListResources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListResources operation.
pageNum := 0
err := client.ListResourcesPages(params,
    func(page *lakeformation.ListResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LakeFormation) ListResourcesPagesWithContext

func (c *LakeFormation) ListResourcesPagesWithContext(ctx aws.Context, input *ListResourcesInput, fn func(*ListResourcesOutput, bool) bool, opts ...request.Option) error

ListResourcesPagesWithContext same as ListResourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) ListResourcesRequest

func (c *LakeFormation) ListResourcesRequest(input *ListResourcesInput) (req *request.Request, output *ListResourcesOutput)

ListResourcesRequest generates a "aws/request.Request" representing the client's request for the ListResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListResources for more information on using the ListResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListResourcesRequest method.
req, resp := client.ListResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/ListResources

func (*LakeFormation) ListResourcesWithContext

func (c *LakeFormation) ListResourcesWithContext(ctx aws.Context, input *ListResourcesInput, opts ...request.Option) (*ListResourcesOutput, error)

ListResourcesWithContext is the same as ListResources with the addition of the ability to pass a context and additional request options.

See ListResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) PutDataLakeSettings

func (c *LakeFormation) PutDataLakeSettings(input *PutDataLakeSettingsInput) (*PutDataLakeSettingsOutput, error)

PutDataLakeSettings API operation for AWS Lake Formation.

Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions (https://docs.aws.amazon.com/lake-formation/latest/dg/lake-formation-permissions.html).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation PutDataLakeSettings for usage and error information.

Returned Error Types:

  • InternalServiceException An internal service error occurred.

  • InvalidInputException The input provided was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/PutDataLakeSettings

func (*LakeFormation) PutDataLakeSettingsRequest

func (c *LakeFormation) PutDataLakeSettingsRequest(input *PutDataLakeSettingsInput) (req *request.Request, output *PutDataLakeSettingsOutput)

PutDataLakeSettingsRequest generates a "aws/request.Request" representing the client's request for the PutDataLakeSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDataLakeSettings for more information on using the PutDataLakeSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutDataLakeSettingsRequest method.
req, resp := client.PutDataLakeSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/PutDataLakeSettings

func (*LakeFormation) PutDataLakeSettingsWithContext

func (c *LakeFormation) PutDataLakeSettingsWithContext(ctx aws.Context, input *PutDataLakeSettingsInput, opts ...request.Option) (*PutDataLakeSettingsOutput, error)

PutDataLakeSettingsWithContext is the same as PutDataLakeSettings with the addition of the ability to pass a context and additional request options.

See PutDataLakeSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) RegisterResource

func (c *LakeFormation) RegisterResource(input *RegisterResourceInput) (*RegisterResourceOutput, error)

RegisterResource API operation for AWS Lake Formation.

Registers the resource as managed by the Data Catalog.

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

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

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

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation RegisterResource for usage and error information.

Returned Error Types:

  • InvalidInputException The input provided was not valid.

  • InternalServiceException An internal service error occurred.

  • OperationTimeoutException The operation timed out.

  • AlreadyExistsException A resource to be created or added already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/RegisterResource

func (*LakeFormation) RegisterResourceRequest

func (c *LakeFormation) RegisterResourceRequest(input *RegisterResourceInput) (req *request.Request, output *RegisterResourceOutput)

RegisterResourceRequest generates a "aws/request.Request" representing the client's request for the RegisterResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterResource for more information on using the RegisterResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterResourceRequest method.
req, resp := client.RegisterResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/RegisterResource

func (*LakeFormation) RegisterResourceWithContext

func (c *LakeFormation) RegisterResourceWithContext(ctx aws.Context, input *RegisterResourceInput, opts ...request.Option) (*RegisterResourceOutput, error)

RegisterResourceWithContext is the same as RegisterResource with the addition of the ability to pass a context and additional request options.

See RegisterResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) RevokePermissions

func (c *LakeFormation) RevokePermissions(input *RevokePermissionsInput) (*RevokePermissionsOutput, error)

RevokePermissions API operation for AWS Lake Formation.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation RevokePermissions for usage and error information.

Returned Error Types:

  • ConcurrentModificationException Two processes are trying to modify a resource simultaneously.

  • EntityNotFoundException A specified entity does not exist

  • InvalidInputException The input provided was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/RevokePermissions

func (*LakeFormation) RevokePermissionsRequest

func (c *LakeFormation) RevokePermissionsRequest(input *RevokePermissionsInput) (req *request.Request, output *RevokePermissionsOutput)

RevokePermissionsRequest generates a "aws/request.Request" representing the client's request for the RevokePermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RevokePermissions for more information on using the RevokePermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RevokePermissionsRequest method.
req, resp := client.RevokePermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/RevokePermissions

func (*LakeFormation) RevokePermissionsWithContext

func (c *LakeFormation) RevokePermissionsWithContext(ctx aws.Context, input *RevokePermissionsInput, opts ...request.Option) (*RevokePermissionsOutput, error)

RevokePermissionsWithContext is the same as RevokePermissions with the addition of the ability to pass a context and additional request options.

See RevokePermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LakeFormation) UpdateResource

func (c *LakeFormation) UpdateResource(input *UpdateResourceInput) (*UpdateResourceOutput, error)

UpdateResource API operation for AWS Lake Formation.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Lake Formation's API operation UpdateResource for usage and error information.

Returned Error Types:

  • InvalidInputException The input provided was not valid.

  • InternalServiceException An internal service error occurred.

  • OperationTimeoutException The operation timed out.

  • EntityNotFoundException A specified entity does not exist

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/UpdateResource

func (*LakeFormation) UpdateResourceRequest

func (c *LakeFormation) UpdateResourceRequest(input *UpdateResourceInput) (req *request.Request, output *UpdateResourceOutput)

UpdateResourceRequest generates a "aws/request.Request" representing the client's request for the UpdateResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateResource for more information on using the UpdateResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateResourceRequest method.
req, resp := client.UpdateResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/UpdateResource

func (*LakeFormation) UpdateResourceWithContext

func (c *LakeFormation) UpdateResourceWithContext(ctx aws.Context, input *UpdateResourceInput, opts ...request.Option) (*UpdateResourceOutput, error)

UpdateResourceWithContext is the same as UpdateResource with the addition of the ability to pass a context and additional request options.

See UpdateResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ListPermissionsInput

type ListPermissionsInput struct {

	// The identifier for the Data Catalog. By default, the account ID. The Data
	// Catalog is the persistent metadata store. It contains database definitions,
	// table definitions, and other control information to manage your AWS Lake
	// Formation environment.
	CatalogId *string `min:"1" type:"string"`

	// The maximum number of results to return.
	MaxResults *int64 `min:"1" type:"integer"`

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

	// Specifies a principal to filter the permissions returned.
	Principal *DataLakePrincipal `type:"structure"`

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

	// Specifies a resource type to filter the permissions returned.
	ResourceType *string `type:"string" enum:"DataLakeResourceType"`
	// contains filtered or unexported fields
}

func (ListPermissionsInput) GoString

func (s ListPermissionsInput) GoString() string

GoString returns the string representation

func (*ListPermissionsInput) SetCatalogId

func (s *ListPermissionsInput) SetCatalogId(v string) *ListPermissionsInput

SetCatalogId sets the CatalogId field's value.

func (*ListPermissionsInput) SetMaxResults

func (s *ListPermissionsInput) SetMaxResults(v int64) *ListPermissionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListPermissionsInput) SetNextToken

func (s *ListPermissionsInput) SetNextToken(v string) *ListPermissionsInput

SetNextToken sets the NextToken field's value.

func (*ListPermissionsInput) SetPrincipal

SetPrincipal sets the Principal field's value.

func (*ListPermissionsInput) SetResource

SetResource sets the Resource field's value.

func (*ListPermissionsInput) SetResourceType

func (s *ListPermissionsInput) SetResourceType(v string) *ListPermissionsInput

SetResourceType sets the ResourceType field's value.

func (ListPermissionsInput) String

func (s ListPermissionsInput) String() string

String returns the string representation

func (*ListPermissionsInput) Validate

func (s *ListPermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPermissionsOutput

type ListPermissionsOutput struct {

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

	// A list of principals and their permissions on the resource for the specified
	// principal and resource types.
	PrincipalResourcePermissions []*PrincipalResourcePermissions `type:"list"`
	// contains filtered or unexported fields
}

func (ListPermissionsOutput) GoString

func (s ListPermissionsOutput) GoString() string

GoString returns the string representation

func (*ListPermissionsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListPermissionsOutput) SetPrincipalResourcePermissions

func (s *ListPermissionsOutput) SetPrincipalResourcePermissions(v []*PrincipalResourcePermissions) *ListPermissionsOutput

SetPrincipalResourcePermissions sets the PrincipalResourcePermissions field's value.

func (ListPermissionsOutput) String

func (s ListPermissionsOutput) String() string

String returns the string representation

type ListResourcesInput

type ListResourcesInput struct {

	// Any applicable row-level and/or column-level filtering conditions for the
	// resources.
	FilterConditionList []*FilterCondition `min:"1" type:"list"`

	// The maximum number of resource results.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (ListResourcesInput) GoString

func (s ListResourcesInput) GoString() string

GoString returns the string representation

func (*ListResourcesInput) SetFilterConditionList

func (s *ListResourcesInput) SetFilterConditionList(v []*FilterCondition) *ListResourcesInput

SetFilterConditionList sets the FilterConditionList field's value.

func (*ListResourcesInput) SetMaxResults

func (s *ListResourcesInput) SetMaxResults(v int64) *ListResourcesInput

SetMaxResults sets the MaxResults field's value.

func (*ListResourcesInput) SetNextToken

func (s *ListResourcesInput) SetNextToken(v string) *ListResourcesInput

SetNextToken sets the NextToken field's value.

func (ListResourcesInput) String

func (s ListResourcesInput) String() string

String returns the string representation

func (*ListResourcesInput) Validate

func (s *ListResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListResourcesOutput

type ListResourcesOutput struct {

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

	// A summary of the data lake resources.
	ResourceInfoList []*ResourceInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListResourcesOutput) GoString

func (s ListResourcesOutput) GoString() string

GoString returns the string representation

func (*ListResourcesOutput) SetNextToken

func (s *ListResourcesOutput) SetNextToken(v string) *ListResourcesOutput

SetNextToken sets the NextToken field's value.

func (*ListResourcesOutput) SetResourceInfoList

func (s *ListResourcesOutput) SetResourceInfoList(v []*ResourceInfo) *ListResourcesOutput

SetResourceInfoList sets the ResourceInfoList field's value.

func (ListResourcesOutput) String

func (s ListResourcesOutput) String() string

String returns the string representation

type OperationTimeoutException added in v1.28.0

type OperationTimeoutException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message describing the problem.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation timed out.

func (*OperationTimeoutException) Code added in v1.28.0

Code returns the exception type name.

func (*OperationTimeoutException) Error added in v1.28.0

func (s *OperationTimeoutException) Error() string

func (OperationTimeoutException) GoString added in v1.28.0

func (s OperationTimeoutException) GoString() string

GoString returns the string representation

func (*OperationTimeoutException) Message added in v1.28.0

func (s *OperationTimeoutException) Message() string

Message returns the exception's message.

func (*OperationTimeoutException) OrigErr added in v1.28.0

func (s *OperationTimeoutException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OperationTimeoutException) RequestID added in v1.28.0

func (s *OperationTimeoutException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OperationTimeoutException) StatusCode added in v1.28.0

func (s *OperationTimeoutException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (OperationTimeoutException) String added in v1.28.0

func (s OperationTimeoutException) String() string

String returns the string representation

type PrincipalPermissions

type PrincipalPermissions struct {

	// The permissions that are granted to the principal.
	Permissions []*string `type:"list"`

	// The principal who is granted permissions.
	Principal *DataLakePrincipal `type:"structure"`
	// contains filtered or unexported fields
}

Permissions granted to a principal.

func (PrincipalPermissions) GoString

func (s PrincipalPermissions) GoString() string

GoString returns the string representation

func (*PrincipalPermissions) SetPermissions

func (s *PrincipalPermissions) SetPermissions(v []*string) *PrincipalPermissions

SetPermissions sets the Permissions field's value.

func (*PrincipalPermissions) SetPrincipal

SetPrincipal sets the Principal field's value.

func (PrincipalPermissions) String

func (s PrincipalPermissions) String() string

String returns the string representation

func (*PrincipalPermissions) Validate

func (s *PrincipalPermissions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `type:"structure"`

	// The permissions to be granted or revoked on the resource.
	Permissions []*string `type:"list"`

	// Indicates whether to grant the ability to grant permissions (as a subset
	// of permissions granted).
	PermissionsWithGrantOption []*string `type:"list"`

	// The Data Lake principal to be granted or revoked permissions.
	Principal *DataLakePrincipal `type:"structure"`

	// The resource where permissions are to be granted or revoked.
	Resource *Resource `type:"structure"`
	// contains filtered or unexported fields
}

The permissions granted or revoked on a resource.

func (PrincipalResourcePermissions) GoString

func (s PrincipalResourcePermissions) GoString() string

GoString returns the string representation

func (*PrincipalResourcePermissions) SetAdditionalDetails added in v1.34.8

SetAdditionalDetails sets the AdditionalDetails field's value.

func (*PrincipalResourcePermissions) SetPermissions

SetPermissions sets the Permissions field's value.

func (*PrincipalResourcePermissions) SetPermissionsWithGrantOption

func (s *PrincipalResourcePermissions) SetPermissionsWithGrantOption(v []*string) *PrincipalResourcePermissions

SetPermissionsWithGrantOption sets the PermissionsWithGrantOption field's value.

func (*PrincipalResourcePermissions) SetPrincipal

SetPrincipal sets the Principal field's value.

func (*PrincipalResourcePermissions) SetResource

SetResource sets the Resource field's value.

func (PrincipalResourcePermissions) String

String returns the string representation

type PutDataLakeSettingsInput

type PutDataLakeSettingsInput 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.
	CatalogId *string `min:"1" type:"string"`

	// A structure representing a list of AWS Lake Formation principals designated
	// as data lake administrators.
	//
	// DataLakeSettings is a required field
	DataLakeSettings *DataLakeSettings `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutDataLakeSettingsInput) GoString

func (s PutDataLakeSettingsInput) GoString() string

GoString returns the string representation

func (*PutDataLakeSettingsInput) SetCatalogId

SetCatalogId sets the CatalogId field's value.

func (*PutDataLakeSettingsInput) SetDataLakeSettings

SetDataLakeSettings sets the DataLakeSettings field's value.

func (PutDataLakeSettingsInput) String

func (s PutDataLakeSettingsInput) String() string

String returns the string representation

func (*PutDataLakeSettingsInput) Validate

func (s *PutDataLakeSettingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutDataLakeSettingsOutput

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

func (PutDataLakeSettingsOutput) GoString

func (s PutDataLakeSettingsOutput) GoString() string

GoString returns the string representation

func (PutDataLakeSettingsOutput) String

func (s PutDataLakeSettingsOutput) String() string

String returns the string representation

type RegisterResourceInput

type RegisterResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to register.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// The identifier for the role that registers the resource.
	RoleArn *string `type:"string"`

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

func (RegisterResourceInput) GoString

func (s RegisterResourceInput) GoString() string

GoString returns the string representation

func (*RegisterResourceInput) SetResourceArn

func (s *RegisterResourceInput) SetResourceArn(v string) *RegisterResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*RegisterResourceInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*RegisterResourceInput) SetUseServiceLinkedRole

func (s *RegisterResourceInput) SetUseServiceLinkedRole(v bool) *RegisterResourceInput

SetUseServiceLinkedRole sets the UseServiceLinkedRole field's value.

func (RegisterResourceInput) String

func (s RegisterResourceInput) String() string

String returns the string representation

func (*RegisterResourceInput) Validate

func (s *RegisterResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterResourceOutput

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

func (RegisterResourceOutput) GoString

func (s RegisterResourceOutput) GoString() string

GoString returns the string representation

func (RegisterResourceOutput) String

func (s RegisterResourceOutput) String() string

String returns the string representation

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 `type:"structure"`

	// The location of an Amazon S3 path where permissions are granted or revoked.
	DataLocation *DataLocationResource `type:"structure"`

	// 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 `type:"structure"`

	// 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 `type:"structure"`

	// 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 `type:"structure"`
	// contains filtered or unexported fields
}

A structure for the resource.

func (Resource) GoString

func (s Resource) GoString() string

GoString returns the string representation

func (*Resource) SetCatalog

func (s *Resource) SetCatalog(v *CatalogResource) *Resource

SetCatalog sets the Catalog field's value.

func (*Resource) SetDataLocation

func (s *Resource) SetDataLocation(v *DataLocationResource) *Resource

SetDataLocation sets the DataLocation field's value.

func (*Resource) SetDatabase

func (s *Resource) SetDatabase(v *DatabaseResource) *Resource

SetDatabase sets the Database field's value.

func (*Resource) SetTable

func (s *Resource) SetTable(v *TableResource) *Resource

SetTable sets the Table field's value.

func (*Resource) SetTableWithColumns

func (s *Resource) SetTableWithColumns(v *TableWithColumnsResource) *Resource

SetTableWithColumns sets the TableWithColumns field's value.

func (Resource) String

func (s Resource) String() string

String returns the string representation

func (*Resource) Validate

func (s *Resource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceInfo

type ResourceInfo struct {

	// The date and time the resource was last modified.
	LastModified *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the resource.
	ResourceArn *string `type:"string"`

	// The IAM role that registered a resource.
	RoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

A structure containing information about an AWS Lake Formation resource.

func (ResourceInfo) GoString

func (s ResourceInfo) GoString() string

GoString returns the string representation

func (*ResourceInfo) SetLastModified

func (s *ResourceInfo) SetLastModified(v time.Time) *ResourceInfo

SetLastModified sets the LastModified field's value.

func (*ResourceInfo) SetResourceArn

func (s *ResourceInfo) SetResourceArn(v string) *ResourceInfo

SetResourceArn sets the ResourceArn field's value.

func (*ResourceInfo) SetRoleArn

func (s *ResourceInfo) SetRoleArn(v string) *ResourceInfo

SetRoleArn sets the RoleArn field's value.

func (ResourceInfo) String

func (s ResourceInfo) String() string

String returns the string representation

type RevokePermissionsInput

type RevokePermissionsInput 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.
	CatalogId *string `min:"1" type:"string"`

	// The permissions revoked to the principal on the resource. For information
	// about permissions, see Security and Access Control to Metadata and Data (https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html).
	//
	// Permissions is a required field
	Permissions []*string `type:"list" required:"true"`

	// Indicates a list of permissions for which to revoke the grant option allowing
	// the principal to pass permissions to other principals.
	PermissionsWithGrantOption []*string `type:"list"`

	// The principal to be revoked permissions on the resource.
	//
	// Principal is a required field
	Principal *DataLakePrincipal `type:"structure" required:"true"`

	// The resource to which permissions are to be revoked.
	//
	// Resource is a required field
	Resource *Resource `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (RevokePermissionsInput) GoString

func (s RevokePermissionsInput) GoString() string

GoString returns the string representation

func (*RevokePermissionsInput) SetCatalogId

SetCatalogId sets the CatalogId field's value.

func (*RevokePermissionsInput) SetPermissions

func (s *RevokePermissionsInput) SetPermissions(v []*string) *RevokePermissionsInput

SetPermissions sets the Permissions field's value.

func (*RevokePermissionsInput) SetPermissionsWithGrantOption

func (s *RevokePermissionsInput) SetPermissionsWithGrantOption(v []*string) *RevokePermissionsInput

SetPermissionsWithGrantOption sets the PermissionsWithGrantOption field's value.

func (*RevokePermissionsInput) SetPrincipal

SetPrincipal sets the Principal field's value.

func (*RevokePermissionsInput) SetResource

SetResource sets the Resource field's value.

func (RevokePermissionsInput) String

func (s RevokePermissionsInput) String() string

String returns the string representation

func (*RevokePermissionsInput) Validate

func (s *RevokePermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RevokePermissionsOutput

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

func (RevokePermissionsOutput) GoString

func (s RevokePermissionsOutput) GoString() string

GoString returns the string representation

func (RevokePermissionsOutput) String

func (s RevokePermissionsOutput) String() string

String returns the string representation

type TableResource

type TableResource struct {

	// The identifier for the Data Catalog. By default, it is the account ID of
	// the caller.
	CatalogId *string `min:"1" type:"string"`

	// 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.
	//
	// DatabaseName is a required field
	DatabaseName *string `min:"1" type:"string" required:"true"`

	// The name of the table.
	Name *string `min:"1" type:"string"`

	// A wildcard object representing every table under a database.
	//
	// At least one of TableResource$Name or TableResource$TableWildcard is required.
	TableWildcard *TableWildcard `type:"structure"`
	// 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.

func (TableResource) GoString

func (s TableResource) GoString() string

GoString returns the string representation

func (*TableResource) SetCatalogId added in v1.33.3

func (s *TableResource) SetCatalogId(v string) *TableResource

SetCatalogId sets the CatalogId field's value.

func (*TableResource) SetDatabaseName

func (s *TableResource) SetDatabaseName(v string) *TableResource

SetDatabaseName sets the DatabaseName field's value.

func (*TableResource) SetName

func (s *TableResource) SetName(v string) *TableResource

SetName sets the Name field's value.

func (*TableResource) SetTableWildcard added in v1.33.3

func (s *TableResource) SetTableWildcard(v *TableWildcard) *TableResource

SetTableWildcard sets the TableWildcard field's value.

func (TableResource) String

func (s TableResource) String() string

String returns the string representation

func (*TableResource) Validate

func (s *TableResource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TableWildcard added in v1.33.3

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

A wildcard object representing every table under a database.

func (TableWildcard) GoString added in v1.33.3

func (s TableWildcard) GoString() string

GoString returns the string representation

func (TableWildcard) String added in v1.33.3

func (s TableWildcard) String() string

String returns the string representation

type TableWithColumnsResource

type TableWithColumnsResource struct {

	// The identifier for the Data Catalog. By default, it is the account ID of
	// the caller.
	CatalogId *string `min:"1" type:"string"`

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

	// A wildcard specified by a ColumnWildcard object. At least one of ColumnNames
	// or ColumnWildcard is required.
	ColumnWildcard *ColumnWildcard `type:"structure"`

	// 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.
	//
	// DatabaseName is a required field
	DatabaseName *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// 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.

func (TableWithColumnsResource) GoString

func (s TableWithColumnsResource) GoString() string

GoString returns the string representation

func (*TableWithColumnsResource) SetCatalogId added in v1.33.3

SetCatalogId sets the CatalogId field's value.

func (*TableWithColumnsResource) SetColumnNames

func (s *TableWithColumnsResource) SetColumnNames(v []*string) *TableWithColumnsResource

SetColumnNames sets the ColumnNames field's value.

func (*TableWithColumnsResource) SetColumnWildcard

SetColumnWildcard sets the ColumnWildcard field's value.

func (*TableWithColumnsResource) SetDatabaseName

SetDatabaseName sets the DatabaseName field's value.

func (*TableWithColumnsResource) SetName

SetName sets the Name field's value.

func (TableWithColumnsResource) String

func (s TableWithColumnsResource) String() string

String returns the string representation

func (*TableWithColumnsResource) Validate

func (s *TableWithColumnsResource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateResourceInput

type UpdateResourceInput struct {

	// The resource ARN.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// The new role to use for the given resource registered in AWS Lake Formation.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateResourceInput) GoString

func (s UpdateResourceInput) GoString() string

GoString returns the string representation

func (*UpdateResourceInput) SetResourceArn

func (s *UpdateResourceInput) SetResourceArn(v string) *UpdateResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UpdateResourceInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (UpdateResourceInput) String

func (s UpdateResourceInput) String() string

String returns the string representation

func (*UpdateResourceInput) Validate

func (s *UpdateResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateResourceOutput

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

func (UpdateResourceOutput) GoString

func (s UpdateResourceOutput) GoString() string

GoString returns the string representation

func (UpdateResourceOutput) String

func (s UpdateResourceOutput) String() string

String returns the string representation

Directories

Path Synopsis
Package lakeformationiface provides an interface to enable mocking the AWS Lake Formation service client for testing your code.
Package lakeformationiface provides an interface to enable mocking the AWS Lake Formation service client for testing your code.

Jump to

Keyboard shortcuts

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