Class: AWS.WorkMail

var params = {
  GroupId: 'STRING_VALUE', /* required */
  MemberId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.associateMemberToGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The organization under which the group exists.

  • GroupId — (String)

    The group to which the member (user or group) is associated.

    The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

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

    • Email address: group@domain.tld

    • Group name: group

  • MemberId — (String)

    The member (user or group) to associate to the group.

    The member ID can accept UserID or GroupId, Username or Groupname, or email.

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

    • Email address: member@domain.tld

    • Member name: member

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ImpersonationRoleId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.assumeImpersonationRole(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The WorkMail organization under which the impersonation role will be assumed.

  • ImpersonationRoleId — (String)

    The impersonation role ID to assume.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Token — (String)

      The authentication token for the impersonation role.

    • ExpiresIn — (Integer)

      The authentication token's validity, in seconds.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.cancelMailboxExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientToken — (String)

    The idempotency token for the client request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • JobId — (String)

    The job ID.

  • OrganizationId — (String)

    The organization ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Alias: 'STRING_VALUE', /* required */
  EntityId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.createAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The organization under which the member (user or group) exists.

  • EntityId — (String)

    The member (user or group) to which this alias is added.

  • Alias — (String)

    The alias to add to the member set.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  EwsProvider: {
    EwsEndpoint: 'STRING_VALUE', /* required */
    EwsPassword: 'STRING_VALUE', /* required */
    EwsUsername: 'STRING_VALUE' /* required */
  },
  LambdaProvider: {
    LambdaArn: 'STRING_VALUE' /* required */
  }
};
workmail.createAvailabilityConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientToken — (String)

    An idempotent token that ensures that an API request is executed only once.

    If a token is not provided, the SDK will use a version 4 UUID.
  • OrganizationId — (String)

    The WorkMail organization for which the AvailabilityConfiguration will be created.

  • DomainName — (String)

    The domain to which the provider applies.

  • EwsProvider — (map)

    Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.

    • EwsEndpoint — required — (String)

      The endpoint of the remote EWS server.

    • EwsUsername — required — (String)

      The username used to authenticate the remote EWS server.

    • EwsPassword — required — (String)

      The password used to authenticate the remote EWS server.

  • LambdaProvider — (map)

    Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.

    • LambdaArn — required — (String)

      The Amazon Resource Name (ARN) of the Lambda that acts as the availability provider.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE', /* required */
  HiddenFromGlobalAddressList: true || false
};
workmail.createGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The organization under which the group is to be created.

  • Name — (String)

    The name of the group.

  • HiddenFromGlobalAddressList — (Boolean)

    If this parameter is enabled, the group will be hidden from the address book.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • GroupId — (String)

      The identifier of the group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE', /* required */
  Rules: [ /* required */
    {
      Effect: ALLOW | DENY, /* required */
      ImpersonationRuleId: 'STRING_VALUE', /* required */
      Description: 'STRING_VALUE',
      Name: 'STRING_VALUE',
      NotTargetUsers: [
        'STRING_VALUE',
        /* more items */
      ],
      TargetUsers: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Type: FULL_ACCESS | READ_ONLY, /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE'
};
workmail.createImpersonationRole(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientToken — (String)

    The idempotency token for the client request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • OrganizationId — (String)

    The WorkMail organization to create the new impersonation role within.

  • Name — (String)

    The name of the new impersonation role.

  • Type — (String)

    The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.

    Possible values include:
    • "FULL_ACCESS"
    • "READ_ONLY"
  • Description — (String)

    The description of the new impersonation role.

  • Rules — (Array<map>)

    The list of rules for the impersonation role.

    • ImpersonationRuleId — required — (String)

      The identifier of the rule.

    • Name — (String)

      The rule name.

    • Description — (String)

      The rule description.

    • Effect — required — (String)

      The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.

      Possible values include:
      • "ALLOW"
      • "DENY"
    • TargetUsers — (Array<String>)

      A list of user IDs that match the rule.

    • NotTargetUsers — (Array<String>)

      A list of user IDs that don't match the rule.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ImpersonationRoleId — (String)

      The new impersonation role ID.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Effect: ALLOW | DENY, /* required */
  Name: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DeviceModels: [
    'STRING_VALUE',
    /* more items */
  ],
  DeviceOperatingSystems: [
    'STRING_VALUE',
    /* more items */
  ],
  DeviceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  DeviceUserAgents: [
    'STRING_VALUE',
    /* more items */
  ],
  NotDeviceModels: [
    'STRING_VALUE',
    /* more items */
  ],
  NotDeviceOperatingSystems: [
    'STRING_VALUE',
    /* more items */
  ],
  NotDeviceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  NotDeviceUserAgents: [
    'STRING_VALUE',
    /* more items */
  ]
};
workmail.createMobileDeviceAccessRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The WorkMail organization under which the rule will be created.

  • ClientToken — (String)

    The idempotency token for the client request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • Name — (String)

    The rule name.

  • Description — (String)

    The rule description.

  • Effect — (String)

    The effect of the rule when it matches. Allowed values are ALLOW or DENY.

    Possible values include:
    • "ALLOW"
    • "DENY"
  • DeviceTypes — (Array<String>)

    Device types that the rule will match.

  • NotDeviceTypes — (Array<String>)

    Device types that the rule will not match. All other device types will match.

  • DeviceModels — (Array<String>)

    Device models that the rule will match.

  • NotDeviceModels — (Array<String>)

    Device models that the rule will not match. All other device models will match.

  • DeviceOperatingSystems — (Array<String>)

    Device operating systems that the rule will match.

  • NotDeviceOperatingSystems — (Array<String>)

    Device operating systems that the rule will not match. All other device operating systems will match.

  • DeviceUserAgents — (Array<String>)

    Device user agents that the rule will match.

  • NotDeviceUserAgents — (Array<String>)

    Device user agents that the rule will not match. All other device user agents will match.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MobileDeviceAccessRuleId — (String)

      The identifier for the newly created mobile device access rule.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Alias: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DirectoryId: 'STRING_VALUE',
  Domains: [
    {
      DomainName: 'STRING_VALUE', /* required */
      HostedZoneId: 'STRING_VALUE'
    },
    /* more items */
  ],
  EnableInteroperability: true || false,
  KmsKeyArn: 'STRING_VALUE'
};
workmail.createOrganization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DirectoryId — (String)

    The AWS Directory Service directory ID.

  • Alias — (String)

    The organization alias.

  • ClientToken — (String)

    The idempotency token associated with the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • Domains — (Array<map>)

    The email domains to associate with the organization.

    • DomainName — required — (String)

      The fully qualified domain name.

    • HostedZoneId — (String)

      The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.

  • KmsKeyArn — (String)

    The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.

  • EnableInteroperability — (Boolean)

    When true, allows organization interoperability between WorkMail and Microsoft Exchange. If true, you must include a AD Connector directory ID in the request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • OrganizationId — (String)

      The organization ID.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE', /* required */
  Type: ROOM | EQUIPMENT, /* required */
  Description: 'STRING_VALUE',
  HiddenFromGlobalAddressList: true || false
};
workmail.createResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier associated with the organization for which the resource is created.

  • Name — (String)

    The name of the new resource.

  • Type — (String)

    The type of the new resource. The available types are equipment and room.

    Possible values include:
    • "ROOM"
    • "EQUIPMENT"
  • Description — (String)

    Resource description.

  • HiddenFromGlobalAddressList — (Boolean)

    If this parameter is enabled, the resource will be hidden from the address book.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ResourceId — (String)

      The identifier of the new resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DisplayName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE', /* required */
  FirstName: 'STRING_VALUE',
  HiddenFromGlobalAddressList: true || false,
  LastName: 'STRING_VALUE',
  Password: 'STRING_VALUE',
  Role: USER | RESOURCE | SYSTEM_USER | REMOTE_USER
};
workmail.createUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier of the organization for which the user is created.

  • Name — (String)

    The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

  • DisplayName — (String)

    The display name for the new user.

  • Password — (String)

    The password for the new user.

  • Role — (String)

    The role of the new user.

    You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

    Possible values include:
    • "USER"
    • "RESOURCE"
    • "SYSTEM_USER"
    • "REMOTE_USER"
  • FirstName — (String)

    The first name of the new user.

  • LastName — (String)

    The last name of the new user.

  • HiddenFromGlobalAddressList — (Boolean)

    If this parameter is enabled, the user will be hidden from the address book.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • UserId — (String)

      The identifier for the new user.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.deleteAccessControlRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier for the organization.

  • Name — (String)

    The name of the access control rule.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Alias: 'STRING_VALUE', /* required */
  EntityId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.deleteAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier for the organization under which the user exists.

  • EntityId — (String)

    The identifier for the member (user or group) from which to have the aliases removed.

  • Alias — (String)

    The aliases to be removed from the user's set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set).

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.deleteAvailabilityConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The WorkMail organization for which the AvailabilityConfiguration will be deleted.

  • DomainName — (String)

    The domain for which the AvailabilityConfiguration will be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.deleteEmailMonitoringConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The ID of the organization from which the email monitoring configuration is deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GroupId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.deleteGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The organization that contains the group.

  • GroupId — (String)

    The identifier of the group to be deleted.

    The identifier can be the GroupId, or Groupname. The following identity formats are available:

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

    • Group name: group

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ImpersonationRoleId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.deleteImpersonationRole(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The WorkMail organization from which to delete the impersonation role.

  • ImpersonationRoleId — (String)

    The ID of the impersonation role to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EntityId: 'STRING_VALUE', /* required */
  GranteeId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.deleteMailboxPermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier of the organization under which the member (user or group) exists.

  • EntityId — (String)

    The identifier of the entity that owns the mailbox.

    The identifier can be UserId or Group Id, Username or Groupname, or email.

    • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: entity@domain.tld

    • Entity name: entity

  • GranteeId — (String)

    The identifier of the entity for which to delete granted permissions.

    The identifier can be UserId, ResourceID, or Group Id, Username or Groupname, or email.

    • Grantee ID: 12345678-1234-1234-1234-123456789012,r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: grantee@domain.tld

    • Grantee name: grantee

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DeviceId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
workmail.deleteMobileDeviceAccessOverride(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

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

  • UserId — (String)

    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: user@domain.tld

    • User name: user

  • DeviceId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MobileDeviceAccessRuleId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.deleteMobileDeviceAccessRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The WorkMail organization under which the rule will be deleted.

  • MobileDeviceAccessRuleId — (String)

    The identifier of the rule to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DeleteDirectory: true || false, /* required */
  OrganizationId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  ForceDelete: true || false
};
workmail.deleteOrganization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientToken — (String)

    The idempotency token associated with the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • OrganizationId — (String)

    The organization ID.

  • DeleteDirectory — (Boolean)

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

  • ForceDelete — (Boolean)

    Deletes a WorkMail organization even if the organization has enabled users.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • OrganizationId — (String)

      The organization ID.

    • State — (String)

      The state of the organization.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  OrganizationId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE' /* required */
};
workmail.deleteResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier associated with the organization from which the resource is deleted.

  • ResourceId — (String)

    The identifier of the resource to be deleted.

    The identifier can accept ResourceId, or Resourcename. The following identity formats are available:

    • Resource ID: r-0123456789a0123456789b0123456789

    • Resource name: resource

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Id: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.deleteRetentionPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The organization ID.

  • Id — (String)

    The retention policy ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  OrganizationId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
