aws-sdk-workmail 1.29.0 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 391228581119410053bad6da98cf9f97a8c31944cc49a6e65090ed56cefebaf6
-  data.tar.gz: 7e1cb7daab540811066cc690804cd4a52d986fcf1f013b2d87d433c9fd6cf2c0
+  metadata.gz: 0af323e7e0592cbb792c427af3d70098c9fb1a2c6a4e909bdbbc020091c02728
+  data.tar.gz: 31516e5354c404443453a1ab6f46da61a0f14aa770eb763dc999b545dd26d9be
 SHA512:
-  metadata.gz: 9943113fe7b5473117123c5d044945f5182d56ef5b891460b198f234518539eaa121111b263ad99ff0d64ab87cf7a43a0a888c37406ca80b0ebeec9bb7efaa4a
-  data.tar.gz: b2f00a115e9c4898303d53665cfc4daff1b89069c6036b7b2e2a92470fce77cabbfcd401349491bcbbfbdc20eab93e0c6de7982f0cf28627a8951bb8f41a4ca5
+  metadata.gz: 60b7863f8dd66cd0b8f1769cdd5b3e73a0e181dca11d383e7cfa510b9c83b5a73af8945eadc03015634bb8d7c94d88d8a1293bb6549f79600eac89045ea9660c
+  data.tar.gz: '01359db269a1e0e809c9995ed52cb3e8dc05777c349e4104a24caa0a217e15503bae9bff7490a32b9e311051047c8d7cd2335644163049b20f1b34c1cd6fb000'

data/lib/aws-sdk-workmail.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-workmail/customizations'
 # @!group service
 module Aws::WorkMail
 
-  GEM_VERSION = '1.29.0'
+  GEM_VERSION = '1.30.0'
 
 end

data/lib/aws-sdk-workmail/client.rb

@@ -397,6 +397,44 @@ module Aws::WorkMail
       req.send_request(options)
     end
 
+    # Cancels a mailbox export job.
+    #
+    # <note markdown="1"> If the mailbox export job is near completion, it might not be possible
+    # to cancel it.
+    #
+    #  </note>
+    #
+    # @option params [required, String] :client_token
+    #   The idempotency token for the client request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @option params [required, String] :job_id
+    #   The job ID.
+    #
+    # @option params [required, String] :organization_id
+    #   The organization ID.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.cancel_mailbox_export_job({
+    #     client_token: "IdempotencyClientToken", # required
+    #     job_id: "MailboxExportJobId", # required
+    #     organization_id: "OrganizationId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CancelMailboxExportJob AWS API Documentation
+    #
+    # @overload cancel_mailbox_export_job(params = {})
+    # @param [Hash] params ({})
+    def cancel_mailbox_export_job(params = {}, options = {})
+      req = build_request(:cancel_mailbox_export_job, params)
+      req.send_request(options)
+    end
+
     # Adds an alias to the set of a given member (user or group) of Amazon
     # WorkMail.
     #
@@ -817,6 +855,60 @@ module Aws::WorkMail
       req.send_request(options)
     end
 
