Class: Aws::Glue::Types::GetDatabasesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

Note:

When making an API call, you may pass GetDatabasesRequest data as a hash:

{
  catalog_id: "CatalogIdString",
  next_token: "Token",
  max_results: 1,
  resource_share_type: "FOREIGN", # accepts FOREIGN, ALL
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

The ID of the Data Catalog from which to retrieve Databases. If none is provided, the AWS account ID is used by default.

Returns:

  • (String)


6151
6152
6153
6154
6155
6156
6157
6158
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 6151

class GetDatabasesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :max_results,
  :resource_share_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of databases to return in one response.

Returns:

  • (Integer)


6151
6152
6153
6154
6155
6156
6157
6158
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 6151

class GetDatabasesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :max_results,
  :resource_share_type)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

A continuation token, if this is a continuation call.

Returns:

  • (String)


6151
6152
6153
6154
6155
6156
6157
6158
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 6151

class GetDatabasesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :max_results,
  :resource_share_type)
  SENSITIVE = []
  include Aws::Structure
end

#resource_share_typeString

Allows you to specify that you want to list the databases shared with your account. The allowable values are FOREIGN or ALL.

  • If set to FOREIGN, will list the databases shared with your account.

  • If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

Returns:

  • (String)


6151
6152
6153
6154
6155
6156
6157
6158
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 6151

class GetDatabasesRequest < Struct.new(
  :catalog_id,
  :next_token,
  :max_results,
  :resource_share_type)
  SENSITIVE = []
  include Aws::Structure
end