| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Glue.GetConnections
Description
Retrieves a list of connection definitions from the Data Catalog.
This operation returns paginated results.
Synopsis
- data GetConnections = GetConnections' {}
- newGetConnections :: GetConnections
- getConnections_catalogId :: Lens' GetConnections (Maybe Text)
- getConnections_nextToken :: Lens' GetConnections (Maybe Text)
- getConnections_hidePassword :: Lens' GetConnections (Maybe Bool)
- getConnections_filter :: Lens' GetConnections (Maybe GetConnectionsFilter)
- getConnections_maxResults :: Lens' GetConnections (Maybe Natural)
- data GetConnectionsResponse = GetConnectionsResponse' {
- nextToken :: Maybe Text
- connectionList :: Maybe [Connection]
- httpStatus :: Int
- newGetConnectionsResponse :: Int -> GetConnectionsResponse
- getConnectionsResponse_nextToken :: Lens' GetConnectionsResponse (Maybe Text)
- getConnectionsResponse_connectionList :: Lens' GetConnectionsResponse (Maybe [Connection])
- getConnectionsResponse_httpStatus :: Lens' GetConnectionsResponse Int
Creating a Request
data GetConnections Source #
See: newGetConnections smart constructor.
Constructors
| GetConnections' | |
Fields
| |
Instances
newGetConnections :: GetConnections Source #
Create a value of GetConnections with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:catalogId:GetConnections', getConnections_catalogId - The ID of the Data Catalog in which the connections reside. If none is
provided, the Amazon Web Services account ID is used by default.
$sel:nextToken:GetConnections', getConnections_nextToken - A continuation token, if this is a continuation call.
$sel:hidePassword:GetConnections', getConnections_hidePassword - 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 KMS key to decrypt
the password, but it does have permission to access the rest of the
connection properties.
$sel:filter':GetConnections', getConnections_filter - A filter that controls which connections are returned.
$sel:maxResults:GetConnections', getConnections_maxResults - The maximum number of connections to return in one response.
Request Lenses
getConnections_catalogId :: Lens' GetConnections (Maybe Text) Source #
The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.
getConnections_nextToken :: Lens' GetConnections (Maybe Text) Source #
A continuation token, if this is a continuation call.
getConnections_hidePassword :: Lens' GetConnections (Maybe Bool) Source #
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 KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
getConnections_filter :: Lens' GetConnections (Maybe GetConnectionsFilter) Source #
A filter that controls which connections are returned.
getConnections_maxResults :: Lens' GetConnections (Maybe Natural) Source #
The maximum number of connections to return in one response.
Destructuring the Response
data GetConnectionsResponse Source #
See: newGetConnectionsResponse smart constructor.
Constructors
| GetConnectionsResponse' | |
Fields
| |
Instances
newGetConnectionsResponse Source #
Create a value of GetConnectionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetConnections', getConnectionsResponse_nextToken - A continuation token, if the list of connections returned does not
include the last of the filtered connections.
$sel:connectionList:GetConnectionsResponse', getConnectionsResponse_connectionList - A list of requested connection definitions.
$sel:httpStatus:GetConnectionsResponse', getConnectionsResponse_httpStatus - The response's http status code.
Response Lenses
getConnectionsResponse_nextToken :: Lens' GetConnectionsResponse (Maybe Text) Source #
A continuation token, if the list of connections returned does not include the last of the filtered connections.
getConnectionsResponse_connectionList :: Lens' GetConnectionsResponse (Maybe [Connection]) Source #
A list of requested connection definitions.
getConnectionsResponse_httpStatus :: Lens' GetConnectionsResponse Int Source #
The response's http status code.