+    # Describes the current status of a mailbox export job.
+    #
+    # @option params [required, String] :job_id
+    #   The mailbox export job ID.
+    #
+    # @option params [required, String] :organization_id
+    #   The organization ID.
+    #
+    # @return [Types::DescribeMailboxExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeMailboxExportJobResponse#entity_id #entity_id} => String
+    #   * {Types::DescribeMailboxExportJobResponse#description #description} => String
+    #   * {Types::DescribeMailboxExportJobResponse#role_arn #role_arn} => String
+    #   * {Types::DescribeMailboxExportJobResponse#kms_key_arn #kms_key_arn} => String
+    #   * {Types::DescribeMailboxExportJobResponse#s3_bucket_name #s3_bucket_name} => String
+    #   * {Types::DescribeMailboxExportJobResponse#s3_prefix #s3_prefix} => String
+    #   * {Types::DescribeMailboxExportJobResponse#s3_path #s3_path} => String
+    #   * {Types::DescribeMailboxExportJobResponse#estimated_progress #estimated_progress} => Integer
+    #   * {Types::DescribeMailboxExportJobResponse#state #state} => String
+    #   * {Types::DescribeMailboxExportJobResponse#error_info #error_info} => String
+    #   * {Types::DescribeMailboxExportJobResponse#start_time #start_time} => Time
+    #   * {Types::DescribeMailboxExportJobResponse#end_time #end_time} => Time
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_mailbox_export_job({
+    #     job_id: "MailboxExportJobId", # required
+    #     organization_id: "OrganizationId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.entity_id #=> String
+    #   resp.description #=> String
+    #   resp.role_arn #=> String
+    #   resp.kms_key_arn #=> String
+    #   resp.s3_bucket_name #=> String
+    #   resp.s3_prefix #=> String
+    #   resp.s3_path #=> String
+    #   resp.estimated_progress #=> Integer
+    #   resp.state #=> String, one of "RUNNING", "COMPLETED", "FAILED", "CANCELLED"
+    #   resp.error_info #=> String
+    #   resp.start_time #=> Time
+    #   resp.end_time #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeMailboxExportJob AWS API Documentation
+    #
+    # @overload describe_mailbox_export_job(params = {})
+    # @param [Hash] params ({})
+    def describe_mailbox_export_job(params = {}, options = {})
+      req = build_request(:describe_mailbox_export_job, params)
+      req.send_request(options)
+    end
+
     # Provides more information regarding a given organization based on its
     # identifier.
     #
@@ -1331,6 +1423,56 @@ module Aws::WorkMail
       req.send_request(options)
     end
 
+    # Lists the mailbox export jobs started for the specified organization
+    # within the last seven days.
+    #
+    # @option params [required, String] :organization_id
+    #   The organization ID.
+    #
+    # @option params [String] :next_token
+    #   The token to use to retrieve the next page of results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return in a single call.
+    #
+    # @return [Types::ListMailboxExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListMailboxExportJobsResponse#jobs #jobs} => Array&lt;Types::MailboxExportJob&gt;
+    #   * {Types::ListMailboxExportJobsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_mailbox_export_jobs({
+    #     organization_id: "OrganizationId", # required
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.jobs #=> Array
+    #   resp.jobs[0].job_id #=> String
+    #   resp.jobs[0].entity_id #=> String
+    #   resp.jobs[0].description #=> String
+    #   resp.jobs[0].s3_bucket_name #=> String
+    #   resp.jobs[0].s3_path #=> String
+    #   resp.jobs[0].estimated_progress #=> Integer
+    #   resp.jobs[0].state #=> String, one of "RUNNING", "COMPLETED", "FAILED", "CANCELLED"
+    #   resp.jobs[0].start_time #=> Time
+    #   resp.jobs[0].end_time #=> Time
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxExportJobs AWS API Documentation
+    #
+    # @overload list_mailbox_export_jobs(params = {})
+    # @param [Hash] params ({})
+    def list_mailbox_export_jobs(params = {}, options = {})
+      req = build_request(:list_mailbox_export_jobs, params)
+      req.send_request(options)
+    end
+
     # Lists the mailbox permissions associated with a user, group, or
     # resource mailbox.
     #
@@ -1829,6 +1971,75 @@ module Aws::WorkMail
       req.send_request(options)
     end
 
+    # Starts a mailbox export job to export MIME-format email messages and
+    # calendar items from the specified mailbox to the specified Amazon
+    # Simple Storage Service (Amazon S3) bucket. For more information, see
+    # [Exporting mailbox content][1] in the *Amazon WorkMail Administrator
+    # Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/workmail/latest/adminguide/mail-export.html
+    #
+    # @option params [required, String] :client_token
+    #   The idempotency token for the client request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @option params [required, String] :organization_id
+    #   The identifier associated with the organization.
+    #
+    # @option params [required, String] :entity_id
+    #   The identifier of the user or resource associated with the mailbox.
+    #
+    # @option params [String] :description
+    #   The mailbox export job description.
+    #
+    # @option params [required, String] :role_arn
+    #   The ARN of the AWS Identity and Access Management (IAM) role that
+    #   grants write permission to the S3 bucket.
+    #
+    # @option params [required, String] :kms_key_arn
+    #   The Amazon Resource Name (ARN) of the symmetric AWS Key Management
+    #   Service (AWS KMS) key that encrypts the exported mailbox content.
+    #
+    # @option params [required, String] :s3_bucket_name
+    #   The name of the S3 bucket.
+    #
+    # @option params [required, String] :s3_prefix
+    #   The S3 bucket prefix.
+    #
+    # @return [Types::StartMailboxExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartMailboxExportJobResponse#job_id #job_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_mailbox_export_job({
+    #     client_token: "IdempotencyClientToken", # required
+    #     organization_id: "OrganizationId", # required
+    #     entity_id: "WorkMailIdentifier", # required
+    #     description: "Description",
+    #     role_arn: "RoleArn", # required
+    #     kms_key_arn: "KmsKeyArn", # required
+    #     s3_bucket_name: "S3BucketName", # required
+    #     s3_prefix: "S3ObjectKey", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.job_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/StartMailboxExportJob AWS API Documentation
+    #
+    # @overload start_mailbox_export_job(params = {})
+    # @param [Hash] params ({})
+    def start_mailbox_export_job(params = {}, options = {})
+      req = build_request(:start_mailbox_export_job, params)
+      req.send_request(options)
+    end
+
     # Applies the specified tags to the specified Amazon WorkMail
     # organization resource.
     #
@@ -2008,7 +2219,7 @@ module Aws::WorkMail
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-workmail'
-      context[:gem_version] = '1.29.0'
+      context[:gem_version] = '1.30.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-workmail/client_api.rb

@@ -29,6 +29,8 @@ module Aws::WorkMail
     AssociateMemberToGroupResponse = Shapes::StructureShape.new(name: 'AssociateMemberToGroupResponse')
     BookingOptions = Shapes::StructureShape.new(name: 'BookingOptions')
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
+    CancelMailboxExportJobRequest = Shapes::StructureShape.new(name: 'CancelMailboxExportJobRequest')
+    CancelMailboxExportJobResponse = Shapes::StructureShape.new(name: 'CancelMailboxExportJobResponse')
     CreateAliasRequest = Shapes::StructureShape.new(name: 'CreateAliasRequest')
     CreateAliasResponse = Shapes::StructureShape.new(name: 'CreateAliasResponse')
     CreateGroupRequest = Shapes::StructureShape.new(name: 'CreateGroupRequest')
@@ -56,12 +58,15 @@ module Aws::WorkMail
     DeregisterFromWorkMailResponse = Shapes::StructureShape.new(name: 'DeregisterFromWorkMailResponse')
     DescribeGroupRequest = Shapes::StructureShape.new(name: 'DescribeGroupRequest')
     DescribeGroupResponse = Shapes::StructureShape.new(name: 'DescribeGroupResponse')
+    DescribeMailboxExportJobRequest = Shapes::StructureShape.new(name: 'DescribeMailboxExportJobRequest')
+    DescribeMailboxExportJobResponse = Shapes::StructureShape.new(name: 'DescribeMailboxExportJobResponse')
     DescribeOrganizationRequest = Shapes::StructureShape.new(name: 'DescribeOrganizationRequest')
     DescribeOrganizationResponse = Shapes::StructureShape.new(name: 'DescribeOrganizationResponse')
     DescribeResourceRequest = Shapes::StructureShape.new(name: 'DescribeResourceRequest')
     DescribeResourceResponse = Shapes::StructureShape.new(name: 'DescribeResourceResponse')
     DescribeUserRequest = Shapes::StructureShape.new(name: 'DescribeUserRequest')
     DescribeUserResponse = Shapes::StructureShape.new(name: 'DescribeUserResponse')
+    Description = Shapes::StringShape.new(name: 'Description')
     DirectoryServiceAuthenticationFailedException = Shapes::StructureShape.new(name: 'DirectoryServiceAuthenticationFailedException')
     DirectoryUnavailableException = Shapes::StructureShape.new(name: 'DirectoryUnavailableException')
     DisassociateDelegateFromResourceRequest = Shapes::StructureShape.new(name: 'DisassociateDelegateFromResourceRequest')
@@ -86,12 +91,15 @@ module Aws::WorkMail
     Group = Shapes::StructureShape.new(name: 'Group')
     GroupName = Shapes::StringShape.new(name: 'GroupName')
     Groups = Shapes::ListShape.new(name: 'Groups')
+    IdempotencyClientToken = Shapes::StringShape.new(name: 'IdempotencyClientToken')
     InvalidConfigurationException = Shapes::StructureShape.new(name: 'InvalidConfigurationException')
     InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
     InvalidPasswordException = Shapes::StructureShape.new(name: 'InvalidPasswordException')
     IpAddress = Shapes::StringShape.new(name: 'IpAddress')
     IpRange = Shapes::StringShape.new(name: 'IpRange')
     IpRangeList = Shapes::ListShape.new(name: 'IpRangeList')
+    Jobs = Shapes::ListShape.new(name: 'Jobs')
+    KmsKeyArn = Shapes::StringShape.new(name: 'KmsKeyArn')
     LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
     ListAccessControlRulesRequest = Shapes::StructureShape.new(name: 'ListAccessControlRulesRequest')
     ListAccessControlRulesResponse = Shapes::StructureShape.new(name: 'ListAccessControlRulesResponse')
@@ -101,6 +109,8 @@ module Aws::WorkMail
     ListGroupMembersResponse = Shapes::StructureShape.new(name: 'ListGroupMembersResponse')
     ListGroupsRequest = Shapes::StructureShape.new(name: 'ListGroupsRequest')
     ListGroupsResponse = Shapes::StructureShape.new(name: 'ListGroupsResponse')
+    ListMailboxExportJobsRequest = Shapes::StructureShape.new(name: 'ListMailboxExportJobsRequest')
+    ListMailboxExportJobsResponse = Shapes::StructureShape.new(name: 'ListMailboxExportJobsResponse')
     ListMailboxPermissionsRequest = Shapes::StructureShape.new(name: 'ListMailboxPermissionsRequest')
     ListMailboxPermissionsResponse = Shapes::StructureShape.new(name: 'ListMailboxPermissionsResponse')
     ListOrganizationsRequest = Shapes::StructureShape.new(name: 'ListOrganizationsRequest')
@@ -115,6 +125,10 @@ module Aws::WorkMail
     ListUsersResponse = Shapes::StructureShape.new(name: 'ListUsersResponse')
     MailDomainNotFoundException = Shapes::StructureShape.new(name: 'MailDomainNotFoundException')
     MailDomainStateException = Shapes::StructureShape.new(name: 'MailDomainStateException')
+    MailboxExportErrorInfo = Shapes::StringShape.new(name: 'MailboxExportErrorInfo')
+    MailboxExportJob = Shapes::StructureShape.new(name: 'MailboxExportJob')
+    MailboxExportJobId = Shapes::StringShape.new(name: 'MailboxExportJobId')
+    MailboxExportJobState = Shapes::StringShape.new(name: 'MailboxExportJobState')
     MailboxQuota = Shapes::IntegerShape.new(name: 'MailboxQuota')
     MailboxSize = Shapes::FloatShape.new(name: 'MailboxSize')
     MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
@@ -130,6 +144,7 @@ module Aws::WorkMail
     OrganizationSummaries = Shapes::ListShape.new(name: 'OrganizationSummaries')
     OrganizationSummary = Shapes::StructureShape.new(name: 'OrganizationSummary')
     Password = Shapes::StringShape.new(name: 'Password')
+    Percentage = Shapes::IntegerShape.new(name: 'Percentage')
     Permission = Shapes::StructureShape.new(name: 'Permission')
     PermissionType = Shapes::StringShape.new(name: 'PermissionType')
     PermissionValues = Shapes::ListShape.new(name: 'PermissionValues')
@@ -155,7 +170,12 @@ module Aws::WorkMail
     Resources = Shapes::ListShape.new(name: 'Resources')
     RetentionAction = Shapes::StringShape.new(name: 'RetentionAction')
     RetentionPeriod = Shapes::IntegerShape.new(name: 'RetentionPeriod')
+    RoleArn = Shapes::StringShape.new(name: 'RoleArn')
+    S3BucketName = Shapes::StringShape.new(name: 'S3BucketName')
+    S3ObjectKey = Shapes::StringShape.new(name: 'S3ObjectKey')
     ShortString = Shapes::StringShape.new(name: 'ShortString')
+    StartMailboxExportJobRequest = Shapes::StructureShape.new(name: 'StartMailboxExportJobRequest')
+    StartMailboxExportJobResponse = Shapes::StructureShape.new(name: 'StartMailboxExportJobResponse')
     String = Shapes::StringShape.new(name: 'String')
     Tag = Shapes::StructureShape.new(name: 'Tag')
     TagKey = Shapes::StringShape.new(name: 'TagKey')
@@ -222,6 +242,13 @@ module Aws::WorkMail
     BookingOptions.add_member(:auto_decline_conflicting_requests, Shapes::ShapeRef.new(shape: Boolean, location_name: "AutoDeclineConflictingRequests"))
     BookingOptions.struct_class = Types::BookingOptions
 
+    CancelMailboxExportJobRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyClientToken, required: true, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
+    CancelMailboxExportJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: MailboxExportJobId, required: true, location_name: "JobId"))
+    CancelMailboxExportJobRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
+    CancelMailboxExportJobRequest.struct_class = Types::CancelMailboxExportJobRequest
+
+    CancelMailboxExportJobResponse.struct_class = Types::CancelMailboxExportJobResponse
+
     CreateAliasRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
     CreateAliasRequest.add_member(:entity_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, required: true, location_name: "EntityId"))
     CreateAliasRequest.add_member(:alias, Shapes::ShapeRef.new(shape: EmailAddress, required: true, location_name: "Alias"))
