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.CloudWatchEvents.DescribeConnection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves details about a connection.

Synopsis

Creating a Request

data DescribeConnection Source #

See: newDescribeConnection smart constructor.

Constructors

DescribeConnection'
Fields name :: Text The name of the connection to retrieve.

Instances

Instances details

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

newDescribeConnection Source #

Arguments

:: Text	`DescribeConnection`
-> DescribeConnection

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

DescribeConnection, describeConnection_name - The name of the connection to retrieve.

Request Lenses

describeConnection_name :: Lens' DescribeConnection Text Source #

The name of the connection to retrieve.

Destructuring the Response

data DescribeConnectionResponse Source #

See: newDescribeConnectionResponse smart constructor.

Constructors

DescribeConnectionResponse'

Fields

authParameters :: Maybe ConnectionAuthResponseParameters
The parameters to use for authorization for the connection.
authorizationType :: Maybe ConnectionAuthorizationType
The type of authorization specified for the connection.
connectionArn :: Maybe Text
The ARN of the connection retrieved.
connectionState :: Maybe ConnectionState
The state of the connection retrieved.
creationTime :: Maybe POSIX
A time stamp for the time that the connection was created.
description :: Maybe Text
The description for the connection retrieved.
lastAuthorizedTime :: Maybe POSIX
A time stamp for the time that the connection was last authorized.
lastModifiedTime :: Maybe POSIX
A time stamp for the time that the connection was last modified.
name :: Maybe Text
The name of the connection retrieved.
secretArn :: Maybe Text
The ARN of the secret created from the authorization parameters specified for the connection.
stateReason :: Maybe Text
The reason that the connection is in the current connection state.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeConnectionResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeConnection Associated Types type Rep DescribeConnectionResponse :: Type -> Type # Methods from :: DescribeConnectionResponse -> Rep DescribeConnectionResponse x # to :: Rep DescribeConnectionResponse x -> DescribeConnectionResponse #
Read DescribeConnectionResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeConnection Methods readsPrec :: Int -> ReadS DescribeConnectionResponse # readList :: ReadS [DescribeConnectionResponse] # readPrec :: ReadPrec DescribeConnectionResponse # readListPrec :: ReadPrec [DescribeConnectionResponse] #
Show DescribeConnectionResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeConnection Methods showsPrec :: Int -> DescribeConnectionResponse -> ShowS # show :: DescribeConnectionResponse -> String # showList :: [DescribeConnectionResponse] -> ShowS #
NFData DescribeConnectionResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeConnection Methods rnf :: DescribeConnectionResponse -> () #
Eq DescribeConnectionResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeConnection Methods (==) :: DescribeConnectionResponse -> DescribeConnectionResponse -> Bool # (/=) :: DescribeConnectionResponse -> DescribeConnectionResponse -> Bool #
type Rep DescribeConnectionResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeConnection type Rep DescribeConnectionResponse = D1 ('MetaData "DescribeConnectionResponse" "Amazonka.CloudWatchEvents.DescribeConnection" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "DescribeConnectionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionAuthResponseParameters)) :: (S1 ('MetaSel ('Just "authorizationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionAuthorizationType)) :: S1 ('MetaSel ('Just "connectionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "connectionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionState)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "lastAuthorizedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeConnectionResponse Source #

Arguments

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

Create a value of DescribeConnectionResponse 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:authParameters:DescribeConnectionResponse', describeConnectionResponse_authParameters - The parameters to use for authorization for the connection.

DescribeConnectionResponse, describeConnectionResponse_authorizationType - The type of authorization specified for the connection.

DescribeConnectionResponse, describeConnectionResponse_connectionArn - The ARN of the connection retrieved.

DescribeConnectionResponse, describeConnectionResponse_connectionState - The state of the connection retrieved.

DescribeConnectionResponse, describeConnectionResponse_creationTime - A time stamp for the time that the connection was created.

DescribeConnectionResponse, describeConnectionResponse_description - The description for the connection retrieved.

DescribeConnectionResponse, describeConnectionResponse_lastAuthorizedTime - A time stamp for the time that the connection was last authorized.

DescribeConnectionResponse, describeConnectionResponse_lastModifiedTime - A time stamp for the time that the connection was last modified.

DescribeConnection, describeConnectionResponse_name - The name of the connection retrieved.

$sel:secretArn:DescribeConnectionResponse', describeConnectionResponse_secretArn - The ARN of the secret created from the authorization parameters specified for the connection.

DescribeConnectionResponse, describeConnectionResponse_stateReason - The reason that the connection is in the current connection state.

$sel:httpStatus:DescribeConnectionResponse', describeConnectionResponse_httpStatus - The response's http status code.

Response Lenses

describeConnectionResponse_authParameters :: Lens' DescribeConnectionResponse (Maybe ConnectionAuthResponseParameters) Source #

The parameters to use for authorization for the connection.

describeConnectionResponse_authorizationType :: Lens' DescribeConnectionResponse (Maybe ConnectionAuthorizationType) Source #

The type of authorization specified for the connection.

describeConnectionResponse_connectionArn :: Lens' DescribeConnectionResponse (Maybe Text) Source #

The ARN of the connection retrieved.

describeConnectionResponse_connectionState :: Lens' DescribeConnectionResponse (Maybe ConnectionState) Source #

The state of the connection retrieved.

describeConnectionResponse_creationTime :: Lens' DescribeConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was created.

describeConnectionResponse_description :: Lens' DescribeConnectionResponse (Maybe Text) Source #

The description for the connection retrieved.

describeConnectionResponse_lastAuthorizedTime :: Lens' DescribeConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was last authorized.

describeConnectionResponse_lastModifiedTime :: Lens' DescribeConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was last modified.

describeConnectionResponse_name :: Lens' DescribeConnectionResponse (Maybe Text) Source #

The name of the connection retrieved.

describeConnectionResponse_secretArn :: Lens' DescribeConnectionResponse (Maybe Text) Source #

The ARN of the secret created from the authorization parameters specified for the connection.

describeConnectionResponse_stateReason :: Lens' DescribeConnectionResponse (Maybe Text) Source #

The reason that the connection is in the current connection state.

describeConnectionResponse_httpStatus :: Lens' DescribeConnectionResponse Int Source #

The response's http status code.