lakeformation

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 12

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 use 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 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 (
	ServiceName = "AWS Lake Formation" // Service's name
	ServiceID   = "LakeFormation"      // Service's identifier
	EndpointsID = "lakeformation"      // Service's Endpoint identifier
)
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"
)

Variables

This section is empty.

Functions

This section is empty.

Types

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

func (s BatchGrantPermissionsInput) String() 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) String 

func (s BatchGrantPermissionsOutput) String() string

String returns the string representation

type BatchGrantPermissionsRequest 

type BatchGrantPermissionsRequest struct {
	*aws.Request
	Input *BatchGrantPermissionsInput
	Copy  func(*BatchGrantPermissionsInput) BatchGrantPermissionsRequest
}

BatchGrantPermissionsRequest is the request type for the BatchGrantPermissions API operation.

func (BatchGrantPermissionsRequest) Send 

func (r BatchGrantPermissionsRequest) Send(ctx context.Context) (*BatchGrantPermissionsResponse, error)

Send marshals and sends the BatchGrantPermissions API request.

type BatchGrantPermissionsResponse 

type BatchGrantPermissionsResponse struct {
	*BatchGrantPermissionsOutput
	// contains filtered or unexported fields
}

BatchGrantPermissionsResponse is the response type for the BatchGrantPermissions API operation.

func (*BatchGrantPermissionsResponse) SDKResponseMetdata 