@@ -319,6 +346,24 @@ module Aws::WorkMail
     DescribeGroupResponse.add_member(:disabled_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "DisabledDate"))
     DescribeGroupResponse.struct_class = Types::DescribeGroupResponse
 
+    DescribeMailboxExportJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: MailboxExportJobId, required: true, location_name: "JobId"))
+    DescribeMailboxExportJobRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
+    DescribeMailboxExportJobRequest.struct_class = Types::DescribeMailboxExportJobRequest
+
+    DescribeMailboxExportJobResponse.add_member(:entity_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, location_name: "EntityId"))
+    DescribeMailboxExportJobResponse.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
+    DescribeMailboxExportJobResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
+    DescribeMailboxExportJobResponse.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "KmsKeyArn"))
+    DescribeMailboxExportJobResponse.add_member(:s3_bucket_name, Shapes::ShapeRef.new(shape: S3BucketName, location_name: "S3BucketName"))
+    DescribeMailboxExportJobResponse.add_member(:s3_prefix, Shapes::ShapeRef.new(shape: S3ObjectKey, location_name: "S3Prefix"))
+    DescribeMailboxExportJobResponse.add_member(:s3_path, Shapes::ShapeRef.new(shape: S3ObjectKey, location_name: "S3Path"))
+    DescribeMailboxExportJobResponse.add_member(:estimated_progress, Shapes::ShapeRef.new(shape: Percentage, location_name: "EstimatedProgress"))
+    DescribeMailboxExportJobResponse.add_member(:state, Shapes::ShapeRef.new(shape: MailboxExportJobState, location_name: "State"))
+    DescribeMailboxExportJobResponse.add_member(:error_info, Shapes::ShapeRef.new(shape: MailboxExportErrorInfo, location_name: "ErrorInfo"))
+    DescribeMailboxExportJobResponse.add_member(:start_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StartTime"))
+    DescribeMailboxExportJobResponse.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
+    DescribeMailboxExportJobResponse.struct_class = Types::DescribeMailboxExportJobResponse
+
     DescribeOrganizationRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
     DescribeOrganizationRequest.struct_class = Types::DescribeOrganizationRequest
 
@@ -448,6 +493,8 @@ module Aws::WorkMail
 
     IpRangeList.member = Shapes::ShapeRef.new(shape: IpRange)
 
+    Jobs.member = Shapes::ShapeRef.new(shape: MailboxExportJob)
+
     LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
     LimitExceededException.struct_class = Types::LimitExceededException
 
@@ -486,6 +533,15 @@ module Aws::WorkMail
     ListGroupsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
     ListGroupsResponse.struct_class = Types::ListGroupsResponse
 
+    ListMailboxExportJobsRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
+    ListMailboxExportJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListMailboxExportJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
+    ListMailboxExportJobsRequest.struct_class = Types::ListMailboxExportJobsRequest
+
+    ListMailboxExportJobsResponse.add_member(:jobs, Shapes::ShapeRef.new(shape: Jobs, location_name: "Jobs"))
+    ListMailboxExportJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListMailboxExportJobsResponse.struct_class = Types::ListMailboxExportJobsResponse
+
     ListMailboxPermissionsRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
     ListMailboxPermissionsRequest.add_member(:entity_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, required: true, location_name: "EntityId"))
     ListMailboxPermissionsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
