workmailmessageflow.d.ts 4.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. import {Readable} from 'stream';
  8. interface Blob {}
  9. declare class WorkMailMessageFlow extends Service {
  10. /**
  11. * Constructs a service object. This object has one method for each API operation.
  12. */
  13. constructor(options?: WorkMailMessageFlow.Types.ClientConfiguration)
  14. config: Config & WorkMailMessageFlow.Types.ClientConfiguration;
  15. /**
  16. * Retrieves the raw content of an in-transit email message, in MIME format.
  17. */
  18. getRawMessageContent(params: WorkMailMessageFlow.Types.GetRawMessageContentRequest, callback?: (err: AWSError, data: WorkMailMessageFlow.Types.GetRawMessageContentResponse) => void): Request<WorkMailMessageFlow.Types.GetRawMessageContentResponse, AWSError>;
  19. /**
  20. * Retrieves the raw content of an in-transit email message, in MIME format.
  21. */
  22. getRawMessageContent(callback?: (err: AWSError, data: WorkMailMessageFlow.Types.GetRawMessageContentResponse) => void): Request<WorkMailMessageFlow.Types.GetRawMessageContentResponse, AWSError>;
  23. /**
  24. * 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.
  25. */
  26. putRawMessageContent(params: WorkMailMessageFlow.Types.PutRawMessageContentRequest, callback?: (err: AWSError, data: WorkMailMessageFlow.Types.PutRawMessageContentResponse) => void): Request<WorkMailMessageFlow.Types.PutRawMessageContentResponse, AWSError>;
  27. /**
  28. * 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.
  29. */
  30. putRawMessageContent(callback?: (err: AWSError, data: WorkMailMessageFlow.Types.PutRawMessageContentResponse) => void): Request<WorkMailMessageFlow.Types.PutRawMessageContentResponse, AWSError>;
  31. }
  32. declare namespace WorkMailMessageFlow {
  33. export interface GetRawMessageContentRequest {
  34. /**
  35. * The identifier of the email message to retrieve.
  36. */
  37. messageId: messageIdType;
  38. }
  39. export interface GetRawMessageContentResponse {
  40. /**
  41. * The raw content of the email message, in MIME format.
  42. */
  43. messageContent: messageContentBlob;
  44. }
  45. export interface PutRawMessageContentRequest {
  46. /**
  47. * The identifier of the email message being updated.
  48. */
  49. messageId: messageIdType;
  50. /**
  51. * Describes the raw message content of the updated email message.
  52. */
  53. content: RawMessageContent;
  54. }
  55. export interface PutRawMessageContentResponse {
  56. }
  57. export interface RawMessageContent {
  58. /**
  59. * The S3 reference of an email message.
  60. */
  61. s3Reference: S3Reference;
  62. }
  63. export interface S3Reference {
  64. /**
  65. * The S3 bucket name.
  66. */
  67. bucket: s3BucketIdType;
  68. /**
  69. * The S3 key object name.
  70. */
  71. key: s3KeyIdType;
  72. /**
  73. * If you enable versioning for the bucket, you can specify the object version.
  74. */
  75. objectVersion?: s3VersionType;
  76. }
  77. export type messageContentBlob = Buffer|Uint8Array|Blob|string|Readable;
  78. export type messageIdType = string;
  79. export type s3BucketIdType = string;
  80. export type s3KeyIdType = string;
  81. export type s3VersionType = string;
  82. /**
  83. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  84. */
  85. export type apiVersion = "2019-05-01"|"latest"|string;
  86. export interface ClientApiVersions {
  87. /**
  88. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  89. */
  90. apiVersion?: apiVersion;
  91. }
  92. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  93. /**
  94. * Contains interfaces for use with the WorkMailMessageFlow client.
  95. */
  96. export import Types = WorkMailMessageFlow;
  97. }
  98. export = WorkMailMessageFlow;