func (r *BatchGrantPermissionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchGrantPermissions request.

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

func (s BatchPermissionsFailureEntry) String() 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 []Permission `type:"list"`

	// Indicates if the option to pass permissions is granted.
	PermissionsWithGrantOption []Permission `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) String 

func (s BatchPermissionsRequestEntry) String() 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) String 

func (s BatchRevokePermissionsInput) String() 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) String 

func (s BatchRevokePermissionsOutput) String() string

String returns the string representation

type BatchRevokePermissionsRequest 

type BatchRevokePermissionsRequest struct {
	*aws.Request
	Input *BatchRevokePermissionsInput
	Copy  func(*BatchRevokePermissionsInput) BatchRevokePermissionsRequest
}

BatchRevokePermissionsRequest is the request type for the BatchRevokePermissions API operation.

func (BatchRevokePermissionsRequest) Send 

func (r BatchRevokePermissionsRequest) Send(ctx context.Context) (*BatchRevokePermissionsResponse, error)

Send marshals and sends the BatchRevokePermissions API request.

type BatchRevokePermissionsResponse 

type BatchRevokePermissionsResponse struct {
	*BatchRevokePermissionsOutput
	// contains filtered or unexported fields
}

BatchRevokePermissionsResponse is the response type for the BatchRevokePermissions API operation.

func (*BatchRevokePermissionsResponse) SDKResponseMetdata 

func (r *BatchRevokePermissionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchRevokePermissions request.

type CatalogResource 

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

A structure for the catalog object.

func (CatalogResource) String 

func (s CatalogResource) String() string

String returns the string representation

type Client 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := lakeformation.New(myConfig)

func (*Client) BatchGrantPermissionsRequest 

func (c *Client) BatchGrantPermissionsRequest(input *BatchGrantPermissionsInput) BatchGrantPermissionsRequest

BatchGrantPermissionsRequest returns a request value for making API operation for AWS Lake Formation.

Batch operation to grant permissions to the principal. 

// Example sending a request using BatchGrantPermissionsRequest.
req := client.BatchGrantPermissionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) BatchRevokePermissionsRequest 

func (c *Client) BatchRevokePermissionsRequest(input *BatchRevokePermissionsInput) BatchRevokePermissionsRequest

BatchRevokePermissionsRequest returns a request value for making API operation for AWS Lake Formation.

Batch operation to revoke permissions from the principal. 

// Example sending a request using BatchRevokePermissionsRequest.
req := client.BatchRevokePermissionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeregisterResourceRequest 

func (c *Client) DeregisterResourceRequest(input *DeregisterResourceInput) DeregisterResourceRequest

DeregisterResourceRequest returns a request value for making 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. 

// Example sending a request using DeregisterResourceRequest.
req := client.DeregisterResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeResourceRequest 

func (c *Client) DescribeResourceRequest(input *DescribeResourceInput) DescribeResourceRequest

DescribeResourceRequest returns a request value for making API operation for AWS Lake Formation.

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

// Example sending a request using DescribeResourceRequest.
req := client.DescribeResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetDataLakeSettingsRequest 

func (c *Client) GetDataLakeSettingsRequest(input *GetDataLakeSettingsInput) GetDataLakeSettingsRequest

GetDataLakeSettingsRequest returns a request value for making API operation for AWS Lake Formation.

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

// Example sending a request using GetDataLakeSettingsRequest.
req := client.GetDataLakeSettingsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetEffectivePermissionsForPathRequest 

func (c *Client) GetEffectivePermissionsForPathRequest(input *GetEffectivePermissionsForPathInput) GetEffectivePermissionsForPathRequest

GetEffectivePermissionsForPathRequest returns a request value for making 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. 

// Example sending a request using GetEffectivePermissionsForPathRequest.
req := client.GetEffectivePermissionsForPathRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GrantPermissionsRequest 

func (c *Client) GrantPermissionsRequest(input *GrantPermissionsInput) GrantPermissionsRequest

GrantPermissionsRequest returns a request value for making 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). 

// Example sending a request using GrantPermissionsRequest.
req := client.GrantPermissionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListPermissionsRequest 

func (c *Client) ListPermissionsRequest(input *ListPermissionsInput) ListPermissionsRequest

ListPermissionsRequest returns a request value for making 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). 

// Example sending a request using ListPermissionsRequest.
req := client.ListPermissionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListResourcesRequest 

func (c *Client) ListResourcesRequest(input *ListResourcesInput) ListResourcesRequest

ListResourcesRequest returns a request value for making API operation for AWS Lake Formation.

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

// Example sending a request using ListResourcesRequest.
req := client.ListResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutDataLakeSettingsRequest 

func (c *Client) PutDataLakeSettingsRequest(input *PutDataLakeSettingsInput) PutDataLakeSettingsRequest

PutDataLakeSettingsRequest returns a request value for making 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. 

// Example sending a request using PutDataLakeSettingsRequest.
req := client.PutDataLakeSettingsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) RegisterResourceRequest 

func (c *Client) RegisterResourceRequest(input *RegisterResourceInput) RegisterResourceRequest

RegisterResourceRequest returns a request value for making 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 

// Example sending a request using RegisterResourceRequest.
req := client.RegisterResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) RevokePermissionsRequest 

func (c *Client) RevokePermissionsRequest(input *RevokePermissionsInput) RevokePermissionsRequest

RevokePermissionsRequest returns a request value for making 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. 

// Example sending a request using RevokePermissionsRequest.
req := client.RevokePermissionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateResourceRequest 

func (c *Client) UpdateResourceRequest(input *UpdateResourceInput) UpdateResourceRequest

UpdateResourceRequest returns a request value for making API operation for AWS Lake Formation.

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

// Example sending a request using UpdateResourceRequest.
req := client.UpdateResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

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

func (s ColumnWildcard) String() string

String returns the string representation

type ComparisonOperator 

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

Enum values for ComparisonOperator

func (ComparisonOperator) MarshalValue 

func (enum ComparisonOperator) MarshalValue() (string, error)

func (ComparisonOperator) MarshalValueBuf 

func (enum ComparisonOperator) MarshalValueBuf(b []byte) ([]byte, error)

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

type DataLakeResourceType string
const (
	DataLakeResourceTypeCatalog      DataLakeResourceType = "CATALOG"
	DataLakeResourceTypeDatabase     DataLakeResourceType = "DATABASE"
	DataLakeResourceTypeTable        DataLakeResourceType = "TABLE"
	DataLakeResourceTypeDataLocation DataLakeResourceType = "DATA_LOCATION"
)

Enum values for DataLakeResourceType

func (DataLakeResourceType) MarshalValue 

func (enum DataLakeResourceType) MarshalValue() (string, error)

func (DataLakeResourceType) MarshalValueBuf 

func (enum DataLakeResourceType) MarshalValueBuf(b []byte) ([]byte, error)

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

func (s DeregisterResourceOutput) String() string

String returns the string representation

type DeregisterResourceRequest 

type DeregisterResourceRequest struct {
	*aws.Request
	Input *DeregisterResourceInput
	Copy  func(*DeregisterResourceInput) DeregisterResourceRequest
}

DeregisterResourceRequest is the request type for the DeregisterResource API operation.

func (DeregisterResourceRequest) Send 

func (r DeregisterResourceRequest) Send(ctx context.Context) (*DeregisterResourceResponse, error)

Send marshals and sends the DeregisterResource API request.

type DeregisterResourceResponse 

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

DeregisterResourceResponse is the response type for the DeregisterResource API operation.

func (*DeregisterResourceResponse) SDKResponseMetdata 

func (r *DeregisterResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeregisterResource request.

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

func (s DescribeResourceOutput) String() string

String returns the string representation

type DescribeResourceRequest 

type DescribeResourceRequest struct {
	*aws.Request
	Input *DescribeResourceInput
	Copy  func(*DescribeResourceInput) DescribeResourceRequest
}

DescribeResourceRequest is the request type for the DescribeResource API operation.

func (DescribeResourceRequest) Send 

func (r DescribeResourceRequest) Send(ctx context.Context) (*DescribeResourceResponse, error)

Send marshals and sends the DescribeResource API request.

type DescribeResourceResponse 

type DescribeResourceResponse struct {
	*DescribeResourceOutput
	// contains filtered or unexported fields
}

DescribeResourceResponse is the response type for the DescribeResource API operation.

func (*DescribeResourceResponse) SDKResponseMetdata 

func (r *DescribeResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeResource request.

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

func (s ErrorDetail) String() string

String returns the string representation

type FieldNameString 

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

Enum values for FieldNameString

func (FieldNameString) MarshalValue 

func (enum FieldNameString) MarshalValue() (string, error)

func (FieldNameString) MarshalValueBuf 

func (enum FieldNameString) MarshalValueBuf(b []byte) ([]byte, error)

type FilterCondition 

type FilterCondition struct {

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

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

	// 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) 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) 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) String 

func (s GetDataLakeSettingsOutput) String() string

String returns the string representation

type GetDataLakeSettingsRequest 

type GetDataLakeSettingsRequest struct {
	*aws.Request
	Input *GetDataLakeSettingsInput
	Copy  func(*GetDataLakeSettingsInput) GetDataLakeSettingsRequest
}

GetDataLakeSettingsRequest is the request type for the GetDataLakeSettings API operation.

func (GetDataLakeSettingsRequest) Send 

func (r GetDataLakeSettingsRequest) Send(ctx context.Context) (*GetDataLakeSettingsResponse, error)

Send marshals and sends the GetDataLakeSettings API request.

type GetDataLakeSettingsResponse 

type GetDataLakeSettingsResponse struct {
	*GetDataLakeSettingsOutput
	// contains filtered or unexported fields
}

GetDataLakeSettingsResponse is the response type for the GetDataLakeSettings API operation.

func (*GetDataLakeSettingsResponse) SDKResponseMetdata 

func (r *GetDataLakeSettingsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDataLakeSettings request.

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

func (s GetEffectivePermissionsForPathInput) String() string

String returns the string representation

func (*GetEffectivePermissionsForPathInput) Validate 

func (s *GetEffectivePermissionsForPathInput) Validate() error

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

func (s GetEffectivePermissionsForPathOutput) String() string

String returns the string representation

type GetEffectivePermissionsForPathPaginator 

type GetEffectivePermissionsForPathPaginator struct {
	aws.Pager
}

GetEffectivePermissionsForPathPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetEffectivePermissionsForPathPaginator 

func NewGetEffectivePermissionsForPathPaginator(req GetEffectivePermissionsForPathRequest) GetEffectivePermissionsForPathPaginator

NewGetEffectivePermissionsForPathRequestPaginator returns a paginator for GetEffectivePermissionsForPath. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.GetEffectivePermissionsForPathRequest(input)
p := lakeformation.NewGetEffectivePermissionsForPathRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetEffectivePermissionsForPathPaginator) CurrentPage 

func (p *GetEffectivePermissionsForPathPaginator) CurrentPage() *GetEffectivePermissionsForPathOutput

type GetEffectivePermissionsForPathRequest 

type GetEffectivePermissionsForPathRequest struct {
	*aws.Request
	Input *GetEffectivePermissionsForPathInput
	Copy  func(*GetEffectivePermissionsForPathInput) GetEffectivePermissionsForPathRequest
}

GetEffectivePermissionsForPathRequest is the request type for the GetEffectivePermissionsForPath API operation.

func (GetEffectivePermissionsForPathRequest) Send 

func (r GetEffectivePermissionsForPathRequest) Send(ctx context.Context) (*GetEffectivePermissionsForPathResponse, error)

Send marshals and sends the GetEffectivePermissionsForPath API request.

type GetEffectivePermissionsForPathResponse 

type GetEffectivePermissionsForPathResponse struct {
	*GetEffectivePermissionsForPathOutput
	// contains filtered or unexported fields
}

GetEffectivePermissionsForPathResponse is the response type for the GetEffectivePermissionsForPath API operation.

func (*GetEffectivePermissionsForPathResponse) SDKResponseMetdata 

func (r *GetEffectivePermissionsForPathResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetEffectivePermissionsForPath request.

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 []Permission `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 []Permission `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) 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) String 

func (s GrantPermissionsOutput) String() string

String returns the string representation

type GrantPermissionsRequest 

type GrantPermissionsRequest struct {
	*aws.Request
	Input *GrantPermissionsInput
	Copy  func(*GrantPermissionsInput) GrantPermissionsRequest
}

GrantPermissionsRequest is the request type for the GrantPermissions API operation.

func (GrantPermissionsRequest) Send 

func (r GrantPermissionsRequest) Send(ctx context.Context) (*GrantPermissionsResponse, error)

Send marshals and sends the GrantPermissions API request.

type GrantPermissionsResponse 

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

GrantPermissionsResponse is the response type for the GrantPermissions API operation.

func (*GrantPermissionsResponse) SDKResponseMetdata 

func (r *GrantPermissionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GrantPermissions request.

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 DataLakeResourceType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

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

func (s ListPermissionsOutput) String() string

String returns the string representation

type ListPermissionsPaginator 

type ListPermissionsPaginator struct {
	aws.Pager
}

ListPermissionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListPermissionsPaginator 

func NewListPermissionsPaginator(req ListPermissionsRequest) ListPermissionsPaginator

NewListPermissionsRequestPaginator returns a paginator for ListPermissions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListPermissionsRequest(input)
p := lakeformation.NewListPermissionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListPermissionsPaginator) CurrentPage 

func (p *ListPermissionsPaginator) CurrentPage() *ListPermissionsOutput

type ListPermissionsRequest 

type ListPermissionsRequest struct {
	*aws.Request
	Input *ListPermissionsInput
	Copy  func(*ListPermissionsInput) ListPermissionsRequest
}

ListPermissionsRequest is the request type for the ListPermissions API operation.

func (ListPermissionsRequest) Send 

func (r ListPermissionsRequest) Send(ctx context.Context) (*ListPermissionsResponse, error)

Send marshals and sends the ListPermissions API request.

type ListPermissionsResponse 

type ListPermissionsResponse struct {
	*ListPermissionsOutput
	// contains filtered or unexported fields
}

ListPermissionsResponse is the response type for the ListPermissions API operation.

func (*ListPermissionsResponse) SDKResponseMetdata 

func (r *ListPermissionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPermissions request.

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

func (s ListResourcesOutput) String() string

String returns the string representation

type ListResourcesPaginator 

type ListResourcesPaginator struct {
	aws.Pager
}

ListResourcesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListResourcesPaginator 

func NewListResourcesPaginator(req ListResourcesRequest) ListResourcesPaginator

NewListResourcesRequestPaginator returns a paginator for ListResources. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListResourcesRequest(input)
p := lakeformation.NewListResourcesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListResourcesPaginator) CurrentPage 

func (p *ListResourcesPaginator) CurrentPage() *ListResourcesOutput

type ListResourcesRequest 

type ListResourcesRequest struct {
	*aws.Request
	Input *ListResourcesInput
	Copy  func(*ListResourcesInput) ListResourcesRequest
}

ListResourcesRequest is the request type for the ListResources API operation.

func (ListResourcesRequest) Send 

func (r ListResourcesRequest) Send(ctx context.Context) (*ListResourcesResponse, error)

Send marshals and sends the ListResources API request.

type ListResourcesResponse 

type ListResourcesResponse struct {
	*ListResourcesOutput
	// contains filtered or unexported fields
}

ListResourcesResponse is the response type for the ListResources API operation.

func (*ListResourcesResponse) SDKResponseMetdata 

func (r *ListResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListResources request.

type Permission 

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

Enum values for Permission

func (Permission) MarshalValue 

func (enum Permission) MarshalValue() (string, error)

func (Permission) MarshalValueBuf 

func (enum Permission) MarshalValueBuf(b []byte) ([]byte, error)

type PrincipalPermissions 

type PrincipalPermissions struct {

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

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

Permissions granted to a principal.

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 {

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

	// Indicates whether to grant the ability to grant permissions (as a subset
	// of permissions granted).
	PermissionsWithGrantOption []Permission `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) String 

