DeleteEmailMonitoringConﬁguration

Service: Amazon WorkMail

Deletes the email monitoring conﬁguration for a speciﬁed organization.

Request Syntax

{ "OrganizationId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 226).

The request accepts the following data in JSON format.

OrganizationId (p. 37)

The ID of the organization from which the email monitoring conﬁguration is deleted.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 228).

InvalidParameterException

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

HTTP Status Code: 400 OrganizationNotFoundException

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

HTTP Status Code: 400 OrganizationStateException

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

HTTP Status Code: 400

DeleteEmailMonitoringConﬁguration

Request Syntax

{

"GroupId": "string", "OrganizationId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 226).

The request accepts the following data in JSON format.

GroupId (p. 39)

The identiﬁer of the group to be deleted.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: Yes OrganizationId (p. 39)

The organization that contains the group.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 228).

DirectoryServiceAuthenticationFailedException

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

HTTP Status Code: 400 DirectoryUnavailableException

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

DeleteGroup

HTTP Status Code: 400 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.

HTTP Status Code: 400 InvalidParameterException

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

HTTP Status Code: 400 OrganizationNotFoundException

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

HTTP Status Code: 400 OrganizationStateException

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

HTTP Status Code: 400 UnsupportedOperationException

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

HTTP Status Code: 400

Request Syntax

{

"EntityId": "string", "GranteeId": "string", "OrganizationId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 226).

The request accepts the following data in JSON format.

EntityId (p. 41)

The identiﬁer of the member (user or group) that owns the mailbox.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: Yes GranteeId (p. 41)

The identiﬁer of the member (user or group) for which to delete granted permissions.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: Yes OrganizationId (p. 41)

The identiﬁer of the organization under which the member (user or group) exists.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 228).

DeleteMailboxPermissions

EntityNotFoundException

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

HTTP Status Code: 400 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.

HTTP Status Code: 400 InvalidParameterException

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

HTTP Status Code: 400 OrganizationNotFoundException

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

HTTP Status Code: 400 OrganizationStateException

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

HTTP Status Code: 400

Request Syntax

{ "DeviceId": "string", "OrganizationId": "string", "UserId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 226).

The request accepts the following data in JSON format.

DeviceId (p. 43)

The mobile device for which you delete the override. DeviceId is case insensitive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: [A-Za-z0-9]+

Required: Yes OrganizationId (p. 43)

The Amazon WorkMail organization for which the access override will be deleted.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes UserId (p. 43)

The WorkMail user for which you want to delete the override. Accepts the following types of user identities:

• User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

• Email address: [email protected]

• User name: user Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

DeleteMobileDeviceAccessOverride

Pattern: [a-zA-Z0-9._%+@-]+

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 228).

EntityNotFoundException

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

HTTP Status Code: 400 InvalidParameterException

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

HTTP Status Code: 400 OrganizationNotFoundException

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

HTTP Status Code: 400 OrganizationStateException

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

HTTP Status Code: 400

Request Syntax

{ "MobileDeviceAccessRuleId": "string", "OrganizationId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 226).

The request accepts the following data in JSON format.

MobileDeviceAccessRuleId (p. 45)

The identiﬁer of the rule to be deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

Required: Yes OrganizationId (p. 45)

The Amazon WorkMail organization under which the rule will be deleted.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 228).

InvalidParameterException

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

DeleteMobileDeviceAccessRule

HTTP Status Code: 400 OrganizationNotFoundException

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

HTTP Status Code: 400 OrganizationStateException

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

HTTP Status Code: 400

Request Syntax

{ "ClientToken": "string", "DeleteDirectory": boolean, "OrganizationId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 226).

The request accepts the following data in JSON format.

ClientToken (p. 47)

The idempotency token associated with the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\x21-\x7e]+

Required: No DeleteDirectory (p. 47)

If true, deletes the AWS Directory Service directory associated with the organization.

Type: Boolean Required: Yes OrganizationId (p. 47)

The organization ID.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Syntax

{ "OrganizationId": "string",

DeleteOrganization

"State": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

OrganizationId (p. 47) The organization ID.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

State (p. 47)

The state of the organization.

Type: String

Length Constraints: Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 228).

InvalidParameterException

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

HTTP Status Code: 400 OrganizationNotFoundException

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

HTTP Status Code: 400 OrganizationStateException

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

HTTP Status Code: 400

Request Syntax

{ "OrganizationId": "string", "ResourceId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 226).

The request accepts the following data in JSON format.

OrganizationId (p. 50)

The identiﬁer associated with the organization from which the resource is deleted.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes ResourceId (p. 50)

The identiﬁer of the resource to be deleted.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^r-[0-9a-f]{32}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 228).

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.

HTTP Status Code: 400

DeleteResource

InvalidParameterException

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

HTTP Status Code: 400 OrganizationNotFoundException

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

HTTP Status Code: 400 OrganizationStateException

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

HTTP Status Code: 400

Request Syntax

{ "Id": "string",

"OrganizationId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 226).

The request accepts the following data in JSON format.

Id (p. 52)

The retention policy ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

Required: Yes OrganizationId (p. 52)

The organization ID.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 228).

InvalidParameterException

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

HTTP Status Code: 400

DeleteRetentionPolicy

OrganizationNotFoundException

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

HTTP Status Code: 400 OrganizationStateException

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

HTTP Status Code: 400

Request Syntax

{

"OrganizationId": "string", "UserId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 226).

The request accepts the following data in JSON format.

OrganizationId (p. 54)

The organization that contains the user to be deleted.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes UserId (p. 54)

The identiﬁer of the user to be deleted.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 228).

DirectoryServiceAuthenticationFailedException

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

HTTP Status Code: 400

DeleteUser

DirectoryUnavailableException

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

HTTP Status Code: 400 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.

HTTP Status Code: 400 InvalidParameterException

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

HTTP Status Code: 400 OrganizationNotFoundException

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

HTTP Status Code: 400 OrganizationStateException

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

HTTP Status Code: 400 UnsupportedOperationException

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

HTTP Status Code: 400

Request Syntax

{ "EntityId": "string", "OrganizationId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 226).

The request accepts the following data in JSON format.

EntityId (p. 56)

The identiﬁer for the member (user or group) to be updated.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: Yes OrganizationId (p. 56)

The identiﬁer for the organization under which the Amazon WorkMail entity exists.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 228).

EntityNotFoundException

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

HTTP Status Code: 400

DeregisterFromWorkMail

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.

HTTP Status Code: 400 InvalidParameterException

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

HTTP Status Code: 400 OrganizationNotFoundException

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

HTTP Status Code: 400 OrganizationStateException

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

HTTP Status Code: 400

Request Syntax

{

"DomainName": "string", "OrganizationId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 226).

The request accepts the following data in JSON format.

DomainName (p. 58)

The domain to deregister in WorkMail and SES.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 209.

Pattern: [a-zA-Z0-9.-]+\.[a-zA-Z-]{2,}

Required: Yes OrganizationId (p. 58)

The Amazon WorkMail organization for which the domain will be deregistered.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 228).

InvalidCustomSesConﬁgurationException

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

DeregisterMailDomain

HTTP Status Code: 400 InvalidParameterException

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

HTTP Status Code: 400 MailDomainInUseException

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

在文檔中 Amazon WorkMail (頁 41-64)

DeleteEmailMonitoringConﬁguration