aws-sdk-go: github.com/aws/aws-sdk-go/service/lakeformation Index | Files | Directories

package lakeformation

import "github.com/aws/aws-sdk-go/service/lakeformation"

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

Package Files

api.go doc.go errors.go service.go

Constants

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

    // 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"
)
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"
)
const (
    ServiceName = "LakeFormation" // Name of service.
    EndpointsID = "lakeformation" // ID to lookup a service endpoint with.
    ServiceID   = "LakeFormation" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type BatchGrantPermissionsInput Uses

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 Uses

func (s BatchGrantPermissionsInput) GoString() string

GoString returns the string representation

func (*BatchGrantPermissionsInput) SetCatalogId Uses

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

SetCatalogId sets the CatalogId field's value.

func (*BatchGrantPermissionsInput) SetEntries Uses

func (s *BatchGrantPermissionsInput) SetEntries(v []*BatchPermissionsRequestEntry) *BatchGrantPermissionsInput

SetEntries sets the Entries field's value.

func (BatchGrantPermissionsInput) String Uses

func (s BatchGrantPermissionsInput) String() string

String returns the string representation

func (*BatchGrantPermissionsInput) Validate Uses

func (s *BatchGrantPermissionsInput) Validate() error

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

type BatchGrantPermissionsOutput Uses

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 Uses

func (s BatchGrantPermissionsOutput) GoString() string

GoString returns the string representation

func (*BatchGrantPermissionsOutput) SetFailures Uses

func (s *BatchGrantPermissionsOutput) SetFailures(v []*BatchPermissionsFailureEntry) *BatchGrantPermissionsOutput

SetFailures sets the Failures field's value.

func (BatchGrantPermissionsOutput) String Uses

func (s BatchGrantPermissionsOutput) String() string

String returns the string representation

type BatchPermissionsFailureEntry Uses

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 Uses

func (s BatchPermissionsFailureEntry) GoString() string

GoString returns the string representation

func (*BatchPermissionsFailureEntry) SetError Uses

func (s *BatchPermissionsFailureEntry) SetError(v *ErrorDetail) *BatchPermissionsFailureEntry

SetError sets the Error field's value.

func (*BatchPermissionsFailureEntry) SetRequestEntry Uses

func (s *BatchPermissionsFailureEntry) SetRequestEntry(v *BatchPermissionsRequestEntry) *BatchPermissionsFailureEntry

SetRequestEntry sets the RequestEntry field's value.

func (BatchPermissionsFailureEntry) String Uses

func (s BatchPermissionsFailureEntry) String() string

String returns the string representation

type BatchPermissionsRequestEntry Uses

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 Uses

func (s BatchPermissionsRequestEntry) GoString() string

GoString returns the string representation

func (*BatchPermissionsRequestEntry) SetId Uses

func (s *BatchPermissionsRequestEntry) SetId(v string) *BatchPermissionsRequestEntry

SetId sets the Id field's value.

func (*BatchPermissionsRequestEntry) SetPermissions Uses

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

SetPermissions sets the Permissions field's value.

func (*BatchPermissionsRequestEntry) SetPermissionsWithGrantOption Uses

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

SetPermissionsWithGrantOption sets the PermissionsWithGrantOption field's value.

func (*BatchPermissionsRequestEntry) SetPrincipal Uses

func (s *BatchPermissionsRequestEntry) SetPrincipal(v *DataLakePrincipal) *BatchPermissionsRequestEntry

SetPrincipal sets the Principal field's value.

func (*BatchPermissionsRequestEntry) SetResource Uses

func (s *BatchPermissionsRequestEntry) SetResource(v *Resource) *BatchPermissionsRequestEntry

SetResource sets the Resource field's value.

func (BatchPermissionsRequestEntry) String Uses

func (s BatchPermissionsRequestEntry) String() string

String returns the string representation

func (*BatchPermissionsRequestEntry) Validate Uses

func (s *BatchPermissionsRequestEntry) Validate() error

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

type BatchRevokePermissionsInput Uses

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 Uses

func (s BatchRevokePermissionsInput) GoString() string

GoString returns the string representation

func (*BatchRevokePermissionsInput) SetCatalogId Uses

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

SetCatalogId sets the CatalogId field's value.

func (*BatchRevokePermissionsInput) SetEntries Uses

func (s *BatchRevokePermissionsInput) SetEntries(v []*BatchPermissionsRequestEntry) *BatchRevokePermissionsInput

SetEntries sets the Entries field's value.

func (BatchRevokePermissionsInput) String Uses

func (s BatchRevokePermissionsInput) String() string

String returns the string representation

func (*BatchRevokePermissionsInput) Validate Uses

func (s *BatchRevokePermissionsInput) Validate() error

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

type BatchRevokePermissionsOutput Uses

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 Uses

func (s BatchRevokePermissionsOutput) GoString() string

GoString returns the string representation

func (*BatchRevokePermissionsOutput) SetFailures Uses

func (s *BatchRevokePermissionsOutput) SetFailures(v []*BatchPermissionsFailureEntry) *BatchRevokePermissionsOutput

SetFailures sets the Failures field's value.

func (BatchRevokePermissionsOutput) String Uses

func (s BatchRevokePermissionsOutput) String() string

String returns the string representation

type CatalogResource Uses

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

A structure for the catalog object.

func (CatalogResource) GoString Uses

func (s CatalogResource) GoString() string

GoString returns the string representation

func (CatalogResource) String Uses

func (s CatalogResource) String() string

String returns the string representation

type ColumnWildcard Uses

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 Uses

func (s ColumnWildcard) GoString() string

GoString returns the string representation

func (*ColumnWildcard) SetExcludedColumnNames Uses

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

SetExcludedColumnNames sets the ExcludedColumnNames field's value.

func (ColumnWildcard) String Uses

func (s ColumnWildcard) String() string

String returns the string representation

type DataLakePrincipal Uses

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.

func (DataLakePrincipal) GoString Uses

func (s DataLakePrincipal) GoString() string

GoString returns the string representation

func (*DataLakePrincipal) SetDataLakePrincipalIdentifier Uses

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

SetDataLakePrincipalIdentifier sets the DataLakePrincipalIdentifier field's value.

func (DataLakePrincipal) String Uses

func (s DataLakePrincipal) String() string

String returns the string representation

func (*DataLakePrincipal) Validate Uses

func (s *DataLakePrincipal) Validate() error

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

type DataLakeSettings Uses

type DataLakeSettings struct {

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

    // 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.
    DataLakeAdmins []*DataLakePrincipal `type:"list"`
    // contains filtered or unexported fields
}

The AWS Lake Formation principal.

func (DataLakeSettings) GoString Uses

func (s DataLakeSettings) GoString() string

GoString returns the string representation

func (*DataLakeSettings) SetCreateDatabaseDefaultPermissions Uses

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

SetCreateDatabaseDefaultPermissions sets the CreateDatabaseDefaultPermissions field's value.

func (*DataLakeSettings) SetCreateTableDefaultPermissions Uses

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

SetCreateTableDefaultPermissions sets the CreateTableDefaultPermissions field's value.

func (*DataLakeSettings) SetDataLakeAdmins Uses

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

SetDataLakeAdmins sets the DataLakeAdmins field's value.

func (DataLakeSettings) String Uses

func (s DataLakeSettings) String() string

String returns the string representation

func (*DataLakeSettings) Validate Uses

func (s *DataLakeSettings) Validate() error

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

type DataLocationResource Uses

type DataLocationResource struct {

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

func (s DataLocationResource) GoString() string

GoString returns the string representation

func (*DataLocationResource) SetResourceArn Uses

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

SetResourceArn sets the ResourceArn field's value.

func (DataLocationResource) String Uses

func (s DataLocationResource) String() string

String returns the string representation

func (*DataLocationResource) Validate Uses

func (s *DataLocationResource) Validate() error

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

type DatabaseResource Uses

type DatabaseResource struct {

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

func (s DatabaseResource) GoString() string

GoString returns the string representation

func (*DatabaseResource) SetName Uses

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

SetName sets the Name field's value.

func (DatabaseResource) String Uses

func (s DatabaseResource) String() string

String returns the string representation

func (*DatabaseResource) Validate Uses

func (s *DatabaseResource) Validate() error

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

type DeregisterResourceInput Uses

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 Uses

func (s DeregisterResourceInput) GoString() string

GoString returns the string representation

func (*DeregisterResourceInput) SetResourceArn Uses

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

SetResourceArn sets the ResourceArn field's value.

func (DeregisterResourceInput) String Uses

func (s DeregisterResourceInput) String() string

String returns the string representation

func (*DeregisterResourceInput) Validate Uses

func (s *DeregisterResourceInput) Validate() error

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

type DeregisterResourceOutput Uses

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

func (DeregisterResourceOutput) GoString Uses

func (s DeregisterResourceOutput) GoString() string

GoString returns the string representation

func (DeregisterResourceOutput) String Uses

func (s DeregisterResourceOutput) String() string

String returns the string representation

type DescribeResourceInput Uses

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 Uses

func (s DescribeResourceInput) GoString() string

GoString returns the string representation

func (*DescribeResourceInput) SetResourceArn Uses

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

SetResourceArn sets the ResourceArn field's value.

func (DescribeResourceInput) String Uses

func (s DescribeResourceInput) String() string

String returns the string representation

func (*DescribeResourceInput) Validate Uses

func (s *DescribeResourceInput) Validate() error

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

type DescribeResourceOutput Uses

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 Uses

func (s DescribeResourceOutput) GoString() string

GoString returns the string representation

func (*DescribeResourceOutput) SetResourceInfo Uses

func (s *DescribeResourceOutput) SetResourceInfo(v *ResourceInfo) *DescribeResourceOutput

SetResourceInfo sets the ResourceInfo field's value.

func (DescribeResourceOutput) String Uses

func (s DescribeResourceOutput) String() string

String returns the string representation

type ErrorDetail Uses

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 Uses

func (s ErrorDetail) GoString() string

GoString returns the string representation

func (*ErrorDetail) SetErrorCode Uses

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

SetErrorCode sets the ErrorCode field's value.

func (*ErrorDetail) SetErrorMessage Uses

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

SetErrorMessage sets the ErrorMessage field's value.

func (ErrorDetail) String Uses

func (s ErrorDetail) String() string

String returns the string representation

type FilterCondition Uses

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 Uses

func (s FilterCondition) GoString() string

GoString returns the string representation

func (*FilterCondition) SetComparisonOperator Uses

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

SetComparisonOperator sets the ComparisonOperator field's value.

func (*FilterCondition) SetField Uses

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

SetField sets the Field field's value.

func (*FilterCondition) SetStringValueList Uses

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

SetStringValueList sets the StringValueList field's value.

func (FilterCondition) String Uses

func (s FilterCondition) String() string

String returns the string representation

type GetDataLakeSettingsInput Uses

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 Uses

func (s GetDataLakeSettingsInput) GoString() string

GoString returns the string representation

func (*GetDataLakeSettingsInput) SetCatalogId Uses

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

SetCatalogId sets the CatalogId field's value.

func (GetDataLakeSettingsInput) String Uses

func (s GetDataLakeSettingsInput) String() string

String returns the string representation

func (*GetDataLakeSettingsInput) Validate Uses

func (s *GetDataLakeSettingsInput) Validate() error

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

type GetDataLakeSettingsOutput Uses

type GetDataLakeSettingsOutput struct {

    // A list of AWS Lake Formation principals.
    DataLakeSettings *DataLakeSettings `type:"structure"`
    // contains filtered or unexported fields
}

func (GetDataLakeSettingsOutput) GoString Uses

func (s GetDataLakeSettingsOutput) GoString() string

GoString returns the string representation

func (*GetDataLakeSettingsOutput) SetDataLakeSettings Uses

func (s *GetDataLakeSettingsOutput) SetDataLakeSettings(v *DataLakeSettings) *GetDataLakeSettingsOutput

SetDataLakeSettings sets the DataLakeSettings field's value.

func (GetDataLakeSettingsOutput) String Uses

func (s GetDataLakeSettingsOutput) String() string

String returns the string representation

type GetEffectivePermissionsForPathInput Uses

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 Uses

func (s GetEffectivePermissionsForPathInput) GoString() string

GoString returns the string representation

func (*GetEffectivePermissionsForPathInput) SetCatalogId Uses

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

SetCatalogId sets the CatalogId field's value.

func (*GetEffectivePermissionsForPathInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*GetEffectivePermissionsForPathInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetEffectivePermissionsForPathInput) SetResourceArn Uses

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

SetResourceArn sets the ResourceArn field's value.

func (GetEffectivePermissionsForPathInput) String Uses

func (s GetEffectivePermissionsForPathInput) String() string

String returns the string representation

func (*GetEffectivePermissionsForPathInput) Validate Uses

func (s *GetEffectivePermissionsForPathInput) Validate() error

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

type GetEffectivePermissionsForPathOutput Uses

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 Uses

func (s GetEffectivePermissionsForPathOutput) GoString() string

GoString returns the string representation

func (*GetEffectivePermissionsForPathOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetEffectivePermissionsForPathOutput) SetPermissions Uses

func (s *GetEffectivePermissionsForPathOutput) SetPermissions(v []*PrincipalResourcePermissions) *GetEffectivePermissionsForPathOutput

SetPermissions sets the Permissions field's value.

func (GetEffectivePermissionsForPathOutput) String Uses

func (s GetEffectivePermissionsForPathOutput) String() string

String returns the string representation

type GrantPermissionsInput Uses

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 Uses

func (s GrantPermissionsInput) GoString() string

GoString returns the string representation

func (*GrantPermissionsInput) SetCatalogId Uses

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

SetCatalogId sets the CatalogId field's value.

func (*GrantPermissionsInput) SetPermissions Uses

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

SetPermissions sets the Permissions field's value.

func (*GrantPermissionsInput) SetPermissionsWithGrantOption Uses

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

SetPermissionsWithGrantOption sets the PermissionsWithGrantOption field's value.

func (*GrantPermissionsInput) SetPrincipal Uses

func (s *GrantPermissionsInput) SetPrincipal(v *DataLakePrincipal) *GrantPermissionsInput

SetPrincipal sets the Principal field's value.

func (*GrantPermissionsInput) SetResource Uses

func (s *GrantPermissionsInput) SetResource(v *Resource) *GrantPermissionsInput

SetResource sets the Resource field's value.

func (GrantPermissionsInput) String Uses

func (s GrantPermissionsInput) String() string

String returns the string representation

func (*GrantPermissionsInput) Validate Uses

func (s *GrantPermissionsInput) Validate() error

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

type GrantPermissionsOutput Uses

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

func (GrantPermissionsOutput) GoString Uses

func (s GrantPermissionsOutput) GoString() string

GoString returns the string representation

func (GrantPermissionsOutput) String Uses

func (s GrantPermissionsOutput) String() string

String returns the string representation

type LakeFormation Uses

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 Uses

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:

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

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

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

* ErrCodeOperationTimeoutException "OperationTimeoutException"
The operation timed out.

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

func (*LakeFormation) BatchGrantPermissionsRequest Uses

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 Uses

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 Uses

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

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

* ErrCodeOperationTimeoutException "OperationTimeoutException"
The operation timed out.

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

func (*LakeFormation) BatchRevokePermissionsRequest Uses

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 Uses

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 Uses

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

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

* ErrCodeInternalServiceException "InternalServiceException"
An internal service error occurred.

* ErrCodeOperationTimeoutException "OperationTimeoutException"
The operation timed out.

* ErrCodeEntityNotFoundException "EntityNotFoundException"
A specified entity does not exist

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

func (*LakeFormation) DeregisterResourceRequest Uses

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 Uses

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 Uses

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

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

* ErrCodeInternalServiceException "InternalServiceException"
An internal service error occurred.

* ErrCodeOperationTimeoutException "OperationTimeoutException"
The operation timed out.

* ErrCodeEntityNotFoundException "EntityNotFoundException"
A specified entity does not exist

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

func (*LakeFormation) DescribeResourceRequest Uses

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 Uses

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 Uses

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

GetDataLakeSettings API operation for AWS Lake Formation.

The AWS Lake Formation 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 GetDataLakeSettings for usage and error information.

Returned Error Codes:

* ErrCodeInternalServiceException "InternalServiceException"
An internal service error occurred.

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

* ErrCodeEntityNotFoundException "EntityNotFoundException"
A specified entity does not exist

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

func (*LakeFormation) GetDataLakeSettingsRequest Uses

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 Uses

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 Uses

func (c *LakeFormation) GetEffectivePermissionsForPath(input *GetEffectivePermissionsForPathInput) (*GetEffectivePermissionsForPathOutput, error)

GetEffectivePermissionsForPath API operation for AWS Lake Formation.

Returns the permissions for a specified table or database resource located at a path in 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 GetEffectivePermissionsForPath for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

* ErrCodeEntityNotFoundException "EntityNotFoundException"
A specified entity does not exist

* ErrCodeOperationTimeoutException "OperationTimeoutException"
The operation timed out.

* ErrCodeInternalServiceException "InternalServiceException"
An internal service error occurred.

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

func (*LakeFormation) GetEffectivePermissionsForPathPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

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/michigan/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 Codes:

* ErrCodeConcurrentModificationException "ConcurrentModificationException"
Two processes are trying to modify a resource simultaneously.

* ErrCodeEntityNotFoundException "EntityNotFoundException"
A specified entity does not exist

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

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

func (*LakeFormation) GrantPermissionsRequest Uses

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 Uses

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 Uses

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/michigan/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 Codes:

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

* ErrCodeOperationTimeoutException "OperationTimeoutException"
The operation timed out.

* ErrCodeInternalServiceException "InternalServiceException"
An internal service error occurred.

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

func (*LakeFormation) ListPermissionsPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

* ErrCodeInternalServiceException "InternalServiceException"
An internal service error occurred.

* ErrCodeOperationTimeoutException "OperationTimeoutException"
The operation timed out.

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

func (*LakeFormation) ListResourcesPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

PutDataLakeSettings API operation for AWS Lake Formation.

The AWS Lake Formation 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 PutDataLakeSettings for usage and error information.

Returned Error Codes:

* ErrCodeInternalServiceException "InternalServiceException"
An internal service error occurred.

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

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

func (*LakeFormation) PutDataLakeSettingsRequest Uses

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 Uses

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 Uses

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.

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

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

* ErrCodeInternalServiceException "InternalServiceException"
An internal service error occurred.

* ErrCodeOperationTimeoutException "OperationTimeoutException"
The operation timed out.

* ErrCodeAlreadyExistsException "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 Uses

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 Uses

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 Uses

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

* ErrCodeConcurrentModificationException "ConcurrentModificationException"
Two processes are trying to modify a resource simultaneously.

* ErrCodeEntityNotFoundException "EntityNotFoundException"
A specified entity does not exist

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

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

func (*LakeFormation) RevokePermissionsRequest Uses

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 Uses

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 Uses

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

* ErrCodeInvalidInputException "InvalidInputException"
The input provided was not valid.

* ErrCodeInternalServiceException "InternalServiceException"
An internal service error occurred.

* ErrCodeOperationTimeoutException "OperationTimeoutException"
The operation timed out.

* ErrCodeEntityNotFoundException "EntityNotFoundException"
A specified entity does not exist

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

func (*LakeFormation) UpdateResourceRequest Uses

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 Uses

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 Uses

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 Uses

func (s ListPermissionsInput) GoString() string

GoString returns the string representation

func (*ListPermissionsInput) SetCatalogId Uses

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

SetCatalogId sets the CatalogId field's value.

func (*ListPermissionsInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListPermissionsInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListPermissionsInput) SetPrincipal Uses

func (s *ListPermissionsInput) SetPrincipal(v *DataLakePrincipal) *ListPermissionsInput

SetPrincipal sets the Principal field's value.

func (*ListPermissionsInput) SetResource Uses

func (s *ListPermissionsInput) SetResource(v *Resource) *ListPermissionsInput

SetResource sets the Resource field's value.

func (*ListPermissionsInput) SetResourceType Uses

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

SetResourceType sets the ResourceType field's value.

func (ListPermissionsInput) String Uses

func (s ListPermissionsInput) String() string

String returns the string representation

func (*ListPermissionsInput) Validate Uses

func (s *ListPermissionsInput) Validate() error

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

type ListPermissionsOutput Uses

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 Uses

func (s ListPermissionsOutput) GoString() string

GoString returns the string representation

func (*ListPermissionsOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListPermissionsOutput) SetPrincipalResourcePermissions Uses

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

SetPrincipalResourcePermissions sets the PrincipalResourcePermissions field's value.

func (ListPermissionsOutput) String Uses

func (s ListPermissionsOutput) String() string

String returns the string representation

type ListResourcesInput Uses

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 Uses

func (s ListResourcesInput) GoString() string

GoString returns the string representation

func (*ListResourcesInput) SetFilterConditionList Uses

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

SetFilterConditionList sets the FilterConditionList field's value.

func (*ListResourcesInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListResourcesInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListResourcesInput) String Uses

func (s ListResourcesInput) String() string

String returns the string representation

func (*ListResourcesInput) Validate Uses

func (s *ListResourcesInput) Validate() error

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

type ListResourcesOutput Uses

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 Uses

func (s ListResourcesOutput) GoString() string

GoString returns the string representation

func (*ListResourcesOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListResourcesOutput) SetResourceInfoList Uses

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

SetResourceInfoList sets the ResourceInfoList field's value.

func (ListResourcesOutput) String Uses

func (s ListResourcesOutput) String() string

String returns the string representation

type PrincipalPermissions Uses

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 Uses

func (s PrincipalPermissions) GoString() string

GoString returns the string representation

func (*PrincipalPermissions) SetPermissions Uses

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

SetPermissions sets the Permissions field's value.

func (*PrincipalPermissions) SetPrincipal Uses

func (s *PrincipalPermissions) SetPrincipal(v *DataLakePrincipal) *PrincipalPermissions

SetPrincipal sets the Principal field's value.

func (PrincipalPermissions) String Uses

func (s PrincipalPermissions) String() string

String returns the string representation

func (*PrincipalPermissions) Validate Uses

func (s *PrincipalPermissions) Validate() error

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

type PrincipalResourcePermissions Uses

type PrincipalResourcePermissions struct {

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

func (s PrincipalResourcePermissions) GoString() string

GoString returns the string representation

func (*PrincipalResourcePermissions) SetPermissions Uses

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

SetPermissions sets the Permissions field's value.

func (*PrincipalResourcePermissions) SetPermissionsWithGrantOption Uses

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

SetPermissionsWithGrantOption sets the PermissionsWithGrantOption field's value.

func (*PrincipalResourcePermissions) SetPrincipal Uses

func (s *PrincipalResourcePermissions) SetPrincipal(v *DataLakePrincipal) *PrincipalResourcePermissions

SetPrincipal sets the Principal field's value.

func (*PrincipalResourcePermissions) SetResource Uses

func (s *PrincipalResourcePermissions) SetResource(v *Resource) *PrincipalResourcePermissions

SetResource sets the Resource field's value.

func (PrincipalResourcePermissions) String Uses

func (s PrincipalResourcePermissions) String() string

String returns the string representation

type PutDataLakeSettingsInput Uses

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 list of AWS Lake Formation principals.
    //
    // DataLakeSettings is a required field
    DataLakeSettings *DataLakeSettings `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (PutDataLakeSettingsInput) GoString Uses

func (s PutDataLakeSettingsInput) GoString() string

GoString returns the string representation

func (*PutDataLakeSettingsInput) SetCatalogId Uses

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

SetCatalogId sets the CatalogId field's value.

func (*PutDataLakeSettingsInput) SetDataLakeSettings Uses

func (s *PutDataLakeSettingsInput) SetDataLakeSettings(v *DataLakeSettings) *PutDataLakeSettingsInput

SetDataLakeSettings sets the DataLakeSettings field's value.

func (PutDataLakeSettingsInput) String Uses

func (s PutDataLakeSettingsInput) String() string

String returns the string representation

func (*PutDataLakeSettingsInput) Validate Uses

func (s *PutDataLakeSettingsInput) Validate() error

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

type PutDataLakeSettingsOutput Uses

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

func (PutDataLakeSettingsOutput) GoString Uses

func (s PutDataLakeSettingsOutput) GoString() string

GoString returns the string representation

func (PutDataLakeSettingsOutput) String Uses

func (s PutDataLakeSettingsOutput) String() string

String returns the string representation

type RegisterResourceInput Uses

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.
    RoleArn *string `type:"string"`

    // Designates a trusted caller, an IAM principal, by registering this caller
    // with the Data Catalog.
    UseServiceLinkedRole *bool `type:"boolean"`
    // contains filtered or unexported fields
}

func (RegisterResourceInput) GoString Uses

func (s RegisterResourceInput) GoString() string

GoString returns the string representation

func (*RegisterResourceInput) SetResourceArn Uses

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

SetResourceArn sets the ResourceArn field's value.

func (*RegisterResourceInput) SetRoleArn Uses

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

SetRoleArn sets the RoleArn field's value.

func (*RegisterResourceInput) SetUseServiceLinkedRole Uses

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

SetUseServiceLinkedRole sets the UseServiceLinkedRole field's value.

func (RegisterResourceInput) String Uses

func (s RegisterResourceInput) String() string

String returns the string representation

func (*RegisterResourceInput) Validate Uses

func (s *RegisterResourceInput) Validate() error

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

type RegisterResourceOutput Uses

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

func (RegisterResourceOutput) GoString Uses

func (s RegisterResourceOutput) GoString() string

GoString returns the string representation

func (RegisterResourceOutput) String Uses

func (s RegisterResourceOutput) String() string

String returns the string representation

type Resource Uses

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 Uses

func (s Resource) GoString() string

GoString returns the string representation

func (*Resource) SetCatalog Uses

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

SetCatalog sets the Catalog field's value.

func (*Resource) SetDataLocation Uses

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

SetDataLocation sets the DataLocation field's value.

func (*Resource) SetDatabase Uses

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

SetDatabase sets the Database field's value.

func (*Resource) SetTable Uses

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

SetTable sets the Table field's value.

func (*Resource) SetTableWithColumns Uses

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

SetTableWithColumns sets the TableWithColumns field's value.

func (Resource) String Uses

func (s Resource) String() string

String returns the string representation

func (*Resource) Validate Uses

func (s *Resource) Validate() error

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

type ResourceInfo Uses

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 Uses

func (s ResourceInfo) GoString() string

GoString returns the string representation

func (*ResourceInfo) SetLastModified Uses

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

SetLastModified sets the LastModified field's value.

func (*ResourceInfo) SetResourceArn Uses

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

SetResourceArn sets the ResourceArn field's value.

func (*ResourceInfo) SetRoleArn Uses

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

SetRoleArn sets the RoleArn field's value.

func (ResourceInfo) String Uses

func (s ResourceInfo) String() string

String returns the string representation

type RevokePermissionsInput Uses

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/michigan/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 Uses

func (s RevokePermissionsInput) GoString() string

GoString returns the string representation

func (*RevokePermissionsInput) SetCatalogId Uses

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

SetCatalogId sets the CatalogId field's value.

func (*RevokePermissionsInput) SetPermissions Uses

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

SetPermissions sets the Permissions field's value.

func (*RevokePermissionsInput) SetPermissionsWithGrantOption Uses

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

SetPermissionsWithGrantOption sets the PermissionsWithGrantOption field's value.

func (*RevokePermissionsInput) SetPrincipal Uses

func (s *RevokePermissionsInput) SetPrincipal(v *DataLakePrincipal) *RevokePermissionsInput

SetPrincipal sets the Principal field's value.

func (*RevokePermissionsInput) SetResource Uses

func (s *RevokePermissionsInput) SetResource(v *Resource) *RevokePermissionsInput

SetResource sets the Resource field's value.

func (RevokePermissionsInput) String Uses

func (s RevokePermissionsInput) String() string

String returns the string representation

func (*RevokePermissionsInput) Validate Uses

func (s *RevokePermissionsInput) Validate() error

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

type RevokePermissionsOutput Uses

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

func (RevokePermissionsOutput) GoString Uses

func (s RevokePermissionsOutput) GoString() string

GoString returns the string representation

func (RevokePermissionsOutput) String Uses

func (s RevokePermissionsOutput) String() string

String returns the string representation

type TableResource Uses

type TableResource struct {

    // The name of the database for the table. Unique to a Data Catalog. A database
    // is a set of associated table definitions organized into a logical group.
    // You can Grant and Revoke database privileges to a principal.
    //
    // DatabaseName is a required field
    DatabaseName *string `min:"1" type:"string" required:"true"`

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

func (s TableResource) GoString() string

GoString returns the string representation

func (*TableResource) SetDatabaseName Uses

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

SetDatabaseName sets the DatabaseName field's value.

func (*TableResource) SetName Uses

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

SetName sets the Name field's value.

func (TableResource) String Uses

func (s TableResource) String() string

String returns the string representation

func (*TableResource) Validate Uses

func (s *TableResource) Validate() error

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

type TableWithColumnsResource Uses

type TableWithColumnsResource struct {

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

    // The name of the table resource. A table is a metadata definition that represents
    // your data. You can Grant and Revoke table privileges to a principal.
    Name *string `min:"1" type:"string"`
    // 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 Uses

func (s TableWithColumnsResource) GoString() string

GoString returns the string representation

func (*TableWithColumnsResource) SetColumnNames Uses

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

SetColumnNames sets the ColumnNames field's value.

func (*TableWithColumnsResource) SetColumnWildcard Uses

func (s *TableWithColumnsResource) SetColumnWildcard(v *ColumnWildcard) *TableWithColumnsResource

SetColumnWildcard sets the ColumnWildcard field's value.

func (*TableWithColumnsResource) SetDatabaseName Uses

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

SetDatabaseName sets the DatabaseName field's value.

func (*TableWithColumnsResource) SetName Uses

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

SetName sets the Name field's value.

func (TableWithColumnsResource) String Uses

func (s TableWithColumnsResource) String() string

String returns the string representation

func (*TableWithColumnsResource) Validate Uses

func (s *TableWithColumnsResource) Validate() error

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

type UpdateResourceInput Uses

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 Uses

func (s UpdateResourceInput) GoString() string

GoString returns the string representation

func (*UpdateResourceInput) SetResourceArn Uses

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

SetResourceArn sets the ResourceArn field's value.

func (*UpdateResourceInput) SetRoleArn Uses

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

SetRoleArn sets the RoleArn field's value.

func (UpdateResourceInput) String Uses

func (s UpdateResourceInput) String() string

String returns the string representation

func (*UpdateResourceInput) Validate Uses

func (s *UpdateResourceInput) Validate() error

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

type UpdateResourceOutput Uses

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

func (UpdateResourceOutput) GoString Uses

func (s UpdateResourceOutput) GoString() string

GoString returns the string representation

func (UpdateResourceOutput) String Uses

func (s UpdateResourceOutput) String() string

String returns the string representation

Directories

PathSynopsis
lakeformationifacePackage lakeformationiface provides an interface to enable mocking the AWS Lake Formation service client for testing your code.

Package lakeformation imports 10 packages (graph) and is imported by 6 packages. Updated 2019-08-08. Refresh now. Tools for package owners.