func (s PrincipalResourcePermissions) String() 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) 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) String 

func (s PutDataLakeSettingsOutput) String() string

String returns the string representation

type PutDataLakeSettingsRequest 

type PutDataLakeSettingsRequest struct {
	*aws.Request
	Input *PutDataLakeSettingsInput
	Copy  func(*PutDataLakeSettingsInput) PutDataLakeSettingsRequest
}

PutDataLakeSettingsRequest is the request type for the PutDataLakeSettings API operation.

func (PutDataLakeSettingsRequest) Send 

func (r PutDataLakeSettingsRequest) Send(ctx context.Context) (*PutDataLakeSettingsResponse, error)

Send marshals and sends the PutDataLakeSettings API request.

type PutDataLakeSettingsResponse 

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

PutDataLakeSettingsResponse is the response type for the PutDataLakeSettings API operation.

func (*PutDataLakeSettingsResponse) SDKResponseMetdata 

func (r *PutDataLakeSettingsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutDataLakeSettings request.

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

func (s RegisterResourceOutput) String() string

String returns the string representation

type RegisterResourceRequest 

type RegisterResourceRequest struct {
	*aws.Request
	Input *RegisterResourceInput
	Copy  func(*RegisterResourceInput) RegisterResourceRequest
}

RegisterResourceRequest is the request type for the RegisterResource API operation.

func (RegisterResourceRequest) Send 

func (r RegisterResourceRequest) Send(ctx context.Context) (*RegisterResourceResponse, error)

Send marshals and sends the RegisterResource API request.

type RegisterResourceResponse 

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

RegisterResourceResponse is the response type for the RegisterResource API operation.

func (*RegisterResourceResponse) SDKResponseMetdata 

func (r *RegisterResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RegisterResource request.

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) 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) 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 []Permission `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 []Permission `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) 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) String 

