You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Glue::Types::GetConnectionsRequest

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 GetConnectionsRequest data as a hash:

{
  catalog_id: "CatalogIdString",
  filter: {
    match_criteria: ["NameString"],
    connection_type: "JDBC", # accepts JDBC, SFTP
  },
  hide_password: false,
  next_token: "Token",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default.

Returns:

  • (String)


3632
3633
3634
3635
3636
3637
3638
3639
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3632

class GetConnectionsRequest < Struct.new(
  :catalog_id,
  :filter,
  :hide_password,
  :next_token,
  :max_results)
  include Aws::Structure
end

#filterTypes::GetConnectionsFilter

A filter that controls which connections will be returned.



3632
3633
3634
3635
3636
3637
3638
3639
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3632

class GetConnectionsRequest < Struct.new(
  :catalog_id,
  :filter,
  :hide_password,
  :next_token,
  :max_results)
  include Aws::Structure
end

#hide_passwordBoolean

Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but does have permission to access the rest of the connection properties.

Returns:

  • (Boolean)


3632
3633
3634
3635
3636
3637
3638
3639
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3632

class GetConnectionsRequest < Struct.new(
  :catalog_id,
  :filter,
  :hide_password,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of connections to return in one response.

Returns:

  • (Integer)


3632
3633
3634
3635
3636
3637
3638
3639
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3632

class GetConnectionsRequest < Struct.new(
  :catalog_id,
  :filter,
  :hide_password,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

A continuation token, if this is a continuation call.

Returns:

  • (String)


3632
3633
3634
3635
3636
3637
3638
3639
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3632

class GetConnectionsRequest < Struct.new(
  :catalog_id,
  :filter,
  :hide_password,
  :next_token,
  :max_results)
  include Aws::Structure
end