workmail.deleteUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The organization that contains the user to be deleted.

  • UserId — (String)

    The identifier of the user to be deleted.

    The identifier can be the UserId or Username. The following identity formats are available:

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

    • User name: user

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EntityId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.deregisterFromWorkMail(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier for the organization under which the WorkMail entity exists.

  • EntityId — (String)

    The identifier for the member to be updated.

    The identifier can be UserId, ResourceId, or Group Id, Username, Resourcename, or Groupname, or email.

    • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: entity@domain.tld

    • Entity name: entity

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.deregisterMailDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The WorkMail organization for which the domain will be deregistered.

  • DomainName — (String)

    The domain to deregister in WorkMail and SES.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.describeEmailMonitoringConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The ID of the organization for which the email monitoring configuration is described.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.

    • LogGroupArn — (String)

      The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Email: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.describeEntity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier for the organization under which the entity exists.

  • Email — (String)

    The email under which the entity exists.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EntityId — (String)

      The entity ID under which the entity exists.

    • Name — (String)

      Username, GroupName, or ResourceName based on entity type.

    • Type — (String)

      Entity type.

      Possible values include:
      • "GROUP"
      • "USER"
      • "RESOURCE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GroupId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.describeGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier for the organization under which the group exists.

  • GroupId — (String)

    The identifier for the group to be described.

    The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

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

    • Email address: group@domain.tld

    • Group name: group

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • GroupId — (String)

      The identifier of the described group.

    • Name — (String)

      The name of the described group.

    • Email — (String)

      The email of the described group.

    • State — (String)

      The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

      Possible values include:
      • "ENABLED"
      • "DISABLED"
      • "DELETED"
    • EnabledDate — (Date)

      The date and time when a user was registered to WorkMail, in UNIX epoch time format.

    • DisabledDate — (Date)

      The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

    • HiddenFromGlobalAddressList — (Boolean)

      If the value is set to true, the group is hidden from the address book.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.describeInboundDmarcSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    Lists the ID of the given organization.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Enforced — (Boolean)

      Lists the enforcement setting of the applied policy.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.describeMailboxExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

    The mailbox export job ID.

  • OrganizationId — (String)

    The organization ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EntityId — (String)

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

    • Description — (String)

      The mailbox export job description.

    • RoleArn — (String)

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

    • KmsKeyArn — (String)

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

    • S3BucketName — (String)

      The name of the S3 bucket.

    • S3Prefix — (String)

      The S3 bucket prefix.

    • S3Path — (String)

      The path to the S3 bucket and file that the mailbox export job is exporting to.

    • EstimatedProgress — (Integer)

      The estimated progress of the mailbox export job, in percentage points.

    • State — (String)

      The state of the mailbox export job.

      Possible values include:
      • "RUNNING"
      • "COMPLETED"
      • "FAILED"
      • "CANCELLED"
    • ErrorInfo — (String)

      Error information for failed mailbox export jobs.

    • StartTime — (Date)

      The mailbox export job start timestamp.

    • EndTime — (Date)

      The mailbox export job end timestamp.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.describeOrganization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier for the organization to be described.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • OrganizationId — (String)

      The identifier of an organization.

    • Alias — (String)

      The alias for an organization.

    • State — (String)

      The state of an organization.

    • DirectoryId — (String)

      The identifier for the directory associated with an WorkMail organization.

    • DirectoryType — (String)

      The type of directory associated with the WorkMail organization.

    • DefaultMailDomain — (String)

      The default mail domain associated with the organization.

    • CompletedDate — (Date)

      The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.

    • ErrorMessage — (String)

      (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.

    • ARN — (String)

      The Amazon Resource Name (ARN) of the organization.

    • MigrationAdmin — (String)

      The user ID of the migration admin if migration is enabled for the organization.

    • InteroperabilityEnabled — (Boolean)

      Indicates if interoperability is enabled for this organization.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  OrganizationId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE' /* required */
};
workmail.describeResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier associated with the organization for which the resource is described.

  • ResourceId — (String)

    The identifier of the resource to be described.

    The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:

    • Resource ID: r-0123456789a0123456789b0123456789

    • Email address: resource@domain.tld

    • Resource name: resource

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ResourceId — (String)

      The identifier of the described resource.

    • Email — (String)

      The email of the described resource.

    • Name — (String)

      The name of the described resource.

    • Type — (String)

      The type of the described resource.

      Possible values include:
      • "ROOM"
      • "EQUIPMENT"
    • BookingOptions — (map)

      The booking options for the described resource.

      • AutoAcceptRequests — (Boolean)

        The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.

      • AutoDeclineRecurringRequests — (Boolean)

        The resource's ability to automatically decline any recurring requests.

      • AutoDeclineConflictingRequests — (Boolean)

        The resource's ability to automatically decline any conflicting requests.

    • State — (String)

      The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
      • "DELETED"
    • EnabledDate — (Date)

      The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

    • DisabledDate — (Date)

      The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.

    • Description — (String)

      Description of the resource.

    • HiddenFromGlobalAddressList — (Boolean)

      If enabled, the resource is hidden from the global address list.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  OrganizationId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
workmail.describeUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier for the organization under which the user exists.

  • UserId — (String)

    The identifier for the user to be described.

    The identifier can be the UserId, Username, or email. The following identity formats are available:

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

    • Email address: user@domain.tld

    • User name: user

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • UserId — (String)

      The identifier for the described user.

    • Name — (String)

      The name for the user.

    • Email — (String)

      The email of the user.

    • DisplayName — (String)

      The display name of the user.

    • State — (String)

      The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

      Possible values include:
      • "ENABLED"
      • "DISABLED"
      • "DELETED"
    • UserRole — (String)

      In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.

      Possible values include:
      • "USER"
      • "RESOURCE"
      • "SYSTEM_USER"
      • "REMOTE_USER"
    • EnabledDate — (Date)

      The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.

    • DisabledDate — (Date)

      The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.

    • MailboxProvisionedDate — (Date)

      The date when the mailbox was created for the user.

    • MailboxDeprovisionedDate — (Date)

      The date when the mailbox was removed for the user.

    • FirstName — (String)

      First name of the user.

    • LastName — (String)

      Last name of the user.

    • HiddenFromGlobalAddressList — (Boolean)

      If enabled, the user is hidden from the global address list.

    • Initials — (String)

      Initials of the user.

    • Telephone — (String)

      User's contact number.

    • Street — (String)

      Street where the user is located.

    • JobTitle — (String)

      Job title of the user.

    • City — (String)

      City where the user is located.

    • Company — (String)

      Company of the user.

    • ZipCode — (String)

      Zip code of the user.

    • Department — (String)

      Department of the user.

    • Country — (String)

      Country where the user is located.

    • Office — (String)

      Office where the user is located.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EntityId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE' /* required */
};
workmail.disassociateDelegateFromResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier for the organization under which the resource exists.

  • ResourceId — (String)

    The identifier of the resource from which delegates' set members are removed.

    The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:

    • Resource ID: r-0123456789a0123456789b0123456789

    • Email address: resource@domain.tld

    • Resource name: resource

  • EntityId — (String)

    The identifier for the member (user, group) to be removed from the resource's delegates.

    The entity ID can accept UserId or GroupID, Username or Groupname, or email.

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

    • Email address: entity@domain.tld

    • Entity: entity

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GroupId: 'STRING_VALUE', /* required */
  MemberId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.disassociateMemberFromGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier for the organization under which the group exists.

  • GroupId — (String)

    The identifier for the group from which members are removed.

    The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

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

    • Email address: group@domain.tld

    • Group name: group

  • MemberId — (String)

    The identifier for the member to be removed from the group.

    The member ID can accept UserID or GroupId, Username or Groupname, or email.

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

    • Email address: member@domain.tld

    • Member name: member

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Action: 'STRING_VALUE', /* required */
  IpAddress: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE', /* required */
  ImpersonationRoleId: 'STRING_VALUE',
  UserId: 'STRING_VALUE'
};
workmail.getAccessControlEffect(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The identifier for the organization.

  • IpAddress — (String)

    The IPv4 address.

  • Action — (String)

    The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

  • UserId — (String)

    The user ID.

  • ImpersonationRoleId — (String)

    The impersonation role ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Effect — (String)

      The rule effect.

      Possible values include:
      • "ALLOW"
      • "DENY"
    • MatchedRules — (Array<String>)

      The rules that match the given parameters, resulting in an effect.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.getDefaultRetentionPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The organization ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Id — (String)

      The retention policy ID.

    • Name — (String)

      The retention policy name.

    • Description — (String)

      The retention policy description.

    • FolderConfigurations — (Array<map>)

      The retention policy folder configurations.

      • Name — required — (String)

        The folder name.

        Possible values include:
        • "INBOX"
        • "DELETED_ITEMS"
        • "SENT_ITEMS"
        • "DRAFTS"
        • "JUNK_EMAIL"
      • Action — required — (String)

        The action to take on the folder contents at the end of the folder configuration period.

        Possible values include:
        • "NONE"
        • "DELETE"
        • "PERMANENTLY_DELETE"
      • Period — (Integer)

        The number of days for which the folder-configuration action applies.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ImpersonationRoleId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE' /* required */
};
workmail.getImpersonationRole(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The WorkMail organization from which to retrieve the impersonation role.

  • ImpersonationRoleId — (String)

    The impersonation role ID to retrieve.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ImpersonationRoleId — (String)

      The impersonation role ID.

    • Name — (String)

      The impersonation role name.

    • Type — (String)

      The impersonation role type.

      Possible values include:
      • "FULL_ACCESS"
      • "READ_ONLY"
    • Description — (String)

      The impersonation role description.

    • Rules — (Array<map>)

      The list of rules for the given impersonation role.

      • ImpersonationRuleId — required — (String)

        The identifier of the rule.

      • Name — (String)

        The rule name.

      • Description — (String)

        The rule description.

      • Effect — required — (String)

        The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.

        Possible values include:
        • "ALLOW"
        • "DENY"
      • TargetUsers — (Array<String>)

        A list of user IDs that match the rule.

      • NotTargetUsers — (Array<String>)

        A list of user IDs that don't match the rule.

    • DateCreated — (Date)

      The date when the impersonation role was created.

    • DateModified — (Date)

      The date when the impersonation role was last modified.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ImpersonationRoleId: 'STRING_VALUE', /* required */
  OrganizationId: 'STRING_VALUE', /* required */
  TargetUser: 'STRING_VALUE' /* required */
};
workmail.getImpersonationRoleEffect(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OrganizationId — (String)

    The WorkMail organization where the impersonation role is defined.

  • ImpersonationRoleId — (String)

    The impersonation role ID to test.

  • TargetUser — (String)

    The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:

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

    • Email address: user@domain.tld

    • User name: user

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Type — (String)

      The impersonation role type.

      Possible values include:
      • "FULL_ACCESS"
      • "READ_ONLY"
    • Effect — (String)

      Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.

      Possible values include:
      • "ALLOW"
      • "DENY"
    • MatchedRules — (Array<map>)

      A list of the rules that match the input and produce the configured effect.

      • ImpersonationRuleId — (String)

        The ID of the rule that matched the input

      • Name — (String)

        The name of the rule that matched the input.