Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Glue.GetConnections

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list of connection definitions from the Data Catalog.

This operation returns paginated results.

Synopsis

data GetConnections = GetConnections' {
- catalogId :: Maybe Text
- filter' :: Maybe GetConnectionsFilter
- hidePassword :: Maybe Bool
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newGetConnections :: GetConnections
getConnections_catalogId :: Lens' GetConnections (Maybe Text)
getConnections_filter :: Lens' GetConnections (Maybe GetConnectionsFilter)
getConnections_hidePassword :: Lens' GetConnections (Maybe Bool)
getConnections_maxResults :: Lens' GetConnections (Maybe Natural)
getConnections_nextToken :: Lens' GetConnections (Maybe Text)
data GetConnectionsResponse = GetConnectionsResponse' {
- connectionList :: Maybe [Connection]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetConnectionsResponse :: Int -> GetConnectionsResponse
getConnectionsResponse_connectionList :: Lens' GetConnectionsResponse (Maybe [Connection])
getConnectionsResponse_nextToken :: Lens' GetConnectionsResponse (Maybe Text)
getConnectionsResponse_httpStatus :: Lens' GetConnectionsResponse Int

Creating a Request

data GetConnections Source #

See: newGetConnections smart constructor.

Constructors

GetConnections'

Fields

catalogId :: Maybe Text
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.
filter' :: Maybe GetConnectionsFilter
A filter that controls which connections are returned.
hidePassword :: Maybe Bool
Allows you to retrieve the connection metadata without returning the password. For instance, the 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.
maxResults :: Maybe Natural
The maximum number of connections to return in one response.
nextToken :: Maybe Text
A continuation token, if this is a continuation call.

Instances

Instances details

ToJSON GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods toJSON :: GetConnections -> Value # toEncoding :: GetConnections -> Encoding # toJSONList :: [GetConnections] -> Value # toEncodingList :: [GetConnections] -> Encoding #
ToHeaders GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods toHeaders :: GetConnections -> [Header] #
ToPath GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods toPath :: GetConnections -> ByteString #
ToQuery GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods toQuery :: GetConnections -> QueryString #
AWSPager GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods page :: GetConnections -> AWSResponse GetConnections -> Maybe GetConnections #
AWSRequest GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections Associated Types type AWSResponse GetConnections # Methods request :: (Service -> Service) -> GetConnections -> Request GetConnections # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetConnections -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetConnections))) #
Generic GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections Associated Types type Rep GetConnections :: Type -> Type # Methods from :: GetConnections -> Rep GetConnections x # to :: Rep GetConnections x -> GetConnections #
Read GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods readsPrec :: Int -> ReadS GetConnections # readList :: ReadS [GetConnections] # readPrec :: ReadPrec GetConnections # readListPrec :: ReadPrec [GetConnections] #
Show GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods showsPrec :: Int -> GetConnections -> ShowS # show :: GetConnections -> String # showList :: [GetConnections] -> ShowS #
NFData GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods rnf :: GetConnections -> () #
Eq GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods (==) :: GetConnections -> GetConnections -> Bool # (/=) :: GetConnections -> GetConnections -> Bool #
Hashable GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods hashWithSalt :: Int -> GetConnections -> Int # hash :: GetConnections -> Int #
type AWSResponse GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections type AWSResponse GetConnections = GetConnectionsResponse
type Rep GetConnections Source #
Instance details Defined in Amazonka.Glue.GetConnections type Rep GetConnections = D1 ('MetaData "GetConnections" "Amazonka.Glue.GetConnections" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetConnections'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "catalogId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GetConnectionsFilter))) :: (S1 ('MetaSel ('Just "hidePassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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:

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.

GetConnections, getConnections_filter - A filter that controls which connections are returned.

$sel:hidePassword:GetConnections', getConnections_hidePassword - Allows you to retrieve the connection metadata without returning the password. For instance, the 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:maxResults:GetConnections', getConnections_maxResults - The maximum number of connections to return in one response.

GetConnections, getConnections_nextToken - A continuation token, if this is a continuation call.

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_filter :: Lens' GetConnections (Maybe GetConnectionsFilter) Source #

A filter that controls which connections are returned.

getConnections_hidePassword :: Lens' GetConnections (Maybe Bool) Source #

Allows you to retrieve the connection metadata without returning the password. For instance, the 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_maxResults :: Lens' GetConnections (Maybe Natural) Source #

The maximum number of connections to return in one response.

getConnections_nextToken :: Lens' GetConnections (Maybe Text) Source #

A continuation token, if this is a continuation call.

Destructuring the Response

data GetConnectionsResponse Source #

See: newGetConnectionsResponse smart constructor.

Constructors

GetConnectionsResponse'
Fields connectionList :: Maybe [Connection] A list of requested connection definitions. nextToken :: Maybe Text A continuation token, if the list of connections returned does not include the last of the filtered connections. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetConnectionsResponse Source #
Instance details Defined in Amazonka.Glue.GetConnections Associated Types type Rep GetConnectionsResponse :: Type -> Type # Methods from :: GetConnectionsResponse -> Rep GetConnectionsResponse x # to :: Rep GetConnectionsResponse x -> GetConnectionsResponse #
Read GetConnectionsResponse Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods readsPrec :: Int -> ReadS GetConnectionsResponse # readList :: ReadS [GetConnectionsResponse] # readPrec :: ReadPrec GetConnectionsResponse # readListPrec :: ReadPrec [GetConnectionsResponse] #
Show GetConnectionsResponse Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods showsPrec :: Int -> GetConnectionsResponse -> ShowS # show :: GetConnectionsResponse -> String # showList :: [GetConnectionsResponse] -> ShowS #
NFData GetConnectionsResponse Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods rnf :: GetConnectionsResponse -> () #
Eq GetConnectionsResponse Source #
Instance details Defined in Amazonka.Glue.GetConnections Methods (==) :: GetConnectionsResponse -> GetConnectionsResponse -> Bool # (/=) :: GetConnectionsResponse -> GetConnectionsResponse -> Bool #
type Rep GetConnectionsResponse Source #
Instance details Defined in Amazonka.Glue.GetConnections type Rep GetConnectionsResponse = D1 ('MetaData "GetConnectionsResponse" "Amazonka.Glue.GetConnections" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetConnectionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectionList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Connection])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetConnectionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetConnectionsResponse'`
-> GetConnectionsResponse

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:connectionList:GetConnectionsResponse', getConnectionsResponse_connectionList - A list of requested connection definitions.

GetConnections, getConnectionsResponse_nextToken - A continuation token, if the list of connections returned does not include the last of the filtered connections.

$sel:httpStatus:GetConnectionsResponse', getConnectionsResponse_httpStatus - The response's http status code.

Response Lenses

getConnectionsResponse_connectionList :: Lens' GetConnectionsResponse (Maybe [Connection]) Source #

A list of requested connection definitions.

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_httpStatus :: Lens' GetConnectionsResponse Int Source #

The response's http status code.