Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListAvailabilityConfigurations

Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

List all the AvailabilityConfiguration's for the given WorkMail organization.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "OrganizationId": "string"
}

Request Parameters

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

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return in a single call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token to use to retrieve the next page of results. The first call does not require a token.

Type: String

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

Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024}

Required: No

OrganizationId

The WorkMail organization for which the AvailabilityConfiguration's will be listed.

Type: String

Length Constraints: Fixed length of 34.

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

Required: Yes

Response Syntax


{
   "AvailabilityConfigurations": [ 
      { 
         "DateCreated": number,
         "DateModified": number,
         "DomainName": "string",
         "EwsProvider": { 
            "EwsEndpoint": "string",
            "EwsUsername": "string"
         },
         "LambdaProvider": { 
            "LambdaArn": "string"
         },
         "ProviderType": "string"
      }
   ],
   "NextToken": "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.

AvailabilityConfigurations

The list of AvailabilityConfiguration's that exist for the specified WorkMail organization.

Type: Array of AvailabilityConfiguration objects

NextToken

The token to use to retrieve the next page of results. The value is null when there are no further results to return.

Type: String

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

Pattern: [\S\s]*|[a-zA-Z0-9/+=]{1,1024}

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidParameterException

Important

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

HTTP Status Code: 400

OrganizationNotFoundException

Important

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

HTTP Status Code: 400

OrganizationStateException

Important

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

HTTP Status Code: 400