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.SSMContacts.GetContactChannel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List details about a specific contact channel.

Synopsis

data GetContactChannel = GetContactChannel' {
- contactChannelId :: Text
}
newGetContactChannel :: Text -> GetContactChannel
getContactChannel_contactChannelId :: Lens' GetContactChannel Text
data GetContactChannelResponse = GetContactChannelResponse' {
- activationStatus :: Maybe ActivationStatus
- httpStatus :: Int
- contactArn :: Text
- contactChannelArn :: Text
- name :: Text
- type' :: ChannelType
- deliveryAddress :: ContactChannelAddress
}
newGetContactChannelResponse :: Int -> Text -> Text -> Text -> ChannelType -> ContactChannelAddress -> GetContactChannelResponse
getContactChannelResponse_activationStatus :: Lens' GetContactChannelResponse (Maybe ActivationStatus)
getContactChannelResponse_httpStatus :: Lens' GetContactChannelResponse Int
getContactChannelResponse_contactArn :: Lens' GetContactChannelResponse Text
getContactChannelResponse_contactChannelArn :: Lens' GetContactChannelResponse Text
getContactChannelResponse_name :: Lens' GetContactChannelResponse Text
getContactChannelResponse_type :: Lens' GetContactChannelResponse ChannelType
getContactChannelResponse_deliveryAddress :: Lens' GetContactChannelResponse ContactChannelAddress

Creating a Request

data GetContactChannel Source #

See: newGetContactChannel smart constructor.

Constructors

GetContactChannel'
Fields contactChannelId :: Text The Amazon Resource Name (ARN) of the contact channel you want information about.

Instances

Instances details

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

newGetContactChannel Source #

Arguments

:: Text	`GetContactChannel`
-> GetContactChannel

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

GetContactChannel, getContactChannel_contactChannelId - The Amazon Resource Name (ARN) of the contact channel you want information about.

Request Lenses

getContactChannel_contactChannelId :: Lens' GetContactChannel Text Source #

The Amazon Resource Name (ARN) of the contact channel you want information about.

Destructuring the Response

data GetContactChannelResponse Source #

See: newGetContactChannelResponse smart constructor.

Constructors

GetContactChannelResponse'

Fields

activationStatus :: Maybe ActivationStatus
A Boolean value indicating if the contact channel has been activated or not.
httpStatus :: Int
The response's http status code.
contactArn :: Text
The ARN of the contact that the channel belongs to.
contactChannelArn :: Text
The ARN of the contact channel.
name :: Text
The name of the contact channel
type' :: ChannelType
The type of contact channel. The type is SMS, VOICE, or EMAIL.
deliveryAddress :: ContactChannelAddress
The details that Incident Manager uses when trying to engage the contact channel.

Instances

Instances details

Generic GetContactChannelResponse Source #
Instance details Defined in Amazonka.SSMContacts.GetContactChannel Associated Types type Rep GetContactChannelResponse :: Type -> Type # Methods from :: GetContactChannelResponse -> Rep GetContactChannelResponse x # to :: Rep GetContactChannelResponse x -> GetContactChannelResponse #
Read GetContactChannelResponse Source #
Instance details Defined in Amazonka.SSMContacts.GetContactChannel Methods readsPrec :: Int -> ReadS GetContactChannelResponse # readList :: ReadS [GetContactChannelResponse] # readPrec :: ReadPrec GetContactChannelResponse # readListPrec :: ReadPrec [GetContactChannelResponse] #
Show GetContactChannelResponse Source #
Instance details Defined in Amazonka.SSMContacts.GetContactChannel Methods showsPrec :: Int -> GetContactChannelResponse -> ShowS # show :: GetContactChannelResponse -> String # showList :: [GetContactChannelResponse] -> ShowS #
NFData GetContactChannelResponse Source #
Instance details Defined in Amazonka.SSMContacts.GetContactChannel Methods rnf :: GetContactChannelResponse -> () #
Eq GetContactChannelResponse Source #
Instance details Defined in Amazonka.SSMContacts.GetContactChannel Methods (==) :: GetContactChannelResponse -> GetContactChannelResponse -> Bool # (/=) :: GetContactChannelResponse -> GetContactChannelResponse -> Bool #
type Rep GetContactChannelResponse Source #
Instance details Defined in Amazonka.SSMContacts.GetContactChannel type Rep GetContactChannelResponse = D1 ('MetaData "GetContactChannelResponse" "Amazonka.SSMContacts.GetContactChannel" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "GetContactChannelResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "activationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivationStatus)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "contactArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "contactChannelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChannelType) :: S1 ('MetaSel ('Just "deliveryAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContactChannelAddress)))))

newGetContactChannelResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetContactChannelResponse'`
-> Text	`GetContactChannelResponse`
-> Text	`GetContactChannelResponse`
-> Text	`GetContactChannelResponse`
-> ChannelType	`GetContactChannelResponse`
-> ContactChannelAddress	`GetContactChannelResponse`
-> GetContactChannelResponse

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

GetContactChannelResponse, getContactChannelResponse_activationStatus - A Boolean value indicating if the contact channel has been activated or not.

$sel:httpStatus:GetContactChannelResponse', getContactChannelResponse_httpStatus - The response's http status code.

GetContactChannelResponse, getContactChannelResponse_contactArn - The ARN of the contact that the channel belongs to.

GetContactChannelResponse, getContactChannelResponse_contactChannelArn - The ARN of the contact channel.

GetContactChannelResponse, getContactChannelResponse_name - The name of the contact channel

GetContactChannelResponse, getContactChannelResponse_type - The type of contact channel. The type is SMS, VOICE, or EMAIL.

GetContactChannelResponse, getContactChannelResponse_deliveryAddress - The details that Incident Manager uses when trying to engage the contact channel.

Response Lenses

getContactChannelResponse_activationStatus :: Lens' GetContactChannelResponse (Maybe ActivationStatus) Source #

A Boolean value indicating if the contact channel has been activated or not.

getContactChannelResponse_httpStatus :: Lens' GetContactChannelResponse Int Source #

The response's http status code.

getContactChannelResponse_contactArn :: Lens' GetContactChannelResponse Text Source #

The ARN of the contact that the channel belongs to.

getContactChannelResponse_contactChannelArn :: Lens' GetContactChannelResponse Text Source #

The ARN of the contact channel.

getContactChannelResponse_name :: Lens' GetContactChannelResponse Text Source #

The name of the contact channel

getContactChannelResponse_type :: Lens' GetContactChannelResponse ChannelType Source #

The type of contact channel. The type is SMS, VOICE, or EMAIL.

getContactChannelResponse_deliveryAddress :: Lens' GetContactChannelResponse ContactChannelAddress Source #

The details that Incident Manager uses when trying to engage the contact channel.