GetAccessControlEffect
Service: Amazon WorkMail
Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.
Request Syntax
{ "Action": "string", "IpAddress": "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.
Action (p. 85)
The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z]+
Required: Yes IpAddress (p. 85)
The IPv4 address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 15.
Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9]
[0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Required: Yes OrganizationId (p. 85)
The identifier for the organization.
Type: String
Length Constraints: Fixed length of 34.
Pattern: ^m-[0-9a-f]{32}$
Required: Yes
GetAccessControlEffect
UserId (p. 85) The user ID.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 256.
Required: Yes
Response Syntax
{ "Effect": "string",
"MatchedRules": [ "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.
Effect (p. 86) The rule effect.
Type: String
Valid Values: ALLOW | DENY MatchedRules (p. 86)
The rules that match the given parameters, resulting in an effect.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9_-]+
Errors
For information about the errors that are common to all actions, see Common Errors (p. 228).
EntityNotFoundException
The identifier 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
GetAccessControlEffect
OrganizationNotFoundException
An operation received a valid organization identifier 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetDefaultRetentionPolicy
GetDefaultRetentionPolicy
Service: Amazon WorkMail
Gets the default retention policy details for the specified 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. 88) The organization ID.
Type: String
Length Constraints: Fixed length of 34.
Pattern: ^m-[0-9a-f]{32}$
Required: Yes
Response Syntax
{
"Description": "string", "FolderConfigurations": [ {
"Id": "string", "Name": "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.
Description (p. 88)
The retention policy description.
Type: String
GetDefaultRetentionPolicy
Length Constraints: Maximum length of 256.
FolderConfigurations (p. 88)
The retention policy folder configurations.
Type: Array of FolderConfiguration (p. 202) objects Id (p. 88)
The retention policy ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9_-]+
Name (p. 88)
The retention policy name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9_-]+
Errors
For information about the errors that are common to all actions, see Common Errors (p. 228).
EntityNotFoundException
The identifier 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 identifier 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
GetDefaultRetentionPolicy
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetMailboxDetails
GetMailboxDetails
Service: Amazon WorkMail
Requests a user's mailbox details for a specified organization and user.
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. 91)
The identifier for the organization that contains the user whose mailbox details are being requested.
Type: String
Length Constraints: Fixed length of 34.
Pattern: ^m-[0-9a-f]{32}$
Required: Yes UserId (p. 91)
The identifier for the user whose mailbox details are being requested.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 256.
Required: Yes
Response Syntax
{
"MailboxQuota": number, "MailboxSize": number }
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.
MailboxQuota (p. 91)
The maximum allowed mailbox size, in MB, for the specified user.
GetMailboxDetails
Type: Integer
Valid Range: Minimum value of 1.
MailboxSize (p. 91)
The current mailbox size, in MB, for the specified user.
Type: Double
Valid Range: Minimum value of 0.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 228).
EntityNotFoundException
The identifier supplied for the user, group, or resource does not exist in your organization.
HTTP Status Code: 400 OrganizationNotFoundException
An operation received a valid organization identifier 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetMailDomain
GetMailDomain
Service: Amazon WorkMail
Gets details for a mail domain, including domain records required to configure your domain with recommended security.
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. 93)
The domain from which you want to retrieve details.
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. 93)
The Amazon WorkMail organization for which the domain is retrieved.
Type: String
Length Constraints: Fixed length of 34.
Pattern: ^m-[0-9a-f]{32}$
Required: Yes
Response Syntax
{ "DkimVerificationStatus": "string", "IsDefault": boolean,
"IsTestDomain": boolean,
"OwnershipVerificationStatus": "string", "Records": [
GetMailDomain
}
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.
DkimVerificationStatus (p. 93)
Indicates the status of a DKIM verification.
Type: String
Valid Values: PENDING | VERIFIED | FAILED IsDefault (p. 93)
Specifies whether the domain is the default domain for your organization.
Type: Boolean IsTestDomain (p. 93)
Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.
Type: Boolean
OwnershipVerificationStatus (p. 93)
Indicates the status of the domain ownership verification.
Type: String
Valid Values: PENDING | VERIFIED | FAILED Records (p. 93)
A list of the DNS records that Amazon WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details.
Type: Array of DnsRecord (p. 200) objects
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 MailDomainNotFoundException
The domain specified is not found in your organization.
HTTP Status Code: 400 OrganizationNotFoundException
An operation received a valid organization identifier that either doesn't belong or exist in the system.
GetMailDomain
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3