@@ -544,6 +600,17 @@ module Aws::WorkMail
     MailDomainStateException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
     MailDomainStateException.struct_class = Types::MailDomainStateException
 
+    MailboxExportJob.add_member(:job_id, Shapes::ShapeRef.new(shape: MailboxExportJobId, location_name: "JobId"))
+    MailboxExportJob.add_member(:entity_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, location_name: "EntityId"))
+    MailboxExportJob.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
+    MailboxExportJob.add_member(:s3_bucket_name, Shapes::ShapeRef.new(shape: S3BucketName, location_name: "S3BucketName"))
+    MailboxExportJob.add_member(:s3_path, Shapes::ShapeRef.new(shape: S3ObjectKey, location_name: "S3Path"))
+    MailboxExportJob.add_member(:estimated_progress, Shapes::ShapeRef.new(shape: Percentage, location_name: "EstimatedProgress"))
+    MailboxExportJob.add_member(:state, Shapes::ShapeRef.new(shape: MailboxExportJobState, location_name: "State"))
+    MailboxExportJob.add_member(:start_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StartTime"))
+    MailboxExportJob.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
+    MailboxExportJob.struct_class = Types::MailboxExportJob
+
     Member.add_member(:id, Shapes::ShapeRef.new(shape: String, location_name: "Id"))
     Member.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
     Member.add_member(:type, Shapes::ShapeRef.new(shape: MemberType, location_name: "Type"))
@@ -644,6 +711,19 @@ module Aws::WorkMail
 
     Resources.member = Shapes::ShapeRef.new(shape: Resource)
 
+    StartMailboxExportJobRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyClientToken, required: true, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
+    StartMailboxExportJobRequest.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
+    StartMailboxExportJobRequest.add_member(:entity_id, Shapes::ShapeRef.new(shape: WorkMailIdentifier, required: true, location_name: "EntityId"))
+    StartMailboxExportJobRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
+    StartMailboxExportJobRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
+    StartMailboxExportJobRequest.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, required: true, location_name: "KmsKeyArn"))
+    StartMailboxExportJobRequest.add_member(:s3_bucket_name, Shapes::ShapeRef.new(shape: S3BucketName, required: true, location_name: "S3BucketName"))
+    StartMailboxExportJobRequest.add_member(:s3_prefix, Shapes::ShapeRef.new(shape: S3ObjectKey, required: true, location_name: "S3Prefix"))
+    StartMailboxExportJobRequest.struct_class = Types::StartMailboxExportJobRequest
+
+    StartMailboxExportJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: MailboxExportJobId, location_name: "JobId"))
+    StartMailboxExportJobResponse.struct_class = Types::StartMailboxExportJobResponse
+
     Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "Key"))
     Tag.add_member(:value, Shapes::ShapeRef.new(shape: TagValue, required: true, location_name: "Value"))
     Tag.struct_class = Types::Tag