func (s RevokePermissionsOutput) String() string

String returns the string representation

type RevokePermissionsRequest 

type RevokePermissionsRequest struct {
	*aws.Request
	Input *RevokePermissionsInput
	Copy  func(*RevokePermissionsInput) RevokePermissionsRequest
}

RevokePermissionsRequest is the request type for the RevokePermissions API operation.

func (RevokePermissionsRequest) Send 

func (r RevokePermissionsRequest) Send(ctx context.Context) (*RevokePermissionsResponse, error)

Send marshals and sends the RevokePermissions API request.

type RevokePermissionsResponse 

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

RevokePermissionsResponse is the response type for the RevokePermissions API operation.

func (*RevokePermissionsResponse) SDKResponseMetdata 

func (r *RevokePermissionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RevokePermissions request.

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) 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 v0.24.0 

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

A wildcard object representing every table under a database.

func (TableWildcard) String added in v0.24.0 

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

func (s UpdateResourceOutput) String() string

String returns the string representation

type UpdateResourceRequest 

type UpdateResourceRequest struct {
	*aws.Request
	Input *UpdateResourceInput
	Copy  func(*UpdateResourceInput) UpdateResourceRequest
}

UpdateResourceRequest is the request type for the UpdateResource API operation.

func (UpdateResourceRequest) Send 

func (r UpdateResourceRequest) Send(ctx context.Context) (*UpdateResourceResponse, error)

Send marshals and sends the UpdateResource API request.

type UpdateResourceResponse 

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

UpdateResourceResponse is the response type for the UpdateResource API operation.

func (*UpdateResourceResponse) SDKResponseMetdata 

func (r *UpdateResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateResource request.

Source Files

View all Source files

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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.