amazonka-glue-2.0: Amazon Glue SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Glue.GetConnection

Description

Retrieves a connection definition from the Data Catalog.

Synopsis

Creating a Request

data GetConnection Source #

See: newGetConnection smart constructor.

Constructors

GetConnection' 

Fields

  • catalogId :: Maybe Text

    The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.

  • 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.

  • name :: Text

    The name of the connection definition to retrieve.

Instances

Instances details
ToJSON GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

toJSON :: GetConnection -> Value #

toEncoding :: GetConnection -> Encoding #

toJSONList :: [GetConnection] -> Value #

toEncodingList :: [GetConnection] -> Encoding #

ToHeaders GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

toHeaders :: GetConnection -> [Header] #

ToPath GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

toPath :: GetConnection -> ByteString #

ToQuery GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

toQuery :: GetConnection -> QueryString #

AWSRequest GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Associated Types

type AWSResponse GetConnection #

Methods

request :: (Service -> Service) -> GetConnection -> Request GetConnection #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetConnection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetConnection))) #

Generic GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Associated Types

type Rep GetConnection :: Type -> Type #

Methods

from :: GetConnection -> Rep GetConnection x #

to :: Rep GetConnection x -> GetConnection #

Read GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

readsPrec :: Int -> ReadS GetConnection #

readList :: ReadS [GetConnection] #

readPrec :: ReadPrec GetConnection #

readListPrec :: ReadPrec [GetConnection] #

Show GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

showsPrec :: Int -> GetConnection -> ShowS #

show :: GetConnection -> String #

showList :: [GetConnection] -> ShowS #

NFData GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

rnf :: GetConnection -> () #

Eq GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

(==) :: GetConnection -> GetConnection -> Bool #

(/=) :: GetConnection -> GetConnection -> Bool #

Hashable GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

hashWithSalt :: Int -> GetConnection -> Int #

hash :: GetConnection -> Int #

type AWSResponse GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

type AWSResponse GetConnection = GetConnectionResponse
type Rep GetConnection Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

type Rep GetConnection = D1 ('MetaData "GetConnection" "Amazonka.Glue.GetConnection" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetConnection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "catalogId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "hidePassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetConnection Source #

Arguments

:: Text

GetConnection

-> GetConnection 

Create a value of GetConnection 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:

GetConnection, getConnection_catalogId - The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.

$sel:hidePassword:GetConnection', getConnection_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.

GetConnection, getConnection_name - The name of the connection definition to retrieve.

Request Lenses

getConnection_catalogId :: Lens' GetConnection (Maybe Text) Source #

The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services account ID is used by default.

getConnection_hidePassword :: Lens' GetConnection (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.

getConnection_name :: Lens' GetConnection Text Source #

The name of the connection definition to retrieve.

Destructuring the Response

data GetConnectionResponse Source #

See: newGetConnectionResponse smart constructor.

Constructors

GetConnectionResponse' 

Fields

Instances

Instances details
Generic GetConnectionResponse Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Associated Types

type Rep GetConnectionResponse :: Type -> Type #

Methods

from :: GetConnectionResponse -> Rep GetConnectionResponse x #

to :: Rep GetConnectionResponse x -> GetConnectionResponse #

Read GetConnectionResponse Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

readsPrec :: Int -> ReadS GetConnectionResponse #

readList :: ReadS [GetConnectionResponse] #

readPrec :: ReadPrec GetConnectionResponse #

readListPrec :: ReadPrec [GetConnectionResponse] #

Show GetConnectionResponse Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

showsPrec :: Int -> GetConnectionResponse -> ShowS #

show :: GetConnectionResponse -> String #

showList :: [GetConnectionResponse] -> ShowS #

NFData GetConnectionResponse Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

rnf :: GetConnectionResponse -> () #

Eq GetConnectionResponse Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

Methods

(==) :: GetConnectionResponse -> GetConnectionResponse -> Bool #

(/=) :: GetConnectionResponse -> GetConnectionResponse -> Bool #

type Rep GetConnectionResponse Source # 
Instance details

Defined in Amazonka.Glue.GetConnection

type Rep GetConnectionResponse = D1 ('MetaData "GetConnectionResponse" "Amazonka.Glue.GetConnection" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetConnectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Connection)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetConnectionResponse Source #

Arguments

:: Int

$sel:httpStatus:GetConnectionResponse'

-> GetConnectionResponse 

Create a value of GetConnectionResponse 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:connection:GetConnectionResponse', getConnectionResponse_connection - The requested connection definition.

$sel:httpStatus:GetConnectionResponse', getConnectionResponse_httpStatus - The response's http status code.

Response Lenses

getConnectionResponse_connection :: Lens' GetConnectionResponse (Maybe Connection) Source #

The requested connection definition.

getConnectionResponse_httpStatus :: Lens' GetConnectionResponse Int Source #

The response's http status code.