@@ -753,6 +833,18 @@ module Aws::WorkMail
         o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationException)
       end)
 
+      api.add_operation(:cancel_mailbox_export_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "CancelMailboxExportJob"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: CancelMailboxExportJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: CancelMailboxExportJobResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
+        o.errors << Shapes::ShapeRef.new(shape: EntityNotFoundException)
+      end)
+
       api.add_operation(:create_alias, Seahorse::Model::Operation.new.tap do |o|
         o.name = "CreateAlias"
         o.http_method = "POST"
@@ -932,6 +1024,18 @@ module Aws::WorkMail
         o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
       end)
 
+      api.add_operation(:describe_mailbox_export_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DescribeMailboxExportJob"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DescribeMailboxExportJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: DescribeMailboxExportJobResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
+        o.errors << Shapes::ShapeRef.new(shape: EntityNotFoundException)
+      end)
+
       api.add_operation(:describe_organization, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DescribeOrganization"
         o.http_method = "POST"
@@ -1096,6 +1200,23 @@ module Aws::WorkMail
         )
       end)
 
+      api.add_operation(:list_mailbox_export_jobs, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListMailboxExportJobs"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ListMailboxExportJobsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListMailboxExportJobsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_mailbox_permissions, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListMailboxPermissions"
         o.http_method = "POST"
@@ -1265,6 +1386,19 @@ module Aws::WorkMail
         o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationException)
       end)
 
