/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::WorkMail::StartMailboxExportJob

NAME

Paws::WorkMail::StartMailboxExportJob - Arguments for method StartMailboxExportJob on Paws::WorkMail

DESCRIPTION

This class represents the parameters used for calling the method StartMailboxExportJob on the Amazon WorkMail service. Use the attributes of this class as arguments to method StartMailboxExportJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartMailboxExportJob.

SYNOPSIS

my $workmail = Paws->service('WorkMail');
my $StartMailboxExportJobResponse = $workmail->StartMailboxExportJob(
  ClientToken    => 'MyIdempotencyClientToken',
  EntityId       => 'MyWorkMailIdentifier',
  KmsKeyArn      => 'MyKmsKeyArn',
  OrganizationId => 'MyOrganizationId',
  RoleArn        => 'MyRoleArn',
  S3BucketName   => 'MyS3BucketName',
  S3Prefix       => 'MyS3ObjectKey',
  Description    => 'MyDescription',              # OPTIONAL
);

# Results:
my $JobId = $StartMailboxExportJobResponse->JobId;

# Returns a L<Paws::WorkMail::StartMailboxExportJobResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/workmail/StartMailboxExportJob

ATTRIBUTES

REQUIRED ClientToken => Str

The idempotency token for the client request.

Description => Str

The mailbox export job description.

REQUIRED EntityId => Str

The identifier of the user or resource associated with the mailbox.

REQUIRED KmsKeyArn => Str

The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

REQUIRED OrganizationId => Str

The identifier associated with the organization.

REQUIRED RoleArn => Str

The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

REQUIRED S3BucketName => Str

The name of the S3 bucket.

REQUIRED S3Prefix => Str

The S3 bucket prefix.

SEE ALSO

This class forms part of Paws, documenting arguments for method StartMailboxExportJob in Paws::WorkMail

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues