-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Amazon WorkMail Message Flow SDK. -- -- Derived from API version 2019-05-01 of the AWS service -- descriptions, licensed under Apache 2.0. -- -- The types from this library are intended to be used with -- amazonka, which provides mechanisms for specifying AuthN/AuthZ -- information, sending requests, and receiving responses. -- -- It is recommended to use generic lenses or optics from packages such -- as generic-lens or optics to modify optional fields and -- deconstruct responses. -- -- Generated lenses can be found in -- Amazonka.WorkMailMessageFlow.Lens and are suitable for use with -- a lens package such as lens or lens-family-core. -- -- See Amazonka.WorkMailMessageFlow and the AWS -- documentation to get started. @package amazonka-workmailmessageflow @version 2.0 module Amazonka.WorkMailMessageFlow.Types.S3Reference -- | Amazon S3 object representing the updated message content, in MIME -- format. -- -- The region for the S3 bucket containing the S3 object must match the -- region used for WorkMail operations. Also, for WorkMail to process an -- S3 object, it must have permission to access that object. For more -- information, see Updating message content with AWS Lambda. -- -- See: newS3Reference smart constructor. data S3Reference S3Reference' :: Maybe Text -> Text -> Text -> S3Reference -- | If you enable versioning for the bucket, you can specify the object -- version. [$sel:objectVersion:S3Reference'] :: S3Reference -> Maybe Text -- | The S3 bucket name. [$sel:bucket:S3Reference'] :: S3Reference -> Text -- | The S3 key object name. [$sel:key:S3Reference'] :: S3Reference -> Text -- | Create a value of S3Reference 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:objectVersion:S3Reference', -- s3Reference_objectVersion - If you enable versioning for the -- bucket, you can specify the object version. -- -- $sel:bucket:S3Reference', s3Reference_bucket - The S3 -- bucket name. -- -- $sel:key:S3Reference', s3Reference_key - The S3 key -- object name. newS3Reference :: Text -> Text -> S3Reference -- | If you enable versioning for the bucket, you can specify the object -- version. s3Reference_objectVersion :: Lens' S3Reference (Maybe Text) -- | The S3 bucket name. s3Reference_bucket :: Lens' S3Reference Text -- | The S3 key object name. s3Reference_key :: Lens' S3Reference Text instance GHC.Generics.Generic Amazonka.WorkMailMessageFlow.Types.S3Reference.S3Reference instance GHC.Show.Show Amazonka.WorkMailMessageFlow.Types.S3Reference.S3Reference instance GHC.Read.Read Amazonka.WorkMailMessageFlow.Types.S3Reference.S3Reference instance GHC.Classes.Eq Amazonka.WorkMailMessageFlow.Types.S3Reference.S3Reference instance Data.Hashable.Class.Hashable Amazonka.WorkMailMessageFlow.Types.S3Reference.S3Reference instance Control.DeepSeq.NFData Amazonka.WorkMailMessageFlow.Types.S3Reference.S3Reference instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkMailMessageFlow.Types.S3Reference.S3Reference module Amazonka.WorkMailMessageFlow.Types.RawMessageContent -- | Provides the MIME content of the updated email message as an S3 -- object. All MIME content must meet the following criteria: -- -- -- -- See: newRawMessageContent smart constructor. data RawMessageContent RawMessageContent' :: S3Reference -> RawMessageContent -- | The S3 reference of an email message. [$sel:s3Reference:RawMessageContent'] :: RawMessageContent -> S3Reference -- | Create a value of RawMessageContent 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:s3Reference:RawMessageContent', -- rawMessageContent_s3Reference - The S3 reference of an email -- message. newRawMessageContent :: S3Reference -> RawMessageContent -- | The S3 reference of an email message. rawMessageContent_s3Reference :: Lens' RawMessageContent S3Reference instance GHC.Generics.Generic Amazonka.WorkMailMessageFlow.Types.RawMessageContent.RawMessageContent instance GHC.Show.Show Amazonka.WorkMailMessageFlow.Types.RawMessageContent.RawMessageContent instance GHC.Read.Read Amazonka.WorkMailMessageFlow.Types.RawMessageContent.RawMessageContent instance GHC.Classes.Eq Amazonka.WorkMailMessageFlow.Types.RawMessageContent.RawMessageContent instance Data.Hashable.Class.Hashable Amazonka.WorkMailMessageFlow.Types.RawMessageContent.RawMessageContent instance Control.DeepSeq.NFData Amazonka.WorkMailMessageFlow.Types.RawMessageContent.RawMessageContent instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkMailMessageFlow.Types.RawMessageContent.RawMessageContent module Amazonka.WorkMailMessageFlow.Types -- | API version 2019-05-01 of the Amazon WorkMail Message Flow -- SDK configuration. defaultService :: Service -- | WorkMail could not access the updated email content. Possible reasons: -- -- _InvalidContentLocation :: AsError a => Fold a ServiceError -- | The requested email is not eligible for update. This is usually the -- case for a redirected email. _MessageFrozen :: AsError a => Fold a ServiceError -- | The requested email could not be updated due to an error in the MIME -- content. Check the error message for more information about what -- caused the error. _MessageRejected :: AsError a => Fold a ServiceError -- | The requested email message is not found. _ResourceNotFoundException :: AsError a => Fold a ServiceError -- | Provides the MIME content of the updated email message as an S3 -- object. All MIME content must meet the following criteria: -- -- -- -- See: newRawMessageContent smart constructor. data RawMessageContent RawMessageContent' :: S3Reference -> RawMessageContent -- | The S3 reference of an email message. [$sel:s3Reference:RawMessageContent'] :: RawMessageContent -> S3Reference -- | Create a value of RawMessageContent 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:s3Reference:RawMessageContent', -- rawMessageContent_s3Reference - The S3 reference of an email -- message. newRawMessageContent :: S3Reference -> RawMessageContent -- | The S3 reference of an email message. rawMessageContent_s3Reference :: Lens' RawMessageContent S3Reference -- | Amazon S3 object representing the updated message content, in MIME -- format. -- -- The region for the S3 bucket containing the S3 object must match the -- region used for WorkMail operations. Also, for WorkMail to process an -- S3 object, it must have permission to access that object. For more -- information, see Updating message content with AWS Lambda. -- -- See: newS3Reference smart constructor. data S3Reference S3Reference' :: Maybe Text -> Text -> Text -> S3Reference -- | If you enable versioning for the bucket, you can specify the object -- version. [$sel:objectVersion:S3Reference'] :: S3Reference -> Maybe Text -- | The S3 bucket name. [$sel:bucket:S3Reference'] :: S3Reference -> Text -- | The S3 key object name. [$sel:key:S3Reference'] :: S3Reference -> Text -- | Create a value of S3Reference 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:objectVersion:S3Reference', -- s3Reference_objectVersion - If you enable versioning for the -- bucket, you can specify the object version. -- -- $sel:bucket:S3Reference', s3Reference_bucket - The S3 -- bucket name. -- -- $sel:key:S3Reference', s3Reference_key - The S3 key -- object name. newS3Reference :: Text -> Text -> S3Reference -- | If you enable versioning for the bucket, you can specify the object -- version. s3Reference_objectVersion :: Lens' S3Reference (Maybe Text) -- | The S3 bucket name. s3Reference_bucket :: Lens' S3Reference Text -- | The S3 key object name. s3Reference_key :: Lens' S3Reference Text -- | Updates the raw content of an in-transit email message, in MIME -- format. -- -- This example describes how to update in-transit email message. For -- more information and examples for using this API, see Updating -- message content with AWS Lambda. -- -- Updates to an in-transit message only appear when you call -- PutRawMessageContent from an AWS Lambda function configured -- with a synchronous Run Lambda rule. If you call -- PutRawMessageContent on a delivered or sent message, the -- message remains unchanged, even though GetRawMessageContent -- returns an updated message. module Amazonka.WorkMailMessageFlow.PutRawMessageContent -- | See: newPutRawMessageContent smart constructor. data PutRawMessageContent PutRawMessageContent' :: Text -> RawMessageContent -> PutRawMessageContent -- | The identifier of the email message being updated. [$sel:messageId:PutRawMessageContent'] :: PutRawMessageContent -> Text -- | Describes the raw message content of the updated email message. [$sel:content:PutRawMessageContent'] :: PutRawMessageContent -> RawMessageContent -- | Create a value of PutRawMessageContent 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:messageId:PutRawMessageContent', -- putRawMessageContent_messageId - The identifier of the email -- message being updated. -- -- $sel:content:PutRawMessageContent', -- putRawMessageContent_content - Describes the raw message -- content of the updated email message. newPutRawMessageContent :: Text -> RawMessageContent -> PutRawMessageContent -- | The identifier of the email message being updated. putRawMessageContent_messageId :: Lens' PutRawMessageContent Text -- | Describes the raw message content of the updated email message. putRawMessageContent_content :: Lens' PutRawMessageContent RawMessageContent -- | See: newPutRawMessageContentResponse smart constructor. data PutRawMessageContentResponse PutRawMessageContentResponse' :: Int -> PutRawMessageContentResponse -- | The response's http status code. [$sel:httpStatus:PutRawMessageContentResponse'] :: PutRawMessageContentResponse -> Int -- | Create a value of PutRawMessageContentResponse 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:httpStatus:PutRawMessageContentResponse', -- putRawMessageContentResponse_httpStatus - The response's http -- status code. newPutRawMessageContentResponse :: Int -> PutRawMessageContentResponse -- | The response's http status code. putRawMessageContentResponse_httpStatus :: Lens' PutRawMessageContentResponse Int instance GHC.Generics.Generic Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContent instance GHC.Show.Show Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContent instance GHC.Read.Read Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContent instance GHC.Classes.Eq Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContent instance GHC.Generics.Generic Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContentResponse instance GHC.Show.Show Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContentResponse instance GHC.Read.Read Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContentResponse instance GHC.Classes.Eq Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContentResponse instance Amazonka.Types.AWSRequest Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContent instance Control.DeepSeq.NFData Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContentResponse instance Data.Hashable.Class.Hashable Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContent instance Control.DeepSeq.NFData Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContent instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContent instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContent instance Amazonka.Data.Path.ToPath Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContent instance Amazonka.Data.Query.ToQuery Amazonka.WorkMailMessageFlow.PutRawMessageContent.PutRawMessageContent -- | Retrieves the raw content of an in-transit email message, in MIME -- format. module Amazonka.WorkMailMessageFlow.GetRawMessageContent -- | See: newGetRawMessageContent smart constructor. data GetRawMessageContent GetRawMessageContent' :: Text -> GetRawMessageContent -- | The identifier of the email message to retrieve. [$sel:messageId:GetRawMessageContent'] :: GetRawMessageContent -> Text -- | Create a value of GetRawMessageContent 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:messageId:GetRawMessageContent', -- getRawMessageContent_messageId - The identifier of the email -- message to retrieve. newGetRawMessageContent :: Text -> GetRawMessageContent -- | The identifier of the email message to retrieve. getRawMessageContent_messageId :: Lens' GetRawMessageContent Text -- | See: newGetRawMessageContentResponse smart constructor. data GetRawMessageContentResponse GetRawMessageContentResponse' :: Int -> ResponseBody -> GetRawMessageContentResponse -- | The response's http status code. [$sel:httpStatus:GetRawMessageContentResponse'] :: GetRawMessageContentResponse -> Int -- | The raw content of the email message, in MIME format. [$sel:messageContent:GetRawMessageContentResponse'] :: GetRawMessageContentResponse -> ResponseBody -- | Create a value of GetRawMessageContentResponse 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:httpStatus:GetRawMessageContentResponse', -- getRawMessageContentResponse_httpStatus - The response's http -- status code. -- -- $sel:messageContent:GetRawMessageContentResponse', -- getRawMessageContentResponse_messageContent - The raw content -- of the email message, in MIME format. newGetRawMessageContentResponse :: Int -> ResponseBody -> GetRawMessageContentResponse -- | The response's http status code. getRawMessageContentResponse_httpStatus :: Lens' GetRawMessageContentResponse Int -- | The raw content of the email message, in MIME format. getRawMessageContentResponse_messageContent :: Lens' GetRawMessageContentResponse ResponseBody instance GHC.Generics.Generic Amazonka.WorkMailMessageFlow.GetRawMessageContent.GetRawMessageContent instance GHC.Show.Show Amazonka.WorkMailMessageFlow.GetRawMessageContent.GetRawMessageContent instance GHC.Read.Read Amazonka.WorkMailMessageFlow.GetRawMessageContent.GetRawMessageContent instance GHC.Classes.Eq Amazonka.WorkMailMessageFlow.GetRawMessageContent.GetRawMessageContent instance GHC.Generics.Generic Amazonka.WorkMailMessageFlow.GetRawMessageContent.GetRawMessageContentResponse instance GHC.Show.Show Amazonka.WorkMailMessageFlow.GetRawMessageContent.GetRawMessageContentResponse instance Amazonka.Types.AWSRequest Amazonka.WorkMailMessageFlow.GetRawMessageContent.GetRawMessageContent instance Data.Hashable.Class.Hashable Amazonka.WorkMailMessageFlow.GetRawMessageContent.GetRawMessageContent instance Control.DeepSeq.NFData Amazonka.WorkMailMessageFlow.GetRawMessageContent.GetRawMessageContent instance Amazonka.Data.Headers.ToHeaders Amazonka.WorkMailMessageFlow.GetRawMessageContent.GetRawMessageContent instance Amazonka.Data.Path.ToPath Amazonka.WorkMailMessageFlow.GetRawMessageContent.GetRawMessageContent instance Amazonka.Data.Query.ToQuery Amazonka.WorkMailMessageFlow.GetRawMessageContent.GetRawMessageContent module Amazonka.WorkMailMessageFlow.Lens -- | The identifier of the email message to retrieve. getRawMessageContent_messageId :: Lens' GetRawMessageContent Text -- | The response's http status code. getRawMessageContentResponse_httpStatus :: Lens' GetRawMessageContentResponse Int -- | The raw content of the email message, in MIME format. getRawMessageContentResponse_messageContent :: Lens' GetRawMessageContentResponse ResponseBody -- | The identifier of the email message being updated. putRawMessageContent_messageId :: Lens' PutRawMessageContent Text -- | Describes the raw message content of the updated email message. putRawMessageContent_content :: Lens' PutRawMessageContent RawMessageContent -- | The response's http status code. putRawMessageContentResponse_httpStatus :: Lens' PutRawMessageContentResponse Int -- | The S3 reference of an email message. rawMessageContent_s3Reference :: Lens' RawMessageContent S3Reference -- | If you enable versioning for the bucket, you can specify the object -- version. s3Reference_objectVersion :: Lens' S3Reference (Maybe Text) -- | The S3 bucket name. s3Reference_bucket :: Lens' S3Reference Text -- | The S3 key object name. s3Reference_key :: Lens' S3Reference Text module Amazonka.WorkMailMessageFlow.Waiters -- | Derived from API version 2019-05-01 of the AWS service -- descriptions, licensed under Apache 2.0. -- -- The WorkMail Message Flow API provides access to email messages as -- they are being sent and received by a WorkMail organization. module Amazonka.WorkMailMessageFlow -- | API version 2019-05-01 of the Amazon WorkMail Message Flow -- SDK configuration. defaultService :: Service -- | WorkMail could not access the updated email content. Possible reasons: -- -- _InvalidContentLocation :: AsError a => Fold a ServiceError -- | The requested email is not eligible for update. This is usually the -- case for a redirected email. _MessageFrozen :: AsError a => Fold a ServiceError -- | The requested email could not be updated due to an error in the MIME -- content. Check the error message for more information about what -- caused the error. _MessageRejected :: AsError a => Fold a ServiceError -- | The requested email message is not found. _ResourceNotFoundException :: AsError a => Fold a ServiceError -- | See: newGetRawMessageContent smart constructor. data GetRawMessageContent GetRawMessageContent' :: Text -> GetRawMessageContent -- | Create a value of GetRawMessageContent 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:messageId:GetRawMessageContent', -- getRawMessageContent_messageId - The identifier of the email -- message to retrieve. newGetRawMessageContent :: Text -> GetRawMessageContent -- | See: newGetRawMessageContentResponse smart constructor. data GetRawMessageContentResponse GetRawMessageContentResponse' :: Int -> ResponseBody -> GetRawMessageContentResponse -- | Create a value of GetRawMessageContentResponse 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:httpStatus:GetRawMessageContentResponse', -- getRawMessageContentResponse_httpStatus - The response's http -- status code. -- -- $sel:messageContent:GetRawMessageContentResponse', -- getRawMessageContentResponse_messageContent - The raw content -- of the email message, in MIME format. newGetRawMessageContentResponse :: Int -> ResponseBody -> GetRawMessageContentResponse -- | See: newPutRawMessageContent smart constructor. data PutRawMessageContent PutRawMessageContent' :: Text -> RawMessageContent -> PutRawMessageContent -- | Create a value of PutRawMessageContent 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:messageId:PutRawMessageContent', -- putRawMessageContent_messageId - The identifier of the email -- message being updated. -- -- $sel:content:PutRawMessageContent', -- putRawMessageContent_content - Describes the raw message -- content of the updated email message. newPutRawMessageContent :: Text -> RawMessageContent -> PutRawMessageContent -- | See: newPutRawMessageContentResponse smart constructor. data PutRawMessageContentResponse PutRawMessageContentResponse' :: Int -> PutRawMessageContentResponse -- | Create a value of PutRawMessageContentResponse 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:httpStatus:PutRawMessageContentResponse', -- putRawMessageContentResponse_httpStatus - The response's http -- status code. newPutRawMessageContentResponse :: Int -> PutRawMessageContentResponse -- | Provides the MIME content of the updated email message as an S3 -- object. All MIME content must meet the following criteria: -- -- -- -- See: newRawMessageContent smart constructor. data RawMessageContent RawMessageContent' :: S3Reference -> RawMessageContent -- | Create a value of RawMessageContent 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:s3Reference:RawMessageContent', -- rawMessageContent_s3Reference - The S3 reference of an email -- message. newRawMessageContent :: S3Reference -> RawMessageContent -- | Amazon S3 object representing the updated message content, in MIME -- format. -- -- The region for the S3 bucket containing the S3 object must match the -- region used for WorkMail operations. Also, for WorkMail to process an -- S3 object, it must have permission to access that object. For more -- information, see Updating message content with AWS Lambda. -- -- See: newS3Reference smart constructor. data S3Reference S3Reference' :: Maybe Text -> Text -> Text -> S3Reference -- | Create a value of S3Reference 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:objectVersion:S3Reference', -- s3Reference_objectVersion - If you enable versioning for the -- bucket, you can specify the object version. -- -- $sel:bucket:S3Reference', s3Reference_bucket - The S3 -- bucket name. -- -- $sel:key:S3Reference', s3Reference_key - The S3 key -- object name. newS3Reference :: Text -> Text -> S3Reference