+      api.add_operation(:start_mailbox_export_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StartMailboxExportJob"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: StartMailboxExportJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: StartMailboxExportJobResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: OrganizationNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: OrganizationStateException)
+        o.errors << Shapes::ShapeRef.new(shape: EntityNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+      end)
+
       api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
         o.name = "TagResource"
         o.http_method = "POST"

data/lib/aws-sdk-workmail/types.rb

@@ -185,6 +185,44 @@ module Aws::WorkMail
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass CancelMailboxExportJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         client_token: "IdempotencyClientToken", # required
+    #         job_id: "MailboxExportJobId", # required
+    #         organization_id: "OrganizationId", # required
+    #       }
+    #
+    # @!attribute [rw] client_token
+    #   The idempotency token for the client request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_id
+    #   The job ID.
+    #   @return [String]
+    #
+    # @!attribute [rw] organization_id
+    #   The organization ID.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CancelMailboxExportJobRequest AWS API Documentation
+    #
+    class CancelMailboxExportJobRequest < Struct.new(
+      :client_token,
+      :job_id,
+      :organization_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CancelMailboxExportJobResponse AWS API Documentation
+    #
+    class CancelMailboxExportJobResponse < Aws::EmptyStructure; end
+
     # @note When making an API call, you may pass CreateAliasRequest
     #   data as a hash:
     #
@@ -689,6 +727,103 @@ module Aws::WorkMail
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DescribeMailboxExportJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_id: "MailboxExportJobId", # required
+    #         organization_id: "OrganizationId", # required
+    #       }
+    #
+    # @!attribute [rw] job_id
+    #   The mailbox export job ID.
+    #   @return [String]
+    #
+    # @!attribute [rw] organization_id
+    #   The organization ID.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeMailboxExportJobRequest AWS API Documentation
+    #
+    class DescribeMailboxExportJobRequest < Struct.new(
+      :job_id,
+      :organization_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] entity_id
+    #   The identifier of the user or resource associated with the mailbox.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   The mailbox export job description.
+    #   @return [String]
+    #
+    # @!attribute [rw] role_arn
+    #   The ARN of the AWS Identity and Access Management (IAM) role that
+    #   grants write permission to the Amazon Simple Storage Service (Amazon
+    #   S3) bucket.
+    #   @return [String]
+    #
+    # @!attribute [rw] kms_key_arn
+    #   The Amazon Resource Name (ARN) of the symmetric AWS Key Management
+    #   Service (AWS KMS) key that encrypts the exported mailbox content.
+    #   @return [String]
+    #
+    # @!attribute [rw] s3_bucket_name
+    #   The name of the S3 bucket.
+    #   @return [String]
+    #
+    # @!attribute [rw] s3_prefix
+    #   The S3 bucket prefix.
+    #   @return [String]
+    #
+    # @!attribute [rw] s3_path
+    #   The path to the S3 bucket and file that the mailbox export job is
+    #   exporting to.
+    #   @return [String]
+    #
+    # @!attribute [rw] estimated_progress
+    #   The estimated progress of the mailbox export job, in percentage
+    #   points.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] state
+    #   The state of the mailbox export job.
+    #   @return [String]
+    #
+    # @!attribute [rw] error_info
+    #   Error information for failed mailbox export jobs.
+    #   @return [String]
+    #
+    # @!attribute [rw] start_time
+    #   The mailbox export job start timestamp.
+    #   @return [Time]
+    #
+    # @!attribute [rw] end_time
+    #   The mailbox export job end timestamp.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeMailboxExportJobResponse AWS API Documentation
+    #
+    class DescribeMailboxExportJobResponse < Struct.new(
+      :entity_id,
+      :description,
+      :role_arn,
+      :kms_key_arn,
+      :s3_bucket_name,
+      :s3_prefix,
+      :s3_path,
+      :estimated_progress,
+      :state,
+      :error_info,
+      :start_time,
+      :end_time)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DescribeOrganizationRequest
     #   data as a hash:
     #
@@ -1549,6 +1684,54 @@ module Aws::WorkMail
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListMailboxExportJobsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         organization_id: "OrganizationId", # required
+    #         next_token: "NextToken",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] organization_id
+    #   The organization ID.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   The token to use to retrieve the next page of results.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return in a single call.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxExportJobsRequest AWS API Documentation
+    #
+    class ListMailboxExportJobsRequest < Struct.new(
+      :organization_id,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] jobs
+    #   The mailbox export job details.
+    #   @return [Array<Types::MailboxExportJob>]
+    #
+    # @!attribute [rw] next_token
+    #   The token to use to retrieve the next page of results.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxExportJobsResponse AWS API Documentation
+    #
+    class ListMailboxExportJobsResponse < Struct.new(
+      :jobs,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListMailboxPermissionsRequest
     #   data as a hash:
     #
@@ -1870,6 +2053,64 @@ module Aws::WorkMail
       include Aws::Structure
     end
 
+    # The details of a mailbox export job, including the user or resource ID
+    # associated with the mailbox and the S3 bucket that the mailbox
+    # contents are exported to.
+    #
+    # @!attribute [rw] job_id
+    #   The identifier of the mailbox export job.
+    #   @return [String]
+    #
+    # @!attribute [rw] entity_id
+    #   The identifier of the user or resource associated with the mailbox.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   The mailbox export job description.
+    #   @return [String]
+    #
+    # @!attribute [rw] s3_bucket_name
+    #   The name of the S3 bucket.
+    #   @return [String]
+    #
+    # @!attribute [rw] s3_path
+    #   The path to the S3 bucket and file that the mailbox export job
+    #   exports to.
+    #   @return [String]
+    #
+    # @!attribute [rw] estimated_progress
+    #   The estimated progress of the mailbox export job, in percentage
+    #   points.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] state
+    #   The state of the mailbox export job.
+    #   @return [String]
+    #
+    # @!attribute [rw] start_time
+    #   The mailbox export job start timestamp.
+    #   @return [Time]
+    #
+    # @!attribute [rw] end_time
+    #   The mailbox export job end timestamp.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/MailboxExportJob AWS API Documentation
+    #
+    class MailboxExportJob < Struct.new(
+      :job_id,
+      :entity_id,
+      :description,
+      :s3_bucket_name,
+      :s3_path,
+      :estimated_progress,
+      :state,
+      :start_time,
+      :end_time)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The representation of a user or group.
     #
     # @!attribute [rw] id
@@ -2192,7 +2433,7 @@ module Aws::WorkMail
       :name,
       :description,
       :folder_configurations)
-      SENSITIVE = []
+      SENSITIVE = [:description]
       include Aws::Structure
     end
 
@@ -2345,6 +2586,84 @@ module Aws::WorkMail
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass StartMailboxExportJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         client_token: "IdempotencyClientToken", # required
+    #         organization_id: "OrganizationId", # required
+    #         entity_id: "WorkMailIdentifier", # required
+    #         description: "Description",
+    #         role_arn: "RoleArn", # required
+    #         kms_key_arn: "KmsKeyArn", # required
+    #         s3_bucket_name: "S3BucketName", # required
+    #         s3_prefix: "S3ObjectKey", # required
+    #       }
+    #
+    # @!attribute [rw] client_token
+    #   The idempotency token for the client request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #   @return [String]
+    #
+    # @!attribute [rw] organization_id
+    #   The identifier associated with the organization.
+    #   @return [String]
+    #
+    # @!attribute [rw] entity_id
+    #   The identifier of the user or resource associated with the mailbox.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   The mailbox export job description.
+    #   @return [String]
+    #
+    # @!attribute [rw] role_arn
+    #   The ARN of the AWS Identity and Access Management (IAM) role that
+    #   grants write permission to the S3 bucket.
+    #   @return [String]
+    #
+    # @!attribute [rw] kms_key_arn
+    #   The Amazon Resource Name (ARN) of the symmetric AWS Key Management
+    #   Service (AWS KMS) key that encrypts the exported mailbox content.
+    #   @return [String]
+    #
+    # @!attribute [rw] s3_bucket_name
+    #   The name of the S3 bucket.
+    #   @return [String]
+    #
+    # @!attribute [rw] s3_prefix
+    #   The S3 bucket prefix.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/StartMailboxExportJobRequest AWS API Documentation
+    #
+    class StartMailboxExportJobRequest < Struct.new(
+      :client_token,
+      :organization_id,
+      :entity_id,
+      :description,
+      :role_arn,
+      :kms_key_arn,
+      :s3_bucket_name,
+      :s3_prefix)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] job_id
+    #   The job ID.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/StartMailboxExportJobResponse AWS API Documentation
+    #
+    class StartMailboxExportJobResponse < Struct.new(
+      :job_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Describes a tag applied to a resource.
     #
     # @note When making an API call, you may pass Tag

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-workmail
 version: !ruby/object:Gem::Version
-  version: 1.29.0
+  version: 1.30.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core