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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists details of the engagement to a contact channel.

Synopsis

data DescribePage = DescribePage' {
- pageId :: Text
}
newDescribePage :: Text -> DescribePage
describePage_pageId :: Lens' DescribePage Text
data DescribePageResponse = DescribePageResponse' {
- readTime :: Maybe POSIX
- publicSubject :: Maybe Text
- publicContent :: Maybe Text
- deliveryTime :: Maybe POSIX
- incidentId :: Maybe Text
- sentTime :: Maybe POSIX
- httpStatus :: Int
- pageArn :: Text
- engagementArn :: Text
- contactArn :: Text
- sender :: Text
- subject :: Text
- content :: Text
}
newDescribePageResponse :: Int -> Text -> Text -> Text -> Text -> Text -> Text -> DescribePageResponse
describePageResponse_readTime :: Lens' DescribePageResponse (Maybe UTCTime)
describePageResponse_publicSubject :: Lens' DescribePageResponse (Maybe Text)
describePageResponse_publicContent :: Lens' DescribePageResponse (Maybe Text)
describePageResponse_deliveryTime :: Lens' DescribePageResponse (Maybe UTCTime)
describePageResponse_incidentId :: Lens' DescribePageResponse (Maybe Text)
describePageResponse_sentTime :: Lens' DescribePageResponse (Maybe UTCTime)
describePageResponse_httpStatus :: Lens' DescribePageResponse Int
describePageResponse_pageArn :: Lens' DescribePageResponse Text
describePageResponse_engagementArn :: Lens' DescribePageResponse Text
describePageResponse_contactArn :: Lens' DescribePageResponse Text
describePageResponse_sender :: Lens' DescribePageResponse Text
describePageResponse_subject :: Lens' DescribePageResponse Text
describePageResponse_content :: Lens' DescribePageResponse Text

Creating a Request

data DescribePage Source #

See: newDescribePage smart constructor.

Constructors

DescribePage'
Fields pageId :: Text The ID of the engagement to a contact channel.

Instances

Instances details

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

newDescribePage Source #

Arguments

:: Text	`$sel:pageId:DescribePage'`
-> DescribePage

Create a value of DescribePage 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:pageId:DescribePage', describePage_pageId - The ID of the engagement to a contact channel.

Request Lenses

describePage_pageId :: Lens' DescribePage Text Source #

The ID of the engagement to a contact channel.

Destructuring the Response

data DescribePageResponse Source #

See: newDescribePageResponse smart constructor.

Constructors

DescribePageResponse'

Fields

readTime :: Maybe POSIX
The time that the contact channel acknowledged the engagement.
publicSubject :: Maybe Text
The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.
publicContent :: Maybe Text
The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.
deliveryTime :: Maybe POSIX
The time that the contact channel received the engagement.
incidentId :: Maybe Text
The ARN of the incident that engaged the contact channel.
sentTime :: Maybe POSIX
The time the engagement was sent to the contact channel.
httpStatus :: Int
The response's http status code.
pageArn :: Text
The Amazon Resource Name (ARN) of the engagement to a contact channel.
engagementArn :: Text
The ARN of the engagement that engaged the contact channel.
contactArn :: Text
The ARN of the contact that was engaged.
sender :: Text
The user that started the engagement.
subject :: Text
The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.
content :: Text
The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

Instances

Instances details

Eq DescribePageResponse Source #
Instance details Defined in Amazonka.SSMContacts.DescribePage Methods (==) :: DescribePageResponse -> DescribePageResponse -> Bool # (/=) :: DescribePageResponse -> DescribePageResponse -> Bool #
Read DescribePageResponse Source #
Instance details Defined in Amazonka.SSMContacts.DescribePage Methods readsPrec :: Int -> ReadS DescribePageResponse # readList :: ReadS [DescribePageResponse] # readPrec :: ReadPrec DescribePageResponse # readListPrec :: ReadPrec [DescribePageResponse] #
Show DescribePageResponse Source #
Instance details Defined in Amazonka.SSMContacts.DescribePage Methods showsPrec :: Int -> DescribePageResponse -> ShowS # show :: DescribePageResponse -> String # showList :: [DescribePageResponse] -> ShowS #
Generic DescribePageResponse Source #
Instance details Defined in Amazonka.SSMContacts.DescribePage Associated Types type Rep DescribePageResponse :: Type -> Type # Methods from :: DescribePageResponse -> Rep DescribePageResponse x # to :: Rep DescribePageResponse x -> DescribePageResponse #
NFData DescribePageResponse Source #
Instance details Defined in Amazonka.SSMContacts.DescribePage Methods rnf :: DescribePageResponse -> () #
type Rep DescribePageResponse Source #
Instance details Defined in Amazonka.SSMContacts.DescribePage type Rep DescribePageResponse = D1 ('MetaData "DescribePageResponse" "Amazonka.SSMContacts.DescribePage" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "DescribePageResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "readTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "publicSubject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "publicContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "deliveryTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "incidentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sentTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "pageArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "engagementArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "contactArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sender") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDescribePageResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribePageResponse'`
-> Text	`$sel:pageArn:DescribePageResponse'`
-> Text	`$sel:engagementArn:DescribePageResponse'`
-> Text	`$sel:contactArn:DescribePageResponse'`
-> Text	`$sel:sender:DescribePageResponse'`
-> Text	`$sel:subject:DescribePageResponse'`
-> Text	`$sel:content:DescribePageResponse'`
-> DescribePageResponse

Create a value of DescribePageResponse 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:readTime:DescribePageResponse', describePageResponse_readTime - The time that the contact channel acknowledged the engagement.

$sel:publicSubject:DescribePageResponse', describePageResponse_publicSubject - The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

$sel:publicContent:DescribePageResponse', describePageResponse_publicContent - The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

$sel:deliveryTime:DescribePageResponse', describePageResponse_deliveryTime - The time that the contact channel received the engagement.

$sel:incidentId:DescribePageResponse', describePageResponse_incidentId - The ARN of the incident that engaged the contact channel.

$sel:sentTime:DescribePageResponse', describePageResponse_sentTime - The time the engagement was sent to the contact channel.

$sel:httpStatus:DescribePageResponse', describePageResponse_httpStatus - The response's http status code.

$sel:pageArn:DescribePageResponse', describePageResponse_pageArn - The Amazon Resource Name (ARN) of the engagement to a contact channel.

$sel:engagementArn:DescribePageResponse', describePageResponse_engagementArn - The ARN of the engagement that engaged the contact channel.

$sel:contactArn:DescribePageResponse', describePageResponse_contactArn - The ARN of the contact that was engaged.

$sel:sender:DescribePageResponse', describePageResponse_sender - The user that started the engagement.

$sel:subject:DescribePageResponse', describePageResponse_subject - The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

$sel:content:DescribePageResponse', describePageResponse_content - The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.