AssociateDelegateToResource

$result = $client->associateDelegateToResource([/* ... */]);
$promise = $client->associateDelegateToResourceAsync([/* ... */]);

Adds a member (user or group) to the resource's set of delegates.

Parameter Syntax

$result = $client->associateDelegateToResource([
    'EntityId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

EntityStateException:

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

UnsupportedOperationException:

You can't perform a write operation against a read-only directory.

AssociateMemberToGroup

$result = $client->associateMemberToGroup([/* ... */]);
$promise = $client->associateMemberToGroupAsync([/* ... */]);

Adds a member (user or group) to the group's set.

Parameter Syntax

$result = $client->associateMemberToGroup([
    'GroupId' => '<string>', // REQUIRED
    'MemberId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryServiceAuthenticationFailedException:

The directory service doesn't recognize the credentials supplied by WorkMail.

DirectoryUnavailableException:

The directory is unavailable. It might be located in another Region or deleted.

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

EntityStateException:

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

UnsupportedOperationException:

You can't perform a write operation against a read-only directory.

AssumeImpersonationRole

$result = $client->assumeImpersonationRole([/* ... */]);
$promise = $client->assumeImpersonationRoleAsync([/* ... */]);

Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.

Parameter Syntax

$result = $client->assumeImpersonationRole([
    'ImpersonationRoleId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ExpiresIn' => <integer>,
    'Token' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

ResourceNotFoundException:

The resource cannot be found.

CancelMailboxExportJob

$result = $client->cancelMailboxExportJob([/* ... */]);
$promise = $client->cancelMailboxExportJobAsync([/* ... */]);

Cancels a mailbox export job.

Parameter Syntax

$result = $client->cancelMailboxExportJob([
    'ClientToken' => '<string>', // REQUIRED
    'JobId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

CreateAlias

$result = $client->createAlias([/* ... */]);
$promise = $client->createAliasAsync([/* ... */]);

Adds an alias to the set of a given member (user or group) of WorkMail.

Parameter Syntax

$result = $client->createAlias([
    'Alias' => '<string>', // REQUIRED
    'EntityId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EmailAddressInUseException:

The email address that you're trying to assign is already created for a different user, group, or resource.

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

EntityStateException:

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

MailDomainNotFoundException:

The domain specified is not found in your organization.

MailDomainStateException:

After a domain has been added to the organization, it must be verified. The domain is not yet verified.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

LimitExceededException:

The request exceeds the limit of the resource.

CreateAvailabilityConfiguration

$result = $client->createAvailabilityConfiguration([/* ... */]);
$promise = $client->createAvailabilityConfigurationAsync([/* ... */]);

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

Parameter Syntax

$result = $client->createAvailabilityConfiguration([
    'ClientToken' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'EwsProvider' => [
        'EwsEndpoint' => '<string>', // REQUIRED
        'EwsPassword' => '<string>', // REQUIRED
        'EwsUsername' => '<string>', // REQUIRED
    ],
    'LambdaProvider' => [
        'LambdaArn' => '<string>', // REQUIRED
    ],
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

NameAvailabilityException:

The user, group, or resource name isn't unique in WorkMail.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

LimitExceededException:

The request exceeds the limit of the resource.

CreateGroup

$result = $client->createGroup([/* ... */]);
$promise = $client->createGroupAsync([/* ... */]);

Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.

Parameter Syntax

$result = $client->createGroup([
    'HiddenFromGlobalAddressList' => true || false,
    'Name' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GroupId' => '<string>',
]

Result Details

Errors

DirectoryServiceAuthenticationFailedException:

The directory service doesn't recognize the credentials supplied by WorkMail.

DirectoryUnavailableException:

The directory is unavailable. It might be located in another Region or deleted.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

NameAvailabilityException:

The user, group, or resource name isn't unique in WorkMail.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

ReservedNameException:

This user, group, or resource name is not allowed in WorkMail.

UnsupportedOperationException:

You can't perform a write operation against a read-only directory.

CreateIdentityCenterApplication

$result = $client->createIdentityCenterApplication([/* ... */]);
$promise = $client->createIdentityCenterApplicationAsync([/* ... */]);

Creates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration. For more information, see PutIdentityProviderConfiguration. This action does not affect the authentication settings for any WorkMail organizations.

Parameter Syntax

$result = $client->createIdentityCenterApplication([
    'ClientToken' => '<string>',
    'InstanceArn' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationArn' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

CreateImpersonationRole

$result = $client->createImpersonationRole([/* ... */]);
$promise = $client->createImpersonationRoleAsync([/* ... */]);

Creates an impersonation role for the given WorkMail organization.

Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.

Parameter Syntax

$result = $client->createImpersonationRole([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
    'Rules' => [ // REQUIRED
        [
            'Description' => '<string>',
            'Effect' => 'ALLOW|DENY', // REQUIRED
            'ImpersonationRuleId' => '<string>', // REQUIRED
            'Name' => '<string>',
            'NotTargetUsers' => ['<string>', ...],
            'TargetUsers' => ['<string>', ...],
        ],
        // ...
    ],
    'Type' => 'FULL_ACCESS|READ_ONLY', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ImpersonationRoleId' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

EntityStateException:

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

LimitExceededException:

The request exceeds the limit of the resource.

CreateMobileDeviceAccessRule

$result = $client->createMobileDeviceAccessRule([/* ... */]);
$promise = $client->createMobileDeviceAccessRuleAsync([/* ... */]);

Creates a new mobile device access rule for the specified WorkMail organization.

Parameter Syntax

$result = $client->createMobileDeviceAccessRule([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'DeviceModels' => ['<string>', ...],
    'DeviceOperatingSystems' => ['<string>', ...],
    'DeviceTypes' => ['<string>', ...],
    'DeviceUserAgents' => ['<string>', ...],
    'Effect' => 'ALLOW|DENY', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'NotDeviceModels' => ['<string>', ...],
    'NotDeviceOperatingSystems' => ['<string>', ...],
    'NotDeviceTypes' => ['<string>', ...],
    'NotDeviceUserAgents' => ['<string>', ...],
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'MobileDeviceAccessRuleId' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

LimitExceededException:

The request exceeds the limit of the resource.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

CreateOrganization

$result = $client->createOrganization([/* ... */]);
$promise = $client->createOrganizationAsync([/* ... */]);

Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.

You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide.

Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.

Parameter Syntax

$result = $client->createOrganization([
    'Alias' => '<string>', // REQUIRED
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>',
    'Domains' => [
        [
            'DomainName' => '<string>', // REQUIRED
            'HostedZoneId' => '<string>',
        ],
        // ...
    ],
    'EnableInteroperability' => true || false,
    'KmsKeyArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'OrganizationId' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

DirectoryInUseException:

The directory is already in use by another WorkMail organization in the same account and Region.

DirectoryUnavailableException:

The directory is unavailable. It might be located in another Region or deleted.

LimitExceededException:

The request exceeds the limit of the resource.

NameAvailabilityException:

The user, group, or resource name isn't unique in WorkMail.

CreateResource

$result = $client->createResource([/* ... */]);
$promise = $client->createResourceAsync([/* ... */]);

Creates a new WorkMail resource.

Parameter Syntax

$result = $client->createResource([
    'Description' => '<string>',
    'HiddenFromGlobalAddressList' => true || false,
    'Name' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
    'Type' => 'ROOM|EQUIPMENT', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ResourceId' => '<string>',
]

Result Details

Errors

DirectoryServiceAuthenticationFailedException:

The directory service doesn't recognize the credentials supplied by WorkMail.

DirectoryUnavailableException:

The directory is unavailable. It might be located in another Region or deleted.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

NameAvailabilityException:

The user, group, or resource name isn't unique in WorkMail.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

ReservedNameException:

This user, group, or resource name is not allowed in WorkMail.

UnsupportedOperationException:

You can't perform a write operation against a read-only directory.

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.

Parameter Syntax

$result = $client->createUser([
    'DisplayName' => '<string>', // REQUIRED
    'FirstName' => '<string>',
    'HiddenFromGlobalAddressList' => true || false,
    'IdentityProviderUserId' => '<string>',
    'LastName' => '<string>',
    'Name' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
    'Password' => '<string>',
    'Role' => 'USER|RESOURCE|SYSTEM_USER|REMOTE_USER',
]);

Parameter Details

Result Syntax

[
    'UserId' => '<string>',
]

Result Details

Errors

DirectoryServiceAuthenticationFailedException:

The directory service doesn't recognize the credentials supplied by WorkMail.

DirectoryUnavailableException:

The directory is unavailable. It might be located in another Region or deleted.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

InvalidPasswordException:

The supplied password doesn't match the minimum security constraints, such as length or use of special characters.

NameAvailabilityException:

The user, group, or resource name isn't unique in WorkMail.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

ReservedNameException:

This user, group, or resource name is not allowed in WorkMail.

UnsupportedOperationException:

You can't perform a write operation against a read-only directory.

DeleteAccessControlRule

$result = $client->deleteAccessControlRule([/* ... */]);
$promise = $client->deleteAccessControlRuleAsync([/* ... */]);

Deletes an access control rule for the specified WorkMail organization.

Parameter Syntax

$result = $client->deleteAccessControlRule([
    'Name' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeleteAlias

$result = $client->deleteAlias([/* ... */]);
$promise = $client->deleteAliasAsync([/* ... */]);

Remove one or more specified aliases from a set of aliases for a given user.

Parameter Syntax

$result = $client->deleteAlias([
    'Alias' => '<string>', // REQUIRED
    'EntityId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

EntityStateException:

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeleteAvailabilityConfiguration

$result = $client->deleteAvailabilityConfiguration([/* ... */]);
$promise = $client->deleteAvailabilityConfigurationAsync([/* ... */]);

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

Parameter Syntax

$result = $client->deleteAvailabilityConfiguration([
    'DomainName' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeleteEmailMonitoringConfiguration

$result = $client->deleteEmailMonitoringConfiguration([/* ... */]);
$promise = $client->deleteEmailMonitoringConfigurationAsync([/* ... */]);

Deletes the email monitoring configuration for a specified organization.

Parameter Syntax

$result = $client->deleteEmailMonitoringConfiguration([
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeleteGroup

$result = $client->deleteGroup([/* ... */]);
$promise = $client->deleteGroupAsync([/* ... */]);

Deletes a group from WorkMail.

Parameter Syntax

$result = $client->deleteGroup([
    'GroupId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryServiceAuthenticationFailedException:

The directory service doesn't recognize the credentials supplied by WorkMail.

DirectoryUnavailableException:

The directory is unavailable. It might be located in another Region or deleted.

EntityStateException:

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

UnsupportedOperationException:

You can't perform a write operation against a read-only directory.

DeleteIdentityCenterApplication

$result = $client->deleteIdentityCenterApplication([/* ... */]);
$promise = $client->deleteIdentityCenterApplicationAsync([/* ... */]);

Deletes the IAM Identity Center application from WorkMail. This action does not affect the authentication settings for any WorkMail organizations.

Parameter Syntax

$result = $client->deleteIdentityCenterApplication([
    'ApplicationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeleteIdentityProviderConfiguration

$result = $client->deleteIdentityProviderConfiguration([/* ... */]);
$promise = $client->deleteIdentityProviderConfigurationAsync([/* ... */]);

Disables the integration between IdC and WorkMail. Authentication will continue with the directory as it was before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and mobile email clients.

Parameter Syntax

$result = $client->deleteIdentityProviderConfiguration([
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeleteImpersonationRole

$result = $client->deleteImpersonationRole([/* ... */]);
$promise = $client->deleteImpersonationRoleAsync([/* ... */]);

Deletes an impersonation role for the given WorkMail organization.

Parameter Syntax

$result = $client->deleteImpersonationRole([
    'ImpersonationRoleId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeleteMailboxPermissions

$result = $client->deleteMailboxPermissions([/* ... */]);
$promise = $client->deleteMailboxPermissionsAsync([/* ... */]);

Deletes permissions granted to a member (user or group).

Parameter Syntax

$result = $client->deleteMailboxPermissions([
    'EntityId' => '<string>', // REQUIRED
    'GranteeId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

EntityStateException:

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeleteMobileDeviceAccessOverride

$result = $client->deleteMobileDeviceAccessOverride([/* ... */]);
$promise = $client->deleteMobileDeviceAccessOverrideAsync([/* ... */]);

Deletes the mobile device access override for the given WorkMail organization, user, and device.

Parameter Syntax

$result = $client->deleteMobileDeviceAccessOverride([
    'DeviceId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

DeleteMobileDeviceAccessRule

$result = $client->deleteMobileDeviceAccessRule([/* ... */]);
$promise = $client->deleteMobileDeviceAccessRuleAsync([/* ... */]);

Deletes a mobile device access rule for the specified WorkMail organization.

Parameter Syntax

$result = $client->deleteMobileDeviceAccessRule([
    'MobileDeviceAccessRuleId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeleteOrganization

$result = $client->deleteOrganization([/* ... */]);
$promise = $client->deleteOrganizationAsync([/* ... */]);

Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.

Parameter Syntax

$result = $client->deleteOrganization([
    'ClientToken' => '<string>',
    'DeleteDirectory' => true || false, // REQUIRED
    'DeleteIdentityCenterApplication' => true || false,
    'ForceDelete' => true || false,
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'OrganizationId' => '<string>',
    'State' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeletePersonalAccessToken

$result = $client->deletePersonalAccessToken([/* ... */]);
$promise = $client->deletePersonalAccessTokenAsync([/* ... */]);

Deletes the Personal Access Token from the provided WorkMail Organization.

Parameter Syntax

$result = $client->deletePersonalAccessToken([
    'OrganizationId' => '<string>', // REQUIRED
    'PersonalAccessTokenId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeleteResource

$result = $client->deleteResource([/* ... */]);
$promise = $client->deleteResourceAsync([/* ... */]);

Deletes the specified resource.

Parameter Syntax

$result = $client->deleteResource([
    'OrganizationId' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityStateException:

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

UnsupportedOperationException:

You can't perform a write operation against a read-only directory.

DeleteRetentionPolicy

$result = $client->deleteRetentionPolicy([/* ... */]);
$promise = $client->deleteRetentionPolicyAsync([/* ... */]);

Deletes the specified retention policy from the specified organization.

Parameter Syntax

$result = $client->deleteRetentionPolicy([
    'Id' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state.

Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.

Parameter Syntax

$result = $client->deleteUser([
    'OrganizationId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryServiceAuthenticationFailedException:

The directory service doesn't recognize the credentials supplied by WorkMail.

DirectoryUnavailableException:

The directory is unavailable. It might be located in another Region or deleted.

EntityStateException:

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

UnsupportedOperationException:

You can't perform a write operation against a read-only directory.

DeregisterFromWorkMail

$result = $client->deregisterFromWorkMail([/* ... */]);
$promise = $client->deregisterFromWorkMailAsync([/* ... */]);

Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.

Parameter Syntax

$result = $client->deregisterFromWorkMail([
    'EntityId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

EntityStateException:

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DeregisterMailDomain

$result = $client->deregisterMailDomain([/* ... */]);
$promise = $client->deregisterMailDomainAsync([/* ... */]);

Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.

Parameter Syntax

$result = $client->deregisterMailDomain([
    'DomainName' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

MailDomainInUseException:

The domain you're trying to change is in use by another user or organization in your account. See the error message for details.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

InvalidCustomSesConfigurationException:

You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.

DescribeEmailMonitoringConfiguration

$result = $client->describeEmailMonitoringConfiguration([/* ... */]);
$promise = $client->describeEmailMonitoringConfigurationAsync([/* ... */]);

Describes the current email monitoring configuration for a specified organization.

Parameter Syntax

$result = $client->describeEmailMonitoringConfiguration([
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LogGroupArn' => '<string>',
    'RoleArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource cannot be found.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DescribeEntity

$result = $client->describeEntity([/* ... */]);
$promise = $client->describeEntityAsync([/* ... */]);

Returns basic details about an entity in WorkMail.

Parameter Syntax

$result = $client->describeEntity([
    'Email' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EntityId' => '<string>',
    'Name' => '<string>',
    'Type' => 'GROUP|USER|RESOURCE',
]

Result Details

Errors

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DescribeGroup

$result = $client->describeGroup([/* ... */]);
$promise = $client->describeGroupAsync([/* ... */]);

Returns the data available for the group.

Parameter Syntax

$result = $client->describeGroup([
    'GroupId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DisabledDate' => <DateTime>,
    'Email' => '<string>',
    'EnabledDate' => <DateTime>,
    'GroupId' => '<string>',
    'HiddenFromGlobalAddressList' => true || false,
    'Name' => '<string>',
    'State' => 'ENABLED|DISABLED|DELETED',
]

Result Details

Errors

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DescribeIdentityProviderConfiguration

$result = $client->describeIdentityProviderConfiguration([/* ... */]);
$promise = $client->describeIdentityProviderConfigurationAsync([/* ... */]);

Returns detailed information on the current IdC setup for the WorkMail organization.

Parameter Syntax

$result = $client->describeIdentityProviderConfiguration([
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AuthenticationMode' => 'IDENTITY_PROVIDER_ONLY|IDENTITY_PROVIDER_AND_DIRECTORY',
    'IdentityCenterConfiguration' => [
        'ApplicationArn' => '<string>',
        'InstanceArn' => '<string>',
    ],
    'PersonalAccessTokenConfiguration' => [
        'LifetimeInDays' => <integer>,
        'Status' => 'ACTIVE|INACTIVE',
    ],
]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

ResourceNotFoundException:

The resource cannot be found.

DescribeInboundDmarcSettings

$result = $client->describeInboundDmarcSettings([/* ... */]);
$promise = $client->describeInboundDmarcSettingsAsync([/* ... */]);

Lists the settings in a DMARC policy for a specified organization.

Parameter Syntax

$result = $client->describeInboundDmarcSettings([
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Enforced' => true || false,
]

Result Details

Errors

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DescribeMailboxExportJob

$result = $client->describeMailboxExportJob([/* ... */]);
$promise = $client->describeMailboxExportJobAsync([/* ... */]);

Describes the current status of a mailbox export job.

Parameter Syntax

$result = $client->describeMailboxExportJob([
    'JobId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'EndTime' => <DateTime>,
    'EntityId' => '<string>',
    'ErrorInfo' => '<string>',
    'EstimatedProgress' => <integer>,
    'KmsKeyArn' => '<string>',
    'RoleArn' => '<string>',
    'S3BucketName' => '<string>',
    'S3Path' => '<string>',
    'S3Prefix' => '<string>',
    'StartTime' => <DateTime>,
    'State' => 'RUNNING|COMPLETED|FAILED|CANCELLED',
]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

DescribeOrganization

$result = $client->describeOrganization([/* ... */]);
$promise = $client->describeOrganizationAsync([/* ... */]);

Provides more information regarding a given organization based on its identifier.

Parameter Syntax

$result = $client->describeOrganization([
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ARN' => '<string>',
    'Alias' => '<string>',
    'CompletedDate' => <DateTime>,
    'DefaultMailDomain' => '<string>',
    'DirectoryId' => '<string>',
    'DirectoryType' => '<string>',
    'ErrorMessage' => '<string>',
    'InteroperabilityEnabled' => true || false,
    'MigrationAdmin' => '<string>',
    'OrganizationId' => '<string>',
    'State' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

DescribeResource

$result = $client->describeResource([/* ... */]);
$promise = $client->describeResourceAsync([/* ... */]);

Returns the data available for the resource.

Parameter Syntax

$result = $client->describeResource([
    'OrganizationId' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BookingOptions' => [
        'AutoAcceptRequests' => true || false,
        'AutoDeclineConflictingRequests' => true || false,
        'AutoDeclineRecurringRequests' => true || false,
    ],
    'Description' => '<string>',
    'DisabledDate' => <DateTime>,
    'Email' => '<string>',
    'EnabledDate' => <DateTime>,
    'HiddenFromGlobalAddressList' => true || false,
    'Name' => '<string>',
    'ResourceId' => '<string>',
    'State' => 'ENABLED|DISABLED|DELETED',
    'Type' => 'ROOM|EQUIPMENT',
]

Result Details

Errors

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

UnsupportedOperationException:

You can't perform a write operation against a read-only directory.

DescribeUser

$result = $client->describeUser([/* ... */]);
$promise = $client->describeUserAsync([/* ... */]);

Provides information regarding the user.

Parameter Syntax

$result = $client->describeUser([
    'OrganizationId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'City' => '<string>',
    'Company' => '<string>',
    'Country' => '<string>',
    'Department' => '<string>',
    'DisabledDate' => <DateTime>,
    'DisplayName' => '<string>',
    'Email' => '<string>',
    'EnabledDate' => <DateTime>,
    'FirstName' => '<string>',
    'HiddenFromGlobalAddressList' => true || false,
    'IdentityProviderIdentityStoreId' => '<string>',
    'IdentityProviderUserId' => '<string>',
    'Initials' => '<string>',
    'JobTitle' => '<string>',
    'LastName' => '<string>',
    'MailboxDeprovisionedDate' => <DateTime>,
    'MailboxProvisionedDate' => <DateTime>,
    'Name' => '<string>',
    'Office' => '<string>',
    'State' => 'ENABLED|DISABLED|DELETED',
    'Street' => '<string>',
    'Telephone' => '<string>',
    'UserId' => '<string>',
    'UserRole' => 'USER|RESOURCE|SYSTEM_USER|REMOTE_USER',
    'ZipCode' => '<string>',
]

Result Details

Errors

DirectoryServiceAuthenticationFailedException:

The directory service doesn't recognize the credentials supplied by WorkMail.

DirectoryUnavailableException:

The directory is unavailable. It might be located in another Region or deleted.

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

DisassociateDelegateFromResource

$result = $client->disassociateDelegateFromResource([/* ... */]);
$promise = $client->disassociateDelegateFromResourceAsync([/* ... */]);

Removes a member from the resource's set of delegates.

Parameter Syntax

$result = $client->disassociateDelegateFromResource([
    'EntityId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

EntityStateException:

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

UnsupportedOperationException:

You can't perform a write operation against a read-only directory.

DisassociateMemberFromGroup

$result = $client->disassociateMemberFromGroup([/* ... */]);
$promise = $client->disassociateMemberFromGroupAsync([/* ... */]);

Removes a member from a group.

Parameter Syntax

$result = $client->disassociateMemberFromGroup([
    'GroupId' => '<string>', // REQUIRED
    'MemberId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryServiceAuthenticationFailedException:

The directory service doesn't recognize the credentials supplied by WorkMail.

DirectoryUnavailableException:

The directory is unavailable. It might be located in another Region or deleted.

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

EntityStateException:

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

UnsupportedOperationException:

You can't perform a write operation against a read-only directory.

GetAccessControlEffect

$result = $client->getAccessControlEffect([/* ... */]);
$promise = $client->getAccessControlEffectAsync([/* ... */]);

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.

Parameter Syntax

$result = $client->getAccessControlEffect([
    'Action' => '<string>', // REQUIRED
    'ImpersonationRoleId' => '<string>',
    'IpAddress' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
    'UserId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Effect' => 'ALLOW|DENY',
    'MatchedRules' => ['<string>', ...],
]

Result Details

Errors

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

ResourceNotFoundException:

The resource cannot be found.

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

GetDefaultRetentionPolicy

$result = $client->getDefaultRetentionPolicy([/* ... */]);
$promise = $client->getDefaultRetentionPolicyAsync([/* ... */]);

Gets the default retention policy details for the specified organization.

Parameter Syntax

$result = $client->getDefaultRetentionPolicy([
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'FolderConfigurations' => [
        [
            'Action' => 'NONE|DELETE|PERMANENTLY_DELETE',
            'Name' => 'INBOX|DELETED_ITEMS|SENT_ITEMS|DRAFTS|JUNK_EMAIL',
            'Period' => <integer>,
        ],
        // ...
    ],
    'Id' => '<string>',
    'Name' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

EntityNotFoundException:

The identifier supplied for the user, group, or resource does not exist in your organization.

GetImpersonationRole

$result = $client->getImpersonationRole([/* ... */]);
$promise = $client->getImpersonationRoleAsync([/* ... */]);

Gets the impersonation role details for the given WorkMail organization.

Parameter Syntax

$result = $client->getImpersonationRole([
    'ImpersonationRoleId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DateCreated' => <DateTime>,
    'DateModified' => <DateTime>,
    'Description' => '<string>',
    'ImpersonationRoleId' => '<string>',
    'Name' => '<string>',
    'Rules' => [
        [
            'Description' => '<string>',
            'Effect' => 'ALLOW|DENY',
            'ImpersonationRuleId' => '<string>',
            'Name' => '<string>',
            'NotTargetUsers' => ['<string>', ...],
            'TargetUsers' => ['<string>', ...],
        ],
        // ...
    ],
    'Type' => 'FULL_ACCESS|READ_ONLY',
]

Result Details

Errors

InvalidParameterException:

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException:

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException:

The organization must have a valid state to perform certain operations on the organization or its members.

ResourceNotFoundException:

The resource cannot be found.

GetImpersonationRoleEffect

$result = $client->getImpersonationRoleEffect([/* ... */]);
$promise = $client->getImpersonationRoleEffectAsync([/* ... */]);

Tests whether the given impersonation role can impersonate a target user.

Parameter Syntax

$result = $client->getImpersonationRoleEffect([
    'ImpersonationRoleId' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
    'TargetUser' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Effect' => 'ALLOW|DENY',
    'MatchedRules' => [
        [
            'ImpersonationRuleId' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'Type' => 'FULL_ACCESS|READ_ONLY',
]

Result Details