From 87bd7c79c32b290430709179354f113910189398 Mon Sep 17 00:00:00 2001 From: AwsSdkPhpAutomation Date: Mon, 18 Sep 2023 18:11:01 +0000 Subject: [PATCH] Update models for release --- .changes/3.281.9 | 17 + CHANGELOG.md | 6 + src/WorkMail/WorkMailClient.php | 8 + src/data/discovery/2015-11-01/api-2.json | 3 +- src/data/discovery/2015-11-01/api-2.json.php | 2 +- .../2015-11-01/endpoint-rule-set-1.json | 344 +++++++-------- .../2015-11-01/endpoint-rule-set-1.json.php | 2 +- src/data/macie2/2020-01-01/docs-2.json | 4 +- src/data/macie2/2020-01-01/docs-2.json.php | 2 +- .../2020-01-01/endpoint-rule-set-1.json | 344 +++++++-------- .../2020-01-01/endpoint-rule-set-1.json.php | 2 +- src/data/workmail/2017-10-01/api-2.json | 391 +++++++++++++++--- src/data/workmail/2017-10-01/api-2.json.php | 2 +- src/data/workmail/2017-10-01/docs-2.json | 251 +++++++++-- src/data/workmail/2017-10-01/docs-2.json.php | 2 +- .../2017-10-01/endpoint-rule-set-1.json | 341 ++++++++------- .../2017-10-01/endpoint-rule-set-1.json.php | 2 +- .../workmail/2017-10-01/endpoint-tests-1.json | 265 +++++++++--- .../2017-10-01/endpoint-tests-1.json.php | 2 +- .../workmail/2017-10-01/paginators-1.json | 5 + .../workmail/2017-10-01/paginators-1.json.php | 2 +- 21 files changed, 1275 insertions(+), 722 deletions(-) create mode 100644 .changes/3.281.9 diff --git a/.changes/3.281.9 b/.changes/3.281.9 new file mode 100644 index 0000000000..3363c91cf4 --- /dev/null +++ b/.changes/3.281.9 @@ -0,0 +1,17 @@ +[ + { + "type": "api-change", + "category": "WorkMail", + "description": "This release includes four new APIs UpdateUser, UpdateGroup, ListGroupsForEntity and DescribeEntity, along with RemoteUsers and some enhancements to existing APIs." + }, + { + "type": "api-change", + "category": "ApplicationDiscoveryService", + "description": "Add sensitive protection for customer information" + }, + { + "type": "enhancement", + "category": "Macie2", + "description": "This release changes the default managedDataIdentifierSelector setting for new classification jobs to RECOMMENDED. By default, new classification jobs now use the recommended set of managed data identifiers." + } +] diff --git a/CHANGELOG.md b/CHANGELOG.md index 92913427d9..e3602b98b5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # CHANGELOG +## next release + +* `Aws\WorkMail` - This release includes four new APIs UpdateUser, UpdateGroup, ListGroupsForEntity and DescribeEntity, along with RemoteUsers and some enhancements to existing APIs. +* `Aws\ApplicationDiscoveryService` - Add sensitive protection for customer information +* `Aws\Macie2` - This release changes the default managedDataIdentifierSelector setting for new classification jobs to RECOMMENDED. By default, new classification jobs now use the recommended set of managed data identifiers. + ## 3.281.8 - 2023-09-15 * `Aws\SageMaker` - This release introduces Skip Model Validation for Model Packages diff --git a/src/WorkMail/WorkMailClient.php b/src/WorkMail/WorkMailClient.php index b2509c3ca4..9f3a67da9e 100644 --- a/src/WorkMail/WorkMailClient.php +++ b/src/WorkMail/WorkMailClient.php @@ -61,6 +61,8 @@ * @method \GuzzleHttp\Promise\Promise deregisterMailDomainAsync(array $args = []) * @method \Aws\Result describeEmailMonitoringConfiguration(array $args = []) * @method \GuzzleHttp\Promise\Promise describeEmailMonitoringConfigurationAsync(array $args = []) + * @method \Aws\Result describeEntity(array $args = []) + * @method \GuzzleHttp\Promise\Promise describeEntityAsync(array $args = []) * @method \Aws\Result describeGroup(array $args = []) * @method \GuzzleHttp\Promise\Promise describeGroupAsync(array $args = []) * @method \Aws\Result describeInboundDmarcSettings(array $args = []) @@ -103,6 +105,8 @@ * @method \GuzzleHttp\Promise\Promise listGroupMembersAsync(array $args = []) * @method \Aws\Result listGroups(array $args = []) * @method \GuzzleHttp\Promise\Promise listGroupsAsync(array $args = []) + * @method \Aws\Result listGroupsForEntity(array $args = []) + * @method \GuzzleHttp\Promise\Promise listGroupsForEntityAsync(array $args = []) * @method \Aws\Result listImpersonationRoles(array $args = []) * @method \GuzzleHttp\Promise\Promise listImpersonationRolesAsync(array $args = []) * @method \Aws\Result listMailDomains(array $args = []) @@ -155,6 +159,8 @@ * @method \GuzzleHttp\Promise\Promise updateAvailabilityConfigurationAsync(array $args = []) * @method \Aws\Result updateDefaultMailDomain(array $args = []) * @method \GuzzleHttp\Promise\Promise updateDefaultMailDomainAsync(array $args = []) + * @method \Aws\Result updateGroup(array $args = []) + * @method \GuzzleHttp\Promise\Promise updateGroupAsync(array $args = []) * @method \Aws\Result updateImpersonationRole(array $args = []) * @method \GuzzleHttp\Promise\Promise updateImpersonationRoleAsync(array $args = []) * @method \Aws\Result updateMailboxQuota(array $args = []) @@ -165,5 +171,7 @@ * @method \GuzzleHttp\Promise\Promise updatePrimaryEmailAddressAsync(array $args = []) * @method \Aws\Result updateResource(array $args = []) * @method \GuzzleHttp\Promise\Promise updateResourceAsync(array $args = []) + * @method \Aws\Result updateUser(array $args = []) + * @method \GuzzleHttp\Promise\Promise updateUserAsync(array $args = []) */ class WorkMailClient extends AwsClient {} diff --git a/src/data/discovery/2015-11-01/api-2.json b/src/data/discovery/2015-11-01/api-2.json index d538ff0aed..24718e0740 100644 --- a/src/data/discovery/2015-11-01/api-2.json +++ b/src/data/discovery/2015-11-01/api-2.json @@ -473,7 +473,8 @@ "members":{ "ipAddress":{"shape":"String"}, "macAddress":{"shape":"String"} - } + }, + "sensitive":true }, "AgentNetworkInfoList":{ "type":"list", diff --git a/src/data/discovery/2015-11-01/api-2.json.php b/src/data/discovery/2015-11-01/api-2.json.php index 121fe862d8..69de2ea932 100644 --- a/src/data/discovery/2015-11-01/api-2.json.php +++ b/src/data/discovery/2015-11-01/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2015-11-01', 'endpointPrefix' => 'discovery', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'AWS Application Discovery Service', 'serviceId' => 'Application Discovery Service', 'signatureVersion' => 'v4', 'targetPrefix' => 'AWSPoseidonService_V2015_11_01', 'uid' => 'discovery-2015-11-01', ], 'operations' => [ 'AssociateConfigurationItemsToApplication' => [ 'name' => 'AssociateConfigurationItemsToApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateConfigurationItemsToApplicationRequest', ], 'output' => [ 'shape' => 'AssociateConfigurationItemsToApplicationResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'BatchDeleteImportData' => [ 'name' => 'BatchDeleteImportData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchDeleteImportDataRequest', ], 'output' => [ 'shape' => 'BatchDeleteImportDataResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'CreateApplication' => [ 'name' => 'CreateApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateApplicationRequest', ], 'output' => [ 'shape' => 'CreateApplicationResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'CreateTags' => [ 'name' => 'CreateTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTagsRequest', ], 'output' => [ 'shape' => 'CreateTagsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DeleteApplications' => [ 'name' => 'DeleteApplications', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationsRequest', ], 'output' => [ 'shape' => 'DeleteApplicationsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DeleteTags' => [ 'name' => 'DeleteTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTagsRequest', ], 'output' => [ 'shape' => 'DeleteTagsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DescribeAgents' => [ 'name' => 'DescribeAgents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAgentsRequest', ], 'output' => [ 'shape' => 'DescribeAgentsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DescribeConfigurations' => [ 'name' => 'DescribeConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigurationsRequest', ], 'output' => [ 'shape' => 'DescribeConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DescribeContinuousExports' => [ 'name' => 'DescribeContinuousExports', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContinuousExportsRequest', ], 'output' => [ 'shape' => 'DescribeContinuousExportsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'OperationNotPermittedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DescribeExportConfigurations' => [ 'name' => 'DescribeExportConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExportConfigurationsRequest', ], 'output' => [ 'shape' => 'DescribeExportConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], 'deprecated' => true, ], 'DescribeExportTasks' => [ 'name' => 'DescribeExportTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExportTasksRequest', ], 'output' => [ 'shape' => 'DescribeExportTasksResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DescribeImportTasks' => [ 'name' => 'DescribeImportTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImportTasksRequest', ], 'output' => [ 'shape' => 'DescribeImportTasksResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DescribeTags' => [ 'name' => 'DescribeTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTagsRequest', ], 'output' => [ 'shape' => 'DescribeTagsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DisassociateConfigurationItemsFromApplication' => [ 'name' => 'DisassociateConfigurationItemsFromApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateConfigurationItemsFromApplicationRequest', ], 'output' => [ 'shape' => 'DisassociateConfigurationItemsFromApplicationResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'ExportConfigurations' => [ 'name' => 'ExportConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'output' => [ 'shape' => 'ExportConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'OperationNotPermittedException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], 'deprecated' => true, ], 'GetDiscoverySummary' => [ 'name' => 'GetDiscoverySummary', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiscoverySummaryRequest', ], 'output' => [ 'shape' => 'GetDiscoverySummaryResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'ListConfigurations' => [ 'name' => 'ListConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListConfigurationsRequest', ], 'output' => [ 'shape' => 'ListConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'ListServerNeighbors' => [ 'name' => 'ListServerNeighbors', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServerNeighborsRequest', ], 'output' => [ 'shape' => 'ListServerNeighborsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'StartContinuousExport' => [ 'name' => 'StartContinuousExport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartContinuousExportRequest', ], 'output' => [ 'shape' => 'StartContinuousExportResponse', ], 'errors' => [ [ 'shape' => 'ConflictErrorException', ], [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'OperationNotPermittedException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'StartDataCollectionByAgentIds' => [ 'name' => 'StartDataCollectionByAgentIds', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDataCollectionByAgentIdsRequest', ], 'output' => [ 'shape' => 'StartDataCollectionByAgentIdsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'StartExportTask' => [ 'name' => 'StartExportTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartExportTaskRequest', ], 'output' => [ 'shape' => 'StartExportTaskResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'OperationNotPermittedException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'StartImportTask' => [ 'name' => 'StartImportTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartImportTaskRequest', ], 'output' => [ 'shape' => 'StartImportTaskResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'StopContinuousExport' => [ 'name' => 'StopContinuousExport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopContinuousExportRequest', ], 'output' => [ 'shape' => 'StopContinuousExportResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'OperationNotPermittedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'StopDataCollectionByAgentIds' => [ 'name' => 'StopDataCollectionByAgentIds', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDataCollectionByAgentIdsRequest', ], 'output' => [ 'shape' => 'StopDataCollectionByAgentIdsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'UpdateApplication' => [ 'name' => 'UpdateApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateApplicationRequest', ], 'output' => [ 'shape' => 'UpdateApplicationResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], ], 'shapes' => [ 'AgentConfigurationStatus' => [ 'type' => 'structure', 'members' => [ 'agentId' => [ 'shape' => 'String', ], 'operationSucceeded' => [ 'shape' => 'Boolean', ], 'description' => [ 'shape' => 'String', ], ], ], 'AgentConfigurationStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentConfigurationStatus', ], ], 'AgentId' => [ 'type' => 'string', 'max' => 20, 'min' => 10, 'pattern' => '\\S+', ], 'AgentIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentId', ], ], 'AgentInfo' => [ 'type' => 'structure', 'members' => [ 'agentId' => [ 'shape' => 'AgentId', ], 'hostName' => [ 'shape' => 'String', ], 'agentNetworkInfoList' => [ 'shape' => 'AgentNetworkInfoList', ], 'connectorId' => [ 'shape' => 'String', ], 'version' => [ 'shape' => 'String', ], 'health' => [ 'shape' => 'AgentStatus', ], 'lastHealthPingTime' => [ 'shape' => 'String', ], 'collectionStatus' => [ 'shape' => 'String', ], 'agentType' => [ 'shape' => 'String', ], 'registeredTime' => [ 'shape' => 'String', ], ], ], 'AgentNetworkInfo' => [ 'type' => 'structure', 'members' => [ 'ipAddress' => [ 'shape' => 'String', ], 'macAddress' => [ 'shape' => 'String', ], ], ], 'AgentNetworkInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentNetworkInfo', ], ], 'AgentStatus' => [ 'type' => 'string', 'enum' => [ 'HEALTHY', 'UNHEALTHY', 'RUNNING', 'UNKNOWN', 'BLACKLISTED', 'SHUTDOWN', ], ], 'AgentsInfo' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentInfo', ], ], 'ApplicationDescription' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '(^$|[\\s\\S]*\\S[\\s\\S]*)', ], 'ApplicationId' => [ 'type' => 'string', 'max' => 200, 'pattern' => '\\S+', ], 'ApplicationIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ApplicationId', ], ], 'ApplicationName' => [ 'type' => 'string', 'max' => 127, 'pattern' => '[\\s\\S]*\\S[\\s\\S]*', ], 'AssociateConfigurationItemsToApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationConfigurationId', 'configurationIds', ], 'members' => [ 'applicationConfigurationId' => [ 'shape' => 'ApplicationId', ], 'configurationIds' => [ 'shape' => 'ConfigurationIdList', ], ], ], 'AssociateConfigurationItemsToApplicationResponse' => [ 'type' => 'structure', 'members' => [], ], 'AuthorizationErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'BatchDeleteImportDataError' => [ 'type' => 'structure', 'members' => [ 'importTaskId' => [ 'shape' => 'ImportTaskIdentifier', ], 'errorCode' => [ 'shape' => 'BatchDeleteImportDataErrorCode', ], 'errorDescription' => [ 'shape' => 'BatchDeleteImportDataErrorDescription', ], ], ], 'BatchDeleteImportDataErrorCode' => [ 'type' => 'string', 'enum' => [ 'NOT_FOUND', 'INTERNAL_SERVER_ERROR', 'OVER_LIMIT', ], ], 'BatchDeleteImportDataErrorDescription' => [ 'type' => 'string', ], 'BatchDeleteImportDataErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BatchDeleteImportDataError', ], ], 'BatchDeleteImportDataRequest' => [ 'type' => 'structure', 'required' => [ 'importTaskIds', ], 'members' => [ 'importTaskIds' => [ 'shape' => 'ToDeleteIdentifierList', ], ], ], 'BatchDeleteImportDataResponse' => [ 'type' => 'structure', 'members' => [ 'errors' => [ 'shape' => 'BatchDeleteImportDataErrorList', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BoxedInteger' => [ 'type' => 'integer', 'box' => true, ], 'ClientRequestToken' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'Condition' => [ 'type' => 'string', 'max' => 200, 'pattern' => '\\S+', ], 'Configuration' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'ConfigurationId' => [ 'type' => 'string', 'max' => 200, 'pattern' => '\\S*', ], 'ConfigurationIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationId', ], ], 'ConfigurationItemType' => [ 'type' => 'string', 'enum' => [ 'SERVER', 'PROCESS', 'CONNECTION', 'APPLICATION', ], ], 'ConfigurationTag' => [ 'type' => 'structure', 'members' => [ 'configurationType' => [ 'shape' => 'ConfigurationItemType', ], 'configurationId' => [ 'shape' => 'ConfigurationId', ], 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'timeOfCreation' => [ 'shape' => 'TimeStamp', ], ], ], 'ConfigurationTagSet' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationTag', ], ], 'Configurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'Configuration', ], ], 'ConfigurationsDownloadUrl' => [ 'type' => 'string', ], 'ConfigurationsExportId' => [ 'type' => 'string', 'max' => 200, 'pattern' => '\\S*', ], 'ConflictErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'ContinuousExportDescription' => [ 'type' => 'structure', 'members' => [ 'exportId' => [ 'shape' => 'ConfigurationsExportId', ], 'status' => [ 'shape' => 'ContinuousExportStatus', ], 'statusDetail' => [ 'shape' => 'StringMax255', ], 's3Bucket' => [ 'shape' => 'S3Bucket', ], 'startTime' => [ 'shape' => 'TimeStamp', ], 'stopTime' => [ 'shape' => 'TimeStamp', ], 'dataSource' => [ 'shape' => 'DataSource', ], 'schemaStorageConfig' => [ 'shape' => 'SchemaStorageConfig', ], ], ], 'ContinuousExportDescriptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContinuousExportDescription', ], ], 'ContinuousExportIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationsExportId', ], ], 'ContinuousExportStatus' => [ 'type' => 'string', 'enum' => [ 'START_IN_PROGRESS', 'START_FAILED', 'ACTIVE', 'ERROR', 'STOP_IN_PROGRESS', 'STOP_FAILED', 'INACTIVE', ], ], 'CreateApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'ApplicationName', ], 'description' => [ 'shape' => 'ApplicationDescription', ], ], ], 'CreateApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'configurationId' => [ 'shape' => 'String', ], ], ], 'CreateTagsRequest' => [ 'type' => 'structure', 'required' => [ 'configurationIds', 'tags', ], 'members' => [ 'configurationIds' => [ 'shape' => 'ConfigurationIdList', ], 'tags' => [ 'shape' => 'TagSet', ], ], ], 'CreateTagsResponse' => [ 'type' => 'structure', 'members' => [], ], 'CustomerAgentInfo' => [ 'type' => 'structure', 'required' => [ 'activeAgents', 'healthyAgents', 'blackListedAgents', 'shutdownAgents', 'unhealthyAgents', 'totalAgents', 'unknownAgents', ], 'members' => [ 'activeAgents' => [ 'shape' => 'Integer', ], 'healthyAgents' => [ 'shape' => 'Integer', ], 'blackListedAgents' => [ 'shape' => 'Integer', ], 'shutdownAgents' => [ 'shape' => 'Integer', ], 'unhealthyAgents' => [ 'shape' => 'Integer', ], 'totalAgents' => [ 'shape' => 'Integer', ], 'unknownAgents' => [ 'shape' => 'Integer', ], ], ], 'CustomerAgentlessCollectorInfo' => [ 'type' => 'structure', 'required' => [ 'activeAgentlessCollectors', 'healthyAgentlessCollectors', 'denyListedAgentlessCollectors', 'shutdownAgentlessCollectors', 'unhealthyAgentlessCollectors', 'totalAgentlessCollectors', 'unknownAgentlessCollectors', ], 'members' => [ 'activeAgentlessCollectors' => [ 'shape' => 'Integer', ], 'healthyAgentlessCollectors' => [ 'shape' => 'Integer', ], 'denyListedAgentlessCollectors' => [ 'shape' => 'Integer', ], 'shutdownAgentlessCollectors' => [ 'shape' => 'Integer', ], 'unhealthyAgentlessCollectors' => [ 'shape' => 'Integer', ], 'totalAgentlessCollectors' => [ 'shape' => 'Integer', ], 'unknownAgentlessCollectors' => [ 'shape' => 'Integer', ], ], ], 'CustomerConnectorInfo' => [ 'type' => 'structure', 'required' => [ 'activeConnectors', 'healthyConnectors', 'blackListedConnectors', 'shutdownConnectors', 'unhealthyConnectors', 'totalConnectors', 'unknownConnectors', ], 'members' => [ 'activeConnectors' => [ 'shape' => 'Integer', ], 'healthyConnectors' => [ 'shape' => 'Integer', ], 'blackListedConnectors' => [ 'shape' => 'Integer', ], 'shutdownConnectors' => [ 'shape' => 'Integer', ], 'unhealthyConnectors' => [ 'shape' => 'Integer', ], 'totalConnectors' => [ 'shape' => 'Integer', ], 'unknownConnectors' => [ 'shape' => 'Integer', ], ], ], 'CustomerMeCollectorInfo' => [ 'type' => 'structure', 'required' => [ 'activeMeCollectors', 'healthyMeCollectors', 'denyListedMeCollectors', 'shutdownMeCollectors', 'unhealthyMeCollectors', 'totalMeCollectors', 'unknownMeCollectors', ], 'members' => [ 'activeMeCollectors' => [ 'shape' => 'Integer', ], 'healthyMeCollectors' => [ 'shape' => 'Integer', ], 'denyListedMeCollectors' => [ 'shape' => 'Integer', ], 'shutdownMeCollectors' => [ 'shape' => 'Integer', ], 'unhealthyMeCollectors' => [ 'shape' => 'Integer', ], 'totalMeCollectors' => [ 'shape' => 'Integer', ], 'unknownMeCollectors' => [ 'shape' => 'Integer', ], ], ], 'DataSource' => [ 'type' => 'string', 'enum' => [ 'AGENT', ], ], 'DatabaseName' => [ 'type' => 'string', 'max' => 252, 'min' => 1, ], 'DeleteApplicationsRequest' => [ 'type' => 'structure', 'required' => [ 'configurationIds', ], 'members' => [ 'configurationIds' => [ 'shape' => 'ApplicationIdsList', ], ], ], 'DeleteApplicationsResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTagsRequest' => [ 'type' => 'structure', 'required' => [ 'configurationIds', ], 'members' => [ 'configurationIds' => [ 'shape' => 'ConfigurationIdList', ], 'tags' => [ 'shape' => 'TagSet', ], ], ], 'DeleteTagsResponse' => [ 'type' => 'structure', 'members' => [], ], 'DescribeAgentsRequest' => [ 'type' => 'structure', 'members' => [ 'agentIds' => [ 'shape' => 'AgentIds', ], 'filters' => [ 'shape' => 'Filters', ], 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeAgentsResponse' => [ 'type' => 'structure', 'members' => [ 'agentsInfo' => [ 'shape' => 'AgentsInfo', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConfigurationsAttribute' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'DescribeConfigurationsAttributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribeConfigurationsAttribute', ], ], 'DescribeConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'configurationIds', ], 'members' => [ 'configurationIds' => [ 'shape' => 'ConfigurationIdList', ], ], ], 'DescribeConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'configurations' => [ 'shape' => 'DescribeConfigurationsAttributes', ], ], ], 'DescribeContinuousExportsMaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'DescribeContinuousExportsRequest' => [ 'type' => 'structure', 'members' => [ 'exportIds' => [ 'shape' => 'ContinuousExportIds', ], 'maxResults' => [ 'shape' => 'DescribeContinuousExportsMaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeContinuousExportsResponse' => [ 'type' => 'structure', 'members' => [ 'descriptions' => [ 'shape' => 'ContinuousExportDescriptions', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeExportConfigurationsRequest' => [ 'type' => 'structure', 'members' => [ 'exportIds' => [ 'shape' => 'ExportIds', ], 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeExportConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'exportsInfo' => [ 'shape' => 'ExportsInfo', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeExportTasksRequest' => [ 'type' => 'structure', 'members' => [ 'exportIds' => [ 'shape' => 'ExportIds', ], 'filters' => [ 'shape' => 'ExportFilters', ], 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeExportTasksResponse' => [ 'type' => 'structure', 'members' => [ 'exportsInfo' => [ 'shape' => 'ExportsInfo', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeImportTasksFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportTaskFilter', ], ], 'DescribeImportTasksMaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'DescribeImportTasksRequest' => [ 'type' => 'structure', 'members' => [ 'filters' => [ 'shape' => 'DescribeImportTasksFilterList', ], 'maxResults' => [ 'shape' => 'DescribeImportTasksMaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeImportTasksResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'tasks' => [ 'shape' => 'ImportTaskList', ], ], ], 'DescribeTagsRequest' => [ 'type' => 'structure', 'members' => [ 'filters' => [ 'shape' => 'TagFilters', ], 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeTagsResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'ConfigurationTagSet', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DisassociateConfigurationItemsFromApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationConfigurationId', 'configurationIds', ], 'members' => [ 'applicationConfigurationId' => [ 'shape' => 'ApplicationId', ], 'configurationIds' => [ 'shape' => 'ConfigurationIdList', ], ], ], 'DisassociateConfigurationItemsFromApplicationResponse' => [ 'type' => 'structure', 'members' => [], ], 'EC2InstanceType' => [ 'type' => 'string', 'max' => 25, 'min' => 1, 'pattern' => '[a-zA-Z0-9\\d\\.\\-]+', ], 'Ec2RecommendationsExportPreferences' => [ 'type' => 'structure', 'members' => [ 'enabled' => [ 'shape' => 'ExportEnabled', ], 'cpuPerformanceMetricBasis' => [ 'shape' => 'UsageMetricBasis', ], 'ramPerformanceMetricBasis' => [ 'shape' => 'UsageMetricBasis', ], 'tenancy' => [ 'shape' => 'Tenancy', ], 'excludedInstanceTypes' => [ 'shape' => 'ExcludedInstanceTypes', ], 'preferredRegion' => [ 'shape' => 'UserPreferredRegion', ], 'reservedInstanceOptions' => [ 'shape' => 'ReservedInstanceOptions', ], ], ], 'ExcludedInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'EC2InstanceType', ], ], 'ExportConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'exportId' => [ 'shape' => 'ConfigurationsExportId', ], ], ], 'ExportDataFormat' => [ 'type' => 'string', 'enum' => [ 'CSV', ], ], 'ExportDataFormats' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportDataFormat', ], ], 'ExportEnabled' => [ 'type' => 'boolean', ], 'ExportFilter' => [ 'type' => 'structure', 'required' => [ 'name', 'values', 'condition', ], 'members' => [ 'name' => [ 'shape' => 'FilterName', ], 'values' => [ 'shape' => 'FilterValues', ], 'condition' => [ 'shape' => 'Condition', ], ], ], 'ExportFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportFilter', ], ], 'ExportIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationsExportId', ], ], 'ExportInfo' => [ 'type' => 'structure', 'required' => [ 'exportId', 'exportStatus', 'statusMessage', 'exportRequestTime', ], 'members' => [ 'exportId' => [ 'shape' => 'ConfigurationsExportId', ], 'exportStatus' => [ 'shape' => 'ExportStatus', ], 'statusMessage' => [ 'shape' => 'ExportStatusMessage', ], 'configurationsDownloadUrl' => [ 'shape' => 'ConfigurationsDownloadUrl', ], 'exportRequestTime' => [ 'shape' => 'ExportRequestTime', ], 'isTruncated' => [ 'shape' => 'Boolean', ], 'requestedStartTime' => [ 'shape' => 'TimeStamp', ], 'requestedEndTime' => [ 'shape' => 'TimeStamp', ], ], ], 'ExportPreferences' => [ 'type' => 'structure', 'members' => [ 'ec2RecommendationsPreferences' => [ 'shape' => 'Ec2RecommendationsExportPreferences', ], ], 'union' => true, ], 'ExportRequestTime' => [ 'type' => 'timestamp', ], 'ExportStatus' => [ 'type' => 'string', 'enum' => [ 'FAILED', 'SUCCEEDED', 'IN_PROGRESS', ], ], 'ExportStatusMessage' => [ 'type' => 'string', ], 'ExportsInfo' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportInfo', ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'name', 'values', 'condition', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'values' => [ 'shape' => 'FilterValues', ], 'condition' => [ 'shape' => 'Condition', ], ], ], 'FilterName' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '[\\s\\S]*\\S[\\s\\S]*', ], 'FilterValue' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '(^$|[\\s\\S]*\\S[\\s\\S]*)', ], 'FilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterValue', ], ], 'Filters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], ], 'GetDiscoverySummaryRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetDiscoverySummaryResponse' => [ 'type' => 'structure', 'members' => [ 'servers' => [ 'shape' => 'Long', ], 'applications' => [ 'shape' => 'Long', ], 'serversMappedToApplications' => [ 'shape' => 'Long', ], 'serversMappedtoTags' => [ 'shape' => 'Long', ], 'agentSummary' => [ 'shape' => 'CustomerAgentInfo', ], 'connectorSummary' => [ 'shape' => 'CustomerConnectorInfo', ], 'meCollectorSummary' => [ 'shape' => 'CustomerMeCollectorInfo', ], 'agentlessCollectorSummary' => [ 'shape' => 'CustomerAgentlessCollectorInfo', ], ], ], 'HomeRegionNotSetException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'ImportStatus' => [ 'type' => 'string', 'enum' => [ 'IMPORT_IN_PROGRESS', 'IMPORT_COMPLETE', 'IMPORT_COMPLETE_WITH_ERRORS', 'IMPORT_FAILED', 'IMPORT_FAILED_SERVER_LIMIT_EXCEEDED', 'IMPORT_FAILED_RECORD_LIMIT_EXCEEDED', 'DELETE_IN_PROGRESS', 'DELETE_COMPLETE', 'DELETE_FAILED', 'DELETE_FAILED_LIMIT_EXCEEDED', 'INTERNAL_ERROR', ], ], 'ImportTask' => [ 'type' => 'structure', 'members' => [ 'importTaskId' => [ 'shape' => 'ImportTaskIdentifier', ], 'clientRequestToken' => [ 'shape' => 'ClientRequestToken', ], 'name' => [ 'shape' => 'ImportTaskName', ], 'importUrl' => [ 'shape' => 'ImportURL', ], 'status' => [ 'shape' => 'ImportStatus', ], 'importRequestTime' => [ 'shape' => 'TimeStamp', ], 'importCompletionTime' => [ 'shape' => 'TimeStamp', ], 'importDeletedTime' => [ 'shape' => 'TimeStamp', ], 'serverImportSuccess' => [ 'shape' => 'Integer', ], 'serverImportFailure' => [ 'shape' => 'Integer', ], 'applicationImportSuccess' => [ 'shape' => 'Integer', ], 'applicationImportFailure' => [ 'shape' => 'Integer', ], 'errorsAndFailedEntriesZip' => [ 'shape' => 'S3PresignedUrl', ], ], ], 'ImportTaskFilter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ImportTaskFilterName', ], 'values' => [ 'shape' => 'ImportTaskFilterValueList', ], ], ], 'ImportTaskFilterName' => [ 'type' => 'string', 'enum' => [ 'IMPORT_TASK_ID', 'STATUS', 'NAME', ], ], 'ImportTaskFilterValue' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'ImportTaskFilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportTaskFilterValue', ], 'max' => 100, 'min' => 1, ], 'ImportTaskIdentifier' => [ 'type' => 'string', 'max' => 200, 'pattern' => '\\S*', ], 'ImportTaskList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportTask', ], ], 'ImportTaskName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\s\\S]*\\S[\\s\\S]*', ], 'ImportURL' => [ 'type' => 'string', 'max' => 4000, 'min' => 1, 'pattern' => '\\S+://\\S+/[\\s\\S]*\\S[\\s\\S]*', ], 'Integer' => [ 'type' => 'integer', ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'InvalidParameterValueException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'ListConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'configurationType', ], 'members' => [ 'configurationType' => [ 'shape' => 'ConfigurationItemType', ], 'filters' => [ 'shape' => 'Filters', ], 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'orderBy' => [ 'shape' => 'OrderByList', ], ], ], 'ListConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'configurations' => [ 'shape' => 'Configurations', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListServerNeighborsRequest' => [ 'type' => 'structure', 'required' => [ 'configurationId', ], 'members' => [ 'configurationId' => [ 'shape' => 'ConfigurationId', ], 'portInformationNeeded' => [ 'shape' => 'Boolean', ], 'neighborConfigurationIds' => [ 'shape' => 'ConfigurationIdList', ], 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListServerNeighborsResponse' => [ 'type' => 'structure', 'required' => [ 'neighbors', ], 'members' => [ 'neighbors' => [ 'shape' => 'NeighborDetailsList', ], 'nextToken' => [ 'shape' => 'String', ], 'knownDependencyCount' => [ 'shape' => 'Long', ], ], ], 'Long' => [ 'type' => 'long', ], 'Message' => [ 'type' => 'string', ], 'NeighborConnectionDetail' => [ 'type' => 'structure', 'required' => [ 'sourceServerId', 'destinationServerId', 'connectionsCount', ], 'members' => [ 'sourceServerId' => [ 'shape' => 'ConfigurationId', ], 'destinationServerId' => [ 'shape' => 'ConfigurationId', ], 'destinationPort' => [ 'shape' => 'BoxedInteger', ], 'transportProtocol' => [ 'shape' => 'String', ], 'connectionsCount' => [ 'shape' => 'Long', ], ], ], 'NeighborDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeighborConnectionDetail', ], ], 'NextToken' => [ 'type' => 'string', ], 'OfferingClass' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'CONVERTIBLE', ], ], 'OperationNotPermittedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'OrderByElement' => [ 'type' => 'structure', 'required' => [ 'fieldName', ], 'members' => [ 'fieldName' => [ 'shape' => 'OrderByElementFieldName', ], 'sortOrder' => [ 'shape' => 'orderString', ], ], ], 'OrderByElementFieldName' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '[\\s\\S]*\\S[\\s\\S]*', ], 'OrderByList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrderByElement', ], ], 'PurchasingOption' => [ 'type' => 'string', 'enum' => [ 'ALL_UPFRONT', 'PARTIAL_UPFRONT', 'NO_UPFRONT', ], ], 'ReservedInstanceOptions' => [ 'type' => 'structure', 'required' => [ 'purchasingOption', 'offeringClass', 'termLength', ], 'members' => [ 'purchasingOption' => [ 'shape' => 'PurchasingOption', ], 'offeringClass' => [ 'shape' => 'OfferingClass', ], 'termLength' => [ 'shape' => 'TermLength', ], ], ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'S3Bucket' => [ 'type' => 'string', ], 'S3PresignedUrl' => [ 'type' => 'string', ], 'SchemaStorageConfig' => [ 'type' => 'map', 'key' => [ 'shape' => 'DatabaseName', ], 'value' => [ 'shape' => 'String', ], ], 'ServerInternalErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, 'fault' => true, ], 'StartContinuousExportRequest' => [ 'type' => 'structure', 'members' => [], ], 'StartContinuousExportResponse' => [ 'type' => 'structure', 'members' => [ 'exportId' => [ 'shape' => 'ConfigurationsExportId', ], 's3Bucket' => [ 'shape' => 'S3Bucket', ], 'startTime' => [ 'shape' => 'TimeStamp', ], 'dataSource' => [ 'shape' => 'DataSource', ], 'schemaStorageConfig' => [ 'shape' => 'SchemaStorageConfig', ], ], ], 'StartDataCollectionByAgentIdsRequest' => [ 'type' => 'structure', 'required' => [ 'agentIds', ], 'members' => [ 'agentIds' => [ 'shape' => 'AgentIds', ], ], ], 'StartDataCollectionByAgentIdsResponse' => [ 'type' => 'structure', 'members' => [ 'agentsConfigurationStatus' => [ 'shape' => 'AgentConfigurationStatusList', ], ], ], 'StartExportTaskRequest' => [ 'type' => 'structure', 'members' => [ 'exportDataFormat' => [ 'shape' => 'ExportDataFormats', ], 'filters' => [ 'shape' => 'ExportFilters', ], 'startTime' => [ 'shape' => 'TimeStamp', ], 'endTime' => [ 'shape' => 'TimeStamp', ], 'preferences' => [ 'shape' => 'ExportPreferences', ], ], ], 'StartExportTaskResponse' => [ 'type' => 'structure', 'members' => [ 'exportId' => [ 'shape' => 'ConfigurationsExportId', ], ], ], 'StartImportTaskRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'importUrl', ], 'members' => [ 'clientRequestToken' => [ 'shape' => 'ClientRequestToken', 'idempotencyToken' => true, ], 'name' => [ 'shape' => 'ImportTaskName', ], 'importUrl' => [ 'shape' => 'ImportURL', ], ], ], 'StartImportTaskResponse' => [ 'type' => 'structure', 'members' => [ 'task' => [ 'shape' => 'ImportTask', ], ], ], 'StopContinuousExportRequest' => [ 'type' => 'structure', 'required' => [ 'exportId', ], 'members' => [ 'exportId' => [ 'shape' => 'ConfigurationsExportId', ], ], ], 'StopContinuousExportResponse' => [ 'type' => 'structure', 'members' => [ 'startTime' => [ 'shape' => 'TimeStamp', ], 'stopTime' => [ 'shape' => 'TimeStamp', ], ], ], 'StopDataCollectionByAgentIdsRequest' => [ 'type' => 'structure', 'required' => [ 'agentIds', ], 'members' => [ 'agentIds' => [ 'shape' => 'AgentIds', ], ], ], 'StopDataCollectionByAgentIdsResponse' => [ 'type' => 'structure', 'members' => [ 'agentsConfigurationStatus' => [ 'shape' => 'AgentConfigurationStatusList', ], ], ], 'String' => [ 'type' => 'string', 'max' => 10000, 'pattern' => '[\\s\\S]*', ], 'StringMax255' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\s\\S]*\\S[\\s\\S]*', ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagFilter' => [ 'type' => 'structure', 'required' => [ 'name', 'values', ], 'members' => [ 'name' => [ 'shape' => 'FilterName', ], 'values' => [ 'shape' => 'FilterValues', ], ], ], 'TagFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagFilter', ], ], 'TagKey' => [ 'type' => 'string', ], 'TagSet' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagValue' => [ 'type' => 'string', ], 'Tenancy' => [ 'type' => 'string', 'enum' => [ 'DEDICATED', 'SHARED', ], ], 'TermLength' => [ 'type' => 'string', 'enum' => [ 'ONE_YEAR', 'THREE_YEAR', ], ], 'TimeStamp' => [ 'type' => 'timestamp', ], 'ToDeleteIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportTaskIdentifier', ], 'max' => 10, 'min' => 1, ], 'UpdateApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'configurationId', ], 'members' => [ 'configurationId' => [ 'shape' => 'ApplicationId', ], 'name' => [ 'shape' => 'ApplicationName', ], 'description' => [ 'shape' => 'ApplicationDescription', ], ], ], 'UpdateApplicationResponse' => [ 'type' => 'structure', 'members' => [], ], 'UsageMetricBasis' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'UsageMetricBasisName', ], 'percentageAdjust' => [ 'shape' => 'UsageMetricPercentageAdjust', ], ], ], 'UsageMetricBasisName' => [ 'type' => 'string', 'pattern' => '^(p(\\d{1,2}|100)|AVG|SPEC|MAX)$', ], 'UsageMetricPercentageAdjust' => [ 'type' => 'double', 'max' => 100.0, 'min' => 0.0, ], 'UserPreferredRegion' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '[a-z]{2}-[a-z\\-]+-[0-9]+', ], 'orderString' => [ 'type' => 'string', 'enum' => [ 'ASC', 'DESC', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2015-11-01', 'endpointPrefix' => 'discovery', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'AWS Application Discovery Service', 'serviceId' => 'Application Discovery Service', 'signatureVersion' => 'v4', 'targetPrefix' => 'AWSPoseidonService_V2015_11_01', 'uid' => 'discovery-2015-11-01', ], 'operations' => [ 'AssociateConfigurationItemsToApplication' => [ 'name' => 'AssociateConfigurationItemsToApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateConfigurationItemsToApplicationRequest', ], 'output' => [ 'shape' => 'AssociateConfigurationItemsToApplicationResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'BatchDeleteImportData' => [ 'name' => 'BatchDeleteImportData', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchDeleteImportDataRequest', ], 'output' => [ 'shape' => 'BatchDeleteImportDataResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'CreateApplication' => [ 'name' => 'CreateApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateApplicationRequest', ], 'output' => [ 'shape' => 'CreateApplicationResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'CreateTags' => [ 'name' => 'CreateTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTagsRequest', ], 'output' => [ 'shape' => 'CreateTagsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DeleteApplications' => [ 'name' => 'DeleteApplications', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteApplicationsRequest', ], 'output' => [ 'shape' => 'DeleteApplicationsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DeleteTags' => [ 'name' => 'DeleteTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteTagsRequest', ], 'output' => [ 'shape' => 'DeleteTagsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DescribeAgents' => [ 'name' => 'DescribeAgents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeAgentsRequest', ], 'output' => [ 'shape' => 'DescribeAgentsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DescribeConfigurations' => [ 'name' => 'DescribeConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConfigurationsRequest', ], 'output' => [ 'shape' => 'DescribeConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DescribeContinuousExports' => [ 'name' => 'DescribeContinuousExports', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeContinuousExportsRequest', ], 'output' => [ 'shape' => 'DescribeContinuousExportsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'OperationNotPermittedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DescribeExportConfigurations' => [ 'name' => 'DescribeExportConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExportConfigurationsRequest', ], 'output' => [ 'shape' => 'DescribeExportConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], 'deprecated' => true, ], 'DescribeExportTasks' => [ 'name' => 'DescribeExportTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeExportTasksRequest', ], 'output' => [ 'shape' => 'DescribeExportTasksResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DescribeImportTasks' => [ 'name' => 'DescribeImportTasks', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeImportTasksRequest', ], 'output' => [ 'shape' => 'DescribeImportTasksResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DescribeTags' => [ 'name' => 'DescribeTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTagsRequest', ], 'output' => [ 'shape' => 'DescribeTagsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'DisassociateConfigurationItemsFromApplication' => [ 'name' => 'DisassociateConfigurationItemsFromApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateConfigurationItemsFromApplicationRequest', ], 'output' => [ 'shape' => 'DisassociateConfigurationItemsFromApplicationResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'ExportConfigurations' => [ 'name' => 'ExportConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'output' => [ 'shape' => 'ExportConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'OperationNotPermittedException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], 'deprecated' => true, ], 'GetDiscoverySummary' => [ 'name' => 'GetDiscoverySummary', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDiscoverySummaryRequest', ], 'output' => [ 'shape' => 'GetDiscoverySummaryResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'ListConfigurations' => [ 'name' => 'ListConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListConfigurationsRequest', ], 'output' => [ 'shape' => 'ListConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'ListServerNeighbors' => [ 'name' => 'ListServerNeighbors', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListServerNeighborsRequest', ], 'output' => [ 'shape' => 'ListServerNeighborsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'StartContinuousExport' => [ 'name' => 'StartContinuousExport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartContinuousExportRequest', ], 'output' => [ 'shape' => 'StartContinuousExportResponse', ], 'errors' => [ [ 'shape' => 'ConflictErrorException', ], [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'OperationNotPermittedException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'StartDataCollectionByAgentIds' => [ 'name' => 'StartDataCollectionByAgentIds', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartDataCollectionByAgentIdsRequest', ], 'output' => [ 'shape' => 'StartDataCollectionByAgentIdsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'StartExportTask' => [ 'name' => 'StartExportTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartExportTaskRequest', ], 'output' => [ 'shape' => 'StartExportTaskResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'OperationNotPermittedException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'StartImportTask' => [ 'name' => 'StartImportTask', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartImportTaskRequest', ], 'output' => [ 'shape' => 'StartImportTaskResponse', ], 'errors' => [ [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'StopContinuousExport' => [ 'name' => 'StopContinuousExport', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopContinuousExportRequest', ], 'output' => [ 'shape' => 'StopContinuousExportResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'OperationNotPermittedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ResourceInUseException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'StopDataCollectionByAgentIds' => [ 'name' => 'StopDataCollectionByAgentIds', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopDataCollectionByAgentIdsRequest', ], 'output' => [ 'shape' => 'StopDataCollectionByAgentIdsResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], 'UpdateApplication' => [ 'name' => 'UpdateApplication', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateApplicationRequest', ], 'output' => [ 'shape' => 'UpdateApplicationResponse', ], 'errors' => [ [ 'shape' => 'AuthorizationErrorException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'ServerInternalErrorException', ], [ 'shape' => 'HomeRegionNotSetException', ], ], ], ], 'shapes' => [ 'AgentConfigurationStatus' => [ 'type' => 'structure', 'members' => [ 'agentId' => [ 'shape' => 'String', ], 'operationSucceeded' => [ 'shape' => 'Boolean', ], 'description' => [ 'shape' => 'String', ], ], ], 'AgentConfigurationStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentConfigurationStatus', ], ], 'AgentId' => [ 'type' => 'string', 'max' => 20, 'min' => 10, 'pattern' => '\\S+', ], 'AgentIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentId', ], ], 'AgentInfo' => [ 'type' => 'structure', 'members' => [ 'agentId' => [ 'shape' => 'AgentId', ], 'hostName' => [ 'shape' => 'String', ], 'agentNetworkInfoList' => [ 'shape' => 'AgentNetworkInfoList', ], 'connectorId' => [ 'shape' => 'String', ], 'version' => [ 'shape' => 'String', ], 'health' => [ 'shape' => 'AgentStatus', ], 'lastHealthPingTime' => [ 'shape' => 'String', ], 'collectionStatus' => [ 'shape' => 'String', ], 'agentType' => [ 'shape' => 'String', ], 'registeredTime' => [ 'shape' => 'String', ], ], ], 'AgentNetworkInfo' => [ 'type' => 'structure', 'members' => [ 'ipAddress' => [ 'shape' => 'String', ], 'macAddress' => [ 'shape' => 'String', ], ], 'sensitive' => true, ], 'AgentNetworkInfoList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentNetworkInfo', ], ], 'AgentStatus' => [ 'type' => 'string', 'enum' => [ 'HEALTHY', 'UNHEALTHY', 'RUNNING', 'UNKNOWN', 'BLACKLISTED', 'SHUTDOWN', ], ], 'AgentsInfo' => [ 'type' => 'list', 'member' => [ 'shape' => 'AgentInfo', ], ], 'ApplicationDescription' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '(^$|[\\s\\S]*\\S[\\s\\S]*)', ], 'ApplicationId' => [ 'type' => 'string', 'max' => 200, 'pattern' => '\\S+', ], 'ApplicationIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ApplicationId', ], ], 'ApplicationName' => [ 'type' => 'string', 'max' => 127, 'pattern' => '[\\s\\S]*\\S[\\s\\S]*', ], 'AssociateConfigurationItemsToApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationConfigurationId', 'configurationIds', ], 'members' => [ 'applicationConfigurationId' => [ 'shape' => 'ApplicationId', ], 'configurationIds' => [ 'shape' => 'ConfigurationIdList', ], ], ], 'AssociateConfigurationItemsToApplicationResponse' => [ 'type' => 'structure', 'members' => [], ], 'AuthorizationErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'BatchDeleteImportDataError' => [ 'type' => 'structure', 'members' => [ 'importTaskId' => [ 'shape' => 'ImportTaskIdentifier', ], 'errorCode' => [ 'shape' => 'BatchDeleteImportDataErrorCode', ], 'errorDescription' => [ 'shape' => 'BatchDeleteImportDataErrorDescription', ], ], ], 'BatchDeleteImportDataErrorCode' => [ 'type' => 'string', 'enum' => [ 'NOT_FOUND', 'INTERNAL_SERVER_ERROR', 'OVER_LIMIT', ], ], 'BatchDeleteImportDataErrorDescription' => [ 'type' => 'string', ], 'BatchDeleteImportDataErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BatchDeleteImportDataError', ], ], 'BatchDeleteImportDataRequest' => [ 'type' => 'structure', 'required' => [ 'importTaskIds', ], 'members' => [ 'importTaskIds' => [ 'shape' => 'ToDeleteIdentifierList', ], ], ], 'BatchDeleteImportDataResponse' => [ 'type' => 'structure', 'members' => [ 'errors' => [ 'shape' => 'BatchDeleteImportDataErrorList', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BoxedInteger' => [ 'type' => 'integer', 'box' => true, ], 'ClientRequestToken' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'Condition' => [ 'type' => 'string', 'max' => 200, 'pattern' => '\\S+', ], 'Configuration' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'ConfigurationId' => [ 'type' => 'string', 'max' => 200, 'pattern' => '\\S*', ], 'ConfigurationIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationId', ], ], 'ConfigurationItemType' => [ 'type' => 'string', 'enum' => [ 'SERVER', 'PROCESS', 'CONNECTION', 'APPLICATION', ], ], 'ConfigurationTag' => [ 'type' => 'structure', 'members' => [ 'configurationType' => [ 'shape' => 'ConfigurationItemType', ], 'configurationId' => [ 'shape' => 'ConfigurationId', ], 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'timeOfCreation' => [ 'shape' => 'TimeStamp', ], ], ], 'ConfigurationTagSet' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationTag', ], ], 'Configurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'Configuration', ], ], 'ConfigurationsDownloadUrl' => [ 'type' => 'string', ], 'ConfigurationsExportId' => [ 'type' => 'string', 'max' => 200, 'pattern' => '\\S*', ], 'ConflictErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'ContinuousExportDescription' => [ 'type' => 'structure', 'members' => [ 'exportId' => [ 'shape' => 'ConfigurationsExportId', ], 'status' => [ 'shape' => 'ContinuousExportStatus', ], 'statusDetail' => [ 'shape' => 'StringMax255', ], 's3Bucket' => [ 'shape' => 'S3Bucket', ], 'startTime' => [ 'shape' => 'TimeStamp', ], 'stopTime' => [ 'shape' => 'TimeStamp', ], 'dataSource' => [ 'shape' => 'DataSource', ], 'schemaStorageConfig' => [ 'shape' => 'SchemaStorageConfig', ], ], ], 'ContinuousExportDescriptions' => [ 'type' => 'list', 'member' => [ 'shape' => 'ContinuousExportDescription', ], ], 'ContinuousExportIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationsExportId', ], ], 'ContinuousExportStatus' => [ 'type' => 'string', 'enum' => [ 'START_IN_PROGRESS', 'START_FAILED', 'ACTIVE', 'ERROR', 'STOP_IN_PROGRESS', 'STOP_FAILED', 'INACTIVE', ], ], 'CreateApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'ApplicationName', ], 'description' => [ 'shape' => 'ApplicationDescription', ], ], ], 'CreateApplicationResponse' => [ 'type' => 'structure', 'members' => [ 'configurationId' => [ 'shape' => 'String', ], ], ], 'CreateTagsRequest' => [ 'type' => 'structure', 'required' => [ 'configurationIds', 'tags', ], 'members' => [ 'configurationIds' => [ 'shape' => 'ConfigurationIdList', ], 'tags' => [ 'shape' => 'TagSet', ], ], ], 'CreateTagsResponse' => [ 'type' => 'structure', 'members' => [], ], 'CustomerAgentInfo' => [ 'type' => 'structure', 'required' => [ 'activeAgents', 'healthyAgents', 'blackListedAgents', 'shutdownAgents', 'unhealthyAgents', 'totalAgents', 'unknownAgents', ], 'members' => [ 'activeAgents' => [ 'shape' => 'Integer', ], 'healthyAgents' => [ 'shape' => 'Integer', ], 'blackListedAgents' => [ 'shape' => 'Integer', ], 'shutdownAgents' => [ 'shape' => 'Integer', ], 'unhealthyAgents' => [ 'shape' => 'Integer', ], 'totalAgents' => [ 'shape' => 'Integer', ], 'unknownAgents' => [ 'shape' => 'Integer', ], ], ], 'CustomerAgentlessCollectorInfo' => [ 'type' => 'structure', 'required' => [ 'activeAgentlessCollectors', 'healthyAgentlessCollectors', 'denyListedAgentlessCollectors', 'shutdownAgentlessCollectors', 'unhealthyAgentlessCollectors', 'totalAgentlessCollectors', 'unknownAgentlessCollectors', ], 'members' => [ 'activeAgentlessCollectors' => [ 'shape' => 'Integer', ], 'healthyAgentlessCollectors' => [ 'shape' => 'Integer', ], 'denyListedAgentlessCollectors' => [ 'shape' => 'Integer', ], 'shutdownAgentlessCollectors' => [ 'shape' => 'Integer', ], 'unhealthyAgentlessCollectors' => [ 'shape' => 'Integer', ], 'totalAgentlessCollectors' => [ 'shape' => 'Integer', ], 'unknownAgentlessCollectors' => [ 'shape' => 'Integer', ], ], ], 'CustomerConnectorInfo' => [ 'type' => 'structure', 'required' => [ 'activeConnectors', 'healthyConnectors', 'blackListedConnectors', 'shutdownConnectors', 'unhealthyConnectors', 'totalConnectors', 'unknownConnectors', ], 'members' => [ 'activeConnectors' => [ 'shape' => 'Integer', ], 'healthyConnectors' => [ 'shape' => 'Integer', ], 'blackListedConnectors' => [ 'shape' => 'Integer', ], 'shutdownConnectors' => [ 'shape' => 'Integer', ], 'unhealthyConnectors' => [ 'shape' => 'Integer', ], 'totalConnectors' => [ 'shape' => 'Integer', ], 'unknownConnectors' => [ 'shape' => 'Integer', ], ], ], 'CustomerMeCollectorInfo' => [ 'type' => 'structure', 'required' => [ 'activeMeCollectors', 'healthyMeCollectors', 'denyListedMeCollectors', 'shutdownMeCollectors', 'unhealthyMeCollectors', 'totalMeCollectors', 'unknownMeCollectors', ], 'members' => [ 'activeMeCollectors' => [ 'shape' => 'Integer', ], 'healthyMeCollectors' => [ 'shape' => 'Integer', ], 'denyListedMeCollectors' => [ 'shape' => 'Integer', ], 'shutdownMeCollectors' => [ 'shape' => 'Integer', ], 'unhealthyMeCollectors' => [ 'shape' => 'Integer', ], 'totalMeCollectors' => [ 'shape' => 'Integer', ], 'unknownMeCollectors' => [ 'shape' => 'Integer', ], ], ], 'DataSource' => [ 'type' => 'string', 'enum' => [ 'AGENT', ], ], 'DatabaseName' => [ 'type' => 'string', 'max' => 252, 'min' => 1, ], 'DeleteApplicationsRequest' => [ 'type' => 'structure', 'required' => [ 'configurationIds', ], 'members' => [ 'configurationIds' => [ 'shape' => 'ApplicationIdsList', ], ], ], 'DeleteApplicationsResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteTagsRequest' => [ 'type' => 'structure', 'required' => [ 'configurationIds', ], 'members' => [ 'configurationIds' => [ 'shape' => 'ConfigurationIdList', ], 'tags' => [ 'shape' => 'TagSet', ], ], ], 'DeleteTagsResponse' => [ 'type' => 'structure', 'members' => [], ], 'DescribeAgentsRequest' => [ 'type' => 'structure', 'members' => [ 'agentIds' => [ 'shape' => 'AgentIds', ], 'filters' => [ 'shape' => 'Filters', ], 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeAgentsResponse' => [ 'type' => 'structure', 'members' => [ 'agentsInfo' => [ 'shape' => 'AgentsInfo', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeConfigurationsAttribute' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'DescribeConfigurationsAttributes' => [ 'type' => 'list', 'member' => [ 'shape' => 'DescribeConfigurationsAttribute', ], ], 'DescribeConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'configurationIds', ], 'members' => [ 'configurationIds' => [ 'shape' => 'ConfigurationIdList', ], ], ], 'DescribeConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'configurations' => [ 'shape' => 'DescribeConfigurationsAttributes', ], ], ], 'DescribeContinuousExportsMaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'DescribeContinuousExportsRequest' => [ 'type' => 'structure', 'members' => [ 'exportIds' => [ 'shape' => 'ContinuousExportIds', ], 'maxResults' => [ 'shape' => 'DescribeContinuousExportsMaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeContinuousExportsResponse' => [ 'type' => 'structure', 'members' => [ 'descriptions' => [ 'shape' => 'ContinuousExportDescriptions', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeExportConfigurationsRequest' => [ 'type' => 'structure', 'members' => [ 'exportIds' => [ 'shape' => 'ExportIds', ], 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeExportConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'exportsInfo' => [ 'shape' => 'ExportsInfo', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeExportTasksRequest' => [ 'type' => 'structure', 'members' => [ 'exportIds' => [ 'shape' => 'ExportIds', ], 'filters' => [ 'shape' => 'ExportFilters', ], 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeExportTasksResponse' => [ 'type' => 'structure', 'members' => [ 'exportsInfo' => [ 'shape' => 'ExportsInfo', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeImportTasksFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportTaskFilter', ], ], 'DescribeImportTasksMaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'DescribeImportTasksRequest' => [ 'type' => 'structure', 'members' => [ 'filters' => [ 'shape' => 'DescribeImportTasksFilterList', ], 'maxResults' => [ 'shape' => 'DescribeImportTasksMaxResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeImportTasksResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'tasks' => [ 'shape' => 'ImportTaskList', ], ], ], 'DescribeTagsRequest' => [ 'type' => 'structure', 'members' => [ 'filters' => [ 'shape' => 'TagFilters', ], 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DescribeTagsResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'ConfigurationTagSet', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'DisassociateConfigurationItemsFromApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'applicationConfigurationId', 'configurationIds', ], 'members' => [ 'applicationConfigurationId' => [ 'shape' => 'ApplicationId', ], 'configurationIds' => [ 'shape' => 'ConfigurationIdList', ], ], ], 'DisassociateConfigurationItemsFromApplicationResponse' => [ 'type' => 'structure', 'members' => [], ], 'EC2InstanceType' => [ 'type' => 'string', 'max' => 25, 'min' => 1, 'pattern' => '[a-zA-Z0-9\\d\\.\\-]+', ], 'Ec2RecommendationsExportPreferences' => [ 'type' => 'structure', 'members' => [ 'enabled' => [ 'shape' => 'ExportEnabled', ], 'cpuPerformanceMetricBasis' => [ 'shape' => 'UsageMetricBasis', ], 'ramPerformanceMetricBasis' => [ 'shape' => 'UsageMetricBasis', ], 'tenancy' => [ 'shape' => 'Tenancy', ], 'excludedInstanceTypes' => [ 'shape' => 'ExcludedInstanceTypes', ], 'preferredRegion' => [ 'shape' => 'UserPreferredRegion', ], 'reservedInstanceOptions' => [ 'shape' => 'ReservedInstanceOptions', ], ], ], 'ExcludedInstanceTypes' => [ 'type' => 'list', 'member' => [ 'shape' => 'EC2InstanceType', ], ], 'ExportConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'exportId' => [ 'shape' => 'ConfigurationsExportId', ], ], ], 'ExportDataFormat' => [ 'type' => 'string', 'enum' => [ 'CSV', ], ], 'ExportDataFormats' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportDataFormat', ], ], 'ExportEnabled' => [ 'type' => 'boolean', ], 'ExportFilter' => [ 'type' => 'structure', 'required' => [ 'name', 'values', 'condition', ], 'members' => [ 'name' => [ 'shape' => 'FilterName', ], 'values' => [ 'shape' => 'FilterValues', ], 'condition' => [ 'shape' => 'Condition', ], ], ], 'ExportFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportFilter', ], ], 'ExportIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigurationsExportId', ], ], 'ExportInfo' => [ 'type' => 'structure', 'required' => [ 'exportId', 'exportStatus', 'statusMessage', 'exportRequestTime', ], 'members' => [ 'exportId' => [ 'shape' => 'ConfigurationsExportId', ], 'exportStatus' => [ 'shape' => 'ExportStatus', ], 'statusMessage' => [ 'shape' => 'ExportStatusMessage', ], 'configurationsDownloadUrl' => [ 'shape' => 'ConfigurationsDownloadUrl', ], 'exportRequestTime' => [ 'shape' => 'ExportRequestTime', ], 'isTruncated' => [ 'shape' => 'Boolean', ], 'requestedStartTime' => [ 'shape' => 'TimeStamp', ], 'requestedEndTime' => [ 'shape' => 'TimeStamp', ], ], ], 'ExportPreferences' => [ 'type' => 'structure', 'members' => [ 'ec2RecommendationsPreferences' => [ 'shape' => 'Ec2RecommendationsExportPreferences', ], ], 'union' => true, ], 'ExportRequestTime' => [ 'type' => 'timestamp', ], 'ExportStatus' => [ 'type' => 'string', 'enum' => [ 'FAILED', 'SUCCEEDED', 'IN_PROGRESS', ], ], 'ExportStatusMessage' => [ 'type' => 'string', ], 'ExportsInfo' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExportInfo', ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'name', 'values', 'condition', ], 'members' => [ 'name' => [ 'shape' => 'String', ], 'values' => [ 'shape' => 'FilterValues', ], 'condition' => [ 'shape' => 'Condition', ], ], ], 'FilterName' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '[\\s\\S]*\\S[\\s\\S]*', ], 'FilterValue' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '(^$|[\\s\\S]*\\S[\\s\\S]*)', ], 'FilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterValue', ], ], 'Filters' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], ], 'GetDiscoverySummaryRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetDiscoverySummaryResponse' => [ 'type' => 'structure', 'members' => [ 'servers' => [ 'shape' => 'Long', ], 'applications' => [ 'shape' => 'Long', ], 'serversMappedToApplications' => [ 'shape' => 'Long', ], 'serversMappedtoTags' => [ 'shape' => 'Long', ], 'agentSummary' => [ 'shape' => 'CustomerAgentInfo', ], 'connectorSummary' => [ 'shape' => 'CustomerConnectorInfo', ], 'meCollectorSummary' => [ 'shape' => 'CustomerMeCollectorInfo', ], 'agentlessCollectorSummary' => [ 'shape' => 'CustomerAgentlessCollectorInfo', ], ], ], 'HomeRegionNotSetException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'ImportStatus' => [ 'type' => 'string', 'enum' => [ 'IMPORT_IN_PROGRESS', 'IMPORT_COMPLETE', 'IMPORT_COMPLETE_WITH_ERRORS', 'IMPORT_FAILED', 'IMPORT_FAILED_SERVER_LIMIT_EXCEEDED', 'IMPORT_FAILED_RECORD_LIMIT_EXCEEDED', 'DELETE_IN_PROGRESS', 'DELETE_COMPLETE', 'DELETE_FAILED', 'DELETE_FAILED_LIMIT_EXCEEDED', 'INTERNAL_ERROR', ], ], 'ImportTask' => [ 'type' => 'structure', 'members' => [ 'importTaskId' => [ 'shape' => 'ImportTaskIdentifier', ], 'clientRequestToken' => [ 'shape' => 'ClientRequestToken', ], 'name' => [ 'shape' => 'ImportTaskName', ], 'importUrl' => [ 'shape' => 'ImportURL', ], 'status' => [ 'shape' => 'ImportStatus', ], 'importRequestTime' => [ 'shape' => 'TimeStamp', ], 'importCompletionTime' => [ 'shape' => 'TimeStamp', ], 'importDeletedTime' => [ 'shape' => 'TimeStamp', ], 'serverImportSuccess' => [ 'shape' => 'Integer', ], 'serverImportFailure' => [ 'shape' => 'Integer', ], 'applicationImportSuccess' => [ 'shape' => 'Integer', ], 'applicationImportFailure' => [ 'shape' => 'Integer', ], 'errorsAndFailedEntriesZip' => [ 'shape' => 'S3PresignedUrl', ], ], ], 'ImportTaskFilter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'ImportTaskFilterName', ], 'values' => [ 'shape' => 'ImportTaskFilterValueList', ], ], ], 'ImportTaskFilterName' => [ 'type' => 'string', 'enum' => [ 'IMPORT_TASK_ID', 'STATUS', 'NAME', ], ], 'ImportTaskFilterValue' => [ 'type' => 'string', 'max' => 255, 'min' => 1, ], 'ImportTaskFilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportTaskFilterValue', ], 'max' => 100, 'min' => 1, ], 'ImportTaskIdentifier' => [ 'type' => 'string', 'max' => 200, 'pattern' => '\\S*', ], 'ImportTaskList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportTask', ], ], 'ImportTaskName' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\s\\S]*\\S[\\s\\S]*', ], 'ImportURL' => [ 'type' => 'string', 'max' => 4000, 'min' => 1, 'pattern' => '\\S+://\\S+/[\\s\\S]*\\S[\\s\\S]*', ], 'Integer' => [ 'type' => 'integer', ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'InvalidParameterValueException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'ListConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'configurationType', ], 'members' => [ 'configurationType' => [ 'shape' => 'ConfigurationItemType', ], 'filters' => [ 'shape' => 'Filters', ], 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'orderBy' => [ 'shape' => 'OrderByList', ], ], ], 'ListConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'configurations' => [ 'shape' => 'Configurations', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListServerNeighborsRequest' => [ 'type' => 'structure', 'required' => [ 'configurationId', ], 'members' => [ 'configurationId' => [ 'shape' => 'ConfigurationId', ], 'portInformationNeeded' => [ 'shape' => 'Boolean', ], 'neighborConfigurationIds' => [ 'shape' => 'ConfigurationIdList', ], 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'String', ], ], ], 'ListServerNeighborsResponse' => [ 'type' => 'structure', 'required' => [ 'neighbors', ], 'members' => [ 'neighbors' => [ 'shape' => 'NeighborDetailsList', ], 'nextToken' => [ 'shape' => 'String', ], 'knownDependencyCount' => [ 'shape' => 'Long', ], ], ], 'Long' => [ 'type' => 'long', ], 'Message' => [ 'type' => 'string', ], 'NeighborConnectionDetail' => [ 'type' => 'structure', 'required' => [ 'sourceServerId', 'destinationServerId', 'connectionsCount', ], 'members' => [ 'sourceServerId' => [ 'shape' => 'ConfigurationId', ], 'destinationServerId' => [ 'shape' => 'ConfigurationId', ], 'destinationPort' => [ 'shape' => 'BoxedInteger', ], 'transportProtocol' => [ 'shape' => 'String', ], 'connectionsCount' => [ 'shape' => 'Long', ], ], ], 'NeighborDetailsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NeighborConnectionDetail', ], ], 'NextToken' => [ 'type' => 'string', ], 'OfferingClass' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'CONVERTIBLE', ], ], 'OperationNotPermittedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'OrderByElement' => [ 'type' => 'structure', 'required' => [ 'fieldName', ], 'members' => [ 'fieldName' => [ 'shape' => 'OrderByElementFieldName', ], 'sortOrder' => [ 'shape' => 'orderString', ], ], ], 'OrderByElementFieldName' => [ 'type' => 'string', 'max' => 1000, 'pattern' => '[\\s\\S]*\\S[\\s\\S]*', ], 'OrderByList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrderByElement', ], ], 'PurchasingOption' => [ 'type' => 'string', 'enum' => [ 'ALL_UPFRONT', 'PARTIAL_UPFRONT', 'NO_UPFRONT', ], ], 'ReservedInstanceOptions' => [ 'type' => 'structure', 'required' => [ 'purchasingOption', 'offeringClass', 'termLength', ], 'members' => [ 'purchasingOption' => [ 'shape' => 'PurchasingOption', ], 'offeringClass' => [ 'shape' => 'OfferingClass', ], 'termLength' => [ 'shape' => 'TermLength', ], ], ], 'ResourceInUseException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'S3Bucket' => [ 'type' => 'string', ], 'S3PresignedUrl' => [ 'type' => 'string', ], 'SchemaStorageConfig' => [ 'type' => 'map', 'key' => [ 'shape' => 'DatabaseName', ], 'value' => [ 'shape' => 'String', ], ], 'ServerInternalErrorException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, 'fault' => true, ], 'StartContinuousExportRequest' => [ 'type' => 'structure', 'members' => [], ], 'StartContinuousExportResponse' => [ 'type' => 'structure', 'members' => [ 'exportId' => [ 'shape' => 'ConfigurationsExportId', ], 's3Bucket' => [ 'shape' => 'S3Bucket', ], 'startTime' => [ 'shape' => 'TimeStamp', ], 'dataSource' => [ 'shape' => 'DataSource', ], 'schemaStorageConfig' => [ 'shape' => 'SchemaStorageConfig', ], ], ], 'StartDataCollectionByAgentIdsRequest' => [ 'type' => 'structure', 'required' => [ 'agentIds', ], 'members' => [ 'agentIds' => [ 'shape' => 'AgentIds', ], ], ], 'StartDataCollectionByAgentIdsResponse' => [ 'type' => 'structure', 'members' => [ 'agentsConfigurationStatus' => [ 'shape' => 'AgentConfigurationStatusList', ], ], ], 'StartExportTaskRequest' => [ 'type' => 'structure', 'members' => [ 'exportDataFormat' => [ 'shape' => 'ExportDataFormats', ], 'filters' => [ 'shape' => 'ExportFilters', ], 'startTime' => [ 'shape' => 'TimeStamp', ], 'endTime' => [ 'shape' => 'TimeStamp', ], 'preferences' => [ 'shape' => 'ExportPreferences', ], ], ], 'StartExportTaskResponse' => [ 'type' => 'structure', 'members' => [ 'exportId' => [ 'shape' => 'ConfigurationsExportId', ], ], ], 'StartImportTaskRequest' => [ 'type' => 'structure', 'required' => [ 'name', 'importUrl', ], 'members' => [ 'clientRequestToken' => [ 'shape' => 'ClientRequestToken', 'idempotencyToken' => true, ], 'name' => [ 'shape' => 'ImportTaskName', ], 'importUrl' => [ 'shape' => 'ImportURL', ], ], ], 'StartImportTaskResponse' => [ 'type' => 'structure', 'members' => [ 'task' => [ 'shape' => 'ImportTask', ], ], ], 'StopContinuousExportRequest' => [ 'type' => 'structure', 'required' => [ 'exportId', ], 'members' => [ 'exportId' => [ 'shape' => 'ConfigurationsExportId', ], ], ], 'StopContinuousExportResponse' => [ 'type' => 'structure', 'members' => [ 'startTime' => [ 'shape' => 'TimeStamp', ], 'stopTime' => [ 'shape' => 'TimeStamp', ], ], ], 'StopDataCollectionByAgentIdsRequest' => [ 'type' => 'structure', 'required' => [ 'agentIds', ], 'members' => [ 'agentIds' => [ 'shape' => 'AgentIds', ], ], ], 'StopDataCollectionByAgentIdsResponse' => [ 'type' => 'structure', 'members' => [ 'agentsConfigurationStatus' => [ 'shape' => 'AgentConfigurationStatusList', ], ], ], 'String' => [ 'type' => 'string', 'max' => 10000, 'pattern' => '[\\s\\S]*', ], 'StringMax255' => [ 'type' => 'string', 'max' => 255, 'min' => 1, 'pattern' => '[\\s\\S]*\\S[\\s\\S]*', ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'key', 'value', ], 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagFilter' => [ 'type' => 'structure', 'required' => [ 'name', 'values', ], 'members' => [ 'name' => [ 'shape' => 'FilterName', ], 'values' => [ 'shape' => 'FilterValues', ], ], ], 'TagFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagFilter', ], ], 'TagKey' => [ 'type' => 'string', ], 'TagSet' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagValue' => [ 'type' => 'string', ], 'Tenancy' => [ 'type' => 'string', 'enum' => [ 'DEDICATED', 'SHARED', ], ], 'TermLength' => [ 'type' => 'string', 'enum' => [ 'ONE_YEAR', 'THREE_YEAR', ], ], 'TimeStamp' => [ 'type' => 'timestamp', ], 'ToDeleteIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImportTaskIdentifier', ], 'max' => 10, 'min' => 1, ], 'UpdateApplicationRequest' => [ 'type' => 'structure', 'required' => [ 'configurationId', ], 'members' => [ 'configurationId' => [ 'shape' => 'ApplicationId', ], 'name' => [ 'shape' => 'ApplicationName', ], 'description' => [ 'shape' => 'ApplicationDescription', ], ], ], 'UpdateApplicationResponse' => [ 'type' => 'structure', 'members' => [], ], 'UsageMetricBasis' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'UsageMetricBasisName', ], 'percentageAdjust' => [ 'shape' => 'UsageMetricPercentageAdjust', ], ], ], 'UsageMetricBasisName' => [ 'type' => 'string', 'pattern' => '^(p(\\d{1,2}|100)|AVG|SPEC|MAX)$', ], 'UsageMetricPercentageAdjust' => [ 'type' => 'double', 'max' => 100.0, 'min' => 0.0, ], 'UserPreferredRegion' => [ 'type' => 'string', 'max' => 30, 'min' => 1, 'pattern' => '[a-z]{2}-[a-z\\-]+-[0-9]+', ], 'orderString' => [ 'type' => 'string', 'enum' => [ 'ASC', 'DESC', ], ], ],]; diff --git a/src/data/discovery/2015-11-01/endpoint-rule-set-1.json b/src/data/discovery/2015-11-01/endpoint-rule-set-1.json index b745570fa9..825e814d7f 100644 --- a/src/data/discovery/2015-11-01/endpoint-rule-set-1.json +++ b/src/data/discovery/2015-11-01/endpoint-rule-set-1.json @@ -58,52 +58,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -111,13 +115,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -127,224 +140,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://discovery-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://discovery-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://discovery-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://discovery-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://discovery.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://discovery.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://discovery.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://discovery.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } \ No newline at end of file diff --git a/src/data/discovery/2015-11-01/endpoint-rule-set-1.json.php b/src/data/discovery/2015-11-01/endpoint-rule-set-1.json.php index de496ad772..14ff4b29de 100644 --- a/src/data/discovery/2015-11-01/endpoint-rule-set-1.json.php +++ b/src/data/discovery/2015-11-01/endpoint-rule-set-1.json.php @@ -1,3 +1,3 @@ '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://discovery-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://discovery-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://discovery.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://discovery.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], ], ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ], ], ],]; +return [ 'version' => '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://discovery-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://discovery-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://discovery.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://discovery.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ],]; diff --git a/src/data/macie2/2020-01-01/docs-2.json b/src/data/macie2/2020-01-01/docs-2.json index de827384a9..c5ccdf5b6a 100644 --- a/src/data/macie2/2020-01-01/docs-2.json +++ b/src/data/macie2/2020-01-01/docs-2.json @@ -1062,8 +1062,8 @@ "ManagedDataIdentifierSelector" : { "base" : "

The selection type that determines which managed data identifiers a classification job uses to analyze data. Valid values are:

", "refs" : { - "CreateClassificationJobRequest$ManagedDataIdentifierSelector" : "

The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

If you don't specify a value for this property, the job uses all managed data identifiers.

If the job is a recurring job and you don't specify a value for this property or you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the job starts to run.

For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

", - "DescribeClassificationJobResponse$ManagedDataIdentifierSelector" : "

The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:

If this value is null, the job uses all managed data identifiers.

If the job is a recurring job and this value is null, ALL, or EXCLUDE, each job run automatically uses new managed data identifiers that are released after the job was created or the preceding run ended. If this value is RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.

For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

" + "CreateClassificationJobRequest$ManagedDataIdentifierSelector" : "

The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

If you don't specify a value for this property, the job uses the recommended set of managed data identifiers.

If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.

For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

", + "DescribeClassificationJobResponse$ManagedDataIdentifierSelector" : "

The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:

If this value is null, the job uses the recommended set of managed data identifiers.

If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.

For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

" } }, "ManagedDataIdentifierSummary" : { diff --git a/src/data/macie2/2020-01-01/docs-2.json.php b/src/data/macie2/2020-01-01/docs-2.json.php index 25e97c17a9..16fa4f3edb 100644 --- a/src/data/macie2/2020-01-01/docs-2.json.php +++ b/src/data/macie2/2020-01-01/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to help you discover and protect your sensitive data in AWS. Macie automates the discovery of sensitive data, such as PII and intellectual property, to provide you with insight into the data that your organization stores in AWS. Macie also provides an inventory of your Amazon S3 buckets, which it continually monitors for you. If Macie detects sensitive data or potential data access issues, it generates detailed findings for you to review and act upon as necessary.

', 'operations' => [ 'AcceptInvitation' => '

Accepts an Amazon Macie membership invitation that was received from a specific account.

', 'BatchGetCustomDataIdentifiers' => '

Retrieves information about one or more custom data identifiers.

', 'CreateAllowList' => '

Creates and defines the settings for an allow list.

', 'CreateClassificationJob' => '

Creates and defines the settings for a classification job.

', 'CreateCustomDataIdentifier' => '

Creates and defines the criteria and other settings for a custom data identifier.

', 'CreateFindingsFilter' => '

Creates and defines the criteria and other settings for a findings filter.

', 'CreateInvitations' => '

Sends an Amazon Macie membership invitation to one or more accounts.

', 'CreateMember' => '

Associates an account with an Amazon Macie administrator account.

', 'CreateSampleFindings' => '

Creates sample findings.

', 'DeclineInvitations' => '

Declines Amazon Macie membership invitations that were received from specific accounts.

', 'DeleteAllowList' => '

Deletes an allow list.

', 'DeleteCustomDataIdentifier' => '

Soft deletes a custom data identifier.

', 'DeleteFindingsFilter' => '

Deletes a findings filter.

', 'DeleteInvitations' => '

Deletes Amazon Macie membership invitations that were received from specific accounts.

', 'DeleteMember' => '

Deletes the association between an Amazon Macie administrator account and an account.

', 'DescribeBuckets' => '

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.

', 'DescribeClassificationJob' => '

Retrieves the status and settings for a classification job.

', 'DescribeOrganizationConfiguration' => '

Retrieves the Amazon Macie configuration settings for an organization in Organizations.

', 'DisableMacie' => '

Disables Amazon Macie and deletes all settings and resources for a Macie account.

', 'DisableOrganizationAdminAccount' => '

Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations.

', 'DisassociateFromAdministratorAccount' => '

Disassociates a member account from its Amazon Macie administrator account.

', 'DisassociateFromMasterAccount' => '

(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation.

', 'DisassociateMember' => '

Disassociates an Amazon Macie administrator account from a member account.

', 'EnableMacie' => '

Enables Amazon Macie and specifies the configuration settings for a Macie account.

', 'EnableOrganizationAdminAccount' => '

Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations.

', 'GetAdministratorAccount' => '

Retrieves information about the Amazon Macie administrator account for an account.

', 'GetAllowList' => '

Retrieves the settings and status of an allow list.

', 'GetAutomatedDiscoveryConfiguration' => '

Retrieves the configuration settings and status of automated sensitive data discovery for an account.

', 'GetBucketStatistics' => '

Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account.

', 'GetClassificationExportConfiguration' => '

Retrieves the configuration settings for storing data classification results.

', 'GetClassificationScope' => '

Retrieves the classification scope settings for an account.

', 'GetCustomDataIdentifier' => '

Retrieves the criteria and other settings for a custom data identifier.

', 'GetFindingStatistics' => '

Retrieves (queries) aggregated statistical data about findings.

', 'GetFindings' => '

Retrieves the details of one or more findings.

', 'GetFindingsFilter' => '

Retrieves the criteria and other settings for a findings filter.

', 'GetFindingsPublicationConfiguration' => '

Retrieves the configuration settings for publishing findings to Security Hub.

', 'GetInvitationsCount' => '

Retrieves the count of Amazon Macie membership invitations that were received by an account.

', 'GetMacieSession' => '

Retrieves the status and configuration settings for an Amazon Macie account.

', 'GetMasterAccount' => '

(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation.

', 'GetMember' => '

Retrieves information about an account that\'s associated with an Amazon Macie administrator account.

', 'GetResourceProfile' => '

Retrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3 bucket.

', 'GetRevealConfiguration' => '

Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

', 'GetSensitiveDataOccurrences' => '

Retrieves occurrences of sensitive data reported by a finding.

', 'GetSensitiveDataOccurrencesAvailability' => '

Checks whether occurrences of sensitive data can be retrieved for a finding.

', 'GetSensitivityInspectionTemplate' => '

Retrieves the settings for the sensitivity inspection template for an account.

', 'GetUsageStatistics' => '

Retrieves (queries) quotas and aggregated usage data for one or more accounts.

', 'GetUsageTotals' => '

Retrieves (queries) aggregated usage data for an account.

', 'ListAllowLists' => '

Retrieves a subset of information about all the allow lists for an account.

', 'ListClassificationJobs' => '

Retrieves a subset of information about one or more classification jobs.

', 'ListClassificationScopes' => '

Retrieves a subset of information about the classification scope for an account.

', 'ListCustomDataIdentifiers' => '

Retrieves a subset of information about all the custom data identifiers for an account.

', 'ListFindings' => '

Retrieves a subset of information about one or more findings.

', 'ListFindingsFilters' => '

Retrieves a subset of information about all the findings filters for an account.

', 'ListInvitations' => '

Retrieves information about the Amazon Macie membership invitations that were received by an account.

', 'ListManagedDataIdentifiers' => '

Retrieves information about all the managed data identifiers that Amazon Macie currently provides.

', 'ListMembers' => '

Retrieves information about the accounts that are associated with an Amazon Macie administrator account.

', 'ListOrganizationAdminAccounts' => '

Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.

', 'ListResourceProfileArtifacts' => '

Retrieves information about objects that were selected from an S3 bucket for automated sensitive data discovery.

', 'ListResourceProfileDetections' => '

Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.

', 'ListSensitivityInspectionTemplates' => '

Retrieves a subset of information about the sensitivity inspection template for an account.

', 'ListTagsForResource' => '

Retrieves the tags (keys and values) that are associated with an Amazon Macie resource.

', 'PutClassificationExportConfiguration' => '

Creates or updates the configuration settings for storing data classification results.

', 'PutFindingsPublicationConfiguration' => '

Updates the configuration settings for publishing findings to Security Hub.

', 'SearchResources' => '

Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

', 'TagResource' => '

Adds or updates one or more tags (keys and values) that are associated with an Amazon Macie resource.

', 'TestCustomDataIdentifier' => '

Tests a custom data identifier.

', 'UntagResource' => '

Removes one or more tags (keys and values) from an Amazon Macie resource.

', 'UpdateAllowList' => '

Updates the settings for an allow list.

', 'UpdateAutomatedDiscoveryConfiguration' => '

Enables or disables automated sensitive data discovery for an account.

', 'UpdateClassificationJob' => '

Changes the status of a classification job.

', 'UpdateClassificationScope' => '

Updates the classification scope settings for an account.

', 'UpdateFindingsFilter' => '

Updates the criteria and other settings for a findings filter.

', 'UpdateMacieSession' => '

Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.

', 'UpdateMemberSession' => '

Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.

', 'UpdateOrganizationConfiguration' => '

Updates the Amazon Macie configuration settings for an organization in Organizations.

', 'UpdateResourceProfile' => '

Updates the sensitivity score for an S3 bucket.

', 'UpdateResourceProfileDetections' => '

Updates the sensitivity scoring settings for an S3 bucket.

', 'UpdateRevealConfiguration' => '

Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

', 'UpdateSensitivityInspectionTemplate' => '

Updates the settings for the sensitivity inspection template for an account.

', ], 'shapes' => [ 'AcceptInvitationRequest' => [ 'base' => '

Specifies an Amazon Macie membership invitation to accept. In the request, you have to specify the ID for the Amazon Web Services account that sent the invitation. Otherwise, a validation error occurs. To specify this ID, we recommend that you use the administratorAccountId property instead of the masterAccount property. The masterAccount property has been deprecated and is retained only for backward compatibility.

', 'refs' => [], ], 'AccessControlList' => [ 'base' => '

Provides information about the permissions settings of the bucket-level access control list (ACL) for an S3 bucket.

', 'refs' => [ 'BucketLevelPermissions$AccessControlList' => '

The permissions settings of the access control list (ACL) for the bucket. This value is null if an ACL hasn\'t been defined for the bucket.

', ], ], 'AccessDeniedException' => [ 'base' => '

Provides information about an error that occurred due to insufficient access to a specified resource.

', 'refs' => [], ], 'AccountDetail' => [ 'base' => '

Specifies the details of an account to associate with an Amazon Macie administrator account.

', 'refs' => [ 'CreateMemberRequest$Account' => '

The details of the account to associate with the administrator account.

', ], ], 'AccountLevelPermissions' => [ 'base' => '

Provides information about the account-level permissions settings that apply to an S3 bucket.

', 'refs' => [ 'BucketPermissionConfiguration$AccountLevelPermissions' => '

The account-level permissions settings that apply to the bucket.

', ], ], 'AdminAccount' => [ 'base' => '

Provides information about the delegated Amazon Macie administrator account for an organization in Organizations.

', 'refs' => [ '__listOfAdminAccount$member' => NULL, ], ], 'AdminStatus' => [ 'base' => '

The current status of an account as the delegated Amazon Macie administrator account for an organization in Organizations. Possible values are:

', 'refs' => [ 'AdminAccount$Status' => '

The current status of the account as the delegated Amazon Macie administrator account for the organization.

', ], ], 'AllowListCriteria' => [ 'base' => '

Specifies the criteria for an allow list. The criteria must specify a regular expression (regex) or an S3 object (s3WordsList). It can\'t specify both.

', 'refs' => [ 'CreateAllowListRequest$Criteria' => '

The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

', 'GetAllowListResponse$Criteria' => '

The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

', 'UpdateAllowListRequest$Criteria' => '

The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression that defines a text pattern to ignore (regex).

You can change a list\'s underlying criteria, such as the name of the S3 object or the regular expression to use. However, you can\'t change the type from s3WordsList to regex or the other way around.

', ], ], 'AllowListStatus' => [ 'base' => '

Provides information about the current status of an allow list, which indicates whether Amazon Macie can access and use the list\'s criteria.

', 'refs' => [ 'GetAllowListResponse$Status' => '

The current status of the allow list, which indicates whether Amazon Macie can access and use the list\'s criteria.

', ], ], 'AllowListStatusCode' => [ 'base' => '

Indicates the current status of an allow list. Depending on the type of criteria that the list specifies, possible values are:

', 'refs' => [ 'AllowListStatus$Code' => '

The current status of the allow list. If the list\'s criteria specify a regular expression (regex), this value is typically OK. Amazon Macie can compile the expression.

If the list\'s criteria specify an S3 object, possible values are:

', ], ], 'AllowListSummary' => [ 'base' => '

Provides a subset of information about an allow list.

', 'refs' => [ '__listOfAllowListSummary$member' => NULL, ], ], 'AllowsUnencryptedObjectUploads' => [ 'base' => NULL, 'refs' => [ 'BucketMetadata$AllowsUnencryptedObjectUploads' => '

Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

', 'S3Bucket$AllowsUnencryptedObjectUploads' => '

Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

', ], ], 'ApiCallDetails' => [ 'base' => '

Provides information about an API operation that an entity invoked for an affected resource.

', 'refs' => [ 'FindingAction$ApiCallDetails' => '

The invocation details of the API operation that an entity invoked for the affected resource, if the value for the actionType property is AWS_API_CALL.

', ], ], 'AssumedRole' => [ 'base' => '

Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the AssumeRole operation of the Security Token Service (STS) API.

', 'refs' => [ 'UserIdentity$AssumedRole' => '

If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.

', ], ], 'AutomatedDiscoveryStatus' => [ 'base' => '

The status of the automated sensitive data discovery configuration for an Amazon Macie account. Valid values are:

', 'refs' => [ 'GetAutomatedDiscoveryConfigurationResponse$Status' => '

The current status of the automated sensitive data discovery configuration for the account. Possible values are: ENABLED, use the specified settings to perform automated sensitive data discovery activities for the account; and, DISABLED, don\'t perform automated sensitive data discovery activities for the account.

', 'UpdateAutomatedDiscoveryConfigurationRequest$Status' => '

The new status of automated sensitive data discovery for the account. Valid values are: ENABLED, start or resume automated sensitive data discovery activities for the account; and, DISABLED, stop performing automated sensitive data discovery activities for the account.

When you enable automated sensitive data discovery for the first time, Amazon Macie uses default configuration settings to determine which data sources to analyze and which managed data identifiers to use. To change these settings, use the UpdateClassificationScope and UpdateSensitivityInspectionTemplate operations, respectively. If you change the settings and subsequently disable the configuration, Amazon Macie retains your changes.

', ], ], 'AvailabilityCode' => [ 'base' => '

Specifies whether occurrences of sensitive data can be retrieved for a finding. Possible values are:

', 'refs' => [ 'GetSensitiveDataOccurrencesAvailabilityResponse$Code' => '

Specifies whether occurrences of sensitive data can be retrieved for the finding. Possible values are: AVAILABLE, the sensitive data can be retrieved; and, UNAVAILABLE, the sensitive data can\'t be retrieved. If this value is UNAVAILABLE, the reasons array indicates why the data can\'t be retrieved.

', ], ], 'AwsAccount' => [ 'base' => '

Provides information about an Amazon Web Services account and entity that performed an action on an affected resource. The action was performed using the credentials for an Amazon Web Services account other than your own account.

', 'refs' => [ 'UserIdentity$AwsAccount' => '

If the action was performed using the credentials for another Amazon Web Services account, the details of that account.

', ], ], 'AwsService' => [ 'base' => '

Provides information about an Amazon Web Service that performed an action on an affected resource.

', 'refs' => [ 'UserIdentity$AwsService' => '

If the action was performed by an Amazon Web Services account that belongs to an Amazon Web Service, the name of the service.

', ], ], 'BatchGetCustomDataIdentifierSummary' => [ 'base' => '

Provides information about a custom data identifier.

', 'refs' => [ '__listOfBatchGetCustomDataIdentifierSummary$member' => NULL, ], ], 'BatchGetCustomDataIdentifiersRequest' => [ 'base' => '

Specifies one or more custom data identifiers to retrieve information about.

', 'refs' => [], ], 'BatchGetCustomDataIdentifiersResponse' => [ 'base' => '

Provides information about one or more custom data identifiers.

', 'refs' => [], ], 'BlockPublicAccess' => [ 'base' => '

Provides information about the block public access settings for an S3 bucket. These settings can apply to a bucket at the account or bucket level. For detailed information about each setting, see Blocking public access to your Amazon S3 storage in the Amazon Simple Storage Service User Guide.

', 'refs' => [ 'AccountLevelPermissions$BlockPublicAccess' => '

The block public access settings for the Amazon Web Services account that owns the bucket.

', 'BucketLevelPermissions$BlockPublicAccess' => '

The block public access settings for the bucket.

', ], ], 'BucketCountByEffectivePermission' => [ 'base' => '

Provides information about the number of S3 buckets that are publicly accessible due to a combination of permissions settings for each bucket.

', 'refs' => [ 'GetBucketStatisticsResponse$BucketCountByEffectivePermission' => '

The total number of buckets that are publicly accessible due to a combination of permissions settings for each bucket.

', ], ], 'BucketCountByEncryptionType' => [ 'base' => '

Provides information about the number of S3 buckets whose settings do or don\'t specify default server-side encryption behavior for objects that are added to the buckets. For detailed information about these settings, see Setting default server-side encryption behavior for Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

', 'refs' => [ 'GetBucketStatisticsResponse$BucketCountByEncryptionType' => '

The total number of buckets whose settings do or don\'t specify default server-side encryption behavior for objects that are added to the buckets.

', ], ], 'BucketCountBySharedAccessType' => [ 'base' => '

Provides information about the number of S3 buckets that are or aren\'t shared with other Amazon Web Services accounts, Amazon CloudFront origin access identities (OAIs), or CloudFront origin access controls (OACs). In this data, an Amazon Macie organization is defined as a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

', 'refs' => [ 'GetBucketStatisticsResponse$BucketCountBySharedAccessType' => '

The total number of buckets that are or aren\'t shared with other Amazon Web Services accounts, Amazon CloudFront origin access identities (OAIs), or CloudFront origin access controls (OACs).

', ], ], 'BucketCountPolicyAllowsUnencryptedObjectUploads' => [ 'base' => '

Provides information about the number of S3 buckets whose bucket policies do or don\'t require server-side encryption of objects when objects are added to the buckets.

', 'refs' => [ 'GetBucketStatisticsResponse$BucketCountByObjectEncryptionRequirement' => '

The total number of buckets whose bucket policies do or don\'t require server-side encryption of objects when objects are added to the buckets.

', ], ], 'BucketCriteria' => [ 'base' => '

Specifies, as a map, one or more property-based conditions that filter the results of a query for information about S3 buckets.

', 'refs' => [ 'DescribeBucketsRequest$Criteria' => '

The criteria to use to filter the query results.

', ], ], 'BucketCriteriaAdditionalProperties' => [ 'base' => '

Specifies the operator to use in a property-based condition that filters the results of a query for information about S3 buckets.

', 'refs' => [ 'BucketCriteria$member' => NULL, ], ], 'BucketLevelPermissions' => [ 'base' => '

Provides information about the bucket-level permissions settings for an S3 bucket.

', 'refs' => [ 'BucketPermissionConfiguration$BucketLevelPermissions' => '

The bucket-level permissions settings for the bucket.

', ], ], 'BucketMetadata' => [ 'base' => '

Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. By default, object count and storage size values include data for object parts that are the result of incomplete multipart uploads. For more information, see How Macie monitors Amazon S3 data security in the Amazon Macie User Guide.

If an error occurs when Macie attempts to retrieve and process metadata from Amazon S3 for the bucket or the bucket\'s objects, the value for the versioning property is false and the value for most other properties is null. Key exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause of the error, refer to the errorCode and errorMessage values.

', 'refs' => [ '__listOfBucketMetadata$member' => NULL, ], ], 'BucketMetadataErrorCode' => [ 'base' => '

The error code for an error that prevented Amazon Macie from retrieving and processing metadata from Amazon S3 for an S3 bucket and the bucket\'s objects.

', 'refs' => [ 'BucketMetadata$ErrorCode' => '

The error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket\'s objects. If this value is ACCESS_DENIED, Macie doesn\'t have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.

', 'MatchingBucket$ErrorCode' => '

The error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket\'s objects. If this value is ACCESS_DENIED, Macie doesn\'t have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.

', ], ], 'BucketPermissionConfiguration' => [ 'base' => '

Provides information about the account-level and bucket-level permissions settings for an S3 bucket.

', 'refs' => [ 'BucketPublicAccess$PermissionConfiguration' => '

The account-level and bucket-level permissions settings for the bucket.

', ], ], 'BucketPolicy' => [ 'base' => '

Provides information about the permissions settings of the bucket policy for an S3 bucket.

', 'refs' => [ 'BucketLevelPermissions$BucketPolicy' => '

The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn\'t been defined for the bucket.

', ], ], 'BucketPublicAccess' => [ 'base' => '

Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.

', 'refs' => [ 'BucketMetadata$PublicAccess' => '

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.

', 'S3Bucket$PublicAccess' => '

The permissions settings that determine whether the bucket is publicly accessible.

', ], ], 'BucketServerSideEncryption' => [ 'base' => '

Provides information about the default server-side encryption settings for an S3 bucket. For detailed information about these settings, see Setting default server-side encryption behavior for Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

', 'refs' => [ 'BucketMetadata$ServerSideEncryption' => '

The default server-side encryption settings for the bucket.

', ], ], 'BucketSortCriteria' => [ 'base' => '

Specifies criteria for sorting the results of a query for information about S3 buckets.

', 'refs' => [ 'DescribeBucketsRequest$SortCriteria' => '

The criteria to use to sort the query results.

', ], ], 'BucketStatisticsBySensitivity' => [ 'base' => '

Provides aggregated statistical data for sensitive data discovery metrics that apply to S3 buckets, grouped by bucket sensitivity score (sensitivityScore). If automated sensitive data discovery is currently disabled for your account, the value for each metric is 0.

', 'refs' => [ 'GetBucketStatisticsResponse$BucketStatisticsBySensitivity' => '

The aggregated sensitive data discovery statistics for the buckets. If automated sensitive data discovery is currently disabled for your account, the value for each statistic is 0.

', ], ], 'Cell' => [ 'base' => '

Specifies the location of an occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.

', 'refs' => [ 'Cells$member' => NULL, ], ], 'Cells' => [ 'base' => '

Specifies the location of occurrences of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.

', 'refs' => [ 'Occurrences$Cells' => '

An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.

Each Cell object specifies a cell or field that contains the sensitive data.

', ], ], 'ClassificationDetails' => [ 'base' => '

Provides information about a sensitive data finding and the details of the finding.

', 'refs' => [ 'Finding$ClassificationDetails' => '

The details of a sensitive data finding. This value is null for a policy finding.

', ], ], 'ClassificationExportConfiguration' => [ 'base' => '

Specifies where to store data classification results, and the encryption settings to use when storing results in that location. The location must be an S3 bucket.

', 'refs' => [ 'GetClassificationExportConfigurationResponse$Configuration' => '

The location where data classification results are stored, and the encryption settings that are used when storing results in that location.

', 'PutClassificationExportConfigurationRequest$Configuration' => '

The location to store data classification results in, and the encryption settings to use when storing results in that location.

', 'PutClassificationExportConfigurationResponse$Configuration' => '

The location where the data classification results are stored, and the encryption settings that are used when storing results in that location.

', ], ], 'ClassificationResult' => [ 'base' => '

Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.

', 'refs' => [ 'ClassificationDetails$Result' => '

The status and other details of the finding.

', ], ], 'ClassificationResultStatus' => [ 'base' => '

Provides information about the status of a sensitive data finding.

', 'refs' => [ 'ClassificationResult$Status' => '

The status of the finding.

', ], ], 'ClassificationScopeId' => [ 'base' => '

The unique identifier the classification scope.

', 'refs' => [ 'ClassificationScopeSummary$Id' => '

The unique identifier for the classification scope.

', 'GetAutomatedDiscoveryConfigurationResponse$ClassificationScopeId' => '

The unique identifier for the classification scope that\'s used when performing automated sensitive data discovery for the account. The classification scope specifies S3 buckets to exclude from automated sensitive data discovery.

', 'GetClassificationScopeResponse$Id' => '

The unique identifier for the classification scope.

', ], ], 'ClassificationScopeName' => [ 'base' => '

The name of the classification scope.

', 'refs' => [ 'ClassificationScopeSummary$Name' => '

The name of the classification scope: automated-sensitive-data-discovery.

', 'GetClassificationScopeResponse$Name' => '

The name of the classification scope: automated-sensitive-data-discovery.

', ], ], 'ClassificationScopeSummary' => [ 'base' => '

Provides information about the classification scope for an Amazon Macie account. Macie uses the scope\'s settings when it performs automated sensitive data discovery for the account.

', 'refs' => [ '__listOfClassificationScopeSummary$member' => NULL, ], ], 'ClassificationScopeUpdateOperation' => [ 'base' => '

Specifies how to apply changes to the S3 bucket exclusion list defined by the classification scope for an Amazon Macie account. Valid values are:

', 'refs' => [ 'S3ClassificationScopeExclusionUpdate$Operation' => '

Specifies how to apply the changes to the exclusion list. Valid values are:

', ], ], 'ConflictException' => [ 'base' => '

Provides information about an error that occurred due to a versioning conflict for a specified resource.

', 'refs' => [], ], 'CreateAllowListRequest' => [ 'base' => '

Specifies the settings for an allow list. When Amazon Macie processes the request, Macie tests the list\'s criteria. If the criteria specify a regular expression that Macie can\'t compile or an S3 object that Macie can\'t retrieve or parse, an error occurs.

', 'refs' => [], ], 'CreateAllowListResponse' => [ 'base' => '

Provides information about an allow list that was created in response to a request.

', 'refs' => [], ], 'CreateClassificationJobRequest' => [ 'base' => '

Specifies the scope, schedule, and other settings for a classification job. You can\'t change any settings for a classification job after you create it. This helps to ensure that you have an immutable history of sensitive data findings and discovery results for data privacy and protection audits or investigations.

', 'refs' => [], ], 'CreateClassificationJobResponse' => [ 'base' => '

Provides information about a classification job that was created in response to a request.

', 'refs' => [], ], 'CreateCustomDataIdentifierRequest' => [ 'base' => '

Specifies the detection criteria and other settings for a custom data identifier. You can\'t change a custom data identifier after you create it. This helps to ensure that you have an immutable history of sensitive data findings and discovery results for data privacy and protection audits or investigations.

', 'refs' => [], ], 'CreateCustomDataIdentifierResponse' => [ 'base' => '

Provides information about a custom data identifier that was created in response to a request.

', 'refs' => [], ], 'CreateFindingsFilterRequest' => [ 'base' => '

Specifies the criteria and other settings for a new findings filter.

', 'refs' => [], ], 'CreateFindingsFilterResponse' => [ 'base' => '

Provides information about a findings filter that was created in response to a request.

', 'refs' => [], ], 'CreateInvitationsRequest' => [ 'base' => '

Specifies the settings for an Amazon Macie membership invitation. When you send an invitation, Macie notifies the recipient by creating an Health event for the recipient\'s account and, if Macie is already enabled for the account, displaying an Accounts badge and notification on the recipient\'s console. You can optionally notify the recipient by also sending the invitation as an email message.

', 'refs' => [], ], 'CreateInvitationsResponse' => [ 'base' => '

Provides information about an unprocessed request to send an Amazon Macie membership invitation to a specific account.

', 'refs' => [], ], 'CreateMemberRequest' => [ 'base' => '

Specifies an Amazon Web Services account to associate with an Amazon Macie administrator account.

', 'refs' => [], ], 'CreateMemberResponse' => [ 'base' => '

Provides information about a request to associate an account with an Amazon Macie administrator account.

', 'refs' => [], ], 'CreateSampleFindingsRequest' => [ 'base' => '

Specifies the types of sample findings to create.

', 'refs' => [], ], 'CriteriaBlockForJob' => [ 'base' => '

Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job.

', 'refs' => [ 'S3BucketCriteriaForJob$Excludes' => '

The property- and tag-based conditions that determine which buckets to exclude from the job.

', 'S3BucketCriteriaForJob$Includes' => '

The property- and tag-based conditions that determine which buckets to include in the job.

', ], ], 'CriteriaForJob' => [ 'base' => '

Specifies a property- or tag-based condition that defines criteria for including or excluding S3 buckets from a classification job.

', 'refs' => [ '__listOfCriteriaForJob$member' => NULL, ], ], 'Criterion' => [ 'base' => '

Specifies a condition that defines a property, operator, and one or more values to filter the results of a query for findings. The number of values depends on the property and operator specified by the condition. For information about defining filter conditions, see Fundamentals of filtering findings in the Amazon Macie User Guide.

', 'refs' => [ 'FindingCriteria$Criterion' => '

A condition that specifies the property, operator, and one or more values to use to filter the results.

', ], ], 'CriterionAdditionalProperties' => [ 'base' => '

Specifies the operator to use in a property-based condition that filters the results of a query for findings. For detailed information and examples of each operator, see Fundamentals of filtering findings in the Amazon Macie User Guide.

', 'refs' => [ 'Criterion$member' => NULL, ], ], 'Currency' => [ 'base' => '

The type of currency that the data for an Amazon Macie usage metric is reported in. Possible values are:

', 'refs' => [ 'UsageByAccount$Currency' => '

The type of currency that the value for the metric (estimatedCost) is reported in.

', 'UsageTotal$Currency' => '

The type of currency that the value for the metric (estimatedCost) is reported in.

', ], ], 'CustomDataIdentifierSummary' => [ 'base' => '

Provides information about a custom data identifier.

', 'refs' => [ '__listOfCustomDataIdentifierSummary$member' => NULL, ], ], 'CustomDataIdentifiers' => [ 'base' => '

Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that they detected for the finding.

', 'refs' => [ 'ClassificationResult$CustomDataIdentifiers' => '

The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.

', ], ], 'CustomDetection' => [ 'base' => '

Provides information about a custom data identifier that produced a sensitive data finding, and the sensitive data that it detected for the finding.

', 'refs' => [ 'CustomDetections$member' => NULL, ], ], 'CustomDetections' => [ 'base' => '

Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that each identifier detected.

', 'refs' => [ 'CustomDataIdentifiers$Detections' => '

The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.

', ], ], 'DailySchedule' => [ 'base' => '

Specifies that a classification job runs once a day, every day. This is an empty object.

', 'refs' => [ 'JobScheduleFrequency$DailySchedule' => '

Specifies a daily recurrence pattern for running the job.

', ], ], 'DataIdentifierSeverity' => [ 'base' => '

The severity of a finding, ranging from LOW, for least severe, to HIGH, for most severe. Valid values are:

', 'refs' => [ 'SeverityLevel$Severity' => '

The severity to assign to a finding: if the number of occurrences is greater than or equal to the specified threshold (occurrencesThreshold); and, if applicable, the number of occurrences is less than the threshold for the next consecutive severity level for the custom data identifier, moving from LOW to HIGH.

', ], ], 'DataIdentifierType' => [ 'base' => '

The type of data identifier that detected a specific type of sensitive data in an S3 bucket. Possible values are:

', 'refs' => [ 'Detection$Type' => '

The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.

', 'SuppressDataIdentifier$Type' => '

The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.

', ], ], 'DayOfWeek' => [ 'base' => NULL, 'refs' => [ 'WeeklySchedule$DayOfWeek' => '

The day of the week when Amazon Macie runs the job.

', ], ], 'DeclineInvitationsRequest' => [ 'base' => '

Specifies one or more accounts that sent Amazon Macie membership invitations to decline.

', 'refs' => [], ], 'DeclineInvitationsResponse' => [ 'base' => '

Provides information about unprocessed requests to decline Amazon Macie membership invitations that were received from specific accounts.

', 'refs' => [], ], 'DefaultDetection' => [ 'base' => '

Provides information about a type of sensitive data that was detected by a managed data identifier and produced a sensitive data finding.

', 'refs' => [ 'DefaultDetections$member' => NULL, ], ], 'DefaultDetections' => [ 'base' => '

Provides information about sensitive data that was detected by managed data identifiers and produced a sensitive data finding, and the number of occurrences of each type of sensitive data that was detected.

', 'refs' => [ 'SensitiveDataItem$Detections' => '

An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected, and the location of up to 15 of those occurrences.

', ], ], 'DeleteInvitationsRequest' => [ 'base' => '

Specifies one or more accounts that sent Amazon Macie membership invitations to delete.

', 'refs' => [], ], 'DeleteInvitationsResponse' => [ 'base' => '

Provides information about unprocessed requests to delete Amazon Macie membership invitations that were received from specific accounts.

', 'refs' => [], ], 'DescribeBucketsRequest' => [ 'base' => '

Specifies criteria for filtering, sorting, and paginating the results of a query for statistical data and other information about S3 buckets.

', 'refs' => [], ], 'DescribeBucketsResponse' => [ 'base' => '

Provides the results of a query that retrieved statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for your account.

', 'refs' => [], ], 'DescribeClassificationJobResponse' => [ 'base' => '

Provides information about a classification job, including the current configuration settings and status of the job.

', 'refs' => [], ], 'DescribeOrganizationConfigurationResponse' => [ 'base' => '

Provides information about the Amazon Macie configuration settings for an organization in Organizations.

', 'refs' => [], ], 'DetectedDataDetails' => [ 'base' => '

Specifies 1-10 occurrences of a specific type of sensitive data reported by a finding.

', 'refs' => [ '__listOfDetectedDataDetails$member' => NULL, ], ], 'Detection' => [ 'base' => '

Provides information about a type of sensitive data that Amazon Macie found in an S3 bucket while performing automated sensitive data discovery for the bucket. The information also specifies the custom data identifier or managed data identifier that detected the data. This information is available only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [ '__listOfDetection$member' => NULL, ], ], 'DomainDetails' => [ 'base' => '

Provides information about the domain name of the device that an entity used to perform an action on an affected resource.

', 'refs' => [ 'FindingActor$DomainDetails' => '

The domain name of the device that the entity used to perform the action on the affected resource.

', ], ], 'EffectivePermission' => [ 'base' => NULL, 'refs' => [ 'BucketPublicAccess$EffectivePermission' => '

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are:

', ], ], 'Empty' => [ 'base' => '

The request succeeded and there isn\'t any content to include in the body of the response (No Content).

', 'refs' => [], ], 'EnableMacieRequest' => [ 'base' => '

Enables Amazon Macie and specifies the configuration settings for a Macie account.

', 'refs' => [], ], 'EnableOrganizationAdminAccountRequest' => [ 'base' => '

Specifies an account to designate as the delegated Amazon Macie administrator account for an organization in Organizations. To submit this request, you must be a user of the Organizations management account.

', 'refs' => [], ], 'EncryptionType' => [ 'base' => '

The server-side encryption algorithm that was used to encrypt an S3 object or is used by default to encrypt objects that are added to an S3 bucket. Possible values are:

', 'refs' => [ 'ServerSideEncryption$EncryptionType' => '

The server-side encryption algorithm that\'s used when storing data in the bucket or object. If default encryption settings aren\'t configured for the bucket or the object isn\'t encrypted using server-side encryption, this value is NONE.

', ], ], 'ErrorCode' => [ 'base' => '

The source of an issue or delay. Possible values are:

', 'refs' => [ 'UnprocessedAccount$ErrorCode' => '

The source of the issue or delay in processing the request.

', ], ], 'FederatedUser' => [ 'base' => '

Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the GetFederationToken operation of the Security Token Service (STS) API.

', 'refs' => [ 'UserIdentity$FederatedUser' => '

If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.

', ], ], 'Finding' => [ 'base' => '

Provides the details of a finding.

', 'refs' => [ '__listOfFinding$member' => NULL, ], ], 'FindingAction' => [ 'base' => '

Provides information about an action that occurred for a resource and produced a policy finding.

', 'refs' => [ 'PolicyDetails$Action' => '

The action that produced the finding.

', ], ], 'FindingActionType' => [ 'base' => '

The type of action that occurred for the resource and produced the policy finding:

', 'refs' => [ 'FindingAction$ActionType' => '

The type of action that occurred for the affected resource. This value is typically AWS_API_CALL, which indicates that an entity invoked an API operation for the resource.

', ], ], 'FindingActor' => [ 'base' => '

Provides information about an entity that performed an action that produced a policy finding for a resource.

', 'refs' => [ 'PolicyDetails$Actor' => '

The entity that performed the action that produced the finding.

', ], ], 'FindingCategory' => [ 'base' => '

The category of the finding. Possible values are:

', 'refs' => [ 'Finding$Category' => '

The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.

', ], ], 'FindingCriteria' => [ 'base' => '

Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.

', 'refs' => [ 'CreateFindingsFilterRequest$FindingCriteria' => '

The criteria to use to filter findings.

', 'GetFindingStatisticsRequest$FindingCriteria' => '

The criteria to use to filter the query results.

', 'GetFindingsFilterResponse$FindingCriteria' => '

The criteria that\'s used to filter findings.

', 'ListFindingsRequest$FindingCriteria' => '

The criteria to use to filter the results.

', 'UpdateFindingsFilterRequest$FindingCriteria' => '

The criteria to use to filter findings.

', ], ], 'FindingPublishingFrequency' => [ 'base' => '

The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events). For more information, see Monitoring and processing findings in the Amazon Macie User Guide. Valid values are:

', 'refs' => [ 'EnableMacieRequest$FindingPublishingFrequency' => '

Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).

', 'GetMacieSessionResponse$FindingPublishingFrequency' => '

The frequency with which Amazon Macie publishes updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).

', 'UpdateMacieSessionRequest$FindingPublishingFrequency' => '

Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).

', ], ], 'FindingStatisticsSortAttributeName' => [ 'base' => '

The grouping to sort the results by. Valid values are:

', 'refs' => [ 'FindingStatisticsSortCriteria$AttributeName' => '

The grouping to sort the results by. Valid values are: count, sort the results by the number of findings in each group of results; and, groupKey, sort the results by the name of each group of results.

', ], ], 'FindingStatisticsSortCriteria' => [ 'base' => '

Specifies criteria for sorting the results of a query that retrieves aggregated statistical data about findings.

', 'refs' => [ 'GetFindingStatisticsRequest$SortCriteria' => '

The criteria to use to sort the query results.

', ], ], 'FindingType' => [ 'base' => '

The type of finding. For details about each type, see Types of Amazon Macie findings in the Amazon Macie User Guide. Possible values are:

', 'refs' => [ 'Finding$Type' => '

The type of the finding.

', '__listOfFindingType$member' => NULL, ], ], 'FindingsFilterAction' => [ 'base' => '

The action to perform on findings that match the filter criteria. To suppress (automatically archive) findings that match the criteria, set this value to ARCHIVE. Valid values are:

', 'refs' => [ 'CreateFindingsFilterRequest$Action' => '

The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don\'t perform any action on the findings.

', 'FindingsFilterListItem$Action' => '

The action that\'s performed on findings that match the filter criteria. Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don\'t perform any action on the findings.

', 'GetFindingsFilterResponse$Action' => '

The action that\'s performed on findings that match the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don\'t perform any action on the findings.

', 'UpdateFindingsFilterRequest$Action' => '

The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don\'t perform any action on the findings.

', ], ], 'FindingsFilterListItem' => [ 'base' => '

Provides information about a findings filter.

', 'refs' => [ '__listOfFindingsFilterListItem$member' => NULL, ], ], 'GetAdministratorAccountResponse' => [ 'base' => '

Provides information about the Amazon Macie administrator account for an account. If the accounts are associated by a Macie membership invitation, the response also provides information about that invitation.

', 'refs' => [], ], 'GetAllowListResponse' => [ 'base' => '

Provides information about the settings and status of an allow list.

', 'refs' => [], ], 'GetAutomatedDiscoveryConfigurationResponse' => [ 'base' => '

Provides information about the configuration settings for performing automated sensitive data discovery for an Amazon Macie account, and the status of the configuration for the account.

', 'refs' => [], ], 'GetBucketStatisticsRequest' => [ 'base' => '

Specifies the account that owns the S3 buckets to retrieve aggregated statistical data for.

', 'refs' => [], ], 'GetBucketStatisticsResponse' => [ 'base' => '

Provides the results of a query that retrieved aggregated statistical data for all the S3 buckets that Amazon Macie monitors and analyzes for your account. By default, object count and storage size values include data for object parts that are the result of incomplete multipart uploads. For more information, see How Macie monitors Amazon S3 data security in the Amazon Macie User Guide.

', 'refs' => [], ], 'GetClassificationExportConfigurationResponse' => [ 'base' => '

Provides information about the current configuration settings for storing data classification results.

', 'refs' => [], ], 'GetClassificationScopeResponse' => [ 'base' => '

Provides information about the classification scope settings for an Amazon Macie account. Macie uses these settings when it performs automated sensitive data discovery for the account.

', 'refs' => [], ], 'GetCustomDataIdentifierResponse' => [ 'base' => '

Provides information about the detection criteria and other settings for a custom data identifier.

', 'refs' => [], ], 'GetFindingStatisticsRequest' => [ 'base' => '

Specifies criteria for filtering, grouping, sorting, and paginating the results of a query that retrieves aggregated statistical data about findings.

', 'refs' => [], ], 'GetFindingStatisticsResponse' => [ 'base' => '

Provides the results of a query that retrieved aggregated statistical data about findings.

', 'refs' => [], ], 'GetFindingsFilterResponse' => [ 'base' => '

Provides information about the criteria and other settings for a findings filter.

', 'refs' => [], ], 'GetFindingsPublicationConfigurationResponse' => [ 'base' => '

Provides information about the current configuration settings for publishing findings to Security Hub automatically.

', 'refs' => [], ], 'GetFindingsRequest' => [ 'base' => '

Specifies one or more findings to retrieve.

', 'refs' => [], ], 'GetFindingsResponse' => [ 'base' => '

Provides the results of a request for one or more findings.

', 'refs' => [], ], 'GetInvitationsCountResponse' => [ 'base' => '

Provides the count of all the Amazon Macie membership invitations that were received by an account, not including the currently accepted invitation.

', 'refs' => [], ], 'GetMacieSessionResponse' => [ 'base' => '

Provides information about the status and configuration settings for an Amazon Macie account.

', 'refs' => [], ], 'GetMasterAccountResponse' => [ 'base' => '

(Deprecated) Provides information about the Amazon Macie administrator account for an account. If the accounts are associated by a Macie membership invitation, the response also provides information about that invitation.

', 'refs' => [], ], 'GetMemberResponse' => [ 'base' => '

Provides information about an account that\'s associated with an Amazon Macie administrator account.

', 'refs' => [], ], 'GetResourceProfileResponse' => [ 'base' => '

Provides the results of a query that retrieved sensitive data discovery statistics and the sensitivity score for an S3 bucket that Amazon Macie monitors and analyzes for your account. This data is available only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [], ], 'GetRevealConfigurationResponse' => [ 'base' => '

Provides information about the configuration settings for retrieving occurrences of sensitive data reported by findings, and the status of the configuration for an Amazon Macie account.

', 'refs' => [], ], 'GetSensitiveDataOccurrencesAvailabilityResponse' => [ 'base' => '

Provides information about whether occurrences of sensitive data can be retrieved for a finding and, if not, why the data can\'t be retrieved.

', 'refs' => [], ], 'GetSensitiveDataOccurrencesResponse' => [ 'base' => '

Provides the results of a request to retrieve occurrences of sensitive data reported by a finding.

', 'refs' => [], ], 'GetSensitivityInspectionTemplateResponse' => [ 'base' => '

Provides information about the settings for the sensitivity inspection template for an Amazon Macie account. Macie uses the template\'s settings when it performs automated sensitive data discovery for the account.

', 'refs' => [], ], 'GetUsageStatisticsRequest' => [ 'base' => '

Specifies criteria for filtering, sorting, and paginating the results of a query for quotas and aggregated usage data for one or more Amazon Macie accounts.

', 'refs' => [], ], 'GetUsageStatisticsResponse' => [ 'base' => '

Provides the results of a query that retrieved quotas and aggregated usage data for one or more Amazon Macie accounts.

', 'refs' => [], ], 'GetUsageTotalsResponse' => [ 'base' => '

Provides the results of a query that retrieved aggregated usage data for an Amazon Macie account.

', 'refs' => [], ], 'GroupBy' => [ 'base' => NULL, 'refs' => [ 'GetFindingStatisticsRequest$GroupBy' => '

The finding property to use to group the query results. Valid values are:

', ], ], 'GroupCount' => [ 'base' => '

Provides a group of results for a query that retrieved aggregated statistical data about findings.

', 'refs' => [ '__listOfGroupCount$member' => NULL, ], ], 'IamUser' => [ 'base' => '

Provides information about an Identity and Access Management (IAM) user who performed an action on an affected resource.

', 'refs' => [ 'UserIdentity$IamUser' => '

If the action was performed using the credentials for an Identity and Access Management (IAM) user, the name and other details about the user.

', ], ], 'InternalServerException' => [ 'base' => '

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

', 'refs' => [], ], 'Invitation' => [ 'base' => '

Provides information about an Amazon Macie membership invitation.

', 'refs' => [ 'GetAdministratorAccountResponse$Administrator' => '

The Amazon Web Services account ID for the administrator account. If the accounts are associated by an Amazon Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.

', 'GetMasterAccountResponse$Master' => '

(Deprecated) The Amazon Web Services account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.

', '__listOfInvitation$member' => NULL, ], ], 'IpAddressDetails' => [ 'base' => '

Provides information about the IP address of the device that an entity used to perform an action on an affected resource.

', 'refs' => [ 'FindingActor$IpAddressDetails' => '

The IP address of the device that the entity used to perform the action on the affected resource. This object also provides information such as the owner and geographic location for the IP address.

', ], ], 'IpCity' => [ 'base' => '

Provides information about the city that an IP address originated from.

', 'refs' => [ 'IpAddressDetails$IpCity' => '

The city that the IP address originated from.

', ], ], 'IpCountry' => [ 'base' => '

Provides information about the country that an IP address originated from.

', 'refs' => [ 'IpAddressDetails$IpCountry' => '

The country that the IP address originated from.

', ], ], 'IpGeoLocation' => [ 'base' => '

Provides geographic coordinates that indicate where a specified IP address originated from.

', 'refs' => [ 'IpAddressDetails$IpGeoLocation' => '

The geographic coordinates of the location that the IP address originated from.

', ], ], 'IpOwner' => [ 'base' => '

Provides information about the registered owner of an IP address.

', 'refs' => [ 'IpAddressDetails$IpOwner' => '

The registered owner of the IP address.

', ], ], 'IsDefinedInJob' => [ 'base' => NULL, 'refs' => [ 'JobDetails$IsDefinedInJob' => '

Specifies whether any one-time or recurring jobs are configured to analyze data in the bucket. Possible values are:

', ], ], 'IsMonitoredByJob' => [ 'base' => NULL, 'refs' => [ 'JobDetails$IsMonitoredByJob' => '

Specifies whether any recurring jobs are configured to analyze data in the bucket. Possible values are:

', ], ], 'JobComparator' => [ 'base' => '

The operator to use in a condition. Depending on the type of condition, possible values are:

', 'refs' => [ 'ListJobsFilterTerm$Comparator' => '

The operator to use to filter the results.

', 'SimpleCriterionForJob$Comparator' => '

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

', 'SimpleScopeTerm$Comparator' => '

The operator to use in the condition. Valid values for each supported property (key) are:

', 'TagCriterionForJob$Comparator' => '

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

', 'TagScopeTerm$Comparator' => '

The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).

', ], ], 'JobDetails' => [ 'base' => '

Specifies whether any one-time or recurring classification jobs are configured to analyze data in an S3 bucket, and, if so, the details of the job that ran most recently.

', 'refs' => [ 'BucketMetadata$JobDetails' => '

Specifies whether any one-time or recurring classification jobs are configured to analyze data in the bucket, and, if so, the details of the job that ran most recently.

', 'MatchingBucket$JobDetails' => '

Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.

', ], ], 'JobScheduleFrequency' => [ 'base' => '

Specifies the recurrence pattern for running a classification job.

', 'refs' => [ 'CreateClassificationJobRequest$ScheduleFrequency' => '

The recurrence pattern for running the job. To run the job only once, don\'t specify a value for this property and set the value for the jobType property to ONE_TIME.

', 'DescribeClassificationJobResponse$ScheduleFrequency' => '

The recurrence pattern for running the job. This value is null if the job is configured to run only once.

', ], ], 'JobScopeTerm' => [ 'base' => '

Specifies a property- or tag-based condition that defines criteria for including or excluding S3 objects from a classification job. A JobScopeTerm object can contain only one simpleScopeTerm object or one tagScopeTerm object.

', 'refs' => [ '__listOfJobScopeTerm$member' => NULL, ], ], 'JobScopingBlock' => [ 'base' => '

Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job.

', 'refs' => [ 'Scoping$Excludes' => '

The property- and tag-based conditions that determine which objects to exclude from the analysis.

', 'Scoping$Includes' => '

The property- and tag-based conditions that determine which objects to include in the analysis.

', ], ], 'JobStatus' => [ 'base' => '

The status of a classification job. Possible values are:

', 'refs' => [ 'DescribeClassificationJobResponse$JobStatus' => '

The current status of the job. Possible values are:

', 'JobSummary$JobStatus' => '

The current status of the job. Possible values are:

', 'UpdateClassificationJobRequest$JobStatus' => '

The new status for the job. Valid values are:

', ], ], 'JobSummary' => [ 'base' => '

Provides information about a classification job, including the current status of the job.

', 'refs' => [ '__listOfJobSummary$member' => NULL, ], ], 'JobType' => [ 'base' => '

The schedule for running a classification job. Valid values are:

', 'refs' => [ 'CreateClassificationJobRequest$JobType' => '

The schedule for running the job. Valid values are:

', 'DescribeClassificationJobResponse$JobType' => '

The schedule for running the job. Possible values are:

', 'JobSummary$JobType' => '

The schedule for running the job. Possible values are:

', ], ], 'KeyValuePair' => [ 'base' => '

Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.

', 'refs' => [ 'KeyValuePairList$member' => NULL, '__listOfKeyValuePair$member' => NULL, ], ], 'KeyValuePairList' => [ 'base' => '

Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.

', 'refs' => [ 'S3Bucket$Tags' => '

The tags that are associated with the bucket.

', 'S3Object$Tags' => '

The tags that are associated with the object.

', ], ], 'LastRunErrorStatus' => [ 'base' => '

Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For information about using logging data to investigate these errors, see Monitoring sensitive data discovery jobs in the Amazon Macie User Guide.

', 'refs' => [ 'DescribeClassificationJobResponse$LastRunErrorStatus' => '

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job\'s most recent run.

', 'JobSummary$LastRunErrorStatus' => '

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job\'s most recent run.

', ], ], 'LastRunErrorStatusCode' => [ 'base' => '

Specifies whether any account- or bucket-level access errors occurred during the run of a one-time classification job or the most recent run of a recurring classification job. Possible values are:

', 'refs' => [ 'LastRunErrorStatus$Code' => '

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job\'s most recent run. Possible values are:

', ], ], 'ListAllowListsResponse' => [ 'base' => '

Provides the results of a request for information about allow lists.

', 'refs' => [], ], 'ListClassificationJobsRequest' => [ 'base' => '

Specifies criteria for filtering, sorting, and paginating the results of a request for information about classification jobs.

', 'refs' => [], ], 'ListClassificationJobsResponse' => [ 'base' => '

Provides the results of a request for information about one or more classification jobs.

', 'refs' => [], ], 'ListClassificationScopesResponse' => [ 'base' => '

Provides the results of a request for information about the classification scope for an Amazon Macie account. Macie uses the scope\'s settings when it performs automated sensitive data discovery for the account.

', 'refs' => [], ], 'ListCustomDataIdentifiersRequest' => [ 'base' => '

Specifies criteria for paginating the results of a request for information about custom data identifiers.

', 'refs' => [], ], 'ListCustomDataIdentifiersResponse' => [ 'base' => '

Provides the results of a request for information about custom data identifiers.

', 'refs' => [], ], 'ListFindingsFiltersResponse' => [ 'base' => '

Provides information about all the findings filters for an account.

', 'refs' => [], ], 'ListFindingsRequest' => [ 'base' => '

Specifies criteria for filtering, sorting, and paginating the results of a request for information about findings.

', 'refs' => [], ], 'ListFindingsResponse' => [ 'base' => '

Provides the results of a request for information about one or more findings.

', 'refs' => [], ], 'ListInvitationsResponse' => [ 'base' => '

Provides information about the Amazon Macie membership invitations that were received by an account.

', 'refs' => [], ], 'ListJobsFilterCriteria' => [ 'base' => '

Specifies criteria for filtering the results of a request for information about classification jobs.

', 'refs' => [ 'ListClassificationJobsRequest$FilterCriteria' => '

The criteria to use to filter the results.

', ], ], 'ListJobsFilterKey' => [ 'base' => '

The property to use to filter the results. Valid values are:

', 'refs' => [ 'ListJobsFilterTerm$Key' => '

The property to use to filter the results.

', ], ], 'ListJobsFilterTerm' => [ 'base' => '

Specifies a condition that filters the results of a request for information about classification jobs. Each condition consists of a property, an operator, and one or more values.

', 'refs' => [ '__listOfListJobsFilterTerm$member' => NULL, ], ], 'ListJobsSortAttributeName' => [ 'base' => '

The property to sort the results by. Valid values are:

', 'refs' => [ 'ListJobsSortCriteria$AttributeName' => '

The property to sort the results by.

', ], ], 'ListJobsSortCriteria' => [ 'base' => '

Specifies criteria for sorting the results of a request for information about classification jobs.

', 'refs' => [ 'ListClassificationJobsRequest$SortCriteria' => '

The criteria to use to sort the results.

', ], ], 'ListManagedDataIdentifiersRequest' => [ 'base' => '

Specifies criteria for paginating the results of a request for information about managed data identifiers.

', 'refs' => [], ], 'ListManagedDataIdentifiersResponse' => [ 'base' => '

Provides information about the managed data identifiers that Amazon Macie currently provides.

', 'refs' => [], ], 'ListMembersResponse' => [ 'base' => '

Provides information about the accounts that are associated with an Amazon Macie administrator account.

', 'refs' => [], ], 'ListOrganizationAdminAccountsResponse' => [ 'base' => '

Provides information about the delegated Amazon Macie administrator accounts for an organization in Organizations.

', 'refs' => [], ], 'ListResourceProfileArtifactsResponse' => [ 'base' => '

Provides the results of a request for information about the S3 objects that Amazon Macie selected for analysis while performing automated sensitive data discovery for an S3 bucket. This information is available only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [], ], 'ListResourceProfileDetectionsResponse' => [ 'base' => '

Provides the results of a request for information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket while performing automated sensitive data discovery for the bucket. This information is available only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [], ], 'ListSensitivityInspectionTemplatesResponse' => [ 'base' => '

Provides the results of a request for information about the sensitivity inspection template for an Amazon Macie account. Macie uses the template\'s settings when it performs automated sensitive data discovery for the account.

', 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => '

Provides information about the tags (keys and values) that are associated with an Amazon Macie resource.

', 'refs' => [], ], 'MacieStatus' => [ 'base' => '

The status of an Amazon Macie account. Valid values are:

', 'refs' => [ 'EnableMacieRequest$Status' => '

Specifies the new status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to ENABLED.

', 'GetMacieSessionResponse$Status' => '

The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Macie activities are enabled for the account.

', 'UpdateMacieSessionRequest$Status' => '

Specifies a new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

', 'UpdateMemberSessionRequest$Status' => '

Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

', ], ], 'ManagedDataIdentifierSelector' => [ 'base' => '

The selection type that determines which managed data identifiers a classification job uses to analyze data. Valid values are:

', 'refs' => [ 'CreateClassificationJobRequest$ManagedDataIdentifierSelector' => '

The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

If you don\'t specify a value for this property, the job uses all managed data identifiers.

If the job is a recurring job and you don\'t specify a value for this property or you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the job starts to run.

For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

', 'DescribeClassificationJobResponse$ManagedDataIdentifierSelector' => '

The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:

If this value is null, the job uses all managed data identifiers.

If the job is a recurring job and this value is null, ALL, or EXCLUDE, each job run automatically uses new managed data identifiers that are released after the job was created or the preceding run ended. If this value is RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.

For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

', ], ], 'ManagedDataIdentifierSummary' => [ 'base' => '

Provides information about a managed data identifier. For additional information, see Using managed data identifiers in the Amazon Macie User Guide.

', 'refs' => [ '__listOfManagedDataIdentifierSummary$member' => NULL, ], ], 'MatchingBucket' => [ 'base' => '

Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. By default, object count and storage size values include data for object parts that are the result of incomplete multipart uploads. For more information, see How Macie monitors Amazon S3 data security in the Amazon Macie User Guide.

If an error occurs when Macie attempts to retrieve and process information about the bucket or the bucket\'s objects, the value for most of these properties is null. Key exceptions are accountId and bucketName. To identify the cause of the error, refer to the errorCode and errorMessage values.

', 'refs' => [ 'MatchingResource$MatchingBucket' => '

The details of an S3 bucket that Amazon Macie monitors and analyzes.

', ], ], 'MatchingResource' => [ 'base' => '

Provides statistical data and other information about an Amazon Web Services resource that Amazon Macie monitors and analyzes for your account.

', 'refs' => [ '__listOfMatchingResource$member' => NULL, ], ], 'Member' => [ 'base' => '

Provides information about an account that\'s associated with an Amazon Macie administrator account.

', 'refs' => [ '__listOfMember$member' => NULL, ], ], 'MonthlySchedule' => [ 'base' => '

Specifies a monthly recurrence pattern for running a classification job.

', 'refs' => [ 'JobScheduleFrequency$MonthlySchedule' => '

Specifies a monthly recurrence pattern for running the job.

', ], ], 'NextToken' => [ 'base' => '

Specifies which page of results to return in a paginated response.

', 'refs' => [ 'ListClassificationScopesResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', ], ], 'ObjectCountByEncryptionType' => [ 'base' => '

Provides information about the number of objects that are in an S3 bucket and use certain types of server-side encryption, use client-side encryption, or aren\'t encrypted.

', 'refs' => [ 'BucketMetadata$ObjectCountByEncryptionType' => '

The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren\'t encrypted or use client-side encryption.

', 'MatchingBucket$ObjectCountByEncryptionType' => '

The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren\'t encrypted or use client-side encryption.

', ], ], 'ObjectLevelStatistics' => [ 'base' => '

Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can\'t analyze in one or more S3 buckets. In a BucketMetadata or MatchingBucket object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results. If versioning is enabled for a bucket, storage size values are based on the size of the latest version of each applicable object in the bucket.

', 'refs' => [ 'BucketMetadata$UnclassifiableObjectCount' => '

The total number of objects that Amazon Macie can\'t analyze in the bucket. These objects don\'t use a supported storage class or don\'t have a file name extension for a supported file or storage format.

', 'BucketMetadata$UnclassifiableObjectSizeInBytes' => '

The total storage size, in bytes, of the objects that Amazon Macie can\'t analyze in the bucket. These objects don\'t use a supported storage class or don\'t have a file name extension for a supported file or storage format.

', 'GetBucketStatisticsResponse$UnclassifiableObjectCount' => '

The total number of objects that Amazon Macie can\'t analyze in the buckets. These objects don\'t use a supported storage class or don\'t have a file name extension for a supported file or storage format.

', 'GetBucketStatisticsResponse$UnclassifiableObjectSizeInBytes' => '

The total storage size, in bytes, of the objects that Amazon Macie can\'t analyze in the buckets. These objects don\'t use a supported storage class or don\'t have a file name extension for a supported file or storage format.

', 'MatchingBucket$UnclassifiableObjectCount' => '

The total number of objects that Amazon Macie can\'t analyze in the bucket. These objects don\'t use a supported storage class or don\'t have a file name extension for a supported file or storage format.

', 'MatchingBucket$UnclassifiableObjectSizeInBytes' => '

The total storage size, in bytes, of the objects that Amazon Macie can\'t analyze in the bucket. These objects don\'t use a supported storage class or don\'t have a file name extension for a supported file or storage format.

', ], ], 'Occurrences' => [ 'base' => '

Specifies the location of 1-15 occurrences of sensitive data that was detected by a managed data identifier or a custom data identifier and produced a sensitive data finding.

', 'refs' => [ 'CustomDetection$Occurrences' => '

The location of 1-15 occurrences of the sensitive data that the custom data identifier detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.

', 'DefaultDetection$Occurrences' => '

The location of 1-15 occurrences of the sensitive data that was detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.

', ], ], 'OrderBy' => [ 'base' => NULL, 'refs' => [ 'BucketSortCriteria$OrderBy' => '

The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

', 'FindingStatisticsSortCriteria$OrderBy' => '

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

', 'ListJobsSortCriteria$OrderBy' => '

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

', 'SearchResourcesSortCriteria$OrderBy' => '

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

', 'SortCriteria$OrderBy' => '

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

', 'UsageStatisticsSortBy$OrderBy' => '

The sort order to apply to the results, based on the value for the field specified by the key property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

', ], ], 'OriginType' => [ 'base' => '

Specifies how Amazon Macie found the sensitive data that produced a finding. Possible values are:

', 'refs' => [ 'ClassificationDetails$OriginType' => '

Specifies how Amazon Macie found the sensitive data that produced the finding. Possible values are: SENSITIVE_DATA_DISCOVERY_JOB, for a classification job; and, AUTOMATED_SENSITIVE_DATA_DISCOVERY, for automated sensitive data discovery.

', ], ], 'Page' => [ 'base' => '

Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.

', 'refs' => [ 'Pages$member' => NULL, ], ], 'Pages' => [ 'base' => '

Specifies the location of occurrences of sensitive data in an Adobe Portable Document Format file.

', 'refs' => [ 'Occurrences$Pages' => '

An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.

Each Page object specifies a page that contains the sensitive data.

', ], ], 'PolicyDetails' => [ 'base' => '

Provides the details of a policy finding.

', 'refs' => [ 'Finding$PolicyDetails' => '

The details of a policy finding. This value is null for a sensitive data finding.

', ], ], 'PutClassificationExportConfigurationRequest' => [ 'base' => '

Specifies where to store data classification results, and the encryption settings to use when storing results in that location.

', 'refs' => [], ], 'PutClassificationExportConfigurationResponse' => [ 'base' => '

Provides information about updated settings for storing data classification results.

', 'refs' => [], ], 'PutFindingsPublicationConfigurationRequest' => [ 'base' => '

Specifies configuration settings for publishing findings to Security Hub automatically.

', 'refs' => [], ], 'Range' => [ 'base' => '

Specifies the location of an occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file.

', 'refs' => [ 'Page$LineRange' => '

Reserved for future use.

', 'Page$OffsetRange' => '

Reserved for future use.

', 'Ranges$member' => NULL, ], ], 'Ranges' => [ 'base' => '

Specifies the locations of occurrences of sensitive data in a non-binary text file.

', 'refs' => [ 'Occurrences$LineRanges' => '

An array of objects, one for each occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.

This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.

', 'Occurrences$OffsetRanges' => '

Reserved for future use.

', ], ], 'Record' => [ 'base' => '

Specifies the location of an occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file.

', 'refs' => [ 'Records$member' => NULL, ], ], 'Records' => [ 'base' => '

Specifies the locations of occurrences of sensitive data in an Apache Avro object container or a structured data file.

', 'refs' => [ 'Occurrences$Records' => '

An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.

For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.

', ], ], 'RelationshipStatus' => [ 'base' => '

The current status of the relationship between an account and an associated Amazon Macie administrator account. Possible values are:

', 'refs' => [ 'GetMemberResponse$RelationshipStatus' => '

The current status of the relationship between the account and the administrator account.

', 'Invitation$RelationshipStatus' => '

The status of the relationship between the account that sent the invitation and the account that received the invitation.

', 'Member$RelationshipStatus' => '

The current status of the relationship between the account and the administrator account.

', ], ], 'ReplicationDetails' => [ 'base' => '

Provides information about settings that define whether one or more objects in an S3 bucket are replicated to S3 buckets for other Amazon Web Services accounts and, if so, which accounts.

', 'refs' => [ 'BucketMetadata$ReplicationDetails' => '

Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

Provides information about an error that occurred because a specified resource wasn\'t found.

', 'refs' => [], ], 'ResourceProfileArtifact' => [ 'base' => '

Provides information about an S3 object that Amazon Macie selected for analysis while performing automated sensitive data discovery for an S3 bucket, and the status and results of the analysis. This information is available only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [ '__listOfResourceProfileArtifact$member' => NULL, ], ], 'ResourceStatistics' => [ 'base' => '

Provides statistical data for sensitive data discovery metrics that apply to an S3 bucket that Amazon Macie monitors and analyzes for your account. The statistics capture the results of automated sensitive data discovery activities that Macie has performed for the bucket. The data is available only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [ 'GetResourceProfileResponse$Statistics' => '

The sensitive data discovery statistics for the bucket. The statistics capture the results of automated sensitive data discovery activities that Amazon Macie has performed for the bucket.

', ], ], 'ResourcesAffected' => [ 'base' => '

Provides information about the resources that a finding applies to.

', 'refs' => [ 'Finding$ResourcesAffected' => '

The resources that the finding applies to.

', ], ], 'RevealConfiguration' => [ 'base' => '

Specifies the configuration settings for retrieving occurrences of sensitive data reported by findings, and the status of the configuration for an Amazon Macie account. When you enable the configuration for the first time, your request must specify an Key Management Service (KMS) key. Otherwise, an error occurs. Macie uses the specified key to encrypt the sensitive data that you retrieve.

', 'refs' => [ 'GetRevealConfigurationResponse$Configuration' => '

The current configuration settings and the status of the configuration for the account.

', 'UpdateRevealConfigurationRequest$Configuration' => '

The new configuration settings and the status of the configuration for the account.

', 'UpdateRevealConfigurationResponse$Configuration' => '

The new configuration settings and the status of the configuration for the account.

', ], ], 'RevealRequestStatus' => [ 'base' => '

The status of a request to retrieve occurrences of sensitive data reported by a finding. Possible values are:

', 'refs' => [ 'GetSensitiveDataOccurrencesResponse$Status' => '

The status of the request to retrieve occurrences of sensitive data reported by the finding. Possible values are:

', ], ], 'RevealStatus' => [ 'base' => '

The status of the configuration for retrieving occurrences of sensitive data reported by findings. Valid values are:

', 'refs' => [ 'RevealConfiguration$Status' => '

The status of the configuration for the Amazon Macie account. In a request, valid values are: ENABLED, enable the configuration for the account; and, DISABLED, disable the configuration for the account. In a response, possible values are: ENABLED, the configuration is currently enabled for the account; and, DISABLED, the configuration is currently disabled for the account.

', ], ], 'S3Bucket' => [ 'base' => '

Provides information about the S3 bucket that a finding applies to.

', 'refs' => [ 'ResourcesAffected$S3Bucket' => '

The details of the S3 bucket that the finding applies to.

', ], ], 'S3BucketCriteriaForJob' => [ 'base' => '

Specifies property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job. Exclude conditions take precedence over include conditions.

', 'refs' => [ 'JobSummary$BucketCriteria' => '

The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job\'s analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job\'s definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

', 'S3JobDefinition$BucketCriteria' => '

The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which buckets contain objects to analyze. A job\'s definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

', ], ], 'S3BucketDefinitionForJob' => [ 'base' => '

Specifies an Amazon Web Services account that owns S3 buckets for a classification job to analyze, and one or more specific buckets to analyze for that account.

', 'refs' => [ '__listOfS3BucketDefinitionForJob$member' => NULL, ], ], 'S3BucketName' => [ 'base' => '

The name of an S3 bucket.

', 'refs' => [ '__listOfS3BucketName$member' => NULL, ], ], 'S3BucketOwner' => [ 'base' => '

Provides information about the Amazon Web Services account that owns an S3 bucket.

', 'refs' => [ 'S3Bucket$Owner' => '

The display name and canonical user ID for the Amazon Web Services account that owns the bucket.

', ], ], 'S3ClassificationScope' => [ 'base' => '

Specifies the S3 buckets that are excluded from automated sensitive data discovery for an Amazon Macie account.

', 'refs' => [ 'GetClassificationScopeResponse$S3' => '

The S3 buckets that are excluded from automated sensitive data discovery.

', ], ], 'S3ClassificationScopeExclusion' => [ 'base' => '

Specifies the names of the S3 buckets that are excluded from automated sensitive data discovery.

', 'refs' => [ 'S3ClassificationScope$Excludes' => '

The S3 buckets that are excluded.

', ], ], 'S3ClassificationScopeExclusionUpdate' => [ 'base' => '

Specifies S3 buckets to add or remove from the exclusion list defined by the classification scope for an Amazon Macie account.

', 'refs' => [ 'S3ClassificationScopeUpdate$Excludes' => '

The names of the S3 buckets to add or remove from the list.

', ], ], 'S3ClassificationScopeUpdate' => [ 'base' => '

Specifies changes to the list of S3 buckets that are excluded from automated sensitive data discovery for an Amazon Macie account.

', 'refs' => [ 'UpdateClassificationScopeRequest$S3' => '

The S3 buckets to add or remove from the exclusion list defined by the classification scope.

', ], ], 'S3Destination' => [ 'base' => '

Specifies an S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.

', 'refs' => [ 'ClassificationExportConfiguration$S3Destination' => '

The S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.

', ], ], 'S3JobDefinition' => [ 'base' => '

Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis. The bucket specification can be static (bucketDefinitions) or dynamic (bucketCriteria). If it\'s static, the job analyzes objects in the same predefined set of buckets each time the job runs. If it\'s dynamic, the job analyzes objects in any buckets that match the specified criteria each time the job starts to run.

', 'refs' => [ 'CreateClassificationJobRequest$S3JobDefinition' => '

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

', 'DescribeClassificationJobResponse$S3JobDefinition' => '

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

', ], ], 'S3Object' => [ 'base' => '

Provides information about the S3 object that a finding applies to.

', 'refs' => [ 'ResourcesAffected$S3Object' => '

The details of the S3 object that the finding applies to.

', ], ], 'S3WordsList' => [ 'base' => '

Provides information about an S3 object that lists specific text to ignore.

', 'refs' => [ 'AllowListCriteria$S3WordsList' => '

The location and name of the S3 object that lists specific text to ignore.

', ], ], 'ScopeFilterKey' => [ 'base' => '

The property to use in a condition that determines whether an S3 object is included or excluded from a classification job. Valid values are:

', 'refs' => [ 'SimpleScopeTerm$Key' => '

The object property to use in the condition.

', ], ], 'Scoping' => [ 'base' => '

Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job. Exclude conditions take precedence over include conditions.

', 'refs' => [ 'S3JobDefinition$Scoping' => '

The property- and tag-based conditions that determine which S3 objects to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which objects to analyze.

', ], ], 'SearchResourcesBucketCriteria' => [ 'base' => '

Specifies property- and tag-based conditions that define filter criteria for including or excluding S3 buckets from the query results. Exclude conditions take precedence over include conditions.

', 'refs' => [ 'SearchResourcesRequest$BucketCriteria' => '

The filter conditions that determine which S3 buckets to include or exclude from the query results.

', ], ], 'SearchResourcesComparator' => [ 'base' => '

The operator to use in a condition that filters the results of a query. Valid values are:

', 'refs' => [ 'SearchResourcesSimpleCriterion$Comparator' => '

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

', 'SearchResourcesTagCriterion$Comparator' => '

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

', ], ], 'SearchResourcesCriteria' => [ 'base' => '

Specifies a property- or tag-based filter condition for including or excluding Amazon Web Services resources from the query results.

', 'refs' => [ '__listOfSearchResourcesCriteria$member' => NULL, ], ], 'SearchResourcesCriteriaBlock' => [ 'base' => '

Specifies property- and tag-based conditions that define filter criteria for including or excluding Amazon Web Services resources from the query results.

', 'refs' => [ 'SearchResourcesBucketCriteria$Excludes' => '

The property- and tag-based conditions that determine which buckets to exclude from the results.

', 'SearchResourcesBucketCriteria$Includes' => '

The property- and tag-based conditions that determine which buckets to include in the results.

', ], ], 'SearchResourcesRequest' => [ 'base' => '

Specifies criteria for filtering, sorting, and paginating the results of a query for statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

', 'refs' => [], ], 'SearchResourcesResponse' => [ 'base' => '

Provides the results of a query that retrieved statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes for your account.

', 'refs' => [], ], 'SearchResourcesSimpleCriterion' => [ 'base' => '

Specifies a property-based filter condition that determines which Amazon Web Services resources are included or excluded from the query results.

', 'refs' => [ 'SearchResourcesCriteria$SimpleCriterion' => '

A property-based condition that defines a property, operator, and one or more values for including or excluding resources from the results.

', ], ], 'SearchResourcesSimpleCriterionKey' => [ 'base' => '

The property to use in a condition that filters the query results. Valid values are:

', 'refs' => [ 'SearchResourcesSimpleCriterion$Key' => '

The property to use in the condition.

', ], ], 'SearchResourcesSortAttributeName' => [ 'base' => '

The property to sort the query results by. Valid values are:

', 'refs' => [ 'SearchResourcesSortCriteria$AttributeName' => '

The property to sort the results by.

', ], ], 'SearchResourcesSortCriteria' => [ 'base' => '

Specifies criteria for sorting the results of a query for information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

', 'refs' => [ 'SearchResourcesRequest$SortCriteria' => '

The criteria to use to sort the results.

', ], ], 'SearchResourcesTagCriterion' => [ 'base' => '

Specifies a tag-based filter condition that determines which Amazon Web Services resources are included or excluded from the query results.

', 'refs' => [ 'SearchResourcesCriteria$TagCriterion' => '

A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding resources from the results.

', ], ], 'SearchResourcesTagCriterionPair' => [ 'base' => '

Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a tag-based filter condition for a query. Tag keys and values are case sensitive. Also, Amazon Macie doesn\'t support use of partial values or wildcard characters in tag-based filter conditions.

', 'refs' => [ '__listOfSearchResourcesTagCriterionPair$member' => NULL, ], ], 'SecurityHubConfiguration' => [ 'base' => '

Specifies configuration settings that determine which findings are published to Security Hub automatically. For information about how Macie publishes findings to Security Hub, see Amazon Macie integration with Security Hub in the Amazon Macie User Guide.

', 'refs' => [ 'GetFindingsPublicationConfigurationResponse$SecurityHubConfiguration' => '

The configuration settings that determine which findings are published to Security Hub.

', 'PutFindingsPublicationConfigurationRequest$SecurityHubConfiguration' => '

The configuration settings that determine which findings to publish to Security Hub.

', ], ], 'SensitiveData' => [ 'base' => '

Provides information about the category and number of occurrences of sensitive data that produced a finding.

', 'refs' => [ 'ClassificationResult$SensitiveData' => '

The category, types, and number of occurrences of the sensitive data that produced the finding.

', ], ], 'SensitiveDataItem' => [ 'base' => '

Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.

', 'refs' => [ 'SensitiveData$member' => NULL, ], ], 'SensitiveDataItemCategory' => [ 'base' => '

For a finding, the category of sensitive data that was detected and produced the finding. For a managed data identifier, the category of sensitive data that the managed data identifier detects. Possible values are:

', 'refs' => [ 'ManagedDataIdentifierSummary$Category' => '

The category of sensitive data that the managed data identifier detects: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

', 'SensitiveDataItem$Category' => '

The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

', ], ], 'SensitiveDataOccurrences' => [ 'base' => '

Specifies a type of sensitive data reported by a finding and provides occurrences of the specified type of sensitive data.

', 'refs' => [ 'GetSensitiveDataOccurrencesResponse$SensitiveDataOccurrences' => '

A map that specifies 1-100 types of sensitive data reported by the finding and, for each type, 1-10 occurrences of sensitive data.

', ], ], 'SensitivityAggregations' => [ 'base' => '

Provides aggregated statistical data for sensitive data discovery metrics that apply to S3 buckets. Each field contains aggregated data for all the buckets that have a sensitivity score (sensitivityScore) of a specified value or within a specified range (BucketStatisticsBySensitivity). If automated sensitive data discovery is currently disabled for your account, the value for each field is 0.

', 'refs' => [ 'BucketStatisticsBySensitivity$ClassificationError' => '

The aggregated statistical data for all buckets that have a sensitivity score of -1.

', 'BucketStatisticsBySensitivity$NotClassified' => '

The aggregated statistical data for all buckets that have a sensitivity score of 50.

', 'BucketStatisticsBySensitivity$NotSensitive' => '

The aggregated statistical data for all buckets that have a sensitivity score of 1-49.

', 'BucketStatisticsBySensitivity$Sensitive' => '

The aggregated statistical data for all buckets that have a sensitivity score of 51-100.

', ], ], 'SensitivityInspectionTemplateExcludes' => [ 'base' => '

Specifies managed data identifiers to exclude (not use) when performing automated sensitive data discovery for an Amazon Macie account. For information about the managed data identifiers that Amazon Macie currently provides, see Using managed data identifiers in the Amazon Macie User Guide.

', 'refs' => [ 'GetSensitivityInspectionTemplateResponse$Excludes' => '

The managed data identifiers that are explicitly excluded (not used) when analyzing data.

', 'UpdateSensitivityInspectionTemplateRequest$Excludes' => '

The managed data identifiers to explicitly exclude (not use) when analyzing data.

To exclude an allow list or custom data identifier that\'s currently included by the template, update the values for the SensitivityInspectionTemplateIncludes.allowListIds and SensitivityInspectionTemplateIncludes.customDataIdentifierIds properties, respectively.

', ], ], 'SensitivityInspectionTemplateId' => [ 'base' => '

The unique identifier for the sensitivity inspection template.

', 'refs' => [ 'GetAutomatedDiscoveryConfigurationResponse$SensitivityInspectionTemplateId' => '

The unique identifier for the sensitivity inspection template that\'s used when performing automated sensitive data discovery for the account. The template specifies which allow lists, custom data identifiers, and managed data identifiers to use when analyzing data.

', 'GetSensitivityInspectionTemplateResponse$SensitivityInspectionTemplateId' => '

The unique identifier for the template.

', ], ], 'SensitivityInspectionTemplateIncludes' => [ 'base' => '

Specifies the allow lists, custom data identifiers, and managed data identifiers to include (use) when performing automated sensitive data discovery for an Amazon Macie account. The configuration must specify at least one custom data identifier or managed data identifier. For information about the managed data identifiers that Amazon Macie currently provides, see Using managed data identifiers in the Amazon Macie User Guide.

', 'refs' => [ 'GetSensitivityInspectionTemplateResponse$Includes' => '

The allow lists, custom data identifiers, and managed data identifiers that are included (used) when analyzing data.

', 'UpdateSensitivityInspectionTemplateRequest$Includes' => '

The allow lists, custom data identifiers, and managed data identifiers to include (use) when analyzing data.

', ], ], 'SensitivityInspectionTemplatesEntry' => [ 'base' => '

Provides information about the sensitivity inspection template for an Amazon Macie account. Macie uses the template\'s settings when it performs automated sensitive data discovery for the account.

', 'refs' => [ '__listOfSensitivityInspectionTemplatesEntry$member' => NULL, ], ], 'ServerSideEncryption' => [ 'base' => '

Provides information about the default server-side encryption settings for an S3 bucket or the encryption settings for an S3 object.

', 'refs' => [ 'S3Bucket$DefaultServerSideEncryption' => '

The default server-side encryption settings for the bucket.

', 'S3Object$ServerSideEncryption' => '

The type of server-side encryption that was used to encrypt the object.

', ], ], 'ServiceLimit' => [ 'base' => '

Specifies a current quota for an Amazon Macie account.

', 'refs' => [ 'UsageByAccount$ServiceLimit' => '

The current value for the quota that corresponds to the metric specified by the type field.

', ], ], 'ServiceQuotaExceededException' => [ 'base' => '

Provides information about an error that occurred due to one or more service quotas for an account.

', 'refs' => [], ], 'SessionContext' => [ 'base' => '

Provides information about a session that was created for an entity that performed an action by using temporary security credentials.

', 'refs' => [ 'AssumedRole$SessionContext' => '

The details of the session that was created for the credentials, including the entity that issued the session.

', 'FederatedUser$SessionContext' => '

The details of the session that was created for the credentials, including the entity that issued the session.

', ], ], 'SessionContextAttributes' => [ 'base' => '

Provides information about the context in which temporary security credentials were issued to an entity.

', 'refs' => [ 'SessionContext$Attributes' => '

The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.

', ], ], 'SessionIssuer' => [ 'base' => '

Provides information about the source and type of temporary security credentials that were issued to an entity.

', 'refs' => [ 'SessionContext$SessionIssuer' => '

The source and type of credentials that were issued to the entity.

', ], ], 'Severity' => [ 'base' => '

Provides the numerical and qualitative representations of a finding\'s severity.

', 'refs' => [ 'Finding$Severity' => '

The severity level and score for the finding.

', ], ], 'SeverityDescription' => [ 'base' => '

The qualitative representation of the finding\'s severity. Possible values are:

', 'refs' => [ 'Severity$Description' => '

The qualitative representation of the finding\'s severity, ranging from Low (least severe) to High (most severe).

', ], ], 'SeverityLevel' => [ 'base' => '

Specifies a severity level for findings that a custom data identifier produces. A severity level determines which severity is assigned to the findings, based on the number of occurrences of text that match the custom data identifier\'s detection criteria.

', 'refs' => [ 'SeverityLevelList$member' => NULL, ], ], 'SeverityLevelList' => [ 'base' => '

The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier\'s detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn\'t create a finding.

If you don\'t specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie automatically assigns the MEDIUM severity to those findings.

', 'refs' => [ 'CreateCustomDataIdentifierRequest$SeverityLevels' => '

The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier\'s detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn\'t create a finding.

If you don\'t specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

', 'GetCustomDataIdentifierResponse$SeverityLevels' => '

Specifies the severity that\'s assigned to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier\'s detection criteria. By default, Amazon Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

', ], ], 'SharedAccess' => [ 'base' => NULL, 'refs' => [ 'BucketMetadata$SharedAccess' => '

Specifies whether the bucket is shared with another Amazon Web Services account, an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access control (OAC). Possible values are:

An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

', ], ], 'SimpleCriterionForJob' => [ 'base' => '

Specifies a property-based condition that determines whether an S3 bucket is included or excluded from a classification job.

', 'refs' => [ 'CriteriaForJob$SimpleCriterion' => '

A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.

', ], ], 'SimpleCriterionKeyForJob' => [ 'base' => '

The property to use in a condition that determines whether an S3 bucket is included or excluded from a classification job. Valid values are:

', 'refs' => [ 'SimpleCriterionForJob$Key' => '

The property to use in the condition.

', ], ], 'SimpleScopeTerm' => [ 'base' => '

Specifies a property-based condition that determines whether an S3 object is included or excluded from a classification job.

', 'refs' => [ 'JobScopeTerm$SimpleScopeTerm' => '

A property-based condition that defines a property, operator, and one or more values for including or excluding objects from the job.

', ], ], 'SortCriteria' => [ 'base' => '

Specifies criteria for sorting the results of a request for findings.

', 'refs' => [ 'GetFindingsRequest$SortCriteria' => '

The criteria for sorting the results of the request.

', 'ListFindingsRequest$SortCriteria' => '

The criteria to use to sort the results.

', ], ], 'Statistics' => [ 'base' => '

Provides processing statistics for a classification job.

', 'refs' => [ 'DescribeClassificationJobResponse$Statistics' => '

The number of times that the job has run and processing statistics for the job\'s current run.

', ], ], 'StorageClass' => [ 'base' => '

The storage class of the S3 object. Possible values are:

', 'refs' => [ 'S3Object$StorageClass' => '

The storage class of the object.

', ], ], 'SuppressDataIdentifier' => [ 'base' => '

Specifies a custom data identifier or managed data identifier that detected a type of sensitive data to start excluding or including in an S3 bucket\'s sensitivity score.

', 'refs' => [ '__listOfSuppressDataIdentifier$member' => NULL, ], ], 'TagCriterionForJob' => [ 'base' => '

Specifies a tag-based condition that determines whether an S3 bucket is included or excluded from a classification job.

', 'refs' => [ 'CriteriaForJob$TagCriterion' => '

A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.

', ], ], 'TagCriterionPairForJob' => [ 'base' => '

Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a tag-based condition that determines whether an S3 bucket is included or excluded from a classification job. Tag keys and values are case sensitive. Also, Amazon Macie doesn\'t support use of partial values or wildcard characters in tag-based conditions.

', 'refs' => [ '__listOfTagCriterionPairForJob$member' => NULL, ], ], 'TagMap' => [ 'base' => '

A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.

', 'refs' => [ 'CreateAllowListRequest$Tags' => '

A map of key-value pairs that specifies the tags to associate with the allow list.

An allow list can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

', 'CreateClassificationJobRequest$Tags' => '

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

', 'CreateCustomDataIdentifierRequest$Tags' => '

A map of key-value pairs that specifies the tags to associate with the custom data identifier.

A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

', 'CreateFindingsFilterRequest$Tags' => '

A map of key-value pairs that specifies the tags to associate with the filter.

A findings filter can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

', 'CreateMemberRequest$Tags' => '

A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.

An account can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

', 'DescribeClassificationJobResponse$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

', 'FindingsFilterListItem$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.

', 'GetAllowListResponse$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the allow list.

', 'GetCustomDataIdentifierResponse$Tags' => '

A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.

', 'GetFindingsFilterResponse$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.

', 'GetMemberResponse$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the account in Amazon Macie.

', 'ListTagsForResourceResponse$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the resource.

', 'Member$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the account in Amazon Macie.

', 'TagResourceRequest$Tags' => '

A map of key-value pairs that specifies the tags to associate with the resource.

A resource can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

', ], ], 'TagResourceRequest' => [ 'base' => '

Specifies the tags (keys and values) to associate with an Amazon Macie resource.

', 'refs' => [], ], 'TagResourceResponse' => [ 'base' => '

The request succeeded. The specified tags were added or updated for the resource.

', 'refs' => [], ], 'TagScopeTerm' => [ 'base' => '

Specifies a tag-based condition that determines whether an S3 object is included or excluded from a classification job.

', 'refs' => [ 'JobScopeTerm$TagScopeTerm' => '

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding objects from the job.

', ], ], 'TagTarget' => [ 'base' => '

The type of object to apply a tag-based condition to. Valid values are:

', 'refs' => [ 'TagScopeTerm$Target' => '

The type of object to apply the condition to.

', ], ], 'TagValuePair' => [ 'base' => '

Specifies a tag key or tag key and value pair to use in a tag-based condition that determines whether an S3 object is included or excluded from a classification job. Tag keys and values are case sensitive. Also, Amazon Macie doesn\'t support use of partial values or wildcard characters in tag-based conditions.

', 'refs' => [ '__listOfTagValuePair$member' => NULL, ], ], 'TestCustomDataIdentifierRequest' => [ 'base' => '

Specifies the detection criteria of a custom data identifier to test.

', 'refs' => [], ], 'TestCustomDataIdentifierResponse' => [ 'base' => '

Provides test results for a custom data identifier.

', 'refs' => [], ], 'ThrottlingException' => [ 'base' => '

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

', 'refs' => [], ], 'TimeRange' => [ 'base' => '

An inclusive time period that Amazon Macie usage data applies to. Possible values are:

', 'refs' => [ 'GetUsageStatisticsRequest$TimeRange' => '

The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don\'t specify a value, Amazon Macie provides usage data for the preceding 30 days.

', 'GetUsageStatisticsResponse$TimeRange' => '

The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

', 'GetUsageTotalsResponse$TimeRange' => '

The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

', ], ], 'Timestamp' => [ 'base' => '

Specifies a date and time in UTC and extended ISO 8601 format.

', 'refs' => [ 'GetAutomatedDiscoveryConfigurationResponse$DisabledAt' => '

The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently disabled for the account. This value is null if automated sensitive data discovery wasn\'t enabled and subsequently disabled for the account.

', 'GetAutomatedDiscoveryConfigurationResponse$FirstEnabledAt' => '

The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was initially enabled for the account. This value is null if automated sensitive data discovery has never been enabled for the account.

', 'GetAutomatedDiscoveryConfigurationResponse$LastUpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently enabled or disabled for the account.

', ], ], 'Type' => [ 'base' => NULL, 'refs' => [ 'BucketServerSideEncryption$Type' => '

The server-side encryption algorithm that\'s used by default to encrypt objects that are added to the bucket. Possible values are:

', ], ], 'UnavailabilityReasonCode' => [ 'base' => '

Specifies why occurrences of sensitive data can\'t be retrieved for a finding. Possible values are:

', 'refs' => [ '__listOfUnavailabilityReasonCode$member' => NULL, ], ], 'Unit' => [ 'base' => NULL, 'refs' => [ 'ServiceLimit$Unit' => '

The unit of measurement for the value specified by the value field.

', ], ], 'UnprocessableEntityException' => [ 'base' => '

Provides information about an error that occurred due to an unprocessable entity.

', 'refs' => [], ], 'UnprocessedAccount' => [ 'base' => '

Provides information about an account-related request that hasn\'t been processed.

', 'refs' => [ '__listOfUnprocessedAccount$member' => NULL, ], ], 'UntagResourceResponse' => [ 'base' => '

The request succeeded. The specified tags were removed from the resource.

', 'refs' => [], ], 'UpdateAllowListRequest' => [ 'base' => '

Changes the settings for an allow list. If you change the list\'s criteria, Amazon Macie tests the new criteria when it processes your request. If the criteria specify a regular expression that Macie can\'t compile or an S3 object that Macie can\'t retrieve or parse, an error occurs.

', 'refs' => [], ], 'UpdateAllowListResponse' => [ 'base' => '

Provides information about an allow list whose settings were changed in response to a request.

', 'refs' => [], ], 'UpdateAutomatedDiscoveryConfigurationRequest' => [ 'base' => '

Enables or disables automated sensitive data discovery for an Amazon Macie account.

', 'refs' => [], ], 'UpdateClassificationJobRequest' => [ 'base' => '

Changes the status of a classification job. For more information about pausing, resuming, or cancelling jobs, see Managing sensitive data discovery jobs in the Amazon Macie User Guide.

', 'refs' => [], ], 'UpdateClassificationScopeRequest' => [ 'base' => '

Specifies new classification scope settings for an Amazon Macie account. Macie uses these settings when it performs automated sensitive data discovery for the account. To update the settings, automated sensitive data discovery must currently be enabled for the account.

', 'refs' => [], ], 'UpdateFindingsFilterRequest' => [ 'base' => '

Specifies the criteria and other settings for a findings filter.

', 'refs' => [], ], 'UpdateFindingsFilterResponse' => [ 'base' => '

Provides information about a findings filter that was updated in response to a request.

', 'refs' => [], ], 'UpdateMacieSessionRequest' => [ 'base' => '

Changes the status or configuration settings for an Amazon Macie account.

', 'refs' => [], ], 'UpdateMemberSessionRequest' => [ 'base' => '

Suspends (pauses) or re-enables Amazon Macie for a member account.

', 'refs' => [], ], 'UpdateOrganizationConfigurationRequest' => [ 'base' => '

Specifies whether to enable Amazon Macie automatically for accounts that are added to an organization in Organizations.

', 'refs' => [], ], 'UpdateResourceProfileDetectionsRequest' => [ 'base' => '

Updates the sensitivity scoring settings for an S3 bucket that Amazon Macie monitors and analyzes for your account. The settings specify whether to exclude or include occurrences of specific types of sensitive data in calculations of the bucket\'s sensitivity score. You can update the settings only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [], ], 'UpdateResourceProfileRequest' => [ 'base' => '

Specifies a new sensitivity score for an S3 bucket that Amazon Macie monitors and analyzes for your account. To update the score, automated sensitive data discovery must currently be enabled for your account.

', 'refs' => [], ], 'UpdateRevealConfigurationRequest' => [ 'base' => '

Specifies the configuration settings for retrieving occurrences of sensitive data reported by findings, and the status of the configuration for an Amazon Macie account.

', 'refs' => [], ], 'UpdateRevealConfigurationResponse' => [ 'base' => '

Provides information about updated configuration settings for retrieving occurrences of sensitive data reported by findings, and the status of the configuration for an Amazon Macie account.

', 'refs' => [], ], 'UpdateSensitivityInspectionTemplateRequest' => [ 'base' => '

Specifies settings for the sensitivity inspection template for an Amazon Macie account. Macie uses the template\'s settings when it performs automated sensitive data discovery for the account. To update the settings, automated sensitive data discovery must currently be enabled for the account.

', 'refs' => [], ], 'UsageByAccount' => [ 'base' => '

Provides data for a specific usage metric and the corresponding quota for an Amazon Macie account.

', 'refs' => [ '__listOfUsageByAccount$member' => NULL, ], ], 'UsageRecord' => [ 'base' => '

Provides quota and aggregated usage data for an Amazon Macie account.

', 'refs' => [ '__listOfUsageRecord$member' => NULL, ], ], 'UsageStatisticsFilter' => [ 'base' => '

Specifies a condition for filtering the results of a query for quota and usage data for one or more Amazon Macie accounts.

', 'refs' => [ '__listOfUsageStatisticsFilter$member' => NULL, ], ], 'UsageStatisticsFilterComparator' => [ 'base' => '

The operator to use in a condition that filters the results of a query for Amazon Macie account quotas and usage data. Valid values are:

', 'refs' => [ 'UsageStatisticsFilter$Comparator' => '

The operator to use in the condition. If the value for the key property is accountId, this value must be CONTAINS. If the value for the key property is any other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE.

', ], ], 'UsageStatisticsFilterKey' => [ 'base' => '

The field to use in a condition that filters the results of a query for Amazon Macie account quotas and usage data. Valid values are:

', 'refs' => [ 'UsageStatisticsFilter$Key' => '

The field to use in the condition.

', ], ], 'UsageStatisticsSortBy' => [ 'base' => '

Specifies criteria for sorting the results of a query for Amazon Macie account quotas and usage data.

', 'refs' => [ 'GetUsageStatisticsRequest$SortBy' => '

The criteria to use to sort the query results.

', ], ], 'UsageStatisticsSortKey' => [ 'base' => '

The field to use to sort the results of a query for Amazon Macie account quotas and usage data. Valid values are:

', 'refs' => [ 'UsageStatisticsSortBy$Key' => '

The field to sort the results by.

', ], ], 'UsageTotal' => [ 'base' => '

Provides aggregated data for an Amazon Macie usage metric. The value for the metric reports estimated usage data for an account for the preceding 30 days or the current calendar month to date, depending on the time period (timeRange) specified in the request.

', 'refs' => [ '__listOfUsageTotal$member' => NULL, ], ], 'UsageType' => [ 'base' => '

The name of an Amazon Macie usage metric for an account. Possible values are:

', 'refs' => [ 'UsageByAccount$Type' => '

The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.

', 'UsageTotal$Type' => '

The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.

', ], ], 'UserIdentity' => [ 'base' => '

Provides information about the type and other characteristics of an entity that performed an action on an affected resource.

', 'refs' => [ 'FindingActor$UserIdentity' => '

The type and other characteristics of the entity that performed the action on the affected resource.

', ], ], 'UserIdentityRoot' => [ 'base' => '

Provides information about an Amazon Web Services account and entity that performed an action on an affected resource. The action was performed using the credentials for your Amazon Web Services account.

', 'refs' => [ 'UserIdentity$Root' => '

If the action was performed using the credentials for your Amazon Web Services account, the details of your account.

', ], ], 'UserIdentityType' => [ 'base' => '

The type of entity that performed the action on the affected resource. Possible values are:

', 'refs' => [ 'UserIdentity$Type' => '

The type of entity that performed the action.

', ], ], 'UserPausedDetails' => [ 'base' => '

Provides information about when a classification job was paused. For a one-time job, this object also specifies when the job will expire and be cancelled if it isn\'t resumed. For a recurring job, this object also specifies when the paused job run will expire and be cancelled if it isn\'t resumed. This object is present only if a job\'s current status (jobStatus) is USER_PAUSED. The information in this object applies only to a job that was paused while it had a status of RUNNING.

', 'refs' => [ 'DescribeClassificationJobResponse$UserPausedDetails' => '

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn\'t resumed. This value is present only if the value for jobStatus is USER_PAUSED.

', 'JobSummary$UserPausedDetails' => '

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn\'t resumed. This value is present only if the value for jobStatus is USER_PAUSED.

', ], ], 'ValidationException' => [ 'base' => '

Provides information about an error that occurred due to a syntax error in a request.

', 'refs' => [], ], 'WeeklySchedule' => [ 'base' => '

Specifies a weekly recurrence pattern for running a classification job.

', 'refs' => [ 'JobScheduleFrequency$WeeklySchedule' => '

Specifies a weekly recurrence pattern for running the job.

', ], ], '__boolean' => [ 'base' => NULL, 'refs' => [ 'AccessControlList$AllowsPublicReadAccess' => '

Specifies whether the ACL grants the general public with read access permissions for the bucket.

', 'AccessControlList$AllowsPublicWriteAccess' => '

Specifies whether the ACL grants the general public with write access permissions for the bucket.

', 'BatchGetCustomDataIdentifierSummary$Deleted' => '

Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn\'t delete it permanently. Instead, it soft deletes the identifier.

', 'BlockPublicAccess$BlockPublicAcls' => '

Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.

', 'BlockPublicAccess$BlockPublicPolicy' => '

Specifies whether Amazon S3 blocks public bucket policies for the bucket.

', 'BlockPublicAccess$IgnorePublicAcls' => '

Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

', 'BlockPublicAccess$RestrictPublicBuckets' => '

Specifies whether Amazon S3 restricts public bucket policies for the bucket.

', 'BucketMetadata$Versioning' => '

Specifies whether versioning is enabled for the bucket.

', 'BucketPolicy$AllowsPublicReadAccess' => '

Specifies whether the bucket policy allows the general public to have read access to the bucket.

', 'BucketPolicy$AllowsPublicWriteAccess' => '

Specifies whether the bucket policy allows the general public to have write access to the bucket.

', 'ClassificationResult$AdditionalOccurrences' => '

Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.

This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation).

', 'CreateClassificationJobRequest$InitialRun' => '

For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job\'s first scheduled run, set this value to false.

If you configure the job to run only once, don\'t specify a value for this property.

', 'CreateInvitationsRequest$DisableEmailNotification' => '

Specifies whether to send the invitation as an email message. If this value is false, Amazon Macie sends the invitation (as an email message) to the email address that you specified for the recipient\'s account when you associated the account with your account. The default value is false.

', 'DescribeClassificationJobResponse$InitialRun' => '

For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job\'s first scheduled run, this value is false. This value is also false for a one-time job.

', 'DescribeOrganizationConfigurationResponse$AutoEnable' => '

Specifies whether Amazon Macie is enabled automatically for accounts that are added to the organization.

', 'DescribeOrganizationConfigurationResponse$MaxAccountLimitReached' => '

Specifies whether the maximum number of Amazon Macie member accounts are part of the organization.

', 'Detection$Suppressed' => '

Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket\'s sensitivity score.

', 'Finding$Archived' => '

Specifies whether the finding is archived (suppressed).

', 'Finding$Sample' => '

Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.

', 'GetCustomDataIdentifierResponse$Deleted' => '

Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn\'t delete it permanently. Instead, it soft deletes the identifier.

', 'GetResourceProfileResponse$SensitivityScoreOverridden' => '

Specifies whether the bucket\'s current sensitivity score was set manually. If this value is true, the score was manually changed to 100. If this value is false, the score was calculated automatically by Amazon Macie.

', 'ReplicationDetails$Replicated' => '

Specifies whether the bucket is configured to replicate one or more objects to any destination.

', 'ReplicationDetails$ReplicatedExternally' => '

Specifies whether the bucket is configured to replicate one or more objects to a bucket for an Amazon Web Services account that isn\'t part of your Amazon Macie organization. An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

', 'ResourceProfileArtifact$Sensitive' => '

Specifies whether Amazon Macie found sensitive data in the object.

', 'S3Object$PublicAccess' => '

Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.

', 'SecurityHubConfiguration$PublishClassificationFindings' => '

Specifies whether to publish sensitive data findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all sensitive data findings that weren\'t suppressed by a findings filter. The default value is false.

', 'SecurityHubConfiguration$PublishPolicyFindings' => '

Specifies whether to publish policy findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all new and updated policy findings that weren\'t suppressed by a findings filter. The default value is true.

', 'ServiceLimit$IsServiceLimited' => '

Specifies whether the account has met the quota that corresponds to the metric specified by the UsageByAccount.type field in the response.

', 'SessionContextAttributes$MfaAuthenticated' => '

Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.

', 'UpdateOrganizationConfigurationRequest$AutoEnable' => '

Specifies whether to enable Amazon Macie automatically for an account when the account is added to the organization in Organizations.

', ], ], '__double' => [ 'base' => NULL, 'refs' => [ 'IpGeoLocation$Lat' => '

The latitude coordinate of the location, rounded to four decimal places.

', 'IpGeoLocation$Lon' => '

The longitude coordinate of the location, rounded to four decimal places.

', 'Statistics$ApproximateNumberOfObjectsToProcess' => '

The approximate number of objects that the job has yet to process during its current run.

', 'Statistics$NumberOfRuns' => '

The number of times that the job has run.

', ], ], '__integer' => [ 'base' => NULL, 'refs' => [ 'BucketMetadata$SensitivityScore' => '

The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.

', 'CreateClassificationJobRequest$SamplingPercentage' => '

The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

', 'CreateCustomDataIdentifierRequest$MaximumMatchDistance' => '

The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

', 'CreateFindingsFilterRequest$Position' => '

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

', 'DescribeBucketsRequest$MaxResults' => '

The maximum number of items to include in each page of the response. The default value is 50.

', 'DescribeClassificationJobResponse$SamplingPercentage' => '

The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.

', 'GetCustomDataIdentifierResponse$MaximumMatchDistance' => '

The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. Otherwise, Macie excludes the result.

', 'GetFindingStatisticsRequest$Size' => '

The maximum number of items to include in each page of the response.

', 'GetFindingsFilterResponse$Position' => '

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

', 'GetResourceProfileResponse$SensitivityScore' => '

The current sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). By default, this score is calculated automatically based on the amount of data that Amazon Macie has analyzed in the bucket and the amount of sensitive data that Macie has found in the bucket.

', 'GetUsageStatisticsRequest$MaxResults' => '

The maximum number of items to include in each page of the response.

', 'ListClassificationJobsRequest$MaxResults' => '

The maximum number of items to include in each page of the response.

', 'ListCustomDataIdentifiersRequest$MaxResults' => '

The maximum number of items to include in each page of the response.

', 'ListFindingsRequest$MaxResults' => '

The maximum number of items to include in each page of the response.

', 'MatchingBucket$SensitivityScore' => '

The current sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.

', 'MonthlySchedule$DayOfMonth' => '

The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.

If this value exceeds the number of days in a certain month, Macie doesn\'t run the job that month. Macie runs the job only during months that have the specified day. For example, if this value is 31 and a month has only 30 days, Macie doesn\'t run the job that month. To run the job every month, specify a value that\'s less than 29.

', 'SearchResourcesRequest$MaxResults' => '

The maximum number of items to include in each page of the response. The default value is 50.

', 'TestCustomDataIdentifierRequest$MaximumMatchDistance' => '

The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

', 'TestCustomDataIdentifierResponse$MatchCount' => '

The number of occurrences of sample text that matched the criteria specified by the custom data identifier.

', 'UpdateFindingsFilterRequest$Position' => '

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

', 'UpdateResourceProfileRequest$SensitivityScoreOverride' => '

The new sensitivity score for the bucket. Valid values are: 100, assign the maximum score and apply the Sensitive label to the bucket; and, null (empty), assign a score that Amazon Macie calculates automatically after you submit the request.

', ], ], '__listOfAdminAccount' => [ 'base' => NULL, 'refs' => [ 'ListOrganizationAdminAccountsResponse$AdminAccounts' => '

An array of objects, one for each delegated Amazon Macie administrator account for the organization. Only one of these accounts can have a status of ENABLED.

', ], ], '__listOfAllowListSummary' => [ 'base' => NULL, 'refs' => [ 'ListAllowListsResponse$AllowLists' => '

An array of objects, one for each allow list.

', ], ], '__listOfBatchGetCustomDataIdentifierSummary' => [ 'base' => NULL, 'refs' => [ 'BatchGetCustomDataIdentifiersResponse$CustomDataIdentifiers' => '

An array of objects, one for each custom data identifier that matches the criteria specified in the request.

', ], ], '__listOfBucketMetadata' => [ 'base' => NULL, 'refs' => [ 'DescribeBucketsResponse$Buckets' => '

An array of objects, one for each bucket that matches the filter criteria specified in the request.

', ], ], '__listOfClassificationScopeSummary' => [ 'base' => NULL, 'refs' => [ 'ListClassificationScopesResponse$ClassificationScopes' => '

An array that specifies the unique identifier and name of the classification scope for the account.

', ], ], '__listOfCriteriaForJob' => [ 'base' => NULL, 'refs' => [ 'CriteriaBlockForJob$And' => '

An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

', ], ], '__listOfCustomDataIdentifierSummary' => [ 'base' => NULL, 'refs' => [ 'ListCustomDataIdentifiersResponse$Items' => '

An array of objects, one for each custom data identifier.

', ], ], '__listOfDetectedDataDetails' => [ 'base' => NULL, 'refs' => [ 'SensitiveDataOccurrences$member' => NULL, ], ], '__listOfDetection' => [ 'base' => NULL, 'refs' => [ 'ListResourceProfileDetectionsResponse$Detections' => '

An array of objects, one for each type of sensitive data that Amazon Macie found in the bucket. Each object reports the number of occurrences of the specified type and provides information about the custom data identifier or managed data identifier that detected the data.

', ], ], '__listOfFinding' => [ 'base' => NULL, 'refs' => [ 'GetFindingsResponse$Findings' => '

An array of objects, one for each finding that matches the criteria specified in the request.

', ], ], '__listOfFindingType' => [ 'base' => NULL, 'refs' => [ 'CreateSampleFindingsRequest$FindingTypes' => '

An array of finding types, one for each type of sample finding to create. To create a sample of every type of finding that Amazon Macie supports, don\'t include this array in your request.

', ], ], '__listOfFindingsFilterListItem' => [ 'base' => NULL, 'refs' => [ 'ListFindingsFiltersResponse$FindingsFilterListItems' => '

An array of objects, one for each filter that\'s associated with the account.

', ], ], '__listOfGroupCount' => [ 'base' => NULL, 'refs' => [ 'GetFindingStatisticsResponse$CountsByGroup' => '

An array of objects, one for each group of findings that matches the filter criteria specified in the request.

', ], ], '__listOfInvitation' => [ 'base' => NULL, 'refs' => [ 'ListInvitationsResponse$Invitations' => '

An array of objects, one for each invitation that was received by the account.

', ], ], '__listOfJobScopeTerm' => [ 'base' => NULL, 'refs' => [ 'JobScopingBlock$And' => '

An array of conditions, one for each property- or tag-based condition that determines which objects to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

', ], ], '__listOfJobSummary' => [ 'base' => NULL, 'refs' => [ 'ListClassificationJobsResponse$Items' => '

An array of objects, one for each job that matches the filter criteria specified in the request.

', ], ], '__listOfKeyValuePair' => [ 'base' => NULL, 'refs' => [ 'BucketMetadata$Tags' => '

An array that specifies the tags (keys and values) that are associated with the bucket.

', ], ], '__listOfListJobsFilterTerm' => [ 'base' => NULL, 'refs' => [ 'ListJobsFilterCriteria$Excludes' => '

An array of objects, one for each condition that determines which jobs to exclude from the results.

', 'ListJobsFilterCriteria$Includes' => '

An array of objects, one for each condition that determines which jobs to include in the results.

', ], ], '__listOfManagedDataIdentifierSummary' => [ 'base' => NULL, 'refs' => [ 'ListManagedDataIdentifiersResponse$Items' => '

An array of objects, one for each managed data identifier.

', ], ], '__listOfMatchingResource' => [ 'base' => NULL, 'refs' => [ 'SearchResourcesResponse$MatchingResources' => '

An array of objects, one for each resource that matches the filter criteria specified in the request.

', ], ], '__listOfMember' => [ 'base' => NULL, 'refs' => [ 'ListMembersResponse$Members' => '

An array of objects, one for each account that\'s associated with the administrator account and matches the criteria specified in the request.

', ], ], '__listOfResourceProfileArtifact' => [ 'base' => NULL, 'refs' => [ 'ListResourceProfileArtifactsResponse$Artifacts' => '

An array of objects, one for each of 1-100 S3 objects that Amazon Macie selected for analysis.

If Macie has analyzed more than 100 objects in the bucket, Macie populates the array based on the value for the ResourceProfileArtifact.sensitive field for an object: true (sensitive), followed by false (not sensitive). Macie then populates any remaining items in the array with information about objects where the value for the ResourceProfileArtifact.classificationResultStatus field is SKIPPED.

', ], ], '__listOfS3BucketDefinitionForJob' => [ 'base' => NULL, 'refs' => [ 'JobSummary$BucketDefinitions' => '

An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job\'s definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

', 'S3JobDefinition$BucketDefinitions' => '

An array of objects, one for each Amazon Web Services account that owns specific S3 buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job\'s definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

', ], ], '__listOfS3BucketName' => [ 'base' => NULL, 'refs' => [ 'S3ClassificationScopeExclusion$BucketNames' => '

An array of strings, one for each S3 bucket that is excluded. Each string is the full name of an excluded bucket.

', 'S3ClassificationScopeExclusionUpdate$BucketNames' => '

Depending on the value specified for the update operation (ClassificationScopeUpdateOperation), an array of strings that: lists the names of buckets to add or remove from the list, or specifies a new set of bucket names that overwrites all existing names in the list. Each string must be the full name of an S3 bucket. Values are case sensitive.

', ], ], '__listOfSearchResourcesCriteria' => [ 'base' => NULL, 'refs' => [ 'SearchResourcesCriteriaBlock$And' => '

An array of objects, one for each property- or tag-based condition that includes or excludes resources from the query results. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

', ], ], '__listOfSearchResourcesTagCriterionPair' => [ 'base' => NULL, 'refs' => [ 'SearchResourcesTagCriterion$TagValues' => '

The tag keys, tag values, or tag key and value pairs to use in the condition.

', ], ], '__listOfSensitivityInspectionTemplatesEntry' => [ 'base' => NULL, 'refs' => [ 'ListSensitivityInspectionTemplatesResponse$SensitivityInspectionTemplates' => '

An array that specifies the unique identifier and name of the sensitivity inspection template for the account.

', ], ], '__listOfSuppressDataIdentifier' => [ 'base' => NULL, 'refs' => [ 'UpdateResourceProfileDetectionsRequest$SuppressDataIdentifiers' => '

An array of objects, one for each custom data identifier or managed data identifier that detected the type of sensitive data to start excluding or including in the bucket\'s score. To start including all sensitive data types in the score, don\'t specify any values for this array.

', ], ], '__listOfTagCriterionPairForJob' => [ 'base' => NULL, 'refs' => [ 'TagCriterionForJob$TagValues' => '

The tag keys, tag values, or tag key and value pairs to use in the condition.

', ], ], '__listOfTagValuePair' => [ 'base' => NULL, 'refs' => [ 'TagScopeTerm$TagValues' => '

The tag keys or tag key and value pairs to use in the condition. To specify only tag keys in a condition, specify the keys in this array and set the value for each associated tag value to an empty string.

', ], ], '__listOfUnavailabilityReasonCode' => [ 'base' => NULL, 'refs' => [ 'GetSensitiveDataOccurrencesAvailabilityResponse$Reasons' => '

Specifies why occurrences of sensitive data can\'t be retrieved for the finding. Possible values are:

This value is null if sensitive data can be retrieved for the finding.

', ], ], '__listOfUnprocessedAccount' => [ 'base' => NULL, 'refs' => [ 'CreateInvitationsResponse$UnprocessedAccounts' => '

An array of objects, one for each account whose invitation hasn\'t been processed. Each object identifies the account and explains why the invitation hasn\'t been processed for the account.

', 'DeclineInvitationsResponse$UnprocessedAccounts' => '

An array of objects, one for each account whose invitation hasn\'t been declined. Each object identifies the account and explains why the request hasn\'t been processed for that account.

', 'DeleteInvitationsResponse$UnprocessedAccounts' => '

An array of objects, one for each account whose invitation hasn\'t been deleted. Each object identifies the account and explains why the request hasn\'t been processed for that account.

', ], ], '__listOfUsageByAccount' => [ 'base' => NULL, 'refs' => [ 'UsageRecord$Usage' => '

An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.

', ], ], '__listOfUsageRecord' => [ 'base' => NULL, 'refs' => [ 'GetUsageStatisticsResponse$Records' => '

An array of objects that contains the results of the query. Each object contains the data for an account that matches the filter criteria specified in the request.

', ], ], '__listOfUsageStatisticsFilter' => [ 'base' => NULL, 'refs' => [ 'GetUsageStatisticsRequest$FilterBy' => '

An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

', ], ], '__listOfUsageTotal' => [ 'base' => NULL, 'refs' => [ 'GetUsageTotalsResponse$UsageTotals' => '

An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.

', ], ], '__listOf__string' => [ 'base' => NULL, 'refs' => [ 'BatchGetCustomDataIdentifiersRequest$Ids' => '

An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.

', 'BatchGetCustomDataIdentifiersResponse$NotFoundIdentifierIds' => '

An array of custom data identifier IDs, one for each custom data identifier that was specified in the request but doesn\'t correlate to an existing custom data identifier.

', 'BucketCriteriaAdditionalProperties$Eq' => '

The value for the property matches (equals) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

', 'BucketCriteriaAdditionalProperties$Neq' => '

The value for the property doesn\'t match (doesn\'t equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

', 'CreateClassificationJobRequest$AllowListIds' => '

An array of unique identifiers, one for each allow list for the job to use when it analyzes data.

', 'CreateClassificationJobRequest$CustomDataIdentifierIds' => '

An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don\'t specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

', 'CreateClassificationJobRequest$ManagedDataIdentifierIds' => '

An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).

To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

', 'CreateCustomDataIdentifierRequest$IgnoreWords' => '

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

', 'CreateCustomDataIdentifierRequest$Keywords' => '

An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren\'t case sensitive.

', 'CreateInvitationsRequest$AccountIds' => '

An array that lists Amazon Web Services account IDs, one for each account to send the invitation to.

', 'CriterionAdditionalProperties$Eq' => '

The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

', 'CriterionAdditionalProperties$EqExactMatch' => '

The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.

', 'CriterionAdditionalProperties$Neq' => '

The value for the property doesn\'t match (doesn\'t equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

', 'DeclineInvitationsRequest$AccountIds' => '

An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to decline.

', 'DeleteInvitationsRequest$AccountIds' => '

An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to delete.

', 'DescribeClassificationJobResponse$AllowListIds' => '

An array of unique identifiers, one for each allow list that the job uses when it analyzes data.

', 'DescribeClassificationJobResponse$CustomDataIdentifierIds' => '

An array of unique identifiers, one for each custom data identifier that the job uses when it analyzes data. This value is null if the job uses only managed data identifiers to analyze data.

', 'DescribeClassificationJobResponse$ManagedDataIdentifierIds' => '

An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector).

This value is null if the job\'s managed data identifier selection type is ALL, NONE, or RECOMMENDED.

', 'GetCustomDataIdentifierResponse$IgnoreWords' => '

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.

', 'GetCustomDataIdentifierResponse$Keywords' => '

An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren\'t case sensitive.

', 'GetFindingsRequest$FindingIds' => '

An array of strings that lists the unique identifiers for the findings to retrieve. You can specify as many as 50 unique identifiers in this array.

', 'ListFindingsResponse$FindingIds' => '

An array of strings, where each string is the unique identifier for a finding that matches the filter criteria specified in the request.

', 'ListJobsFilterTerm$Values' => '

An array that lists one or more values to use to filter the results.

', 'ReplicationDetails$ReplicationAccounts' => '

An array of Amazon Web Services account IDs, one for each Amazon Web Services account that owns a bucket that the bucket is configured to replicate one or more objects to.

', 'S3BucketDefinitionForJob$Buckets' => '

An array that lists the names of the buckets.

', 'SearchResourcesSimpleCriterion$Values' => '

An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

Values are case sensitive. Also, Macie doesn\'t support use of partial values or wildcard characters in values.

', 'SensitivityInspectionTemplateExcludes$ManagedDataIdentifierIds' => '

An array of unique identifiers, one for each managed data identifier to exclude. To retrieve a list of valid values, use the ListManagedDataIdentifiers operation.

', 'SensitivityInspectionTemplateIncludes$AllowListIds' => '

An array of unique identifiers, one for each allow list to include.

', 'SensitivityInspectionTemplateIncludes$CustomDataIdentifierIds' => '

An array of unique identifiers, one for each custom data identifier to include.

', 'SensitivityInspectionTemplateIncludes$ManagedDataIdentifierIds' => '

An array of unique identifiers, one for each managed data identifier to include.

Amazon Macie uses these managed data identifiers in addition to managed data identifiers that are subsequently released and recommended for automated sensitive data discovery. To retrieve a list of valid values for the managed data identifiers that are currently available, use the ListManagedDataIdentifiers operation.

', 'SimpleCriterionForJob$Values' => '

An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

Values are case sensitive. Also, Macie doesn\'t support use of partial values or wildcard characters in these values.

', 'SimpleScopeTerm$Values' => '

An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

Valid values for each supported property (key) are:

Macie doesn\'t support use of wildcard characters in these values. Also, string values are case sensitive.

', 'TestCustomDataIdentifierRequest$IgnoreWords' => '

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

', 'TestCustomDataIdentifierRequest$Keywords' => '

An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren\'t case sensitive.

', 'UsageStatisticsFilter$Values' => '

An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.

Valid values for each supported field are:

', ], ], '__long' => [ 'base' => NULL, 'refs' => [ 'BucketCountByEffectivePermission$PubliclyAccessible' => '

The total number of buckets that allow the general public to have read or write access to the bucket.

', 'BucketCountByEffectivePermission$PubliclyReadable' => '

The total number of buckets that allow the general public to have read access to the bucket.

', 'BucketCountByEffectivePermission$PubliclyWritable' => '

The total number of buckets that allow the general public to have write access to the bucket.

', 'BucketCountByEffectivePermission$Unknown' => '

The total number of buckets that Amazon Macie wasn\'t able to evaluate permissions settings for. Macie can\'t determine whether these buckets are publicly accessible.

', 'BucketCountByEncryptionType$KmsManaged' => '

The total number of buckets whose default encryption settings are configured to encrypt new objects with an Amazon Web Services managed KMS key or a customer managed KMS key. By default, these buckets encrypt new objects automatically using SSE-KMS encryption.

', 'BucketCountByEncryptionType$S3Managed' => '

The total number of buckets whose default encryption settings are configured to encrypt new objects with an Amazon S3 managed key. By default, these buckets encrypt new objects automatically using SSE-S3 encryption.

', 'BucketCountByEncryptionType$Unencrypted' => '

The total number of buckets that don\'t specify default server-side encryption behavior for new objects. Default encryption settings aren\'t configured for these buckets.

', 'BucketCountByEncryptionType$Unknown' => '

The total number of buckets that Amazon Macie doesn\'t have current encryption metadata for. Macie can\'t provide current data about the default encryption settings for these buckets.

', 'BucketCountBySharedAccessType$External' => '

The total number of buckets that are shared with one or more of the following or any combination of the following: an Amazon CloudFront OAI, a CloudFront OAC, or an Amazon Web Services account that isn\'t in the same Amazon Macie organization.

', 'BucketCountBySharedAccessType$Internal' => '

The total number of buckets that are shared with one or more Amazon Web Services accounts in the same Amazon Macie organization. These buckets aren\'t shared with Amazon CloudFront OAIs or OACs.

', 'BucketCountBySharedAccessType$NotShared' => '

The total number of buckets that aren\'t shared with other Amazon Web Services accounts, Amazon CloudFront OAIs, or CloudFront OACs.

', 'BucketCountBySharedAccessType$Unknown' => '

The total number of buckets that Amazon Macie wasn\'t able to evaluate shared access settings for. Macie can\'t determine whether these buckets are shared with other Amazon Web Services accounts, Amazon CloudFront OAIs, or CloudFront OACs.

', 'BucketCountPolicyAllowsUnencryptedObjectUploads$AllowsUnencryptedObjectUploads' => '

The total number of buckets that don\'t have a bucket policy or have a bucket policy that doesn\'t require server-side encryption of new objects. If a bucket policy exists, the policy doesn\'t require PutObject requests to include a valid server-side encryption header: the x-amz-server-side-encryption header with a value of AES256 or aws:kms, or the x-amz-server-side-encryption-customer-algorithm header with a value of AES256.

', 'BucketCountPolicyAllowsUnencryptedObjectUploads$DeniesUnencryptedObjectUploads' => '

The total number of buckets whose bucket policies require server-side encryption of new objects. PutObject requests for these buckets must include a valid server-side encryption header: the x-amz-server-side-encryption header with a value of AES256 or aws:kms, or the x-amz-server-side-encryption-customer-algorithm header with a value of AES256.

', 'BucketCountPolicyAllowsUnencryptedObjectUploads$Unknown' => '

The total number of buckets that Amazon Macie wasn\'t able to evaluate server-side encryption requirements for. Macie can\'t determine whether the bucket policies for these buckets require server-side encryption of new objects.

', 'BucketCriteriaAdditionalProperties$Gt' => '

The value for the property is greater than the specified value.

', 'BucketCriteriaAdditionalProperties$Gte' => '

The value for the property is greater than or equal to the specified value.

', 'BucketCriteriaAdditionalProperties$Lt' => '

The value for the property is less than the specified value.

', 'BucketCriteriaAdditionalProperties$Lte' => '

The value for the property is less than or equal to the specified value.

', 'BucketMetadata$ClassifiableObjectCount' => '

The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

', 'BucketMetadata$ClassifiableSizeInBytes' => '

The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn\'t reflect the storage size of all versions of each applicable object in the bucket.

', 'BucketMetadata$ObjectCount' => '

The total number of objects in the bucket.

', 'BucketMetadata$SizeInBytes' => '

The total storage size, in bytes, of the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn\'t reflect the storage size of all versions of each object in the bucket.

', 'BucketMetadata$SizeInBytesCompressed' => '

The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn\'t reflect the storage size of all versions of each applicable object in the bucket.

', 'Cell$Column' => '

The column number of the column that contains the sensitive data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier, for example: 1 for column A, 2 for column B, and so on.

', 'Cell$Row' => '

The row number of the row that contains the sensitive data.

', 'ClassificationResult$SizeClassified' => '

The total size, in bytes, of the data that the finding applies to.

', 'CriterionAdditionalProperties$Gt' => '

The value for the property is greater than the specified value.

', 'CriterionAdditionalProperties$Gte' => '

The value for the property is greater than or equal to the specified value.

', 'CriterionAdditionalProperties$Lt' => '

The value for the property is less than the specified value.

', 'CriterionAdditionalProperties$Lte' => '

The value for the property is less than or equal to the specified value.

', 'CustomDataIdentifiers$TotalCount' => '

The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.

', 'CustomDetection$Count' => '

The total number of occurrences of the sensitive data that the custom data identifier detected.

', 'DefaultDetection$Count' => '

The total number of occurrences of the type of sensitive data that was detected.

', 'Detection$Count' => '

The total number of occurrences of the sensitive data.

', 'Finding$Count' => '

The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered unique.

', 'GetBucketStatisticsResponse$BucketCount' => '

The total number of buckets.

', 'GetBucketStatisticsResponse$ClassifiableObjectCount' => '

The total number of objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

', 'GetBucketStatisticsResponse$ClassifiableSizeInBytes' => '

The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn\'t reflect the storage size of all versions of all applicable objects in the buckets.

', 'GetBucketStatisticsResponse$ObjectCount' => '

The total number of objects in the buckets.

', 'GetBucketStatisticsResponse$SizeInBytes' => '

The total storage size, in bytes, of the buckets.

If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each object in the buckets. This value doesn\'t reflect the storage size of all versions of the objects in the buckets.

', 'GetBucketStatisticsResponse$SizeInBytesCompressed' => '

The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the buckets.

If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn\'t reflect the storage size of all versions of the applicable objects in the buckets.

', 'GetInvitationsCountResponse$InvitationsCount' => '

The total number of invitations that were received by the account, not including the currently accepted invitation.

', 'GroupCount$Count' => '

The total number of findings in the group of query results.

', 'MatchingBucket$ClassifiableObjectCount' => '

The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

', 'MatchingBucket$ClassifiableSizeInBytes' => '

The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn\'t reflect the storage size of all versions of each applicable object in the bucket.

', 'MatchingBucket$ObjectCount' => '

The total number of objects in the bucket.

', 'MatchingBucket$SizeInBytes' => '

The total storage size, in bytes, of the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn\'t reflect the storage size of all versions of each object in the bucket.

', 'MatchingBucket$SizeInBytesCompressed' => '

The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn\'t reflect the storage size of all versions of each applicable object in the bucket.

', 'ObjectCountByEncryptionType$CustomerManaged' => '

The total number of objects that are encrypted with a customer-provided key. The objects use customer-provided server-side encryption (SSE-C).

', 'ObjectCountByEncryptionType$KmsManaged' => '

The total number of objects that are encrypted with an KMS key, either an Amazon Web Services managed key or a customer managed key. The objects use KMS encryption (SSE-KMS).

', 'ObjectCountByEncryptionType$S3Managed' => '

The total number of objects that are encrypted with an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).

', 'ObjectCountByEncryptionType$Unencrypted' => '

The total number of objects that use client-side encryption or aren\'t encrypted.

', 'ObjectCountByEncryptionType$Unknown' => '

The total number of objects that Amazon Macie doesn\'t have current encryption metadata for. Macie can\'t provide current data about the encryption settings for these objects.

', 'ObjectLevelStatistics$FileType' => '

The total storage size (in bytes) or number of objects that Amazon Macie can\'t analyze because the objects don\'t have a file name extension for a supported file or storage format.

', 'ObjectLevelStatistics$StorageClass' => '

The total storage size (in bytes) or number of objects that Amazon Macie can\'t analyze because the objects use an unsupported storage class.

', 'ObjectLevelStatistics$Total' => '

The total storage size (in bytes) or number of objects that Amazon Macie can\'t analyze because the objects use an unsupported storage class or don\'t have a file name extension for a supported file or storage format.

', 'Page$PageNumber' => '

The page number of the page that contains the sensitive data.

', 'Range$End' => '

The number of lines from the beginning of the file to the end of the sensitive data.

', 'Range$Start' => '

The number of lines from the beginning of the file to the beginning of the sensitive data.

', 'Range$StartColumn' => '

The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.

', 'Record$RecordIndex' => '

For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.

', 'ResourceStatistics$TotalBytesClassified' => '

The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.

', 'ResourceStatistics$TotalDetections' => '

The total number of occurrences of sensitive data that Amazon Macie has found in the bucket\'s objects. This includes occurrences that are currently suppressed by the sensitivity scoring settings for the bucket (totalDetectionsSuppressed).

', 'ResourceStatistics$TotalDetectionsSuppressed' => '

The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in the bucket\'s objects, but the occurrences were manually suppressed. By default, suppressed occurrences are excluded from the bucket\'s sensitivity score.

', 'ResourceStatistics$TotalItemsClassified' => '

The total number of objects that Amazon Macie has analyzed in the bucket.

', 'ResourceStatistics$TotalItemsSensitive' => '

The total number of the bucket\'s objects that Amazon Macie has found sensitive data in.

', 'ResourceStatistics$TotalItemsSkipped' => '

The total number of objects that Amazon Macie wasn\'t able to analyze in the bucket due to an object-level issue or error. For example, the object is a malformed file. This value includes objects that Macie wasn\'t able to analyze for reasons reported by other statistics in the ResourceStatistics object.

', 'ResourceStatistics$TotalItemsSkippedInvalidEncryption' => '

The total number of objects that Amazon Macie wasn\'t able to analyze in the bucket because the objects are encrypted with a key that Macie can\'t access. The objects use server-side encryption with customer-provided keys (SSE-C).

', 'ResourceStatistics$TotalItemsSkippedInvalidKms' => '

The total number of objects that Amazon Macie wasn\'t able to analyze in the bucket because the objects are encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.

', 'ResourceStatistics$TotalItemsSkippedPermissionDenied' => '

The total number of objects that Amazon Macie wasn\'t able to analyze in the bucket due to the permissions settings for the objects or the permissions settings for the keys that were used to encrypt the objects.

', 'S3Object$Size' => '

The total storage size, in bytes, of the object.

', 'SensitiveDataItem$TotalCount' => '

The total number of occurrences of the sensitive data that was detected.

', 'SensitivityAggregations$ClassifiableSizeInBytes' => '

The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn\'t reflect the storage size of all versions of all applicable objects in the buckets.

', 'SensitivityAggregations$PubliclyAccessibleCount' => '

The total number of buckets that are publicly accessible due to a combination of permissions settings for each bucket.

', 'SensitivityAggregations$TotalCount' => '

The total number of buckets.

', 'SensitivityAggregations$TotalSizeInBytes' => '

The total storage size, in bytes, of the buckets.

If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each object in the buckets. This value doesn\'t reflect the storage size of all versions of the objects in the buckets.

', 'ServiceLimit$Value' => '

The value for the metric specified by the UsageByAccount.type field in the response.

', 'Severity$Score' => '

The numerical representation of the finding\'s severity, ranging from 1 (least severe) to 3 (most severe).

', 'SeverityLevel$OccurrencesThreshold' => '

The minimum number of occurrences of text that must match the custom data identifier\'s detection criteria in order to produce a finding with the specified severity (severity).

', ], ], '__string' => [ 'base' => NULL, 'refs' => [ 'AcceptInvitationRequest$AdministratorAccountId' => '

The Amazon Web Services account ID for the account that sent the invitation.

', 'AcceptInvitationRequest$InvitationId' => '

The unique identifier for the invitation to accept.

', 'AcceptInvitationRequest$MasterAccount' => '

(Deprecated) The Amazon Web Services account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

', 'AccessDeniedException$Message' => '

The explanation of the error that occurred.

', 'AccountDetail$AccountId' => '

The Amazon Web Services account ID for the account.

', 'AccountDetail$Email' => '

The email address for the account.

', 'AdminAccount$AccountId' => '

The Amazon Web Services account ID for the account.

', 'ApiCallDetails$Api' => '

The name of the operation that was invoked most recently and produced the finding.

', 'ApiCallDetails$ApiServiceName' => '

The URL of the Amazon Web Service that provides the operation, for example: s3.amazonaws.com.

', 'AssumedRole$AccessKeyId' => '

The Amazon Web Services access key ID that identifies the credentials.

', 'AssumedRole$AccountId' => '

The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

', 'AssumedRole$Arn' => '

The Amazon Resource Name (ARN) of the entity that was used to get the credentials.

', 'AssumedRole$PrincipalId' => '

The unique identifier for the entity that was used to get the credentials.

', 'AwsAccount$AccountId' => '

The unique identifier for the Amazon Web Services account.

', 'AwsAccount$PrincipalId' => '

The unique identifier for the entity that performed the action.

', 'AwsService$InvokedBy' => '

The name of the Amazon Web Service that performed the action.

', 'BatchGetCustomDataIdentifierSummary$Arn' => '

The Amazon Resource Name (ARN) of the custom data identifier.

', 'BatchGetCustomDataIdentifierSummary$Description' => '

The custom description of the custom data identifier.

', 'BatchGetCustomDataIdentifierSummary$Id' => '

The unique identifier for the custom data identifier.

', 'BatchGetCustomDataIdentifierSummary$Name' => '

The custom name of the custom data identifier.

', 'BucketCriteriaAdditionalProperties$Prefix' => '

The name of the bucket begins with the specified value.

', 'BucketMetadata$AccountId' => '

The unique identifier for the Amazon Web Services account that owns the bucket.

', 'BucketMetadata$BucketArn' => '

The Amazon Resource Name (ARN) of the bucket.

', 'BucketMetadata$BucketName' => '

The name of the bucket.

', 'BucketMetadata$ErrorMessage' => '

A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket\'s objects. This value is null if Macie was able to retrieve and process the information.

', 'BucketMetadata$Region' => '

The Amazon Web Services Region that hosts the bucket.

', 'BucketServerSideEncryption$KmsMasterKeyId' => '

The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key that\'s used by default to encrypt objects that are added to the bucket. This value is null if the bucket is configured to use an Amazon S3 managed key to encrypt new objects.

', 'BucketSortCriteria$AttributeName' => '

The name of the bucket property to sort the results by. This value can be one of the following properties that Amazon Macie defines as bucket metadata: accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, objectCount, sensitivityScore, or sizeInBytes.

', 'Cell$CellReference' => '

The location of the cell, as an absolute cell reference, that contains the sensitive data, for example Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.

', 'Cell$ColumnName' => '

The name of the column that contains the sensitive data, if available.

', 'ClassificationDetails$DetailedResultsLocation' => '

The path to the folder or file in Amazon S3 that contains the corresponding sensitive data discovery result for the finding. If a finding applies to a large archive or compressed file, this value is the path to a folder. Otherwise, this value is the path to a file.

', 'ClassificationDetails$JobArn' => '

The Amazon Resource Name (ARN) of the classification job that produced the finding. This value is null if the origin of the finding (originType) is AUTOMATED_SENSITIVE_DATA_DISCOVERY.

', 'ClassificationDetails$JobId' => '

The unique identifier for the classification job that produced the finding. This value is null if the origin of the finding (originType) is AUTOMATED_SENSITIVE_DATA_DISCOVERY.

', 'ClassificationResult$MimeType' => '

The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.

', 'ClassificationResultStatus$Code' => '

The status of the finding. Possible values are:

', 'ClassificationResultStatus$Reason' => '

A brief description of the status of the finding. This value is null if the status (code) of the finding is COMPLETE.

Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding and the affected S3 object. Possible values are:

For information about quotas, supported storage classes, and supported file and storage formats, see Quotas and Supported storage classes and formats in the Amazon Macie User Guide.

', 'ConflictException$Message' => '

The explanation of the error that occurred.

', 'CreateAllowListRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'CreateClassificationJobRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'CreateClassificationJobRequest$Description' => '

A custom description of the job. The description can contain as many as 200 characters.

', 'CreateClassificationJobRequest$Name' => '

A custom name for the job. The name can contain as many as 500 characters.

', 'CreateClassificationJobResponse$JobArn' => '

The Amazon Resource Name (ARN) of the job.

', 'CreateClassificationJobResponse$JobId' => '

The unique identifier for the job.

', 'CreateCustomDataIdentifierRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'CreateCustomDataIdentifierRequest$Description' => '

A custom description of the custom data identifier. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they\'re allowed to perform in Amazon Macie.

', 'CreateCustomDataIdentifierRequest$Name' => '

A custom name for the custom data identifier. The name can contain as many as 128 characters.

We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they\'re allowed to perform in Amazon Macie.

', 'CreateCustomDataIdentifierRequest$Regex' => '

The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

', 'CreateCustomDataIdentifierResponse$CustomDataIdentifierId' => '

The unique identifier for the custom data identifier that was created.

', 'CreateFindingsFilterRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'CreateFindingsFilterRequest$Description' => '

A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see this description, depending on the actions that they\'re allowed to perform in Amazon Macie.

', 'CreateFindingsFilterRequest$Name' => '

A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see this name, depending on the actions that they\'re allowed to perform in Amazon Macie.

', 'CreateFindingsFilterResponse$Arn' => '

The Amazon Resource Name (ARN) of the filter that was created.

', 'CreateFindingsFilterResponse$Id' => '

The unique identifier for the filter that was created.

', 'CreateInvitationsRequest$Message' => '

Custom text to include in the email message that contains the invitation. The text can contain as many as 80 alphanumeric characters.

', 'CreateMemberResponse$Arn' => '

The Amazon Resource Name (ARN) of the account that was associated with the administrator account.

', 'CustomDataIdentifierSummary$Arn' => '

The Amazon Resource Name (ARN) of the custom data identifier.

', 'CustomDataIdentifierSummary$Description' => '

The custom description of the custom data identifier.

', 'CustomDataIdentifierSummary$Id' => '

The unique identifier for the custom data identifier.

', 'CustomDataIdentifierSummary$Name' => '

The custom name of the custom data identifier.

', 'CustomDetection$Arn' => '

The unique identifier for the custom data identifier.

', 'CustomDetection$Name' => '

The name of the custom data identifier.

', 'DefaultDetection$Type' => '

The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.

', 'DescribeBucketsRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'DescribeBucketsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'DescribeClassificationJobResponse$ClientToken' => '

The token that was provided to ensure the idempotency of the request to create the job.

', 'DescribeClassificationJobResponse$Description' => '

The custom description of the job.

', 'DescribeClassificationJobResponse$JobArn' => '

The Amazon Resource Name (ARN) of the job.

', 'DescribeClassificationJobResponse$JobId' => '

The unique identifier for the job.

', 'DescribeClassificationJobResponse$Name' => '

The custom name of the job.

', 'Detection$Arn' => '

If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data. Otherwise, this value is null.

', 'Detection$Id' => '

The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data. For additional details about a specified managed data identifier, see Using managed data identifiers in the Amazon Macie User Guide.

', 'Detection$Name' => '

The name of the custom data identifier or managed data identifier that detected the sensitive data. For a managed data identifier, this value is the same as the unique identifier (id).

', 'DomainDetails$DomainName' => '

The name of the domain.

', 'EnableMacieRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'EnableOrganizationAdminAccountRequest$AdminAccountId' => '

The Amazon Web Services account ID for the account to designate as the delegated Amazon Macie administrator account for the organization.

', 'EnableOrganizationAdminAccountRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'FederatedUser$AccessKeyId' => '

The Amazon Web Services access key ID that identifies the credentials.

', 'FederatedUser$AccountId' => '

The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

', 'FederatedUser$Arn' => '

The Amazon Resource Name (ARN) of the entity that was used to get the credentials.

', 'FederatedUser$PrincipalId' => '

The unique identifier for the entity that was used to get the credentials.

', 'Finding$AccountId' => '

The unique identifier for the Amazon Web Services account that the finding applies to. This is typically the account that owns the affected resource.

', 'Finding$Description' => '

The description of the finding.

', 'Finding$Id' => '

The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

', 'Finding$Partition' => '

The Amazon Web Services partition that Amazon Macie created the finding in.

', 'Finding$Region' => '

The Amazon Web Services Region that Amazon Macie created the finding in.

', 'Finding$SchemaVersion' => '

The version of the schema that was used to define the data structures in the finding.

', 'Finding$Title' => '

The brief description of the finding.

', 'FindingsFilterListItem$Arn' => '

The Amazon Resource Name (ARN) of the filter.

', 'FindingsFilterListItem$Id' => '

The unique identifier for the filter.

', 'FindingsFilterListItem$Name' => '

The custom name of the filter.

', 'GetBucketStatisticsRequest$AccountId' => '

The unique identifier for the Amazon Web Services account.

', 'GetCustomDataIdentifierResponse$Arn' => '

The Amazon Resource Name (ARN) of the custom data identifier.

', 'GetCustomDataIdentifierResponse$Description' => '

The custom description of the custom data identifier.

', 'GetCustomDataIdentifierResponse$Id' => '

The unique identifier for the custom data identifier.

', 'GetCustomDataIdentifierResponse$Name' => '

The custom name of the custom data identifier.

', 'GetCustomDataIdentifierResponse$Regex' => '

The regular expression (regex) that defines the pattern to match.

', 'GetFindingsFilterResponse$Arn' => '

The Amazon Resource Name (ARN) of the filter.

', 'GetFindingsFilterResponse$Description' => '

The custom description of the filter.

', 'GetFindingsFilterResponse$Id' => '

The unique identifier for the filter.

', 'GetFindingsFilterResponse$Name' => '

The custom name of the filter.

', 'GetMacieSessionResponse$ServiceRole' => '

The Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze data in Amazon Web Services resources for the account.

', 'GetMemberResponse$AccountId' => '

The Amazon Web Services account ID for the account.

', 'GetMemberResponse$AdministratorAccountId' => '

The Amazon Web Services account ID for the administrator account.

', 'GetMemberResponse$Arn' => '

The Amazon Resource Name (ARN) of the account.

', 'GetMemberResponse$Email' => '

The email address for the account. This value is null if the account is associated with the administrator account through Organizations.

', 'GetMemberResponse$MasterAccountId' => '

(Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

', 'GetSensitiveDataOccurrencesResponse$Error' => '

If an error occurred when Amazon Macie attempted to retrieve occurrences of sensitive data reported by the finding, a description of the error that occurred. This value is null if the status (status) of the request is PROCESSING or SUCCESS.

', 'GetSensitivityInspectionTemplateResponse$Description' => '

The custom description of the template.

', 'GetSensitivityInspectionTemplateResponse$Name' => '

The name of the template: automated-sensitive-data-discovery.

', 'GetUsageStatisticsRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'GetUsageStatisticsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'GroupCount$GroupKey' => '

The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.

', 'IamUser$AccountId' => '

The unique identifier for the Amazon Web Services account that\'s associated with the IAM user who performed the action.

', 'IamUser$Arn' => '

The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user who performed the action.

', 'IamUser$PrincipalId' => '

The unique identifier for the IAM user who performed the action.

', 'IamUser$UserName' => '

The username of the IAM user who performed the action.

', 'InternalServerException$Message' => '

The explanation of the error that occurred.

', 'Invitation$AccountId' => '

The Amazon Web Services account ID for the account that sent the invitation.

', 'Invitation$InvitationId' => '

The unique identifier for the invitation.

', 'IpAddressDetails$IpAddressV4' => '

The Internet Protocol version 4 (IPv4) address of the device.

', 'IpCity$Name' => '

The name of the city.

', 'IpCountry$Code' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country that the IP address originated from. For example, US for the United States.

', 'IpCountry$Name' => '

The name of the country that the IP address originated from.

', 'IpOwner$Asn' => '

The autonomous system number (ASN) for the autonomous system that included the IP address.

', 'IpOwner$AsnOrg' => '

The organization identifier that\'s associated with the autonomous system number (ASN) for the autonomous system that included the IP address.

', 'IpOwner$Isp' => '

The name of the internet service provider (ISP) that owned the IP address.

', 'IpOwner$Org' => '

The name of the organization that owned the IP address.

', 'JobDetails$LastJobId' => '

The unique identifier for the job that ran most recently and is configured to analyze data in the bucket, either the latest run of a recurring job or the only run of a one-time job.

This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

', 'JobSummary$JobId' => '

The unique identifier for the job.

', 'JobSummary$Name' => '

The custom name of the job.

', 'KeyValuePair$Key' => '

One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.

', 'KeyValuePair$Value' => '

One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.

', 'ListAllowListsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListClassificationJobsRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'ListClassificationJobsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListCustomDataIdentifiersRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'ListCustomDataIdentifiersResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListFindingsFiltersResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListFindingsRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'ListFindingsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListInvitationsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListManagedDataIdentifiersRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'ListManagedDataIdentifiersResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListMembersResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListOrganizationAdminAccountsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListResourceProfileArtifactsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListResourceProfileDetectionsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListSensitivityInspectionTemplatesResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ManagedDataIdentifierSummary$Id' => '

The unique identifier for the managed data identifier. This is a string that describes the type of sensitive data that the managed data identifier detects. For example: OPENSSH_PRIVATE_KEY for OpenSSH private keys, CREDIT_CARD_NUMBER for credit card numbers, or USA_PASSPORT_NUMBER for US passport numbers.

', 'MatchingBucket$AccountId' => '

The unique identifier for the Amazon Web Services account that owns the bucket.

', 'MatchingBucket$BucketName' => '

The name of the bucket.

', 'MatchingBucket$ErrorMessage' => '

A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket\'s objects. This value is null if Macie was able to retrieve and process the information.

', 'Member$AccountId' => '

The Amazon Web Services account ID for the account.

', 'Member$AdministratorAccountId' => '

The Amazon Web Services account ID for the administrator account.

', 'Member$Arn' => '

The Amazon Resource Name (ARN) of the account.

', 'Member$Email' => '

The email address for the account. This value is null if the account is associated with the administrator account through Organizations.

', 'Member$MasterAccountId' => '

(Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

', 'PutFindingsPublicationConfigurationRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'Record$JsonPath' => '

The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.

If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.

', 'ResourceNotFoundException$Message' => '

The explanation of the error that occurred.

', 'ResourceProfileArtifact$Arn' => '

The Amazon Resource Name (ARN) of the object.

', 'ResourceProfileArtifact$ClassificationResultStatus' => '

The status of the analysis. Possible values are:

', 'S3Bucket$Arn' => '

The Amazon Resource Name (ARN) of the bucket.

', 'S3Bucket$Name' => '

The name of the bucket.

', 'S3BucketDefinitionForJob$AccountId' => '

The unique identifier for the Amazon Web Services account that owns the buckets.

', 'S3BucketOwner$DisplayName' => '

The display name of the account that owns the bucket.

', 'S3BucketOwner$Id' => '

The canonical user ID for the account that owns the bucket.

', 'S3Destination$BucketName' => '

The name of the bucket.

', 'S3Destination$KeyPrefix' => '

The path prefix to use in the path to the location in the bucket. This prefix specifies where to store classification results in the bucket.

', 'S3Destination$KmsKeyArn' => '

The Amazon Resource Name (ARN) of the customer managed KMS key to use for encryption of the results. This must be the ARN of an existing, symmetric encryption KMS key that\'s in the same Amazon Web Services Region as the bucket.

', 'S3Object$BucketArn' => '

The Amazon Resource Name (ARN) of the bucket that contains the object.

', 'S3Object$ETag' => '

The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.

', 'S3Object$Extension' => '

The file name extension of the object. If the object doesn\'t have a file name extension, this value is "".

', 'S3Object$Key' => '

The full name (key) of the object, including the object\'s prefix if applicable.

', 'S3Object$Path' => '

The full path to the affected object, including the name of the affected bucket and the object\'s name (key).

', 'S3Object$VersionId' => '

The identifier for the affected version of the object.

', 'SearchResourcesRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'SearchResourcesResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'SearchResourcesTagCriterionPair$Key' => '

The value for the tag key to use in the condition.

', 'SearchResourcesTagCriterionPair$Value' => '

The tag value to use in the condition.

', 'SensitivityInspectionTemplatesEntry$Id' => '

The unique identifier for the sensitivity inspection template.

', 'SensitivityInspectionTemplatesEntry$Name' => '

The name of the sensitivity inspection template: automated-sensitive-data-discovery.

', 'ServerSideEncryption$KmsMasterKeyId' => '

The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key that\'s used to encrypt data in the bucket or the object. This value is null if an KMS key isn\'t used to encrypt the data.

', 'ServiceQuotaExceededException$Message' => '

The explanation of the error that occurred.

', 'SessionIssuer$AccountId' => '

The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

', 'SessionIssuer$Arn' => '

The Amazon Resource Name (ARN) of the source account, Identity and Access Management (IAM) user, or role that was used to get the credentials.

', 'SessionIssuer$PrincipalId' => '

The unique identifier for the entity that was used to get the credentials.

', 'SessionIssuer$Type' => '

The source of the temporary security credentials, such as Root, IAMUser, or Role.

', 'SessionIssuer$UserName' => '

The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn\'t have an alias.

', 'SortCriteria$AttributeName' => '

The name of the property to sort the results by. Valid values are: count, createdAt, policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen, resourcesAffected, severity.score, type, and updatedAt.

', 'SuppressDataIdentifier$Id' => '

The unique identifier for the custom data identifier or managed data identifier that detected the type of sensitive data to exclude or include in the score.

', 'TagCriterionPairForJob$Key' => '

The value for the tag key to use in the condition.

', 'TagCriterionPairForJob$Value' => '

The tag value to use in the condition.

', 'TagMap$member' => NULL, 'TagScopeTerm$Key' => '

The object property to use in the condition. The only valid value is TAG.

', 'TagValuePair$Key' => '

The value for the tag key to use in the condition.

', 'TagValuePair$Value' => '

The tag value, associated with the specified tag key (key), to use in the condition. To specify only a tag key for a condition, specify the tag key for the key property and set this value to an empty string.

', 'TestCustomDataIdentifierRequest$Regex' => '

The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

', 'TestCustomDataIdentifierRequest$SampleText' => '

The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

', 'ThrottlingException$Message' => '

The explanation of the error that occurred.

', 'UnprocessableEntityException$Message' => '

The type of error that occurred and prevented Amazon Macie from retrieving occurrences of sensitive data reported by the finding. Possible values are:

', 'UnprocessedAccount$AccountId' => '

The Amazon Web Services account ID for the account that the request applies to.

', 'UnprocessedAccount$ErrorMessage' => '

The reason why the request hasn\'t been processed.

', 'UpdateFindingsFilterRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'UpdateFindingsFilterRequest$Description' => '

A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see this description, depending on the actions that they\'re allowed to perform in Amazon Macie.

', 'UpdateFindingsFilterRequest$Name' => '

A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see this name, depending on the actions that they\'re allowed to perform in Amazon Macie.

', 'UpdateFindingsFilterResponse$Arn' => '

The Amazon Resource Name (ARN) of the filter that was updated.

', 'UpdateFindingsFilterResponse$Id' => '

The unique identifier for the filter that was updated.

', 'UpdateSensitivityInspectionTemplateRequest$Description' => '

A custom description of the template. The description can contain as many as 200 characters.

', 'UsageByAccount$EstimatedCost' => '

The estimated value for the metric.

', 'UsageRecord$AccountId' => '

The unique identifier for the Amazon Web Services account that the data applies to.

', 'UsageTotal$EstimatedCost' => '

The estimated value for the metric.

', 'UserIdentityRoot$AccountId' => '

The unique identifier for the Amazon Web Services account.

', 'UserIdentityRoot$Arn' => '

The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user or role that performed the action.

', 'UserIdentityRoot$PrincipalId' => '

The unique identifier for the entity that performed the action.

', 'UserPausedDetails$JobImminentExpirationHealthEventArn' => '

The Amazon Resource Name (ARN) of the Health event that Amazon Macie sent to notify you of the job or job run\'s pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.

', 'ValidationException$Message' => '

The explanation of the error that occurred.

', '__listOf__string$member' => NULL, ], ], '__stringMin1Max1024PatternSS' => [ 'base' => NULL, 'refs' => [ 'AllowListStatus$Description' => '

A brief description of the status of the allow list. Amazon Macie uses this value to provide additional information about an error that occurred when Macie tried to access and use the list\'s criteria.

', 'S3WordsList$ObjectKey' => '

The full name (key) of the object.

', ], ], '__stringMin1Max128' => [ 'base' => NULL, 'refs' => [ 'DetectedDataDetails$Value' => '

An occurrence of the specified type of sensitive data. Each occurrence can contain 1-128 characters.

', ], ], '__stringMin1Max128Pattern' => [ 'base' => NULL, 'refs' => [ 'AllowListSummary$Name' => '

The custom name of the allow list.

', 'CreateAllowListRequest$Name' => '

A custom name for the allow list. The name can contain as many as 128 characters.

', 'GetAllowListResponse$Name' => '

The custom name of the allow list.

', 'UpdateAllowListRequest$Name' => '

A custom name for the allow list. The name can contain as many as 128 characters.

', ], ], '__stringMin1Max2048' => [ 'base' => NULL, 'refs' => [ 'RevealConfiguration$KmsKeyId' => '

The Amazon Resource Name (ARN), ID, or alias of the KMS key to use to encrypt sensitive data that\'s retrieved. The key must be an existing, customer managed, symmetric encryption key that\'s in the same Amazon Web Services Region as the Amazon Macie account.

If this value specifies an alias, it must include the following prefix: alias/. If this value specifies a key that\'s owned by another Amazon Web Services account, it must specify the ARN of the key or the ARN of the key\'s alias.

', ], ], '__stringMin1Max512PatternSS' => [ 'base' => NULL, 'refs' => [ 'AllowListCriteria$Regex' => '

The regular expression (regex) that defines the text pattern to ignore. The expression can contain as many as 512 characters.

', 'AllowListSummary$Description' => '

The custom description of the allow list.

', 'CreateAllowListRequest$Description' => '

A custom description of the allow list. The description can contain as many as 512 characters.

', 'GetAllowListResponse$Description' => '

The custom description of the allow list.

', 'UpdateAllowListRequest$Description' => '

A custom description of the allow list. The description can contain as many as 512 characters.

', ], ], '__stringMin22Max22PatternAZ0922' => [ 'base' => NULL, 'refs' => [ 'AllowListSummary$Id' => '

The unique identifier for the allow list.

', 'CreateAllowListResponse$Id' => '

The unique identifier for the allow list.

', 'GetAllowListResponse$Id' => '

The unique identifier for the allow list.

', 'UpdateAllowListResponse$Id' => '

The unique identifier for the allow list.

', ], ], '__stringMin3Max255PatternAZaZ093255' => [ 'base' => NULL, 'refs' => [ 'S3WordsList$BucketName' => '

The full name of the S3 bucket that contains the object.

', ], ], '__stringMin71Max89PatternArnAwsAwsCnAwsUsGovMacie2AZ19920D12AllowListAZ0922' => [ 'base' => NULL, 'refs' => [ 'AllowListSummary$Arn' => '

The Amazon Resource Name (ARN) of the allow list.

', 'CreateAllowListResponse$Arn' => '

The Amazon Resource Name (ARN) of the allow list.

', 'GetAllowListResponse$Arn' => '

The Amazon Resource Name (ARN) of the allow list.

', 'UpdateAllowListResponse$Arn' => '

The Amazon Resource Name (ARN) of the allow list.

', ], ], '__timestampIso8601' => [ 'base' => NULL, 'refs' => [ 'AllowListSummary$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.

', 'AllowListSummary$UpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the allow list\'s settings were most recently changed in Amazon Macie.

', 'ApiCallDetails$FirstSeen' => '

The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.

', 'ApiCallDetails$LastSeen' => '

The most recent date and time, in UTC and extended ISO 8601 format, when the specified operation (api) was invoked and produced the finding.

', 'BatchGetCustomDataIdentifierSummary$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

', 'BucketMetadata$BucketCreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket\'s policy were most recently made to the bucket.

', 'BucketMetadata$LastAutomatedDiscoveryTime' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed data in the bucket while performing automated sensitive data discovery for your account. This value is null if automated sensitive data discovery is currently disabled for your account.

', 'BucketMetadata$LastUpdated' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved bucket or object metadata from Amazon S3 for the bucket.

', 'CustomDataIdentifierSummary$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

', 'DescribeClassificationJobResponse$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the job was created.

', 'DescribeClassificationJobResponse$LastRunTime' => '

The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started or, if the job hasn\'t run yet, when the job was created.

', 'Finding$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.

', 'Finding$UpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last updated the finding. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new.

', 'GetAllowListResponse$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.

', 'GetAllowListResponse$UpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the allow list\'s settings were most recently changed in Amazon Macie.

', 'GetBucketStatisticsResponse$LastUpdated' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved bucket or object metadata from Amazon S3 for the buckets.

', 'GetCustomDataIdentifierResponse$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

', 'GetMacieSessionResponse$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.

', 'GetMacieSessionResponse$UpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Amazon Macie account.

', 'GetMemberResponse$InvitedAt' => '

The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie membership invitation hasn\'t been sent to the account.

', 'GetMemberResponse$UpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.

', 'GetResourceProfileResponse$ProfileUpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently recalculated sensitive data discovery statistics and details for the bucket. If the bucket\'s sensitivity score is calculated automatically, this includes the score.

', 'Invitation$InvitedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.

', 'JobDetails$LastJobRunTime' => '

The date and time, in UTC and extended ISO 8601 format, when the job (lastJobId) started. If the job is a recurring job, this value indicates when the most recent run started.

This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

', 'JobSummary$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the job was created.

', 'MatchingBucket$LastAutomatedDiscoveryTime' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed data in the bucket while performing automated sensitive data discovery for your account. This value is null if automated sensitive data discovery is currently disabled for your account.

', 'Member$InvitedAt' => '

The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie membership invitation hasn\'t been sent to the account.

', 'Member$UpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.

', 'S3Bucket$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket\'s policy were most recently made to the bucket, relative to when the finding was created or last updated.

', 'S3Object$LastModified' => '

The date and time, in UTC and extended ISO 8601 format, when the object was last modified.

', 'SessionContextAttributes$CreationDate' => '

The date and time, in UTC and ISO 8601 format, when the credentials were issued.

', 'UsageRecord$AutomatedDiscoveryFreeTrialStartDate' => '

The date and time, in UTC and extended ISO 8601 format, when the free trial of automated sensitive data discovery started for the account. If the account is a member account in an organization, this value is the same as the value for the organization\'s Amazon Macie administrator account.

', 'UsageRecord$FreeTrialStartDate' => '

The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie free trial started for the account.

', 'UserPausedDetails$JobExpiresAt' => '

The date and time, in UTC and extended ISO 8601 format, when the job or job run will expire and be cancelled if you don\'t resume it first.

', 'UserPausedDetails$JobPausedAt' => '

The date and time, in UTC and extended ISO 8601 format, when you paused the job.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => '

Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to help you discover and protect your sensitive data in AWS. Macie automates the discovery of sensitive data, such as PII and intellectual property, to provide you with insight into the data that your organization stores in AWS. Macie also provides an inventory of your Amazon S3 buckets, which it continually monitors for you. If Macie detects sensitive data or potential data access issues, it generates detailed findings for you to review and act upon as necessary.

', 'operations' => [ 'AcceptInvitation' => '

Accepts an Amazon Macie membership invitation that was received from a specific account.

', 'BatchGetCustomDataIdentifiers' => '

Retrieves information about one or more custom data identifiers.

', 'CreateAllowList' => '

Creates and defines the settings for an allow list.

', 'CreateClassificationJob' => '

Creates and defines the settings for a classification job.

', 'CreateCustomDataIdentifier' => '

Creates and defines the criteria and other settings for a custom data identifier.

', 'CreateFindingsFilter' => '

Creates and defines the criteria and other settings for a findings filter.

', 'CreateInvitations' => '

Sends an Amazon Macie membership invitation to one or more accounts.

', 'CreateMember' => '

Associates an account with an Amazon Macie administrator account.

', 'CreateSampleFindings' => '

Creates sample findings.

', 'DeclineInvitations' => '

Declines Amazon Macie membership invitations that were received from specific accounts.

', 'DeleteAllowList' => '

Deletes an allow list.

', 'DeleteCustomDataIdentifier' => '

Soft deletes a custom data identifier.

', 'DeleteFindingsFilter' => '

Deletes a findings filter.

', 'DeleteInvitations' => '

Deletes Amazon Macie membership invitations that were received from specific accounts.

', 'DeleteMember' => '

Deletes the association between an Amazon Macie administrator account and an account.

', 'DescribeBuckets' => '

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.

', 'DescribeClassificationJob' => '

Retrieves the status and settings for a classification job.

', 'DescribeOrganizationConfiguration' => '

Retrieves the Amazon Macie configuration settings for an organization in Organizations.

', 'DisableMacie' => '

Disables Amazon Macie and deletes all settings and resources for a Macie account.

', 'DisableOrganizationAdminAccount' => '

Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations.

', 'DisassociateFromAdministratorAccount' => '

Disassociates a member account from its Amazon Macie administrator account.

', 'DisassociateFromMasterAccount' => '

(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation.

', 'DisassociateMember' => '

Disassociates an Amazon Macie administrator account from a member account.

', 'EnableMacie' => '

Enables Amazon Macie and specifies the configuration settings for a Macie account.

', 'EnableOrganizationAdminAccount' => '

Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations.

', 'GetAdministratorAccount' => '

Retrieves information about the Amazon Macie administrator account for an account.

', 'GetAllowList' => '

Retrieves the settings and status of an allow list.

', 'GetAutomatedDiscoveryConfiguration' => '

Retrieves the configuration settings and status of automated sensitive data discovery for an account.

', 'GetBucketStatistics' => '

Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account.

', 'GetClassificationExportConfiguration' => '

Retrieves the configuration settings for storing data classification results.

', 'GetClassificationScope' => '

Retrieves the classification scope settings for an account.

', 'GetCustomDataIdentifier' => '

Retrieves the criteria and other settings for a custom data identifier.

', 'GetFindingStatistics' => '

Retrieves (queries) aggregated statistical data about findings.

', 'GetFindings' => '

Retrieves the details of one or more findings.

', 'GetFindingsFilter' => '

Retrieves the criteria and other settings for a findings filter.

', 'GetFindingsPublicationConfiguration' => '

Retrieves the configuration settings for publishing findings to Security Hub.

', 'GetInvitationsCount' => '

Retrieves the count of Amazon Macie membership invitations that were received by an account.

', 'GetMacieSession' => '

Retrieves the status and configuration settings for an Amazon Macie account.

', 'GetMasterAccount' => '

(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation.

', 'GetMember' => '

Retrieves information about an account that\'s associated with an Amazon Macie administrator account.

', 'GetResourceProfile' => '

Retrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3 bucket.

', 'GetRevealConfiguration' => '

Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

', 'GetSensitiveDataOccurrences' => '

Retrieves occurrences of sensitive data reported by a finding.

', 'GetSensitiveDataOccurrencesAvailability' => '

Checks whether occurrences of sensitive data can be retrieved for a finding.

', 'GetSensitivityInspectionTemplate' => '

Retrieves the settings for the sensitivity inspection template for an account.

', 'GetUsageStatistics' => '

Retrieves (queries) quotas and aggregated usage data for one or more accounts.

', 'GetUsageTotals' => '

Retrieves (queries) aggregated usage data for an account.

', 'ListAllowLists' => '

Retrieves a subset of information about all the allow lists for an account.

', 'ListClassificationJobs' => '

Retrieves a subset of information about one or more classification jobs.

', 'ListClassificationScopes' => '

Retrieves a subset of information about the classification scope for an account.

', 'ListCustomDataIdentifiers' => '

Retrieves a subset of information about all the custom data identifiers for an account.

', 'ListFindings' => '

Retrieves a subset of information about one or more findings.

', 'ListFindingsFilters' => '

Retrieves a subset of information about all the findings filters for an account.

', 'ListInvitations' => '

Retrieves information about the Amazon Macie membership invitations that were received by an account.

', 'ListManagedDataIdentifiers' => '

Retrieves information about all the managed data identifiers that Amazon Macie currently provides.

', 'ListMembers' => '

Retrieves information about the accounts that are associated with an Amazon Macie administrator account.

', 'ListOrganizationAdminAccounts' => '

Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.

', 'ListResourceProfileArtifacts' => '

Retrieves information about objects that were selected from an S3 bucket for automated sensitive data discovery.

', 'ListResourceProfileDetections' => '

Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.

', 'ListSensitivityInspectionTemplates' => '

Retrieves a subset of information about the sensitivity inspection template for an account.

', 'ListTagsForResource' => '

Retrieves the tags (keys and values) that are associated with an Amazon Macie resource.

', 'PutClassificationExportConfiguration' => '

Creates or updates the configuration settings for storing data classification results.

', 'PutFindingsPublicationConfiguration' => '

Updates the configuration settings for publishing findings to Security Hub.

', 'SearchResources' => '

Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

', 'TagResource' => '

Adds or updates one or more tags (keys and values) that are associated with an Amazon Macie resource.

', 'TestCustomDataIdentifier' => '

Tests a custom data identifier.

', 'UntagResource' => '

Removes one or more tags (keys and values) from an Amazon Macie resource.

', 'UpdateAllowList' => '

Updates the settings for an allow list.

', 'UpdateAutomatedDiscoveryConfiguration' => '

Enables or disables automated sensitive data discovery for an account.

', 'UpdateClassificationJob' => '

Changes the status of a classification job.

', 'UpdateClassificationScope' => '

Updates the classification scope settings for an account.

', 'UpdateFindingsFilter' => '

Updates the criteria and other settings for a findings filter.

', 'UpdateMacieSession' => '

Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.

', 'UpdateMemberSession' => '

Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.

', 'UpdateOrganizationConfiguration' => '

Updates the Amazon Macie configuration settings for an organization in Organizations.

', 'UpdateResourceProfile' => '

Updates the sensitivity score for an S3 bucket.

', 'UpdateResourceProfileDetections' => '

Updates the sensitivity scoring settings for an S3 bucket.

', 'UpdateRevealConfiguration' => '

Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

', 'UpdateSensitivityInspectionTemplate' => '

Updates the settings for the sensitivity inspection template for an account.

', ], 'shapes' => [ 'AcceptInvitationRequest' => [ 'base' => '

Specifies an Amazon Macie membership invitation to accept. In the request, you have to specify the ID for the Amazon Web Services account that sent the invitation. Otherwise, a validation error occurs. To specify this ID, we recommend that you use the administratorAccountId property instead of the masterAccount property. The masterAccount property has been deprecated and is retained only for backward compatibility.

', 'refs' => [], ], 'AccessControlList' => [ 'base' => '

Provides information about the permissions settings of the bucket-level access control list (ACL) for an S3 bucket.

', 'refs' => [ 'BucketLevelPermissions$AccessControlList' => '

The permissions settings of the access control list (ACL) for the bucket. This value is null if an ACL hasn\'t been defined for the bucket.

', ], ], 'AccessDeniedException' => [ 'base' => '

Provides information about an error that occurred due to insufficient access to a specified resource.

', 'refs' => [], ], 'AccountDetail' => [ 'base' => '

Specifies the details of an account to associate with an Amazon Macie administrator account.

', 'refs' => [ 'CreateMemberRequest$Account' => '

The details of the account to associate with the administrator account.

', ], ], 'AccountLevelPermissions' => [ 'base' => '

Provides information about the account-level permissions settings that apply to an S3 bucket.

', 'refs' => [ 'BucketPermissionConfiguration$AccountLevelPermissions' => '

The account-level permissions settings that apply to the bucket.

', ], ], 'AdminAccount' => [ 'base' => '

Provides information about the delegated Amazon Macie administrator account for an organization in Organizations.

', 'refs' => [ '__listOfAdminAccount$member' => NULL, ], ], 'AdminStatus' => [ 'base' => '

The current status of an account as the delegated Amazon Macie administrator account for an organization in Organizations. Possible values are:

', 'refs' => [ 'AdminAccount$Status' => '

The current status of the account as the delegated Amazon Macie administrator account for the organization.

', ], ], 'AllowListCriteria' => [ 'base' => '

Specifies the criteria for an allow list. The criteria must specify a regular expression (regex) or an S3 object (s3WordsList). It can\'t specify both.

', 'refs' => [ 'CreateAllowListRequest$Criteria' => '

The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

', 'GetAllowListResponse$Criteria' => '

The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

', 'UpdateAllowListRequest$Criteria' => '

The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression that defines a text pattern to ignore (regex).

You can change a list\'s underlying criteria, such as the name of the S3 object or the regular expression to use. However, you can\'t change the type from s3WordsList to regex or the other way around.

', ], ], 'AllowListStatus' => [ 'base' => '

Provides information about the current status of an allow list, which indicates whether Amazon Macie can access and use the list\'s criteria.

', 'refs' => [ 'GetAllowListResponse$Status' => '

The current status of the allow list, which indicates whether Amazon Macie can access and use the list\'s criteria.

', ], ], 'AllowListStatusCode' => [ 'base' => '

Indicates the current status of an allow list. Depending on the type of criteria that the list specifies, possible values are:

', 'refs' => [ 'AllowListStatus$Code' => '

The current status of the allow list. If the list\'s criteria specify a regular expression (regex), this value is typically OK. Amazon Macie can compile the expression.

If the list\'s criteria specify an S3 object, possible values are:

', ], ], 'AllowListSummary' => [ 'base' => '

Provides a subset of information about an allow list.

', 'refs' => [ '__listOfAllowListSummary$member' => NULL, ], ], 'AllowsUnencryptedObjectUploads' => [ 'base' => NULL, 'refs' => [ 'BucketMetadata$AllowsUnencryptedObjectUploads' => '

Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

', 'S3Bucket$AllowsUnencryptedObjectUploads' => '

Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

', ], ], 'ApiCallDetails' => [ 'base' => '

Provides information about an API operation that an entity invoked for an affected resource.

', 'refs' => [ 'FindingAction$ApiCallDetails' => '

The invocation details of the API operation that an entity invoked for the affected resource, if the value for the actionType property is AWS_API_CALL.

', ], ], 'AssumedRole' => [ 'base' => '

Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the AssumeRole operation of the Security Token Service (STS) API.

', 'refs' => [ 'UserIdentity$AssumedRole' => '

If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.

', ], ], 'AutomatedDiscoveryStatus' => [ 'base' => '

The status of the automated sensitive data discovery configuration for an Amazon Macie account. Valid values are:

', 'refs' => [ 'GetAutomatedDiscoveryConfigurationResponse$Status' => '

The current status of the automated sensitive data discovery configuration for the account. Possible values are: ENABLED, use the specified settings to perform automated sensitive data discovery activities for the account; and, DISABLED, don\'t perform automated sensitive data discovery activities for the account.

', 'UpdateAutomatedDiscoveryConfigurationRequest$Status' => '

The new status of automated sensitive data discovery for the account. Valid values are: ENABLED, start or resume automated sensitive data discovery activities for the account; and, DISABLED, stop performing automated sensitive data discovery activities for the account.

When you enable automated sensitive data discovery for the first time, Amazon Macie uses default configuration settings to determine which data sources to analyze and which managed data identifiers to use. To change these settings, use the UpdateClassificationScope and UpdateSensitivityInspectionTemplate operations, respectively. If you change the settings and subsequently disable the configuration, Amazon Macie retains your changes.

', ], ], 'AvailabilityCode' => [ 'base' => '

Specifies whether occurrences of sensitive data can be retrieved for a finding. Possible values are:

', 'refs' => [ 'GetSensitiveDataOccurrencesAvailabilityResponse$Code' => '

Specifies whether occurrences of sensitive data can be retrieved for the finding. Possible values are: AVAILABLE, the sensitive data can be retrieved; and, UNAVAILABLE, the sensitive data can\'t be retrieved. If this value is UNAVAILABLE, the reasons array indicates why the data can\'t be retrieved.

', ], ], 'AwsAccount' => [ 'base' => '

Provides information about an Amazon Web Services account and entity that performed an action on an affected resource. The action was performed using the credentials for an Amazon Web Services account other than your own account.

', 'refs' => [ 'UserIdentity$AwsAccount' => '

If the action was performed using the credentials for another Amazon Web Services account, the details of that account.

', ], ], 'AwsService' => [ 'base' => '

Provides information about an Amazon Web Service that performed an action on an affected resource.

', 'refs' => [ 'UserIdentity$AwsService' => '

If the action was performed by an Amazon Web Services account that belongs to an Amazon Web Service, the name of the service.

', ], ], 'BatchGetCustomDataIdentifierSummary' => [ 'base' => '

Provides information about a custom data identifier.

', 'refs' => [ '__listOfBatchGetCustomDataIdentifierSummary$member' => NULL, ], ], 'BatchGetCustomDataIdentifiersRequest' => [ 'base' => '

Specifies one or more custom data identifiers to retrieve information about.

', 'refs' => [], ], 'BatchGetCustomDataIdentifiersResponse' => [ 'base' => '

Provides information about one or more custom data identifiers.

', 'refs' => [], ], 'BlockPublicAccess' => [ 'base' => '

Provides information about the block public access settings for an S3 bucket. These settings can apply to a bucket at the account or bucket level. For detailed information about each setting, see Blocking public access to your Amazon S3 storage in the Amazon Simple Storage Service User Guide.

', 'refs' => [ 'AccountLevelPermissions$BlockPublicAccess' => '

The block public access settings for the Amazon Web Services account that owns the bucket.

', 'BucketLevelPermissions$BlockPublicAccess' => '

The block public access settings for the bucket.

', ], ], 'BucketCountByEffectivePermission' => [ 'base' => '

Provides information about the number of S3 buckets that are publicly accessible due to a combination of permissions settings for each bucket.

', 'refs' => [ 'GetBucketStatisticsResponse$BucketCountByEffectivePermission' => '

The total number of buckets that are publicly accessible due to a combination of permissions settings for each bucket.

', ], ], 'BucketCountByEncryptionType' => [ 'base' => '

Provides information about the number of S3 buckets whose settings do or don\'t specify default server-side encryption behavior for objects that are added to the buckets. For detailed information about these settings, see Setting default server-side encryption behavior for Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

', 'refs' => [ 'GetBucketStatisticsResponse$BucketCountByEncryptionType' => '

The total number of buckets whose settings do or don\'t specify default server-side encryption behavior for objects that are added to the buckets.

', ], ], 'BucketCountBySharedAccessType' => [ 'base' => '

Provides information about the number of S3 buckets that are or aren\'t shared with other Amazon Web Services accounts, Amazon CloudFront origin access identities (OAIs), or CloudFront origin access controls (OACs). In this data, an Amazon Macie organization is defined as a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

', 'refs' => [ 'GetBucketStatisticsResponse$BucketCountBySharedAccessType' => '

The total number of buckets that are or aren\'t shared with other Amazon Web Services accounts, Amazon CloudFront origin access identities (OAIs), or CloudFront origin access controls (OACs).

', ], ], 'BucketCountPolicyAllowsUnencryptedObjectUploads' => [ 'base' => '

Provides information about the number of S3 buckets whose bucket policies do or don\'t require server-side encryption of objects when objects are added to the buckets.

', 'refs' => [ 'GetBucketStatisticsResponse$BucketCountByObjectEncryptionRequirement' => '

The total number of buckets whose bucket policies do or don\'t require server-side encryption of objects when objects are added to the buckets.

', ], ], 'BucketCriteria' => [ 'base' => '

Specifies, as a map, one or more property-based conditions that filter the results of a query for information about S3 buckets.

', 'refs' => [ 'DescribeBucketsRequest$Criteria' => '

The criteria to use to filter the query results.

', ], ], 'BucketCriteriaAdditionalProperties' => [ 'base' => '

Specifies the operator to use in a property-based condition that filters the results of a query for information about S3 buckets.

', 'refs' => [ 'BucketCriteria$member' => NULL, ], ], 'BucketLevelPermissions' => [ 'base' => '

Provides information about the bucket-level permissions settings for an S3 bucket.

', 'refs' => [ 'BucketPermissionConfiguration$BucketLevelPermissions' => '

The bucket-level permissions settings for the bucket.

', ], ], 'BucketMetadata' => [ 'base' => '

Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. By default, object count and storage size values include data for object parts that are the result of incomplete multipart uploads. For more information, see How Macie monitors Amazon S3 data security in the Amazon Macie User Guide.

If an error occurs when Macie attempts to retrieve and process metadata from Amazon S3 for the bucket or the bucket\'s objects, the value for the versioning property is false and the value for most other properties is null. Key exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause of the error, refer to the errorCode and errorMessage values.

', 'refs' => [ '__listOfBucketMetadata$member' => NULL, ], ], 'BucketMetadataErrorCode' => [ 'base' => '

The error code for an error that prevented Amazon Macie from retrieving and processing metadata from Amazon S3 for an S3 bucket and the bucket\'s objects.

', 'refs' => [ 'BucketMetadata$ErrorCode' => '

The error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket\'s objects. If this value is ACCESS_DENIED, Macie doesn\'t have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.

', 'MatchingBucket$ErrorCode' => '

The error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket\'s objects. If this value is ACCESS_DENIED, Macie doesn\'t have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.

', ], ], 'BucketPermissionConfiguration' => [ 'base' => '

Provides information about the account-level and bucket-level permissions settings for an S3 bucket.

', 'refs' => [ 'BucketPublicAccess$PermissionConfiguration' => '

The account-level and bucket-level permissions settings for the bucket.

', ], ], 'BucketPolicy' => [ 'base' => '

Provides information about the permissions settings of the bucket policy for an S3 bucket.

', 'refs' => [ 'BucketLevelPermissions$BucketPolicy' => '

The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn\'t been defined for the bucket.

', ], ], 'BucketPublicAccess' => [ 'base' => '

Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.

', 'refs' => [ 'BucketMetadata$PublicAccess' => '

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.

', 'S3Bucket$PublicAccess' => '

The permissions settings that determine whether the bucket is publicly accessible.

', ], ], 'BucketServerSideEncryption' => [ 'base' => '

Provides information about the default server-side encryption settings for an S3 bucket. For detailed information about these settings, see Setting default server-side encryption behavior for Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

', 'refs' => [ 'BucketMetadata$ServerSideEncryption' => '

The default server-side encryption settings for the bucket.

', ], ], 'BucketSortCriteria' => [ 'base' => '

Specifies criteria for sorting the results of a query for information about S3 buckets.

', 'refs' => [ 'DescribeBucketsRequest$SortCriteria' => '

The criteria to use to sort the query results.

', ], ], 'BucketStatisticsBySensitivity' => [ 'base' => '

Provides aggregated statistical data for sensitive data discovery metrics that apply to S3 buckets, grouped by bucket sensitivity score (sensitivityScore). If automated sensitive data discovery is currently disabled for your account, the value for each metric is 0.

', 'refs' => [ 'GetBucketStatisticsResponse$BucketStatisticsBySensitivity' => '

The aggregated sensitive data discovery statistics for the buckets. If automated sensitive data discovery is currently disabled for your account, the value for each statistic is 0.

', ], ], 'Cell' => [ 'base' => '

Specifies the location of an occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.

', 'refs' => [ 'Cells$member' => NULL, ], ], 'Cells' => [ 'base' => '

Specifies the location of occurrences of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.

', 'refs' => [ 'Occurrences$Cells' => '

An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.

Each Cell object specifies a cell or field that contains the sensitive data.

', ], ], 'ClassificationDetails' => [ 'base' => '

Provides information about a sensitive data finding and the details of the finding.

', 'refs' => [ 'Finding$ClassificationDetails' => '

The details of a sensitive data finding. This value is null for a policy finding.

', ], ], 'ClassificationExportConfiguration' => [ 'base' => '

Specifies where to store data classification results, and the encryption settings to use when storing results in that location. The location must be an S3 bucket.

', 'refs' => [ 'GetClassificationExportConfigurationResponse$Configuration' => '

The location where data classification results are stored, and the encryption settings that are used when storing results in that location.

', 'PutClassificationExportConfigurationRequest$Configuration' => '

The location to store data classification results in, and the encryption settings to use when storing results in that location.

', 'PutClassificationExportConfigurationResponse$Configuration' => '

The location where the data classification results are stored, and the encryption settings that are used when storing results in that location.

', ], ], 'ClassificationResult' => [ 'base' => '

Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.

', 'refs' => [ 'ClassificationDetails$Result' => '

The status and other details of the finding.

', ], ], 'ClassificationResultStatus' => [ 'base' => '

Provides information about the status of a sensitive data finding.

', 'refs' => [ 'ClassificationResult$Status' => '

The status of the finding.

', ], ], 'ClassificationScopeId' => [ 'base' => '

The unique identifier the classification scope.

', 'refs' => [ 'ClassificationScopeSummary$Id' => '

The unique identifier for the classification scope.

', 'GetAutomatedDiscoveryConfigurationResponse$ClassificationScopeId' => '

The unique identifier for the classification scope that\'s used when performing automated sensitive data discovery for the account. The classification scope specifies S3 buckets to exclude from automated sensitive data discovery.

', 'GetClassificationScopeResponse$Id' => '

The unique identifier for the classification scope.

', ], ], 'ClassificationScopeName' => [ 'base' => '

The name of the classification scope.

', 'refs' => [ 'ClassificationScopeSummary$Name' => '

The name of the classification scope: automated-sensitive-data-discovery.

', 'GetClassificationScopeResponse$Name' => '

The name of the classification scope: automated-sensitive-data-discovery.

', ], ], 'ClassificationScopeSummary' => [ 'base' => '

Provides information about the classification scope for an Amazon Macie account. Macie uses the scope\'s settings when it performs automated sensitive data discovery for the account.

', 'refs' => [ '__listOfClassificationScopeSummary$member' => NULL, ], ], 'ClassificationScopeUpdateOperation' => [ 'base' => '

Specifies how to apply changes to the S3 bucket exclusion list defined by the classification scope for an Amazon Macie account. Valid values are:

', 'refs' => [ 'S3ClassificationScopeExclusionUpdate$Operation' => '

Specifies how to apply the changes to the exclusion list. Valid values are:

', ], ], 'ConflictException' => [ 'base' => '

Provides information about an error that occurred due to a versioning conflict for a specified resource.

', 'refs' => [], ], 'CreateAllowListRequest' => [ 'base' => '

Specifies the settings for an allow list. When Amazon Macie processes the request, Macie tests the list\'s criteria. If the criteria specify a regular expression that Macie can\'t compile or an S3 object that Macie can\'t retrieve or parse, an error occurs.

', 'refs' => [], ], 'CreateAllowListResponse' => [ 'base' => '

Provides information about an allow list that was created in response to a request.

', 'refs' => [], ], 'CreateClassificationJobRequest' => [ 'base' => '

Specifies the scope, schedule, and other settings for a classification job. You can\'t change any settings for a classification job after you create it. This helps to ensure that you have an immutable history of sensitive data findings and discovery results for data privacy and protection audits or investigations.

', 'refs' => [], ], 'CreateClassificationJobResponse' => [ 'base' => '

Provides information about a classification job that was created in response to a request.

', 'refs' => [], ], 'CreateCustomDataIdentifierRequest' => [ 'base' => '

Specifies the detection criteria and other settings for a custom data identifier. You can\'t change a custom data identifier after you create it. This helps to ensure that you have an immutable history of sensitive data findings and discovery results for data privacy and protection audits or investigations.

', 'refs' => [], ], 'CreateCustomDataIdentifierResponse' => [ 'base' => '

Provides information about a custom data identifier that was created in response to a request.

', 'refs' => [], ], 'CreateFindingsFilterRequest' => [ 'base' => '

Specifies the criteria and other settings for a new findings filter.

', 'refs' => [], ], 'CreateFindingsFilterResponse' => [ 'base' => '

Provides information about a findings filter that was created in response to a request.

', 'refs' => [], ], 'CreateInvitationsRequest' => [ 'base' => '

Specifies the settings for an Amazon Macie membership invitation. When you send an invitation, Macie notifies the recipient by creating an Health event for the recipient\'s account and, if Macie is already enabled for the account, displaying an Accounts badge and notification on the recipient\'s console. You can optionally notify the recipient by also sending the invitation as an email message.

', 'refs' => [], ], 'CreateInvitationsResponse' => [ 'base' => '

Provides information about an unprocessed request to send an Amazon Macie membership invitation to a specific account.

', 'refs' => [], ], 'CreateMemberRequest' => [ 'base' => '

Specifies an Amazon Web Services account to associate with an Amazon Macie administrator account.

', 'refs' => [], ], 'CreateMemberResponse' => [ 'base' => '

Provides information about a request to associate an account with an Amazon Macie administrator account.

', 'refs' => [], ], 'CreateSampleFindingsRequest' => [ 'base' => '

Specifies the types of sample findings to create.

', 'refs' => [], ], 'CriteriaBlockForJob' => [ 'base' => '

Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job.

', 'refs' => [ 'S3BucketCriteriaForJob$Excludes' => '

The property- and tag-based conditions that determine which buckets to exclude from the job.

', 'S3BucketCriteriaForJob$Includes' => '

The property- and tag-based conditions that determine which buckets to include in the job.

', ], ], 'CriteriaForJob' => [ 'base' => '

Specifies a property- or tag-based condition that defines criteria for including or excluding S3 buckets from a classification job.

', 'refs' => [ '__listOfCriteriaForJob$member' => NULL, ], ], 'Criterion' => [ 'base' => '

Specifies a condition that defines a property, operator, and one or more values to filter the results of a query for findings. The number of values depends on the property and operator specified by the condition. For information about defining filter conditions, see Fundamentals of filtering findings in the Amazon Macie User Guide.

', 'refs' => [ 'FindingCriteria$Criterion' => '

A condition that specifies the property, operator, and one or more values to use to filter the results.

', ], ], 'CriterionAdditionalProperties' => [ 'base' => '

Specifies the operator to use in a property-based condition that filters the results of a query for findings. For detailed information and examples of each operator, see Fundamentals of filtering findings in the Amazon Macie User Guide.

', 'refs' => [ 'Criterion$member' => NULL, ], ], 'Currency' => [ 'base' => '

The type of currency that the data for an Amazon Macie usage metric is reported in. Possible values are:

', 'refs' => [ 'UsageByAccount$Currency' => '

The type of currency that the value for the metric (estimatedCost) is reported in.

', 'UsageTotal$Currency' => '

The type of currency that the value for the metric (estimatedCost) is reported in.

', ], ], 'CustomDataIdentifierSummary' => [ 'base' => '

Provides information about a custom data identifier.

', 'refs' => [ '__listOfCustomDataIdentifierSummary$member' => NULL, ], ], 'CustomDataIdentifiers' => [ 'base' => '

Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that they detected for the finding.

', 'refs' => [ 'ClassificationResult$CustomDataIdentifiers' => '

The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.

', ], ], 'CustomDetection' => [ 'base' => '

Provides information about a custom data identifier that produced a sensitive data finding, and the sensitive data that it detected for the finding.

', 'refs' => [ 'CustomDetections$member' => NULL, ], ], 'CustomDetections' => [ 'base' => '

Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that each identifier detected.

', 'refs' => [ 'CustomDataIdentifiers$Detections' => '

The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.

', ], ], 'DailySchedule' => [ 'base' => '

Specifies that a classification job runs once a day, every day. This is an empty object.

', 'refs' => [ 'JobScheduleFrequency$DailySchedule' => '

Specifies a daily recurrence pattern for running the job.

', ], ], 'DataIdentifierSeverity' => [ 'base' => '

The severity of a finding, ranging from LOW, for least severe, to HIGH, for most severe. Valid values are:

', 'refs' => [ 'SeverityLevel$Severity' => '

The severity to assign to a finding: if the number of occurrences is greater than or equal to the specified threshold (occurrencesThreshold); and, if applicable, the number of occurrences is less than the threshold for the next consecutive severity level for the custom data identifier, moving from LOW to HIGH.

', ], ], 'DataIdentifierType' => [ 'base' => '

The type of data identifier that detected a specific type of sensitive data in an S3 bucket. Possible values are:

', 'refs' => [ 'Detection$Type' => '

The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.

', 'SuppressDataIdentifier$Type' => '

The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.

', ], ], 'DayOfWeek' => [ 'base' => NULL, 'refs' => [ 'WeeklySchedule$DayOfWeek' => '

The day of the week when Amazon Macie runs the job.

', ], ], 'DeclineInvitationsRequest' => [ 'base' => '

Specifies one or more accounts that sent Amazon Macie membership invitations to decline.

', 'refs' => [], ], 'DeclineInvitationsResponse' => [ 'base' => '

Provides information about unprocessed requests to decline Amazon Macie membership invitations that were received from specific accounts.

', 'refs' => [], ], 'DefaultDetection' => [ 'base' => '

Provides information about a type of sensitive data that was detected by a managed data identifier and produced a sensitive data finding.

', 'refs' => [ 'DefaultDetections$member' => NULL, ], ], 'DefaultDetections' => [ 'base' => '

Provides information about sensitive data that was detected by managed data identifiers and produced a sensitive data finding, and the number of occurrences of each type of sensitive data that was detected.

', 'refs' => [ 'SensitiveDataItem$Detections' => '

An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected, and the location of up to 15 of those occurrences.

', ], ], 'DeleteInvitationsRequest' => [ 'base' => '

Specifies one or more accounts that sent Amazon Macie membership invitations to delete.

', 'refs' => [], ], 'DeleteInvitationsResponse' => [ 'base' => '

Provides information about unprocessed requests to delete Amazon Macie membership invitations that were received from specific accounts.

', 'refs' => [], ], 'DescribeBucketsRequest' => [ 'base' => '

Specifies criteria for filtering, sorting, and paginating the results of a query for statistical data and other information about S3 buckets.

', 'refs' => [], ], 'DescribeBucketsResponse' => [ 'base' => '

Provides the results of a query that retrieved statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for your account.

', 'refs' => [], ], 'DescribeClassificationJobResponse' => [ 'base' => '

Provides information about a classification job, including the current configuration settings and status of the job.

', 'refs' => [], ], 'DescribeOrganizationConfigurationResponse' => [ 'base' => '

Provides information about the Amazon Macie configuration settings for an organization in Organizations.

', 'refs' => [], ], 'DetectedDataDetails' => [ 'base' => '

Specifies 1-10 occurrences of a specific type of sensitive data reported by a finding.

', 'refs' => [ '__listOfDetectedDataDetails$member' => NULL, ], ], 'Detection' => [ 'base' => '

Provides information about a type of sensitive data that Amazon Macie found in an S3 bucket while performing automated sensitive data discovery for the bucket. The information also specifies the custom data identifier or managed data identifier that detected the data. This information is available only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [ '__listOfDetection$member' => NULL, ], ], 'DomainDetails' => [ 'base' => '

Provides information about the domain name of the device that an entity used to perform an action on an affected resource.

', 'refs' => [ 'FindingActor$DomainDetails' => '

The domain name of the device that the entity used to perform the action on the affected resource.

', ], ], 'EffectivePermission' => [ 'base' => NULL, 'refs' => [ 'BucketPublicAccess$EffectivePermission' => '

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are:

', ], ], 'Empty' => [ 'base' => '

The request succeeded and there isn\'t any content to include in the body of the response (No Content).

', 'refs' => [], ], 'EnableMacieRequest' => [ 'base' => '

Enables Amazon Macie and specifies the configuration settings for a Macie account.

', 'refs' => [], ], 'EnableOrganizationAdminAccountRequest' => [ 'base' => '

Specifies an account to designate as the delegated Amazon Macie administrator account for an organization in Organizations. To submit this request, you must be a user of the Organizations management account.

', 'refs' => [], ], 'EncryptionType' => [ 'base' => '

The server-side encryption algorithm that was used to encrypt an S3 object or is used by default to encrypt objects that are added to an S3 bucket. Possible values are:

', 'refs' => [ 'ServerSideEncryption$EncryptionType' => '

The server-side encryption algorithm that\'s used when storing data in the bucket or object. If default encryption settings aren\'t configured for the bucket or the object isn\'t encrypted using server-side encryption, this value is NONE.

', ], ], 'ErrorCode' => [ 'base' => '

The source of an issue or delay. Possible values are:

', 'refs' => [ 'UnprocessedAccount$ErrorCode' => '

The source of the issue or delay in processing the request.

', ], ], 'FederatedUser' => [ 'base' => '

Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the GetFederationToken operation of the Security Token Service (STS) API.

', 'refs' => [ 'UserIdentity$FederatedUser' => '

If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.

', ], ], 'Finding' => [ 'base' => '

Provides the details of a finding.

', 'refs' => [ '__listOfFinding$member' => NULL, ], ], 'FindingAction' => [ 'base' => '

Provides information about an action that occurred for a resource and produced a policy finding.

', 'refs' => [ 'PolicyDetails$Action' => '

The action that produced the finding.

', ], ], 'FindingActionType' => [ 'base' => '

The type of action that occurred for the resource and produced the policy finding:

', 'refs' => [ 'FindingAction$ActionType' => '

The type of action that occurred for the affected resource. This value is typically AWS_API_CALL, which indicates that an entity invoked an API operation for the resource.

', ], ], 'FindingActor' => [ 'base' => '

Provides information about an entity that performed an action that produced a policy finding for a resource.

', 'refs' => [ 'PolicyDetails$Actor' => '

The entity that performed the action that produced the finding.

', ], ], 'FindingCategory' => [ 'base' => '

The category of the finding. Possible values are:

', 'refs' => [ 'Finding$Category' => '

The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.

', ], ], 'FindingCriteria' => [ 'base' => '

Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.

', 'refs' => [ 'CreateFindingsFilterRequest$FindingCriteria' => '

The criteria to use to filter findings.

', 'GetFindingStatisticsRequest$FindingCriteria' => '

The criteria to use to filter the query results.

', 'GetFindingsFilterResponse$FindingCriteria' => '

The criteria that\'s used to filter findings.

', 'ListFindingsRequest$FindingCriteria' => '

The criteria to use to filter the results.

', 'UpdateFindingsFilterRequest$FindingCriteria' => '

The criteria to use to filter findings.

', ], ], 'FindingPublishingFrequency' => [ 'base' => '

The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events). For more information, see Monitoring and processing findings in the Amazon Macie User Guide. Valid values are:

', 'refs' => [ 'EnableMacieRequest$FindingPublishingFrequency' => '

Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).

', 'GetMacieSessionResponse$FindingPublishingFrequency' => '

The frequency with which Amazon Macie publishes updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).

', 'UpdateMacieSessionRequest$FindingPublishingFrequency' => '

Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).

', ], ], 'FindingStatisticsSortAttributeName' => [ 'base' => '

The grouping to sort the results by. Valid values are:

', 'refs' => [ 'FindingStatisticsSortCriteria$AttributeName' => '

The grouping to sort the results by. Valid values are: count, sort the results by the number of findings in each group of results; and, groupKey, sort the results by the name of each group of results.

', ], ], 'FindingStatisticsSortCriteria' => [ 'base' => '

Specifies criteria for sorting the results of a query that retrieves aggregated statistical data about findings.

', 'refs' => [ 'GetFindingStatisticsRequest$SortCriteria' => '

The criteria to use to sort the query results.

', ], ], 'FindingType' => [ 'base' => '

The type of finding. For details about each type, see Types of Amazon Macie findings in the Amazon Macie User Guide. Possible values are:

', 'refs' => [ 'Finding$Type' => '

The type of the finding.

', '__listOfFindingType$member' => NULL, ], ], 'FindingsFilterAction' => [ 'base' => '

The action to perform on findings that match the filter criteria. To suppress (automatically archive) findings that match the criteria, set this value to ARCHIVE. Valid values are:

', 'refs' => [ 'CreateFindingsFilterRequest$Action' => '

The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don\'t perform any action on the findings.

', 'FindingsFilterListItem$Action' => '

The action that\'s performed on findings that match the filter criteria. Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don\'t perform any action on the findings.

', 'GetFindingsFilterResponse$Action' => '

The action that\'s performed on findings that match the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don\'t perform any action on the findings.

', 'UpdateFindingsFilterRequest$Action' => '

The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don\'t perform any action on the findings.

', ], ], 'FindingsFilterListItem' => [ 'base' => '

Provides information about a findings filter.

', 'refs' => [ '__listOfFindingsFilterListItem$member' => NULL, ], ], 'GetAdministratorAccountResponse' => [ 'base' => '

Provides information about the Amazon Macie administrator account for an account. If the accounts are associated by a Macie membership invitation, the response also provides information about that invitation.

', 'refs' => [], ], 'GetAllowListResponse' => [ 'base' => '

Provides information about the settings and status of an allow list.

', 'refs' => [], ], 'GetAutomatedDiscoveryConfigurationResponse' => [ 'base' => '

Provides information about the configuration settings for performing automated sensitive data discovery for an Amazon Macie account, and the status of the configuration for the account.

', 'refs' => [], ], 'GetBucketStatisticsRequest' => [ 'base' => '

Specifies the account that owns the S3 buckets to retrieve aggregated statistical data for.

', 'refs' => [], ], 'GetBucketStatisticsResponse' => [ 'base' => '

Provides the results of a query that retrieved aggregated statistical data for all the S3 buckets that Amazon Macie monitors and analyzes for your account. By default, object count and storage size values include data for object parts that are the result of incomplete multipart uploads. For more information, see How Macie monitors Amazon S3 data security in the Amazon Macie User Guide.

', 'refs' => [], ], 'GetClassificationExportConfigurationResponse' => [ 'base' => '

Provides information about the current configuration settings for storing data classification results.

', 'refs' => [], ], 'GetClassificationScopeResponse' => [ 'base' => '

Provides information about the classification scope settings for an Amazon Macie account. Macie uses these settings when it performs automated sensitive data discovery for the account.

', 'refs' => [], ], 'GetCustomDataIdentifierResponse' => [ 'base' => '

Provides information about the detection criteria and other settings for a custom data identifier.

', 'refs' => [], ], 'GetFindingStatisticsRequest' => [ 'base' => '

Specifies criteria for filtering, grouping, sorting, and paginating the results of a query that retrieves aggregated statistical data about findings.

', 'refs' => [], ], 'GetFindingStatisticsResponse' => [ 'base' => '

Provides the results of a query that retrieved aggregated statistical data about findings.

', 'refs' => [], ], 'GetFindingsFilterResponse' => [ 'base' => '

Provides information about the criteria and other settings for a findings filter.

', 'refs' => [], ], 'GetFindingsPublicationConfigurationResponse' => [ 'base' => '

Provides information about the current configuration settings for publishing findings to Security Hub automatically.

', 'refs' => [], ], 'GetFindingsRequest' => [ 'base' => '

Specifies one or more findings to retrieve.

', 'refs' => [], ], 'GetFindingsResponse' => [ 'base' => '

Provides the results of a request for one or more findings.

', 'refs' => [], ], 'GetInvitationsCountResponse' => [ 'base' => '

Provides the count of all the Amazon Macie membership invitations that were received by an account, not including the currently accepted invitation.

', 'refs' => [], ], 'GetMacieSessionResponse' => [ 'base' => '

Provides information about the status and configuration settings for an Amazon Macie account.

', 'refs' => [], ], 'GetMasterAccountResponse' => [ 'base' => '

(Deprecated) Provides information about the Amazon Macie administrator account for an account. If the accounts are associated by a Macie membership invitation, the response also provides information about that invitation.

', 'refs' => [], ], 'GetMemberResponse' => [ 'base' => '

Provides information about an account that\'s associated with an Amazon Macie administrator account.

', 'refs' => [], ], 'GetResourceProfileResponse' => [ 'base' => '

Provides the results of a query that retrieved sensitive data discovery statistics and the sensitivity score for an S3 bucket that Amazon Macie monitors and analyzes for your account. This data is available only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [], ], 'GetRevealConfigurationResponse' => [ 'base' => '

Provides information about the configuration settings for retrieving occurrences of sensitive data reported by findings, and the status of the configuration for an Amazon Macie account.

', 'refs' => [], ], 'GetSensitiveDataOccurrencesAvailabilityResponse' => [ 'base' => '

Provides information about whether occurrences of sensitive data can be retrieved for a finding and, if not, why the data can\'t be retrieved.

', 'refs' => [], ], 'GetSensitiveDataOccurrencesResponse' => [ 'base' => '

Provides the results of a request to retrieve occurrences of sensitive data reported by a finding.

', 'refs' => [], ], 'GetSensitivityInspectionTemplateResponse' => [ 'base' => '

Provides information about the settings for the sensitivity inspection template for an Amazon Macie account. Macie uses the template\'s settings when it performs automated sensitive data discovery for the account.

', 'refs' => [], ], 'GetUsageStatisticsRequest' => [ 'base' => '

Specifies criteria for filtering, sorting, and paginating the results of a query for quotas and aggregated usage data for one or more Amazon Macie accounts.

', 'refs' => [], ], 'GetUsageStatisticsResponse' => [ 'base' => '

Provides the results of a query that retrieved quotas and aggregated usage data for one or more Amazon Macie accounts.

', 'refs' => [], ], 'GetUsageTotalsResponse' => [ 'base' => '

Provides the results of a query that retrieved aggregated usage data for an Amazon Macie account.

', 'refs' => [], ], 'GroupBy' => [ 'base' => NULL, 'refs' => [ 'GetFindingStatisticsRequest$GroupBy' => '

The finding property to use to group the query results. Valid values are:

', ], ], 'GroupCount' => [ 'base' => '

Provides a group of results for a query that retrieved aggregated statistical data about findings.

', 'refs' => [ '__listOfGroupCount$member' => NULL, ], ], 'IamUser' => [ 'base' => '

Provides information about an Identity and Access Management (IAM) user who performed an action on an affected resource.

', 'refs' => [ 'UserIdentity$IamUser' => '

If the action was performed using the credentials for an Identity and Access Management (IAM) user, the name and other details about the user.

', ], ], 'InternalServerException' => [ 'base' => '

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

', 'refs' => [], ], 'Invitation' => [ 'base' => '

Provides information about an Amazon Macie membership invitation.

', 'refs' => [ 'GetAdministratorAccountResponse$Administrator' => '

The Amazon Web Services account ID for the administrator account. If the accounts are associated by an Amazon Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.

', 'GetMasterAccountResponse$Master' => '

(Deprecated) The Amazon Web Services account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.

', '__listOfInvitation$member' => NULL, ], ], 'IpAddressDetails' => [ 'base' => '

Provides information about the IP address of the device that an entity used to perform an action on an affected resource.

', 'refs' => [ 'FindingActor$IpAddressDetails' => '

The IP address of the device that the entity used to perform the action on the affected resource. This object also provides information such as the owner and geographic location for the IP address.

', ], ], 'IpCity' => [ 'base' => '

Provides information about the city that an IP address originated from.

', 'refs' => [ 'IpAddressDetails$IpCity' => '

The city that the IP address originated from.

', ], ], 'IpCountry' => [ 'base' => '

Provides information about the country that an IP address originated from.

', 'refs' => [ 'IpAddressDetails$IpCountry' => '

The country that the IP address originated from.

', ], ], 'IpGeoLocation' => [ 'base' => '

Provides geographic coordinates that indicate where a specified IP address originated from.

', 'refs' => [ 'IpAddressDetails$IpGeoLocation' => '

The geographic coordinates of the location that the IP address originated from.

', ], ], 'IpOwner' => [ 'base' => '

Provides information about the registered owner of an IP address.

', 'refs' => [ 'IpAddressDetails$IpOwner' => '

The registered owner of the IP address.

', ], ], 'IsDefinedInJob' => [ 'base' => NULL, 'refs' => [ 'JobDetails$IsDefinedInJob' => '

Specifies whether any one-time or recurring jobs are configured to analyze data in the bucket. Possible values are:

', ], ], 'IsMonitoredByJob' => [ 'base' => NULL, 'refs' => [ 'JobDetails$IsMonitoredByJob' => '

Specifies whether any recurring jobs are configured to analyze data in the bucket. Possible values are:

', ], ], 'JobComparator' => [ 'base' => '

The operator to use in a condition. Depending on the type of condition, possible values are:

', 'refs' => [ 'ListJobsFilterTerm$Comparator' => '

The operator to use to filter the results.

', 'SimpleCriterionForJob$Comparator' => '

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

', 'SimpleScopeTerm$Comparator' => '

The operator to use in the condition. Valid values for each supported property (key) are:

', 'TagCriterionForJob$Comparator' => '

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

', 'TagScopeTerm$Comparator' => '

The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).

', ], ], 'JobDetails' => [ 'base' => '

Specifies whether any one-time or recurring classification jobs are configured to analyze data in an S3 bucket, and, if so, the details of the job that ran most recently.

', 'refs' => [ 'BucketMetadata$JobDetails' => '

Specifies whether any one-time or recurring classification jobs are configured to analyze data in the bucket, and, if so, the details of the job that ran most recently.

', 'MatchingBucket$JobDetails' => '

Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.

', ], ], 'JobScheduleFrequency' => [ 'base' => '

Specifies the recurrence pattern for running a classification job.

', 'refs' => [ 'CreateClassificationJobRequest$ScheduleFrequency' => '

The recurrence pattern for running the job. To run the job only once, don\'t specify a value for this property and set the value for the jobType property to ONE_TIME.

', 'DescribeClassificationJobResponse$ScheduleFrequency' => '

The recurrence pattern for running the job. This value is null if the job is configured to run only once.

', ], ], 'JobScopeTerm' => [ 'base' => '

Specifies a property- or tag-based condition that defines criteria for including or excluding S3 objects from a classification job. A JobScopeTerm object can contain only one simpleScopeTerm object or one tagScopeTerm object.

', 'refs' => [ '__listOfJobScopeTerm$member' => NULL, ], ], 'JobScopingBlock' => [ 'base' => '

Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job.

', 'refs' => [ 'Scoping$Excludes' => '

The property- and tag-based conditions that determine which objects to exclude from the analysis.

', 'Scoping$Includes' => '

The property- and tag-based conditions that determine which objects to include in the analysis.

', ], ], 'JobStatus' => [ 'base' => '

The status of a classification job. Possible values are:

', 'refs' => [ 'DescribeClassificationJobResponse$JobStatus' => '

The current status of the job. Possible values are:

', 'JobSummary$JobStatus' => '

The current status of the job. Possible values are:

', 'UpdateClassificationJobRequest$JobStatus' => '

The new status for the job. Valid values are:

', ], ], 'JobSummary' => [ 'base' => '

Provides information about a classification job, including the current status of the job.

', 'refs' => [ '__listOfJobSummary$member' => NULL, ], ], 'JobType' => [ 'base' => '

The schedule for running a classification job. Valid values are:

', 'refs' => [ 'CreateClassificationJobRequest$JobType' => '

The schedule for running the job. Valid values are:

', 'DescribeClassificationJobResponse$JobType' => '

The schedule for running the job. Possible values are:

', 'JobSummary$JobType' => '

The schedule for running the job. Possible values are:

', ], ], 'KeyValuePair' => [ 'base' => '

Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.

', 'refs' => [ 'KeyValuePairList$member' => NULL, '__listOfKeyValuePair$member' => NULL, ], ], 'KeyValuePairList' => [ 'base' => '

Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.

', 'refs' => [ 'S3Bucket$Tags' => '

The tags that are associated with the bucket.

', 'S3Object$Tags' => '

The tags that are associated with the object.

', ], ], 'LastRunErrorStatus' => [ 'base' => '

Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For information about using logging data to investigate these errors, see Monitoring sensitive data discovery jobs in the Amazon Macie User Guide.

', 'refs' => [ 'DescribeClassificationJobResponse$LastRunErrorStatus' => '

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job\'s most recent run.

', 'JobSummary$LastRunErrorStatus' => '

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job\'s most recent run.

', ], ], 'LastRunErrorStatusCode' => [ 'base' => '

Specifies whether any account- or bucket-level access errors occurred during the run of a one-time classification job or the most recent run of a recurring classification job. Possible values are:

', 'refs' => [ 'LastRunErrorStatus$Code' => '

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job\'s most recent run. Possible values are:

', ], ], 'ListAllowListsResponse' => [ 'base' => '

Provides the results of a request for information about allow lists.

', 'refs' => [], ], 'ListClassificationJobsRequest' => [ 'base' => '

Specifies criteria for filtering, sorting, and paginating the results of a request for information about classification jobs.

', 'refs' => [], ], 'ListClassificationJobsResponse' => [ 'base' => '

Provides the results of a request for information about one or more classification jobs.

', 'refs' => [], ], 'ListClassificationScopesResponse' => [ 'base' => '

Provides the results of a request for information about the classification scope for an Amazon Macie account. Macie uses the scope\'s settings when it performs automated sensitive data discovery for the account.

', 'refs' => [], ], 'ListCustomDataIdentifiersRequest' => [ 'base' => '

Specifies criteria for paginating the results of a request for information about custom data identifiers.

', 'refs' => [], ], 'ListCustomDataIdentifiersResponse' => [ 'base' => '

Provides the results of a request for information about custom data identifiers.

', 'refs' => [], ], 'ListFindingsFiltersResponse' => [ 'base' => '

Provides information about all the findings filters for an account.

', 'refs' => [], ], 'ListFindingsRequest' => [ 'base' => '

Specifies criteria for filtering, sorting, and paginating the results of a request for information about findings.

', 'refs' => [], ], 'ListFindingsResponse' => [ 'base' => '

Provides the results of a request for information about one or more findings.

', 'refs' => [], ], 'ListInvitationsResponse' => [ 'base' => '

Provides information about the Amazon Macie membership invitations that were received by an account.

', 'refs' => [], ], 'ListJobsFilterCriteria' => [ 'base' => '

Specifies criteria for filtering the results of a request for information about classification jobs.

', 'refs' => [ 'ListClassificationJobsRequest$FilterCriteria' => '

The criteria to use to filter the results.

', ], ], 'ListJobsFilterKey' => [ 'base' => '

The property to use to filter the results. Valid values are:

', 'refs' => [ 'ListJobsFilterTerm$Key' => '

The property to use to filter the results.

', ], ], 'ListJobsFilterTerm' => [ 'base' => '

Specifies a condition that filters the results of a request for information about classification jobs. Each condition consists of a property, an operator, and one or more values.

', 'refs' => [ '__listOfListJobsFilterTerm$member' => NULL, ], ], 'ListJobsSortAttributeName' => [ 'base' => '

The property to sort the results by. Valid values are:

', 'refs' => [ 'ListJobsSortCriteria$AttributeName' => '

The property to sort the results by.

', ], ], 'ListJobsSortCriteria' => [ 'base' => '

Specifies criteria for sorting the results of a request for information about classification jobs.

', 'refs' => [ 'ListClassificationJobsRequest$SortCriteria' => '

The criteria to use to sort the results.

', ], ], 'ListManagedDataIdentifiersRequest' => [ 'base' => '

Specifies criteria for paginating the results of a request for information about managed data identifiers.

', 'refs' => [], ], 'ListManagedDataIdentifiersResponse' => [ 'base' => '

Provides information about the managed data identifiers that Amazon Macie currently provides.

', 'refs' => [], ], 'ListMembersResponse' => [ 'base' => '

Provides information about the accounts that are associated with an Amazon Macie administrator account.

', 'refs' => [], ], 'ListOrganizationAdminAccountsResponse' => [ 'base' => '

Provides information about the delegated Amazon Macie administrator accounts for an organization in Organizations.

', 'refs' => [], ], 'ListResourceProfileArtifactsResponse' => [ 'base' => '

Provides the results of a request for information about the S3 objects that Amazon Macie selected for analysis while performing automated sensitive data discovery for an S3 bucket. This information is available only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [], ], 'ListResourceProfileDetectionsResponse' => [ 'base' => '

Provides the results of a request for information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket while performing automated sensitive data discovery for the bucket. This information is available only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [], ], 'ListSensitivityInspectionTemplatesResponse' => [ 'base' => '

Provides the results of a request for information about the sensitivity inspection template for an Amazon Macie account. Macie uses the template\'s settings when it performs automated sensitive data discovery for the account.

', 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => '

Provides information about the tags (keys and values) that are associated with an Amazon Macie resource.

', 'refs' => [], ], 'MacieStatus' => [ 'base' => '

The status of an Amazon Macie account. Valid values are:

', 'refs' => [ 'EnableMacieRequest$Status' => '

Specifies the new status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to ENABLED.

', 'GetMacieSessionResponse$Status' => '

The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Macie activities are enabled for the account.

', 'UpdateMacieSessionRequest$Status' => '

Specifies a new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

', 'UpdateMemberSessionRequest$Status' => '

Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

', ], ], 'ManagedDataIdentifierSelector' => [ 'base' => '

The selection type that determines which managed data identifiers a classification job uses to analyze data. Valid values are:

', 'refs' => [ 'CreateClassificationJobRequest$ManagedDataIdentifierSelector' => '

The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

If you don\'t specify a value for this property, the job uses the recommended set of managed data identifiers.

If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.

For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

', 'DescribeClassificationJobResponse$ManagedDataIdentifierSelector' => '

The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:

If this value is null, the job uses the recommended set of managed data identifiers.

If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.

For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.

', ], ], 'ManagedDataIdentifierSummary' => [ 'base' => '

Provides information about a managed data identifier. For additional information, see Using managed data identifiers in the Amazon Macie User Guide.

', 'refs' => [ '__listOfManagedDataIdentifierSummary$member' => NULL, ], ], 'MatchingBucket' => [ 'base' => '

Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. By default, object count and storage size values include data for object parts that are the result of incomplete multipart uploads. For more information, see How Macie monitors Amazon S3 data security in the Amazon Macie User Guide.

If an error occurs when Macie attempts to retrieve and process information about the bucket or the bucket\'s objects, the value for most of these properties is null. Key exceptions are accountId and bucketName. To identify the cause of the error, refer to the errorCode and errorMessage values.

', 'refs' => [ 'MatchingResource$MatchingBucket' => '

The details of an S3 bucket that Amazon Macie monitors and analyzes.

', ], ], 'MatchingResource' => [ 'base' => '

Provides statistical data and other information about an Amazon Web Services resource that Amazon Macie monitors and analyzes for your account.

', 'refs' => [ '__listOfMatchingResource$member' => NULL, ], ], 'Member' => [ 'base' => '

Provides information about an account that\'s associated with an Amazon Macie administrator account.

', 'refs' => [ '__listOfMember$member' => NULL, ], ], 'MonthlySchedule' => [ 'base' => '

Specifies a monthly recurrence pattern for running a classification job.

', 'refs' => [ 'JobScheduleFrequency$MonthlySchedule' => '

Specifies a monthly recurrence pattern for running the job.

', ], ], 'NextToken' => [ 'base' => '

Specifies which page of results to return in a paginated response.

', 'refs' => [ 'ListClassificationScopesResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', ], ], 'ObjectCountByEncryptionType' => [ 'base' => '

Provides information about the number of objects that are in an S3 bucket and use certain types of server-side encryption, use client-side encryption, or aren\'t encrypted.

', 'refs' => [ 'BucketMetadata$ObjectCountByEncryptionType' => '

The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren\'t encrypted or use client-side encryption.

', 'MatchingBucket$ObjectCountByEncryptionType' => '

The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren\'t encrypted or use client-side encryption.

', ], ], 'ObjectLevelStatistics' => [ 'base' => '

Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can\'t analyze in one or more S3 buckets. In a BucketMetadata or MatchingBucket object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results. If versioning is enabled for a bucket, storage size values are based on the size of the latest version of each applicable object in the bucket.

', 'refs' => [ 'BucketMetadata$UnclassifiableObjectCount' => '

The total number of objects that Amazon Macie can\'t analyze in the bucket. These objects don\'t use a supported storage class or don\'t have a file name extension for a supported file or storage format.

', 'BucketMetadata$UnclassifiableObjectSizeInBytes' => '

The total storage size, in bytes, of the objects that Amazon Macie can\'t analyze in the bucket. These objects don\'t use a supported storage class or don\'t have a file name extension for a supported file or storage format.

', 'GetBucketStatisticsResponse$UnclassifiableObjectCount' => '

The total number of objects that Amazon Macie can\'t analyze in the buckets. These objects don\'t use a supported storage class or don\'t have a file name extension for a supported file or storage format.

', 'GetBucketStatisticsResponse$UnclassifiableObjectSizeInBytes' => '

The total storage size, in bytes, of the objects that Amazon Macie can\'t analyze in the buckets. These objects don\'t use a supported storage class or don\'t have a file name extension for a supported file or storage format.

', 'MatchingBucket$UnclassifiableObjectCount' => '

The total number of objects that Amazon Macie can\'t analyze in the bucket. These objects don\'t use a supported storage class or don\'t have a file name extension for a supported file or storage format.

', 'MatchingBucket$UnclassifiableObjectSizeInBytes' => '

The total storage size, in bytes, of the objects that Amazon Macie can\'t analyze in the bucket. These objects don\'t use a supported storage class or don\'t have a file name extension for a supported file or storage format.

', ], ], 'Occurrences' => [ 'base' => '

Specifies the location of 1-15 occurrences of sensitive data that was detected by a managed data identifier or a custom data identifier and produced a sensitive data finding.

', 'refs' => [ 'CustomDetection$Occurrences' => '

The location of 1-15 occurrences of the sensitive data that the custom data identifier detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.

', 'DefaultDetection$Occurrences' => '

The location of 1-15 occurrences of the sensitive data that was detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.

', ], ], 'OrderBy' => [ 'base' => NULL, 'refs' => [ 'BucketSortCriteria$OrderBy' => '

The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

', 'FindingStatisticsSortCriteria$OrderBy' => '

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

', 'ListJobsSortCriteria$OrderBy' => '

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

', 'SearchResourcesSortCriteria$OrderBy' => '

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

', 'SortCriteria$OrderBy' => '

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

', 'UsageStatisticsSortBy$OrderBy' => '

The sort order to apply to the results, based on the value for the field specified by the key property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

', ], ], 'OriginType' => [ 'base' => '

Specifies how Amazon Macie found the sensitive data that produced a finding. Possible values are:

', 'refs' => [ 'ClassificationDetails$OriginType' => '

Specifies how Amazon Macie found the sensitive data that produced the finding. Possible values are: SENSITIVE_DATA_DISCOVERY_JOB, for a classification job; and, AUTOMATED_SENSITIVE_DATA_DISCOVERY, for automated sensitive data discovery.

', ], ], 'Page' => [ 'base' => '

Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.

', 'refs' => [ 'Pages$member' => NULL, ], ], 'Pages' => [ 'base' => '

Specifies the location of occurrences of sensitive data in an Adobe Portable Document Format file.

', 'refs' => [ 'Occurrences$Pages' => '

An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.

Each Page object specifies a page that contains the sensitive data.

', ], ], 'PolicyDetails' => [ 'base' => '

Provides the details of a policy finding.

', 'refs' => [ 'Finding$PolicyDetails' => '

The details of a policy finding. This value is null for a sensitive data finding.

', ], ], 'PutClassificationExportConfigurationRequest' => [ 'base' => '

Specifies where to store data classification results, and the encryption settings to use when storing results in that location.

', 'refs' => [], ], 'PutClassificationExportConfigurationResponse' => [ 'base' => '

Provides information about updated settings for storing data classification results.

', 'refs' => [], ], 'PutFindingsPublicationConfigurationRequest' => [ 'base' => '

Specifies configuration settings for publishing findings to Security Hub automatically.

', 'refs' => [], ], 'Range' => [ 'base' => '

Specifies the location of an occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file.

', 'refs' => [ 'Page$LineRange' => '

Reserved for future use.

', 'Page$OffsetRange' => '

Reserved for future use.

', 'Ranges$member' => NULL, ], ], 'Ranges' => [ 'base' => '

Specifies the locations of occurrences of sensitive data in a non-binary text file.

', 'refs' => [ 'Occurrences$LineRanges' => '

An array of objects, one for each occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.

This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.

', 'Occurrences$OffsetRanges' => '

Reserved for future use.

', ], ], 'Record' => [ 'base' => '

Specifies the location of an occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file.

', 'refs' => [ 'Records$member' => NULL, ], ], 'Records' => [ 'base' => '

Specifies the locations of occurrences of sensitive data in an Apache Avro object container or a structured data file.

', 'refs' => [ 'Occurrences$Records' => '

An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.

For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.

', ], ], 'RelationshipStatus' => [ 'base' => '

The current status of the relationship between an account and an associated Amazon Macie administrator account. Possible values are:

', 'refs' => [ 'GetMemberResponse$RelationshipStatus' => '

The current status of the relationship between the account and the administrator account.

', 'Invitation$RelationshipStatus' => '

The status of the relationship between the account that sent the invitation and the account that received the invitation.

', 'Member$RelationshipStatus' => '

The current status of the relationship between the account and the administrator account.

', ], ], 'ReplicationDetails' => [ 'base' => '

Provides information about settings that define whether one or more objects in an S3 bucket are replicated to S3 buckets for other Amazon Web Services accounts and, if so, which accounts.

', 'refs' => [ 'BucketMetadata$ReplicationDetails' => '

Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

Provides information about an error that occurred because a specified resource wasn\'t found.

', 'refs' => [], ], 'ResourceProfileArtifact' => [ 'base' => '

Provides information about an S3 object that Amazon Macie selected for analysis while performing automated sensitive data discovery for an S3 bucket, and the status and results of the analysis. This information is available only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [ '__listOfResourceProfileArtifact$member' => NULL, ], ], 'ResourceStatistics' => [ 'base' => '

Provides statistical data for sensitive data discovery metrics that apply to an S3 bucket that Amazon Macie monitors and analyzes for your account. The statistics capture the results of automated sensitive data discovery activities that Macie has performed for the bucket. The data is available only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [ 'GetResourceProfileResponse$Statistics' => '

The sensitive data discovery statistics for the bucket. The statistics capture the results of automated sensitive data discovery activities that Amazon Macie has performed for the bucket.

', ], ], 'ResourcesAffected' => [ 'base' => '

Provides information about the resources that a finding applies to.

', 'refs' => [ 'Finding$ResourcesAffected' => '

The resources that the finding applies to.

', ], ], 'RevealConfiguration' => [ 'base' => '

Specifies the configuration settings for retrieving occurrences of sensitive data reported by findings, and the status of the configuration for an Amazon Macie account. When you enable the configuration for the first time, your request must specify an Key Management Service (KMS) key. Otherwise, an error occurs. Macie uses the specified key to encrypt the sensitive data that you retrieve.

', 'refs' => [ 'GetRevealConfigurationResponse$Configuration' => '

The current configuration settings and the status of the configuration for the account.

', 'UpdateRevealConfigurationRequest$Configuration' => '

The new configuration settings and the status of the configuration for the account.

', 'UpdateRevealConfigurationResponse$Configuration' => '

The new configuration settings and the status of the configuration for the account.

', ], ], 'RevealRequestStatus' => [ 'base' => '

The status of a request to retrieve occurrences of sensitive data reported by a finding. Possible values are:

', 'refs' => [ 'GetSensitiveDataOccurrencesResponse$Status' => '

The status of the request to retrieve occurrences of sensitive data reported by the finding. Possible values are:

', ], ], 'RevealStatus' => [ 'base' => '

The status of the configuration for retrieving occurrences of sensitive data reported by findings. Valid values are:

', 'refs' => [ 'RevealConfiguration$Status' => '

The status of the configuration for the Amazon Macie account. In a request, valid values are: ENABLED, enable the configuration for the account; and, DISABLED, disable the configuration for the account. In a response, possible values are: ENABLED, the configuration is currently enabled for the account; and, DISABLED, the configuration is currently disabled for the account.

', ], ], 'S3Bucket' => [ 'base' => '

Provides information about the S3 bucket that a finding applies to.

', 'refs' => [ 'ResourcesAffected$S3Bucket' => '

The details of the S3 bucket that the finding applies to.

', ], ], 'S3BucketCriteriaForJob' => [ 'base' => '

Specifies property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job. Exclude conditions take precedence over include conditions.

', 'refs' => [ 'JobSummary$BucketCriteria' => '

The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job\'s analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job\'s definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

', 'S3JobDefinition$BucketCriteria' => '

The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which buckets contain objects to analyze. A job\'s definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

', ], ], 'S3BucketDefinitionForJob' => [ 'base' => '

Specifies an Amazon Web Services account that owns S3 buckets for a classification job to analyze, and one or more specific buckets to analyze for that account.

', 'refs' => [ '__listOfS3BucketDefinitionForJob$member' => NULL, ], ], 'S3BucketName' => [ 'base' => '

The name of an S3 bucket.

', 'refs' => [ '__listOfS3BucketName$member' => NULL, ], ], 'S3BucketOwner' => [ 'base' => '

Provides information about the Amazon Web Services account that owns an S3 bucket.

', 'refs' => [ 'S3Bucket$Owner' => '

The display name and canonical user ID for the Amazon Web Services account that owns the bucket.

', ], ], 'S3ClassificationScope' => [ 'base' => '

Specifies the S3 buckets that are excluded from automated sensitive data discovery for an Amazon Macie account.

', 'refs' => [ 'GetClassificationScopeResponse$S3' => '

The S3 buckets that are excluded from automated sensitive data discovery.

', ], ], 'S3ClassificationScopeExclusion' => [ 'base' => '

Specifies the names of the S3 buckets that are excluded from automated sensitive data discovery.

', 'refs' => [ 'S3ClassificationScope$Excludes' => '

The S3 buckets that are excluded.

', ], ], 'S3ClassificationScopeExclusionUpdate' => [ 'base' => '

Specifies S3 buckets to add or remove from the exclusion list defined by the classification scope for an Amazon Macie account.

', 'refs' => [ 'S3ClassificationScopeUpdate$Excludes' => '

The names of the S3 buckets to add or remove from the list.

', ], ], 'S3ClassificationScopeUpdate' => [ 'base' => '

Specifies changes to the list of S3 buckets that are excluded from automated sensitive data discovery for an Amazon Macie account.

', 'refs' => [ 'UpdateClassificationScopeRequest$S3' => '

The S3 buckets to add or remove from the exclusion list defined by the classification scope.

', ], ], 'S3Destination' => [ 'base' => '

Specifies an S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.

', 'refs' => [ 'ClassificationExportConfiguration$S3Destination' => '

The S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.

', ], ], 'S3JobDefinition' => [ 'base' => '

Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis. The bucket specification can be static (bucketDefinitions) or dynamic (bucketCriteria). If it\'s static, the job analyzes objects in the same predefined set of buckets each time the job runs. If it\'s dynamic, the job analyzes objects in any buckets that match the specified criteria each time the job starts to run.

', 'refs' => [ 'CreateClassificationJobRequest$S3JobDefinition' => '

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

', 'DescribeClassificationJobResponse$S3JobDefinition' => '

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

', ], ], 'S3Object' => [ 'base' => '

Provides information about the S3 object that a finding applies to.

', 'refs' => [ 'ResourcesAffected$S3Object' => '

The details of the S3 object that the finding applies to.

', ], ], 'S3WordsList' => [ 'base' => '

Provides information about an S3 object that lists specific text to ignore.

', 'refs' => [ 'AllowListCriteria$S3WordsList' => '

The location and name of the S3 object that lists specific text to ignore.

', ], ], 'ScopeFilterKey' => [ 'base' => '

The property to use in a condition that determines whether an S3 object is included or excluded from a classification job. Valid values are:

', 'refs' => [ 'SimpleScopeTerm$Key' => '

The object property to use in the condition.

', ], ], 'Scoping' => [ 'base' => '

Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job. Exclude conditions take precedence over include conditions.

', 'refs' => [ 'S3JobDefinition$Scoping' => '

The property- and tag-based conditions that determine which S3 objects to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which objects to analyze.

', ], ], 'SearchResourcesBucketCriteria' => [ 'base' => '

Specifies property- and tag-based conditions that define filter criteria for including or excluding S3 buckets from the query results. Exclude conditions take precedence over include conditions.

', 'refs' => [ 'SearchResourcesRequest$BucketCriteria' => '

The filter conditions that determine which S3 buckets to include or exclude from the query results.

', ], ], 'SearchResourcesComparator' => [ 'base' => '

The operator to use in a condition that filters the results of a query. Valid values are:

', 'refs' => [ 'SearchResourcesSimpleCriterion$Comparator' => '

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

', 'SearchResourcesTagCriterion$Comparator' => '

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

', ], ], 'SearchResourcesCriteria' => [ 'base' => '

Specifies a property- or tag-based filter condition for including or excluding Amazon Web Services resources from the query results.

', 'refs' => [ '__listOfSearchResourcesCriteria$member' => NULL, ], ], 'SearchResourcesCriteriaBlock' => [ 'base' => '

Specifies property- and tag-based conditions that define filter criteria for including or excluding Amazon Web Services resources from the query results.

', 'refs' => [ 'SearchResourcesBucketCriteria$Excludes' => '

The property- and tag-based conditions that determine which buckets to exclude from the results.

', 'SearchResourcesBucketCriteria$Includes' => '

The property- and tag-based conditions that determine which buckets to include in the results.

', ], ], 'SearchResourcesRequest' => [ 'base' => '

Specifies criteria for filtering, sorting, and paginating the results of a query for statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

', 'refs' => [], ], 'SearchResourcesResponse' => [ 'base' => '

Provides the results of a query that retrieved statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes for your account.

', 'refs' => [], ], 'SearchResourcesSimpleCriterion' => [ 'base' => '

Specifies a property-based filter condition that determines which Amazon Web Services resources are included or excluded from the query results.

', 'refs' => [ 'SearchResourcesCriteria$SimpleCriterion' => '

A property-based condition that defines a property, operator, and one or more values for including or excluding resources from the results.

', ], ], 'SearchResourcesSimpleCriterionKey' => [ 'base' => '

The property to use in a condition that filters the query results. Valid values are:

', 'refs' => [ 'SearchResourcesSimpleCriterion$Key' => '

The property to use in the condition.

', ], ], 'SearchResourcesSortAttributeName' => [ 'base' => '

The property to sort the query results by. Valid values are:

', 'refs' => [ 'SearchResourcesSortCriteria$AttributeName' => '

The property to sort the results by.

', ], ], 'SearchResourcesSortCriteria' => [ 'base' => '

Specifies criteria for sorting the results of a query for information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

', 'refs' => [ 'SearchResourcesRequest$SortCriteria' => '

The criteria to use to sort the results.

', ], ], 'SearchResourcesTagCriterion' => [ 'base' => '

Specifies a tag-based filter condition that determines which Amazon Web Services resources are included or excluded from the query results.

', 'refs' => [ 'SearchResourcesCriteria$TagCriterion' => '

A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding resources from the results.

', ], ], 'SearchResourcesTagCriterionPair' => [ 'base' => '

Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a tag-based filter condition for a query. Tag keys and values are case sensitive. Also, Amazon Macie doesn\'t support use of partial values or wildcard characters in tag-based filter conditions.

', 'refs' => [ '__listOfSearchResourcesTagCriterionPair$member' => NULL, ], ], 'SecurityHubConfiguration' => [ 'base' => '

Specifies configuration settings that determine which findings are published to Security Hub automatically. For information about how Macie publishes findings to Security Hub, see Amazon Macie integration with Security Hub in the Amazon Macie User Guide.

', 'refs' => [ 'GetFindingsPublicationConfigurationResponse$SecurityHubConfiguration' => '

The configuration settings that determine which findings are published to Security Hub.

', 'PutFindingsPublicationConfigurationRequest$SecurityHubConfiguration' => '

The configuration settings that determine which findings to publish to Security Hub.

', ], ], 'SensitiveData' => [ 'base' => '

Provides information about the category and number of occurrences of sensitive data that produced a finding.

', 'refs' => [ 'ClassificationResult$SensitiveData' => '

The category, types, and number of occurrences of the sensitive data that produced the finding.

', ], ], 'SensitiveDataItem' => [ 'base' => '

Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.

', 'refs' => [ 'SensitiveData$member' => NULL, ], ], 'SensitiveDataItemCategory' => [ 'base' => '

For a finding, the category of sensitive data that was detected and produced the finding. For a managed data identifier, the category of sensitive data that the managed data identifier detects. Possible values are:

', 'refs' => [ 'ManagedDataIdentifierSummary$Category' => '

The category of sensitive data that the managed data identifier detects: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

', 'SensitiveDataItem$Category' => '

The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

', ], ], 'SensitiveDataOccurrences' => [ 'base' => '

Specifies a type of sensitive data reported by a finding and provides occurrences of the specified type of sensitive data.

', 'refs' => [ 'GetSensitiveDataOccurrencesResponse$SensitiveDataOccurrences' => '

A map that specifies 1-100 types of sensitive data reported by the finding and, for each type, 1-10 occurrences of sensitive data.

', ], ], 'SensitivityAggregations' => [ 'base' => '

Provides aggregated statistical data for sensitive data discovery metrics that apply to S3 buckets. Each field contains aggregated data for all the buckets that have a sensitivity score (sensitivityScore) of a specified value or within a specified range (BucketStatisticsBySensitivity). If automated sensitive data discovery is currently disabled for your account, the value for each field is 0.

', 'refs' => [ 'BucketStatisticsBySensitivity$ClassificationError' => '

The aggregated statistical data for all buckets that have a sensitivity score of -1.

', 'BucketStatisticsBySensitivity$NotClassified' => '

The aggregated statistical data for all buckets that have a sensitivity score of 50.

', 'BucketStatisticsBySensitivity$NotSensitive' => '

The aggregated statistical data for all buckets that have a sensitivity score of 1-49.

', 'BucketStatisticsBySensitivity$Sensitive' => '

The aggregated statistical data for all buckets that have a sensitivity score of 51-100.

', ], ], 'SensitivityInspectionTemplateExcludes' => [ 'base' => '

Specifies managed data identifiers to exclude (not use) when performing automated sensitive data discovery for an Amazon Macie account. For information about the managed data identifiers that Amazon Macie currently provides, see Using managed data identifiers in the Amazon Macie User Guide.

', 'refs' => [ 'GetSensitivityInspectionTemplateResponse$Excludes' => '

The managed data identifiers that are explicitly excluded (not used) when analyzing data.

', 'UpdateSensitivityInspectionTemplateRequest$Excludes' => '

The managed data identifiers to explicitly exclude (not use) when analyzing data.

To exclude an allow list or custom data identifier that\'s currently included by the template, update the values for the SensitivityInspectionTemplateIncludes.allowListIds and SensitivityInspectionTemplateIncludes.customDataIdentifierIds properties, respectively.

', ], ], 'SensitivityInspectionTemplateId' => [ 'base' => '

The unique identifier for the sensitivity inspection template.

', 'refs' => [ 'GetAutomatedDiscoveryConfigurationResponse$SensitivityInspectionTemplateId' => '

The unique identifier for the sensitivity inspection template that\'s used when performing automated sensitive data discovery for the account. The template specifies which allow lists, custom data identifiers, and managed data identifiers to use when analyzing data.

', 'GetSensitivityInspectionTemplateResponse$SensitivityInspectionTemplateId' => '

The unique identifier for the template.

', ], ], 'SensitivityInspectionTemplateIncludes' => [ 'base' => '

Specifies the allow lists, custom data identifiers, and managed data identifiers to include (use) when performing automated sensitive data discovery for an Amazon Macie account. The configuration must specify at least one custom data identifier or managed data identifier. For information about the managed data identifiers that Amazon Macie currently provides, see Using managed data identifiers in the Amazon Macie User Guide.

', 'refs' => [ 'GetSensitivityInspectionTemplateResponse$Includes' => '

The allow lists, custom data identifiers, and managed data identifiers that are included (used) when analyzing data.

', 'UpdateSensitivityInspectionTemplateRequest$Includes' => '

The allow lists, custom data identifiers, and managed data identifiers to include (use) when analyzing data.

', ], ], 'SensitivityInspectionTemplatesEntry' => [ 'base' => '

Provides information about the sensitivity inspection template for an Amazon Macie account. Macie uses the template\'s settings when it performs automated sensitive data discovery for the account.

', 'refs' => [ '__listOfSensitivityInspectionTemplatesEntry$member' => NULL, ], ], 'ServerSideEncryption' => [ 'base' => '

Provides information about the default server-side encryption settings for an S3 bucket or the encryption settings for an S3 object.

', 'refs' => [ 'S3Bucket$DefaultServerSideEncryption' => '

The default server-side encryption settings for the bucket.

', 'S3Object$ServerSideEncryption' => '

The type of server-side encryption that was used to encrypt the object.

', ], ], 'ServiceLimit' => [ 'base' => '

Specifies a current quota for an Amazon Macie account.

', 'refs' => [ 'UsageByAccount$ServiceLimit' => '

The current value for the quota that corresponds to the metric specified by the type field.

', ], ], 'ServiceQuotaExceededException' => [ 'base' => '

Provides information about an error that occurred due to one or more service quotas for an account.

', 'refs' => [], ], 'SessionContext' => [ 'base' => '

Provides information about a session that was created for an entity that performed an action by using temporary security credentials.

', 'refs' => [ 'AssumedRole$SessionContext' => '

The details of the session that was created for the credentials, including the entity that issued the session.

', 'FederatedUser$SessionContext' => '

The details of the session that was created for the credentials, including the entity that issued the session.

', ], ], 'SessionContextAttributes' => [ 'base' => '

Provides information about the context in which temporary security credentials were issued to an entity.

', 'refs' => [ 'SessionContext$Attributes' => '

The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.

', ], ], 'SessionIssuer' => [ 'base' => '

Provides information about the source and type of temporary security credentials that were issued to an entity.

', 'refs' => [ 'SessionContext$SessionIssuer' => '

The source and type of credentials that were issued to the entity.

', ], ], 'Severity' => [ 'base' => '

Provides the numerical and qualitative representations of a finding\'s severity.

', 'refs' => [ 'Finding$Severity' => '

The severity level and score for the finding.

', ], ], 'SeverityDescription' => [ 'base' => '

The qualitative representation of the finding\'s severity. Possible values are:

', 'refs' => [ 'Severity$Description' => '

The qualitative representation of the finding\'s severity, ranging from Low (least severe) to High (most severe).

', ], ], 'SeverityLevel' => [ 'base' => '

Specifies a severity level for findings that a custom data identifier produces. A severity level determines which severity is assigned to the findings, based on the number of occurrences of text that match the custom data identifier\'s detection criteria.

', 'refs' => [ 'SeverityLevelList$member' => NULL, ], ], 'SeverityLevelList' => [ 'base' => '

The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier\'s detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn\'t create a finding.

If you don\'t specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie automatically assigns the MEDIUM severity to those findings.

', 'refs' => [ 'CreateCustomDataIdentifierRequest$SeverityLevels' => '

The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier\'s detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn\'t create a finding.

If you don\'t specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

', 'GetCustomDataIdentifierResponse$SeverityLevels' => '

Specifies the severity that\'s assigned to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier\'s detection criteria. By default, Amazon Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

', ], ], 'SharedAccess' => [ 'base' => NULL, 'refs' => [ 'BucketMetadata$SharedAccess' => '

Specifies whether the bucket is shared with another Amazon Web Services account, an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access control (OAC). Possible values are:

An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

', ], ], 'SimpleCriterionForJob' => [ 'base' => '

Specifies a property-based condition that determines whether an S3 bucket is included or excluded from a classification job.

', 'refs' => [ 'CriteriaForJob$SimpleCriterion' => '

A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.

', ], ], 'SimpleCriterionKeyForJob' => [ 'base' => '

The property to use in a condition that determines whether an S3 bucket is included or excluded from a classification job. Valid values are:

', 'refs' => [ 'SimpleCriterionForJob$Key' => '

The property to use in the condition.

', ], ], 'SimpleScopeTerm' => [ 'base' => '

Specifies a property-based condition that determines whether an S3 object is included or excluded from a classification job.

', 'refs' => [ 'JobScopeTerm$SimpleScopeTerm' => '

A property-based condition that defines a property, operator, and one or more values for including or excluding objects from the job.

', ], ], 'SortCriteria' => [ 'base' => '

Specifies criteria for sorting the results of a request for findings.

', 'refs' => [ 'GetFindingsRequest$SortCriteria' => '

The criteria for sorting the results of the request.

', 'ListFindingsRequest$SortCriteria' => '

The criteria to use to sort the results.

', ], ], 'Statistics' => [ 'base' => '

Provides processing statistics for a classification job.

', 'refs' => [ 'DescribeClassificationJobResponse$Statistics' => '

The number of times that the job has run and processing statistics for the job\'s current run.

', ], ], 'StorageClass' => [ 'base' => '

The storage class of the S3 object. Possible values are:

', 'refs' => [ 'S3Object$StorageClass' => '

The storage class of the object.

', ], ], 'SuppressDataIdentifier' => [ 'base' => '

Specifies a custom data identifier or managed data identifier that detected a type of sensitive data to start excluding or including in an S3 bucket\'s sensitivity score.

', 'refs' => [ '__listOfSuppressDataIdentifier$member' => NULL, ], ], 'TagCriterionForJob' => [ 'base' => '

Specifies a tag-based condition that determines whether an S3 bucket is included or excluded from a classification job.

', 'refs' => [ 'CriteriaForJob$TagCriterion' => '

A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.

', ], ], 'TagCriterionPairForJob' => [ 'base' => '

Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a tag-based condition that determines whether an S3 bucket is included or excluded from a classification job. Tag keys and values are case sensitive. Also, Amazon Macie doesn\'t support use of partial values or wildcard characters in tag-based conditions.

', 'refs' => [ '__listOfTagCriterionPairForJob$member' => NULL, ], ], 'TagMap' => [ 'base' => '

A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.

', 'refs' => [ 'CreateAllowListRequest$Tags' => '

A map of key-value pairs that specifies the tags to associate with the allow list.

An allow list can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

', 'CreateClassificationJobRequest$Tags' => '

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

', 'CreateCustomDataIdentifierRequest$Tags' => '

A map of key-value pairs that specifies the tags to associate with the custom data identifier.

A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

', 'CreateFindingsFilterRequest$Tags' => '

A map of key-value pairs that specifies the tags to associate with the filter.

A findings filter can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

', 'CreateMemberRequest$Tags' => '

A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.

An account can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

', 'DescribeClassificationJobResponse$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

', 'FindingsFilterListItem$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.

', 'GetAllowListResponse$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the allow list.

', 'GetCustomDataIdentifierResponse$Tags' => '

A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.

', 'GetFindingsFilterResponse$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.

', 'GetMemberResponse$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the account in Amazon Macie.

', 'ListTagsForResourceResponse$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the resource.

', 'Member$Tags' => '

A map of key-value pairs that specifies which tags (keys and values) are associated with the account in Amazon Macie.

', 'TagResourceRequest$Tags' => '

A map of key-value pairs that specifies the tags to associate with the resource.

A resource can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

', ], ], 'TagResourceRequest' => [ 'base' => '

Specifies the tags (keys and values) to associate with an Amazon Macie resource.

', 'refs' => [], ], 'TagResourceResponse' => [ 'base' => '

The request succeeded. The specified tags were added or updated for the resource.

', 'refs' => [], ], 'TagScopeTerm' => [ 'base' => '

Specifies a tag-based condition that determines whether an S3 object is included or excluded from a classification job.

', 'refs' => [ 'JobScopeTerm$TagScopeTerm' => '

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding objects from the job.

', ], ], 'TagTarget' => [ 'base' => '

The type of object to apply a tag-based condition to. Valid values are:

', 'refs' => [ 'TagScopeTerm$Target' => '

The type of object to apply the condition to.

', ], ], 'TagValuePair' => [ 'base' => '

Specifies a tag key or tag key and value pair to use in a tag-based condition that determines whether an S3 object is included or excluded from a classification job. Tag keys and values are case sensitive. Also, Amazon Macie doesn\'t support use of partial values or wildcard characters in tag-based conditions.

', 'refs' => [ '__listOfTagValuePair$member' => NULL, ], ], 'TestCustomDataIdentifierRequest' => [ 'base' => '

Specifies the detection criteria of a custom data identifier to test.

', 'refs' => [], ], 'TestCustomDataIdentifierResponse' => [ 'base' => '

Provides test results for a custom data identifier.

', 'refs' => [], ], 'ThrottlingException' => [ 'base' => '

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

', 'refs' => [], ], 'TimeRange' => [ 'base' => '

An inclusive time period that Amazon Macie usage data applies to. Possible values are:

', 'refs' => [ 'GetUsageStatisticsRequest$TimeRange' => '

The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don\'t specify a value, Amazon Macie provides usage data for the preceding 30 days.

', 'GetUsageStatisticsResponse$TimeRange' => '

The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

', 'GetUsageTotalsResponse$TimeRange' => '

The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

', ], ], 'Timestamp' => [ 'base' => '

Specifies a date and time in UTC and extended ISO 8601 format.

', 'refs' => [ 'GetAutomatedDiscoveryConfigurationResponse$DisabledAt' => '

The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently disabled for the account. This value is null if automated sensitive data discovery wasn\'t enabled and subsequently disabled for the account.

', 'GetAutomatedDiscoveryConfigurationResponse$FirstEnabledAt' => '

The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was initially enabled for the account. This value is null if automated sensitive data discovery has never been enabled for the account.

', 'GetAutomatedDiscoveryConfigurationResponse$LastUpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently enabled or disabled for the account.

', ], ], 'Type' => [ 'base' => NULL, 'refs' => [ 'BucketServerSideEncryption$Type' => '

The server-side encryption algorithm that\'s used by default to encrypt objects that are added to the bucket. Possible values are:

', ], ], 'UnavailabilityReasonCode' => [ 'base' => '

Specifies why occurrences of sensitive data can\'t be retrieved for a finding. Possible values are:

', 'refs' => [ '__listOfUnavailabilityReasonCode$member' => NULL, ], ], 'Unit' => [ 'base' => NULL, 'refs' => [ 'ServiceLimit$Unit' => '

The unit of measurement for the value specified by the value field.

', ], ], 'UnprocessableEntityException' => [ 'base' => '

Provides information about an error that occurred due to an unprocessable entity.

', 'refs' => [], ], 'UnprocessedAccount' => [ 'base' => '

Provides information about an account-related request that hasn\'t been processed.

', 'refs' => [ '__listOfUnprocessedAccount$member' => NULL, ], ], 'UntagResourceResponse' => [ 'base' => '

The request succeeded. The specified tags were removed from the resource.

', 'refs' => [], ], 'UpdateAllowListRequest' => [ 'base' => '

Changes the settings for an allow list. If you change the list\'s criteria, Amazon Macie tests the new criteria when it processes your request. If the criteria specify a regular expression that Macie can\'t compile or an S3 object that Macie can\'t retrieve or parse, an error occurs.

', 'refs' => [], ], 'UpdateAllowListResponse' => [ 'base' => '

Provides information about an allow list whose settings were changed in response to a request.

', 'refs' => [], ], 'UpdateAutomatedDiscoveryConfigurationRequest' => [ 'base' => '

Enables or disables automated sensitive data discovery for an Amazon Macie account.

', 'refs' => [], ], 'UpdateClassificationJobRequest' => [ 'base' => '

Changes the status of a classification job. For more information about pausing, resuming, or cancelling jobs, see Managing sensitive data discovery jobs in the Amazon Macie User Guide.

', 'refs' => [], ], 'UpdateClassificationScopeRequest' => [ 'base' => '

Specifies new classification scope settings for an Amazon Macie account. Macie uses these settings when it performs automated sensitive data discovery for the account. To update the settings, automated sensitive data discovery must currently be enabled for the account.

', 'refs' => [], ], 'UpdateFindingsFilterRequest' => [ 'base' => '

Specifies the criteria and other settings for a findings filter.

', 'refs' => [], ], 'UpdateFindingsFilterResponse' => [ 'base' => '

Provides information about a findings filter that was updated in response to a request.

', 'refs' => [], ], 'UpdateMacieSessionRequest' => [ 'base' => '

Changes the status or configuration settings for an Amazon Macie account.

', 'refs' => [], ], 'UpdateMemberSessionRequest' => [ 'base' => '

Suspends (pauses) or re-enables Amazon Macie for a member account.

', 'refs' => [], ], 'UpdateOrganizationConfigurationRequest' => [ 'base' => '

Specifies whether to enable Amazon Macie automatically for accounts that are added to an organization in Organizations.

', 'refs' => [], ], 'UpdateResourceProfileDetectionsRequest' => [ 'base' => '

Updates the sensitivity scoring settings for an S3 bucket that Amazon Macie monitors and analyzes for your account. The settings specify whether to exclude or include occurrences of specific types of sensitive data in calculations of the bucket\'s sensitivity score. You can update the settings only if automated sensitive data discovery is currently enabled for your account.

', 'refs' => [], ], 'UpdateResourceProfileRequest' => [ 'base' => '

Specifies a new sensitivity score for an S3 bucket that Amazon Macie monitors and analyzes for your account. To update the score, automated sensitive data discovery must currently be enabled for your account.

', 'refs' => [], ], 'UpdateRevealConfigurationRequest' => [ 'base' => '

Specifies the configuration settings for retrieving occurrences of sensitive data reported by findings, and the status of the configuration for an Amazon Macie account.

', 'refs' => [], ], 'UpdateRevealConfigurationResponse' => [ 'base' => '

Provides information about updated configuration settings for retrieving occurrences of sensitive data reported by findings, and the status of the configuration for an Amazon Macie account.

', 'refs' => [], ], 'UpdateSensitivityInspectionTemplateRequest' => [ 'base' => '

Specifies settings for the sensitivity inspection template for an Amazon Macie account. Macie uses the template\'s settings when it performs automated sensitive data discovery for the account. To update the settings, automated sensitive data discovery must currently be enabled for the account.

', 'refs' => [], ], 'UsageByAccount' => [ 'base' => '

Provides data for a specific usage metric and the corresponding quota for an Amazon Macie account.

', 'refs' => [ '__listOfUsageByAccount$member' => NULL, ], ], 'UsageRecord' => [ 'base' => '

Provides quota and aggregated usage data for an Amazon Macie account.

', 'refs' => [ '__listOfUsageRecord$member' => NULL, ], ], 'UsageStatisticsFilter' => [ 'base' => '

Specifies a condition for filtering the results of a query for quota and usage data for one or more Amazon Macie accounts.

', 'refs' => [ '__listOfUsageStatisticsFilter$member' => NULL, ], ], 'UsageStatisticsFilterComparator' => [ 'base' => '

The operator to use in a condition that filters the results of a query for Amazon Macie account quotas and usage data. Valid values are:

', 'refs' => [ 'UsageStatisticsFilter$Comparator' => '

The operator to use in the condition. If the value for the key property is accountId, this value must be CONTAINS. If the value for the key property is any other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE.

', ], ], 'UsageStatisticsFilterKey' => [ 'base' => '

The field to use in a condition that filters the results of a query for Amazon Macie account quotas and usage data. Valid values are:

', 'refs' => [ 'UsageStatisticsFilter$Key' => '

The field to use in the condition.

', ], ], 'UsageStatisticsSortBy' => [ 'base' => '

Specifies criteria for sorting the results of a query for Amazon Macie account quotas and usage data.

', 'refs' => [ 'GetUsageStatisticsRequest$SortBy' => '

The criteria to use to sort the query results.

', ], ], 'UsageStatisticsSortKey' => [ 'base' => '

The field to use to sort the results of a query for Amazon Macie account quotas and usage data. Valid values are:

', 'refs' => [ 'UsageStatisticsSortBy$Key' => '

The field to sort the results by.

', ], ], 'UsageTotal' => [ 'base' => '

Provides aggregated data for an Amazon Macie usage metric. The value for the metric reports estimated usage data for an account for the preceding 30 days or the current calendar month to date, depending on the time period (timeRange) specified in the request.

', 'refs' => [ '__listOfUsageTotal$member' => NULL, ], ], 'UsageType' => [ 'base' => '

The name of an Amazon Macie usage metric for an account. Possible values are:

', 'refs' => [ 'UsageByAccount$Type' => '

The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.

', 'UsageTotal$Type' => '

The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.

', ], ], 'UserIdentity' => [ 'base' => '

Provides information about the type and other characteristics of an entity that performed an action on an affected resource.

', 'refs' => [ 'FindingActor$UserIdentity' => '

The type and other characteristics of the entity that performed the action on the affected resource.

', ], ], 'UserIdentityRoot' => [ 'base' => '

Provides information about an Amazon Web Services account and entity that performed an action on an affected resource. The action was performed using the credentials for your Amazon Web Services account.

', 'refs' => [ 'UserIdentity$Root' => '

If the action was performed using the credentials for your Amazon Web Services account, the details of your account.

', ], ], 'UserIdentityType' => [ 'base' => '

The type of entity that performed the action on the affected resource. Possible values are:

', 'refs' => [ 'UserIdentity$Type' => '

The type of entity that performed the action.

', ], ], 'UserPausedDetails' => [ 'base' => '

Provides information about when a classification job was paused. For a one-time job, this object also specifies when the job will expire and be cancelled if it isn\'t resumed. For a recurring job, this object also specifies when the paused job run will expire and be cancelled if it isn\'t resumed. This object is present only if a job\'s current status (jobStatus) is USER_PAUSED. The information in this object applies only to a job that was paused while it had a status of RUNNING.

', 'refs' => [ 'DescribeClassificationJobResponse$UserPausedDetails' => '

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn\'t resumed. This value is present only if the value for jobStatus is USER_PAUSED.

', 'JobSummary$UserPausedDetails' => '

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn\'t resumed. This value is present only if the value for jobStatus is USER_PAUSED.

', ], ], 'ValidationException' => [ 'base' => '

Provides information about an error that occurred due to a syntax error in a request.

', 'refs' => [], ], 'WeeklySchedule' => [ 'base' => '

Specifies a weekly recurrence pattern for running a classification job.

', 'refs' => [ 'JobScheduleFrequency$WeeklySchedule' => '

Specifies a weekly recurrence pattern for running the job.

', ], ], '__boolean' => [ 'base' => NULL, 'refs' => [ 'AccessControlList$AllowsPublicReadAccess' => '

Specifies whether the ACL grants the general public with read access permissions for the bucket.

', 'AccessControlList$AllowsPublicWriteAccess' => '

Specifies whether the ACL grants the general public with write access permissions for the bucket.

', 'BatchGetCustomDataIdentifierSummary$Deleted' => '

Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn\'t delete it permanently. Instead, it soft deletes the identifier.

', 'BlockPublicAccess$BlockPublicAcls' => '

Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.

', 'BlockPublicAccess$BlockPublicPolicy' => '

Specifies whether Amazon S3 blocks public bucket policies for the bucket.

', 'BlockPublicAccess$IgnorePublicAcls' => '

Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

', 'BlockPublicAccess$RestrictPublicBuckets' => '

Specifies whether Amazon S3 restricts public bucket policies for the bucket.

', 'BucketMetadata$Versioning' => '

Specifies whether versioning is enabled for the bucket.

', 'BucketPolicy$AllowsPublicReadAccess' => '

Specifies whether the bucket policy allows the general public to have read access to the bucket.

', 'BucketPolicy$AllowsPublicWriteAccess' => '

Specifies whether the bucket policy allows the general public to have write access to the bucket.

', 'ClassificationResult$AdditionalOccurrences' => '

Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.

This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation).

', 'CreateClassificationJobRequest$InitialRun' => '

For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job\'s first scheduled run, set this value to false.

If you configure the job to run only once, don\'t specify a value for this property.

', 'CreateInvitationsRequest$DisableEmailNotification' => '

Specifies whether to send the invitation as an email message. If this value is false, Amazon Macie sends the invitation (as an email message) to the email address that you specified for the recipient\'s account when you associated the account with your account. The default value is false.

', 'DescribeClassificationJobResponse$InitialRun' => '

For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job\'s first scheduled run, this value is false. This value is also false for a one-time job.

', 'DescribeOrganizationConfigurationResponse$AutoEnable' => '

Specifies whether Amazon Macie is enabled automatically for accounts that are added to the organization.

', 'DescribeOrganizationConfigurationResponse$MaxAccountLimitReached' => '

Specifies whether the maximum number of Amazon Macie member accounts are part of the organization.

', 'Detection$Suppressed' => '

Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket\'s sensitivity score.

', 'Finding$Archived' => '

Specifies whether the finding is archived (suppressed).

', 'Finding$Sample' => '

Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.

', 'GetCustomDataIdentifierResponse$Deleted' => '

Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn\'t delete it permanently. Instead, it soft deletes the identifier.

', 'GetResourceProfileResponse$SensitivityScoreOverridden' => '

Specifies whether the bucket\'s current sensitivity score was set manually. If this value is true, the score was manually changed to 100. If this value is false, the score was calculated automatically by Amazon Macie.

', 'ReplicationDetails$Replicated' => '

Specifies whether the bucket is configured to replicate one or more objects to any destination.

', 'ReplicationDetails$ReplicatedExternally' => '

Specifies whether the bucket is configured to replicate one or more objects to a bucket for an Amazon Web Services account that isn\'t part of your Amazon Macie organization. An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

', 'ResourceProfileArtifact$Sensitive' => '

Specifies whether Amazon Macie found sensitive data in the object.

', 'S3Object$PublicAccess' => '

Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.

', 'SecurityHubConfiguration$PublishClassificationFindings' => '

Specifies whether to publish sensitive data findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all sensitive data findings that weren\'t suppressed by a findings filter. The default value is false.

', 'SecurityHubConfiguration$PublishPolicyFindings' => '

Specifies whether to publish policy findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all new and updated policy findings that weren\'t suppressed by a findings filter. The default value is true.

', 'ServiceLimit$IsServiceLimited' => '

Specifies whether the account has met the quota that corresponds to the metric specified by the UsageByAccount.type field in the response.

', 'SessionContextAttributes$MfaAuthenticated' => '

Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.

', 'UpdateOrganizationConfigurationRequest$AutoEnable' => '

Specifies whether to enable Amazon Macie automatically for an account when the account is added to the organization in Organizations.

', ], ], '__double' => [ 'base' => NULL, 'refs' => [ 'IpGeoLocation$Lat' => '

The latitude coordinate of the location, rounded to four decimal places.

', 'IpGeoLocation$Lon' => '

The longitude coordinate of the location, rounded to four decimal places.

', 'Statistics$ApproximateNumberOfObjectsToProcess' => '

The approximate number of objects that the job has yet to process during its current run.

', 'Statistics$NumberOfRuns' => '

The number of times that the job has run.

', ], ], '__integer' => [ 'base' => NULL, 'refs' => [ 'BucketMetadata$SensitivityScore' => '

The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.

', 'CreateClassificationJobRequest$SamplingPercentage' => '

The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

', 'CreateCustomDataIdentifierRequest$MaximumMatchDistance' => '

The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

', 'CreateFindingsFilterRequest$Position' => '

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

', 'DescribeBucketsRequest$MaxResults' => '

The maximum number of items to include in each page of the response. The default value is 50.

', 'DescribeClassificationJobResponse$SamplingPercentage' => '

The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.

', 'GetCustomDataIdentifierResponse$MaximumMatchDistance' => '

The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. Otherwise, Macie excludes the result.

', 'GetFindingStatisticsRequest$Size' => '

The maximum number of items to include in each page of the response.

', 'GetFindingsFilterResponse$Position' => '

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

', 'GetResourceProfileResponse$SensitivityScore' => '

The current sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). By default, this score is calculated automatically based on the amount of data that Amazon Macie has analyzed in the bucket and the amount of sensitive data that Macie has found in the bucket.

', 'GetUsageStatisticsRequest$MaxResults' => '

The maximum number of items to include in each page of the response.

', 'ListClassificationJobsRequest$MaxResults' => '

The maximum number of items to include in each page of the response.

', 'ListCustomDataIdentifiersRequest$MaxResults' => '

The maximum number of items to include in each page of the response.

', 'ListFindingsRequest$MaxResults' => '

The maximum number of items to include in each page of the response.

', 'MatchingBucket$SensitivityScore' => '

The current sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.

', 'MonthlySchedule$DayOfMonth' => '

The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.

If this value exceeds the number of days in a certain month, Macie doesn\'t run the job that month. Macie runs the job only during months that have the specified day. For example, if this value is 31 and a month has only 30 days, Macie doesn\'t run the job that month. To run the job every month, specify a value that\'s less than 29.

', 'SearchResourcesRequest$MaxResults' => '

The maximum number of items to include in each page of the response. The default value is 50.

', 'TestCustomDataIdentifierRequest$MaximumMatchDistance' => '

The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

', 'TestCustomDataIdentifierResponse$MatchCount' => '

The number of occurrences of sample text that matched the criteria specified by the custom data identifier.

', 'UpdateFindingsFilterRequest$Position' => '

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

', 'UpdateResourceProfileRequest$SensitivityScoreOverride' => '

The new sensitivity score for the bucket. Valid values are: 100, assign the maximum score and apply the Sensitive label to the bucket; and, null (empty), assign a score that Amazon Macie calculates automatically after you submit the request.

', ], ], '__listOfAdminAccount' => [ 'base' => NULL, 'refs' => [ 'ListOrganizationAdminAccountsResponse$AdminAccounts' => '

An array of objects, one for each delegated Amazon Macie administrator account for the organization. Only one of these accounts can have a status of ENABLED.

', ], ], '__listOfAllowListSummary' => [ 'base' => NULL, 'refs' => [ 'ListAllowListsResponse$AllowLists' => '

An array of objects, one for each allow list.

', ], ], '__listOfBatchGetCustomDataIdentifierSummary' => [ 'base' => NULL, 'refs' => [ 'BatchGetCustomDataIdentifiersResponse$CustomDataIdentifiers' => '

An array of objects, one for each custom data identifier that matches the criteria specified in the request.

', ], ], '__listOfBucketMetadata' => [ 'base' => NULL, 'refs' => [ 'DescribeBucketsResponse$Buckets' => '

An array of objects, one for each bucket that matches the filter criteria specified in the request.

', ], ], '__listOfClassificationScopeSummary' => [ 'base' => NULL, 'refs' => [ 'ListClassificationScopesResponse$ClassificationScopes' => '

An array that specifies the unique identifier and name of the classification scope for the account.

', ], ], '__listOfCriteriaForJob' => [ 'base' => NULL, 'refs' => [ 'CriteriaBlockForJob$And' => '

An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

', ], ], '__listOfCustomDataIdentifierSummary' => [ 'base' => NULL, 'refs' => [ 'ListCustomDataIdentifiersResponse$Items' => '

An array of objects, one for each custom data identifier.

', ], ], '__listOfDetectedDataDetails' => [ 'base' => NULL, 'refs' => [ 'SensitiveDataOccurrences$member' => NULL, ], ], '__listOfDetection' => [ 'base' => NULL, 'refs' => [ 'ListResourceProfileDetectionsResponse$Detections' => '

An array of objects, one for each type of sensitive data that Amazon Macie found in the bucket. Each object reports the number of occurrences of the specified type and provides information about the custom data identifier or managed data identifier that detected the data.

', ], ], '__listOfFinding' => [ 'base' => NULL, 'refs' => [ 'GetFindingsResponse$Findings' => '

An array of objects, one for each finding that matches the criteria specified in the request.

', ], ], '__listOfFindingType' => [ 'base' => NULL, 'refs' => [ 'CreateSampleFindingsRequest$FindingTypes' => '

An array of finding types, one for each type of sample finding to create. To create a sample of every type of finding that Amazon Macie supports, don\'t include this array in your request.

', ], ], '__listOfFindingsFilterListItem' => [ 'base' => NULL, 'refs' => [ 'ListFindingsFiltersResponse$FindingsFilterListItems' => '

An array of objects, one for each filter that\'s associated with the account.

', ], ], '__listOfGroupCount' => [ 'base' => NULL, 'refs' => [ 'GetFindingStatisticsResponse$CountsByGroup' => '

An array of objects, one for each group of findings that matches the filter criteria specified in the request.

', ], ], '__listOfInvitation' => [ 'base' => NULL, 'refs' => [ 'ListInvitationsResponse$Invitations' => '

An array of objects, one for each invitation that was received by the account.

', ], ], '__listOfJobScopeTerm' => [ 'base' => NULL, 'refs' => [ 'JobScopingBlock$And' => '

An array of conditions, one for each property- or tag-based condition that determines which objects to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

', ], ], '__listOfJobSummary' => [ 'base' => NULL, 'refs' => [ 'ListClassificationJobsResponse$Items' => '

An array of objects, one for each job that matches the filter criteria specified in the request.

', ], ], '__listOfKeyValuePair' => [ 'base' => NULL, 'refs' => [ 'BucketMetadata$Tags' => '

An array that specifies the tags (keys and values) that are associated with the bucket.

', ], ], '__listOfListJobsFilterTerm' => [ 'base' => NULL, 'refs' => [ 'ListJobsFilterCriteria$Excludes' => '

An array of objects, one for each condition that determines which jobs to exclude from the results.

', 'ListJobsFilterCriteria$Includes' => '

An array of objects, one for each condition that determines which jobs to include in the results.

', ], ], '__listOfManagedDataIdentifierSummary' => [ 'base' => NULL, 'refs' => [ 'ListManagedDataIdentifiersResponse$Items' => '

An array of objects, one for each managed data identifier.

', ], ], '__listOfMatchingResource' => [ 'base' => NULL, 'refs' => [ 'SearchResourcesResponse$MatchingResources' => '

An array of objects, one for each resource that matches the filter criteria specified in the request.

', ], ], '__listOfMember' => [ 'base' => NULL, 'refs' => [ 'ListMembersResponse$Members' => '

An array of objects, one for each account that\'s associated with the administrator account and matches the criteria specified in the request.

', ], ], '__listOfResourceProfileArtifact' => [ 'base' => NULL, 'refs' => [ 'ListResourceProfileArtifactsResponse$Artifacts' => '

An array of objects, one for each of 1-100 S3 objects that Amazon Macie selected for analysis.

If Macie has analyzed more than 100 objects in the bucket, Macie populates the array based on the value for the ResourceProfileArtifact.sensitive field for an object: true (sensitive), followed by false (not sensitive). Macie then populates any remaining items in the array with information about objects where the value for the ResourceProfileArtifact.classificationResultStatus field is SKIPPED.

', ], ], '__listOfS3BucketDefinitionForJob' => [ 'base' => NULL, 'refs' => [ 'JobSummary$BucketDefinitions' => '

An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job\'s definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

', 'S3JobDefinition$BucketDefinitions' => '

An array of objects, one for each Amazon Web Services account that owns specific S3 buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job\'s definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

', ], ], '__listOfS3BucketName' => [ 'base' => NULL, 'refs' => [ 'S3ClassificationScopeExclusion$BucketNames' => '

An array of strings, one for each S3 bucket that is excluded. Each string is the full name of an excluded bucket.

', 'S3ClassificationScopeExclusionUpdate$BucketNames' => '

Depending on the value specified for the update operation (ClassificationScopeUpdateOperation), an array of strings that: lists the names of buckets to add or remove from the list, or specifies a new set of bucket names that overwrites all existing names in the list. Each string must be the full name of an S3 bucket. Values are case sensitive.

', ], ], '__listOfSearchResourcesCriteria' => [ 'base' => NULL, 'refs' => [ 'SearchResourcesCriteriaBlock$And' => '

An array of objects, one for each property- or tag-based condition that includes or excludes resources from the query results. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

', ], ], '__listOfSearchResourcesTagCriterionPair' => [ 'base' => NULL, 'refs' => [ 'SearchResourcesTagCriterion$TagValues' => '

The tag keys, tag values, or tag key and value pairs to use in the condition.

', ], ], '__listOfSensitivityInspectionTemplatesEntry' => [ 'base' => NULL, 'refs' => [ 'ListSensitivityInspectionTemplatesResponse$SensitivityInspectionTemplates' => '

An array that specifies the unique identifier and name of the sensitivity inspection template for the account.

', ], ], '__listOfSuppressDataIdentifier' => [ 'base' => NULL, 'refs' => [ 'UpdateResourceProfileDetectionsRequest$SuppressDataIdentifiers' => '

An array of objects, one for each custom data identifier or managed data identifier that detected the type of sensitive data to start excluding or including in the bucket\'s score. To start including all sensitive data types in the score, don\'t specify any values for this array.

', ], ], '__listOfTagCriterionPairForJob' => [ 'base' => NULL, 'refs' => [ 'TagCriterionForJob$TagValues' => '

The tag keys, tag values, or tag key and value pairs to use in the condition.

', ], ], '__listOfTagValuePair' => [ 'base' => NULL, 'refs' => [ 'TagScopeTerm$TagValues' => '

The tag keys or tag key and value pairs to use in the condition. To specify only tag keys in a condition, specify the keys in this array and set the value for each associated tag value to an empty string.

', ], ], '__listOfUnavailabilityReasonCode' => [ 'base' => NULL, 'refs' => [ 'GetSensitiveDataOccurrencesAvailabilityResponse$Reasons' => '

Specifies why occurrences of sensitive data can\'t be retrieved for the finding. Possible values are:

This value is null if sensitive data can be retrieved for the finding.

', ], ], '__listOfUnprocessedAccount' => [ 'base' => NULL, 'refs' => [ 'CreateInvitationsResponse$UnprocessedAccounts' => '

An array of objects, one for each account whose invitation hasn\'t been processed. Each object identifies the account and explains why the invitation hasn\'t been processed for the account.

', 'DeclineInvitationsResponse$UnprocessedAccounts' => '

An array of objects, one for each account whose invitation hasn\'t been declined. Each object identifies the account and explains why the request hasn\'t been processed for that account.

', 'DeleteInvitationsResponse$UnprocessedAccounts' => '

An array of objects, one for each account whose invitation hasn\'t been deleted. Each object identifies the account and explains why the request hasn\'t been processed for that account.

', ], ], '__listOfUsageByAccount' => [ 'base' => NULL, 'refs' => [ 'UsageRecord$Usage' => '

An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.

', ], ], '__listOfUsageRecord' => [ 'base' => NULL, 'refs' => [ 'GetUsageStatisticsResponse$Records' => '

An array of objects that contains the results of the query. Each object contains the data for an account that matches the filter criteria specified in the request.

', ], ], '__listOfUsageStatisticsFilter' => [ 'base' => NULL, 'refs' => [ 'GetUsageStatisticsRequest$FilterBy' => '

An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

', ], ], '__listOfUsageTotal' => [ 'base' => NULL, 'refs' => [ 'GetUsageTotalsResponse$UsageTotals' => '

An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.

', ], ], '__listOf__string' => [ 'base' => NULL, 'refs' => [ 'BatchGetCustomDataIdentifiersRequest$Ids' => '

An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.

', 'BatchGetCustomDataIdentifiersResponse$NotFoundIdentifierIds' => '

An array of custom data identifier IDs, one for each custom data identifier that was specified in the request but doesn\'t correlate to an existing custom data identifier.

', 'BucketCriteriaAdditionalProperties$Eq' => '

The value for the property matches (equals) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

', 'BucketCriteriaAdditionalProperties$Neq' => '

The value for the property doesn\'t match (doesn\'t equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

', 'CreateClassificationJobRequest$AllowListIds' => '

An array of unique identifiers, one for each allow list for the job to use when it analyzes data.

', 'CreateClassificationJobRequest$CustomDataIdentifierIds' => '

An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don\'t specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

', 'CreateClassificationJobRequest$ManagedDataIdentifierIds' => '

An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).

To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

', 'CreateCustomDataIdentifierRequest$IgnoreWords' => '

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

', 'CreateCustomDataIdentifierRequest$Keywords' => '

An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren\'t case sensitive.

', 'CreateInvitationsRequest$AccountIds' => '

An array that lists Amazon Web Services account IDs, one for each account to send the invitation to.

', 'CriterionAdditionalProperties$Eq' => '

The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

', 'CriterionAdditionalProperties$EqExactMatch' => '

The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.

', 'CriterionAdditionalProperties$Neq' => '

The value for the property doesn\'t match (doesn\'t equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

', 'DeclineInvitationsRequest$AccountIds' => '

An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to decline.

', 'DeleteInvitationsRequest$AccountIds' => '

An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to delete.

', 'DescribeClassificationJobResponse$AllowListIds' => '

An array of unique identifiers, one for each allow list that the job uses when it analyzes data.

', 'DescribeClassificationJobResponse$CustomDataIdentifierIds' => '

An array of unique identifiers, one for each custom data identifier that the job uses when it analyzes data. This value is null if the job uses only managed data identifiers to analyze data.

', 'DescribeClassificationJobResponse$ManagedDataIdentifierIds' => '

An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector).

This value is null if the job\'s managed data identifier selection type is ALL, NONE, or RECOMMENDED.

', 'GetCustomDataIdentifierResponse$IgnoreWords' => '

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.

', 'GetCustomDataIdentifierResponse$Keywords' => '

An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren\'t case sensitive.

', 'GetFindingsRequest$FindingIds' => '

An array of strings that lists the unique identifiers for the findings to retrieve. You can specify as many as 50 unique identifiers in this array.

', 'ListFindingsResponse$FindingIds' => '

An array of strings, where each string is the unique identifier for a finding that matches the filter criteria specified in the request.

', 'ListJobsFilterTerm$Values' => '

An array that lists one or more values to use to filter the results.

', 'ReplicationDetails$ReplicationAccounts' => '

An array of Amazon Web Services account IDs, one for each Amazon Web Services account that owns a bucket that the bucket is configured to replicate one or more objects to.

', 'S3BucketDefinitionForJob$Buckets' => '

An array that lists the names of the buckets.

', 'SearchResourcesSimpleCriterion$Values' => '

An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

Values are case sensitive. Also, Macie doesn\'t support use of partial values or wildcard characters in values.

', 'SensitivityInspectionTemplateExcludes$ManagedDataIdentifierIds' => '

An array of unique identifiers, one for each managed data identifier to exclude. To retrieve a list of valid values, use the ListManagedDataIdentifiers operation.

', 'SensitivityInspectionTemplateIncludes$AllowListIds' => '

An array of unique identifiers, one for each allow list to include.

', 'SensitivityInspectionTemplateIncludes$CustomDataIdentifierIds' => '

An array of unique identifiers, one for each custom data identifier to include.

', 'SensitivityInspectionTemplateIncludes$ManagedDataIdentifierIds' => '

An array of unique identifiers, one for each managed data identifier to include.

Amazon Macie uses these managed data identifiers in addition to managed data identifiers that are subsequently released and recommended for automated sensitive data discovery. To retrieve a list of valid values for the managed data identifiers that are currently available, use the ListManagedDataIdentifiers operation.

', 'SimpleCriterionForJob$Values' => '

An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

  • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.

  • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.

  • S3_BUCKET_NAME - A string that represents the name of a bucket.

  • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.

Values are case sensitive. Also, Macie doesn\'t support use of partial values or wildcard characters in these values.

', 'SimpleScopeTerm$Values' => '

An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

Valid values for each supported property (key) are:

  • OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf

  • OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.

  • OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z

  • OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.

Macie doesn\'t support use of wildcard characters in these values. Also, string values are case sensitive.

', 'TestCustomDataIdentifierRequest$IgnoreWords' => '

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

', 'TestCustomDataIdentifierRequest$Keywords' => '

An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren\'t case sensitive.

', 'UsageStatisticsFilter$Values' => '

An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.

Valid values for each supported field are:

  • accountId - The unique identifier for an Amazon Web Services account.

  • freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie free trial started for an account.

  • serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.

  • total - A string that represents the current estimated cost for an account.

', ], ], '__long' => [ 'base' => NULL, 'refs' => [ 'BucketCountByEffectivePermission$PubliclyAccessible' => '

The total number of buckets that allow the general public to have read or write access to the bucket.

', 'BucketCountByEffectivePermission$PubliclyReadable' => '

The total number of buckets that allow the general public to have read access to the bucket.

', 'BucketCountByEffectivePermission$PubliclyWritable' => '

The total number of buckets that allow the general public to have write access to the bucket.

', 'BucketCountByEffectivePermission$Unknown' => '

The total number of buckets that Amazon Macie wasn\'t able to evaluate permissions settings for. Macie can\'t determine whether these buckets are publicly accessible.

', 'BucketCountByEncryptionType$KmsManaged' => '

The total number of buckets whose default encryption settings are configured to encrypt new objects with an Amazon Web Services managed KMS key or a customer managed KMS key. By default, these buckets encrypt new objects automatically using SSE-KMS encryption.

', 'BucketCountByEncryptionType$S3Managed' => '

The total number of buckets whose default encryption settings are configured to encrypt new objects with an Amazon S3 managed key. By default, these buckets encrypt new objects automatically using SSE-S3 encryption.

', 'BucketCountByEncryptionType$Unencrypted' => '

The total number of buckets that don\'t specify default server-side encryption behavior for new objects. Default encryption settings aren\'t configured for these buckets.

', 'BucketCountByEncryptionType$Unknown' => '

The total number of buckets that Amazon Macie doesn\'t have current encryption metadata for. Macie can\'t provide current data about the default encryption settings for these buckets.

', 'BucketCountBySharedAccessType$External' => '

The total number of buckets that are shared with one or more of the following or any combination of the following: an Amazon CloudFront OAI, a CloudFront OAC, or an Amazon Web Services account that isn\'t in the same Amazon Macie organization.

', 'BucketCountBySharedAccessType$Internal' => '

The total number of buckets that are shared with one or more Amazon Web Services accounts in the same Amazon Macie organization. These buckets aren\'t shared with Amazon CloudFront OAIs or OACs.

', 'BucketCountBySharedAccessType$NotShared' => '

The total number of buckets that aren\'t shared with other Amazon Web Services accounts, Amazon CloudFront OAIs, or CloudFront OACs.

', 'BucketCountBySharedAccessType$Unknown' => '

The total number of buckets that Amazon Macie wasn\'t able to evaluate shared access settings for. Macie can\'t determine whether these buckets are shared with other Amazon Web Services accounts, Amazon CloudFront OAIs, or CloudFront OACs.

', 'BucketCountPolicyAllowsUnencryptedObjectUploads$AllowsUnencryptedObjectUploads' => '

The total number of buckets that don\'t have a bucket policy or have a bucket policy that doesn\'t require server-side encryption of new objects. If a bucket policy exists, the policy doesn\'t require PutObject requests to include a valid server-side encryption header: the x-amz-server-side-encryption header with a value of AES256 or aws:kms, or the x-amz-server-side-encryption-customer-algorithm header with a value of AES256.

', 'BucketCountPolicyAllowsUnencryptedObjectUploads$DeniesUnencryptedObjectUploads' => '

The total number of buckets whose bucket policies require server-side encryption of new objects. PutObject requests for these buckets must include a valid server-side encryption header: the x-amz-server-side-encryption header with a value of AES256 or aws:kms, or the x-amz-server-side-encryption-customer-algorithm header with a value of AES256.

', 'BucketCountPolicyAllowsUnencryptedObjectUploads$Unknown' => '

The total number of buckets that Amazon Macie wasn\'t able to evaluate server-side encryption requirements for. Macie can\'t determine whether the bucket policies for these buckets require server-side encryption of new objects.

', 'BucketCriteriaAdditionalProperties$Gt' => '

The value for the property is greater than the specified value.

', 'BucketCriteriaAdditionalProperties$Gte' => '

The value for the property is greater than or equal to the specified value.

', 'BucketCriteriaAdditionalProperties$Lt' => '

The value for the property is less than the specified value.

', 'BucketCriteriaAdditionalProperties$Lte' => '

The value for the property is less than or equal to the specified value.

', 'BucketMetadata$ClassifiableObjectCount' => '

The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

', 'BucketMetadata$ClassifiableSizeInBytes' => '

The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn\'t reflect the storage size of all versions of each applicable object in the bucket.

', 'BucketMetadata$ObjectCount' => '

The total number of objects in the bucket.

', 'BucketMetadata$SizeInBytes' => '

The total storage size, in bytes, of the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn\'t reflect the storage size of all versions of each object in the bucket.

', 'BucketMetadata$SizeInBytesCompressed' => '

The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn\'t reflect the storage size of all versions of each applicable object in the bucket.

', 'Cell$Column' => '

The column number of the column that contains the sensitive data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier, for example: 1 for column A, 2 for column B, and so on.

', 'Cell$Row' => '

The row number of the row that contains the sensitive data.

', 'ClassificationResult$SizeClassified' => '

The total size, in bytes, of the data that the finding applies to.

', 'CriterionAdditionalProperties$Gt' => '

The value for the property is greater than the specified value.

', 'CriterionAdditionalProperties$Gte' => '

The value for the property is greater than or equal to the specified value.

', 'CriterionAdditionalProperties$Lt' => '

The value for the property is less than the specified value.

', 'CriterionAdditionalProperties$Lte' => '

The value for the property is less than or equal to the specified value.

', 'CustomDataIdentifiers$TotalCount' => '

The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.

', 'CustomDetection$Count' => '

The total number of occurrences of the sensitive data that the custom data identifier detected.

', 'DefaultDetection$Count' => '

The total number of occurrences of the type of sensitive data that was detected.

', 'Detection$Count' => '

The total number of occurrences of the sensitive data.

', 'Finding$Count' => '

The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered unique.

', 'GetBucketStatisticsResponse$BucketCount' => '

The total number of buckets.

', 'GetBucketStatisticsResponse$ClassifiableObjectCount' => '

The total number of objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

', 'GetBucketStatisticsResponse$ClassifiableSizeInBytes' => '

The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn\'t reflect the storage size of all versions of all applicable objects in the buckets.

', 'GetBucketStatisticsResponse$ObjectCount' => '

The total number of objects in the buckets.

', 'GetBucketStatisticsResponse$SizeInBytes' => '

The total storage size, in bytes, of the buckets.

If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each object in the buckets. This value doesn\'t reflect the storage size of all versions of the objects in the buckets.

', 'GetBucketStatisticsResponse$SizeInBytesCompressed' => '

The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the buckets.

If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn\'t reflect the storage size of all versions of the applicable objects in the buckets.

', 'GetInvitationsCountResponse$InvitationsCount' => '

The total number of invitations that were received by the account, not including the currently accepted invitation.

', 'GroupCount$Count' => '

The total number of findings in the group of query results.

', 'MatchingBucket$ClassifiableObjectCount' => '

The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

', 'MatchingBucket$ClassifiableSizeInBytes' => '

The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn\'t reflect the storage size of all versions of each applicable object in the bucket.

', 'MatchingBucket$ObjectCount' => '

The total number of objects in the bucket.

', 'MatchingBucket$SizeInBytes' => '

The total storage size, in bytes, of the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn\'t reflect the storage size of all versions of each object in the bucket.

', 'MatchingBucket$SizeInBytesCompressed' => '

The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn\'t reflect the storage size of all versions of each applicable object in the bucket.

', 'ObjectCountByEncryptionType$CustomerManaged' => '

The total number of objects that are encrypted with a customer-provided key. The objects use customer-provided server-side encryption (SSE-C).

', 'ObjectCountByEncryptionType$KmsManaged' => '

The total number of objects that are encrypted with an KMS key, either an Amazon Web Services managed key or a customer managed key. The objects use KMS encryption (SSE-KMS).

', 'ObjectCountByEncryptionType$S3Managed' => '

The total number of objects that are encrypted with an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).

', 'ObjectCountByEncryptionType$Unencrypted' => '

The total number of objects that use client-side encryption or aren\'t encrypted.

', 'ObjectCountByEncryptionType$Unknown' => '

The total number of objects that Amazon Macie doesn\'t have current encryption metadata for. Macie can\'t provide current data about the encryption settings for these objects.

', 'ObjectLevelStatistics$FileType' => '

The total storage size (in bytes) or number of objects that Amazon Macie can\'t analyze because the objects don\'t have a file name extension for a supported file or storage format.

', 'ObjectLevelStatistics$StorageClass' => '

The total storage size (in bytes) or number of objects that Amazon Macie can\'t analyze because the objects use an unsupported storage class.

', 'ObjectLevelStatistics$Total' => '

The total storage size (in bytes) or number of objects that Amazon Macie can\'t analyze because the objects use an unsupported storage class or don\'t have a file name extension for a supported file or storage format.

', 'Page$PageNumber' => '

The page number of the page that contains the sensitive data.

', 'Range$End' => '

The number of lines from the beginning of the file to the end of the sensitive data.

', 'Range$Start' => '

The number of lines from the beginning of the file to the beginning of the sensitive data.

', 'Range$StartColumn' => '

The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.

', 'Record$RecordIndex' => '

For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.

', 'ResourceStatistics$TotalBytesClassified' => '

The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.

', 'ResourceStatistics$TotalDetections' => '

The total number of occurrences of sensitive data that Amazon Macie has found in the bucket\'s objects. This includes occurrences that are currently suppressed by the sensitivity scoring settings for the bucket (totalDetectionsSuppressed).

', 'ResourceStatistics$TotalDetectionsSuppressed' => '

The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in the bucket\'s objects, but the occurrences were manually suppressed. By default, suppressed occurrences are excluded from the bucket\'s sensitivity score.

', 'ResourceStatistics$TotalItemsClassified' => '

The total number of objects that Amazon Macie has analyzed in the bucket.

', 'ResourceStatistics$TotalItemsSensitive' => '

The total number of the bucket\'s objects that Amazon Macie has found sensitive data in.

', 'ResourceStatistics$TotalItemsSkipped' => '

The total number of objects that Amazon Macie wasn\'t able to analyze in the bucket due to an object-level issue or error. For example, the object is a malformed file. This value includes objects that Macie wasn\'t able to analyze for reasons reported by other statistics in the ResourceStatistics object.

', 'ResourceStatistics$TotalItemsSkippedInvalidEncryption' => '

The total number of objects that Amazon Macie wasn\'t able to analyze in the bucket because the objects are encrypted with a key that Macie can\'t access. The objects use server-side encryption with customer-provided keys (SSE-C).

', 'ResourceStatistics$TotalItemsSkippedInvalidKms' => '

The total number of objects that Amazon Macie wasn\'t able to analyze in the bucket because the objects are encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.

', 'ResourceStatistics$TotalItemsSkippedPermissionDenied' => '

The total number of objects that Amazon Macie wasn\'t able to analyze in the bucket due to the permissions settings for the objects or the permissions settings for the keys that were used to encrypt the objects.

', 'S3Object$Size' => '

The total storage size, in bytes, of the object.

', 'SensitiveDataItem$TotalCount' => '

The total number of occurrences of the sensitive data that was detected.

', 'SensitivityAggregations$ClassifiableSizeInBytes' => '

The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn\'t reflect the storage size of all versions of all applicable objects in the buckets.

', 'SensitivityAggregations$PubliclyAccessibleCount' => '

The total number of buckets that are publicly accessible due to a combination of permissions settings for each bucket.

', 'SensitivityAggregations$TotalCount' => '

The total number of buckets.

', 'SensitivityAggregations$TotalSizeInBytes' => '

The total storage size, in bytes, of the buckets.

If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each object in the buckets. This value doesn\'t reflect the storage size of all versions of the objects in the buckets.

', 'ServiceLimit$Value' => '

The value for the metric specified by the UsageByAccount.type field in the response.

', 'Severity$Score' => '

The numerical representation of the finding\'s severity, ranging from 1 (least severe) to 3 (most severe).

', 'SeverityLevel$OccurrencesThreshold' => '

The minimum number of occurrences of text that must match the custom data identifier\'s detection criteria in order to produce a finding with the specified severity (severity).

', ], ], '__string' => [ 'base' => NULL, 'refs' => [ 'AcceptInvitationRequest$AdministratorAccountId' => '

The Amazon Web Services account ID for the account that sent the invitation.

', 'AcceptInvitationRequest$InvitationId' => '

The unique identifier for the invitation to accept.

', 'AcceptInvitationRequest$MasterAccount' => '

(Deprecated) The Amazon Web Services account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

', 'AccessDeniedException$Message' => '

The explanation of the error that occurred.

', 'AccountDetail$AccountId' => '

The Amazon Web Services account ID for the account.

', 'AccountDetail$Email' => '

The email address for the account.

', 'AdminAccount$AccountId' => '

The Amazon Web Services account ID for the account.

', 'ApiCallDetails$Api' => '

The name of the operation that was invoked most recently and produced the finding.

', 'ApiCallDetails$ApiServiceName' => '

The URL of the Amazon Web Service that provides the operation, for example: s3.amazonaws.com.

', 'AssumedRole$AccessKeyId' => '

The Amazon Web Services access key ID that identifies the credentials.

', 'AssumedRole$AccountId' => '

The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

', 'AssumedRole$Arn' => '

The Amazon Resource Name (ARN) of the entity that was used to get the credentials.

', 'AssumedRole$PrincipalId' => '

The unique identifier for the entity that was used to get the credentials.

', 'AwsAccount$AccountId' => '

The unique identifier for the Amazon Web Services account.

', 'AwsAccount$PrincipalId' => '

The unique identifier for the entity that performed the action.

', 'AwsService$InvokedBy' => '

The name of the Amazon Web Service that performed the action.

', 'BatchGetCustomDataIdentifierSummary$Arn' => '

The Amazon Resource Name (ARN) of the custom data identifier.

', 'BatchGetCustomDataIdentifierSummary$Description' => '

The custom description of the custom data identifier.

', 'BatchGetCustomDataIdentifierSummary$Id' => '

The unique identifier for the custom data identifier.

', 'BatchGetCustomDataIdentifierSummary$Name' => '

The custom name of the custom data identifier.

', 'BucketCriteriaAdditionalProperties$Prefix' => '

The name of the bucket begins with the specified value.

', 'BucketMetadata$AccountId' => '

The unique identifier for the Amazon Web Services account that owns the bucket.

', 'BucketMetadata$BucketArn' => '

The Amazon Resource Name (ARN) of the bucket.

', 'BucketMetadata$BucketName' => '

The name of the bucket.

', 'BucketMetadata$ErrorMessage' => '

A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket\'s objects. This value is null if Macie was able to retrieve and process the information.

', 'BucketMetadata$Region' => '

The Amazon Web Services Region that hosts the bucket.

', 'BucketServerSideEncryption$KmsMasterKeyId' => '

The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key that\'s used by default to encrypt objects that are added to the bucket. This value is null if the bucket is configured to use an Amazon S3 managed key to encrypt new objects.

', 'BucketSortCriteria$AttributeName' => '

The name of the bucket property to sort the results by. This value can be one of the following properties that Amazon Macie defines as bucket metadata: accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, objectCount, sensitivityScore, or sizeInBytes.

', 'Cell$CellReference' => '

The location of the cell, as an absolute cell reference, that contains the sensitive data, for example Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.

', 'Cell$ColumnName' => '

The name of the column that contains the sensitive data, if available.

', 'ClassificationDetails$DetailedResultsLocation' => '

The path to the folder or file in Amazon S3 that contains the corresponding sensitive data discovery result for the finding. If a finding applies to a large archive or compressed file, this value is the path to a folder. Otherwise, this value is the path to a file.

', 'ClassificationDetails$JobArn' => '

The Amazon Resource Name (ARN) of the classification job that produced the finding. This value is null if the origin of the finding (originType) is AUTOMATED_SENSITIVE_DATA_DISCOVERY.

', 'ClassificationDetails$JobId' => '

The unique identifier for the classification job that produced the finding. This value is null if the origin of the finding (originType) is AUTOMATED_SENSITIVE_DATA_DISCOVERY.

', 'ClassificationResult$MimeType' => '

The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.

', 'ClassificationResultStatus$Code' => '

The status of the finding. Possible values are:

  • COMPLETE - Amazon Macie successfully completed its analysis of the S3 object that the finding applies to.

  • PARTIAL - Macie analyzed only a subset of the data in the S3 object that the finding applies to. For example, the object is an archive file that contains files in an unsupported format.

  • SKIPPED - Macie wasn\'t able to analyze the S3 object that the finding applies to. For example, the object is a file that uses an unsupported format.

', 'ClassificationResultStatus$Reason' => '

A brief description of the status of the finding. This value is null if the status (code) of the finding is COMPLETE.

Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding and the affected S3 object. Possible values are:

  • ARCHIVE_CONTAINS_UNPROCESSED_FILES - The object is an archive file and Macie extracted and analyzed only some or none of the files in the archive. To determine which files Macie analyzed, if any, refer to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation).

  • ARCHIVE_EXCEEDS_SIZE_LIMIT - The object is an archive file whose total storage size exceeds the size quota for this type of archive.

  • ARCHIVE_NESTING_LEVEL_OVER_LIMIT - The object is an archive file whose nested depth exceeds the quota for the maximum number of nested levels that Macie analyzes for this type of archive.

  • ARCHIVE_TOTAL_BYTES_EXTRACTED_OVER_LIMIT - The object is an archive file that exceeds the quota for the maximum amount of data that Macie extracts and analyzes for this type of archive.

  • ARCHIVE_TOTAL_DOCUMENTS_PROCESSED_OVER_LIMIT - The object is an archive file that contains more than the maximum number of files that Macie extracts and analyzes for this type of archive.

  • FILE_EXCEEDS_SIZE_LIMIT - The storage size of the object exceeds the size quota for this type of file.

  • INVALID_ENCRYPTION - The object is encrypted using server-side encryption but Macie isn\'t allowed to use the key. Macie can\'t decrypt and analyze the object.

  • INVALID_KMS_KEY - The object is encrypted with an KMS key that was disabled or is being deleted. Macie can\'t decrypt and analyze the object.

  • INVALID_OBJECT_STATE - The object doesn\'t use a supported Amazon S3 storage class.

  • JSON_NESTING_LEVEL_OVER_LIMIT - The object contains JSON data and the nested depth of the data exceeds the quota for the number of nested levels that Macie analyzes for this type of file.

  • MALFORMED_FILE - The object is a malformed or corrupted file. An error occurred when Macie attempted to detect the file\'s type or extract data from the file.

  • MALFORMED_OR_FILE_SIZE_EXCEEDS_LIMIT - The object is a Microsoft Office file that is malformed or exceeds the size quota for this type of file. If the file is malformed, an error occurred when Macie attempted to extract data from the file.

  • NO_SUCH_BUCKET_AVAILABLE - The object was in a bucket that was deleted shortly before or when Macie attempted to analyze the object.

  • OBJECT_VERSION_MISMATCH - The object was changed while Macie was analyzing it.

  • OOXML_UNCOMPRESSED_RATIO_EXCEEDS_LIMIT - The object is an Office Open XML file whose compression ratio exceeds the compression quota for this type of file.

  • OOXML_UNCOMPRESSED_SIZE_EXCEEDS_LIMIT - The object is an Office Open XML file that exceeds the size quota for this type of file.

  • PERMISSION_DENIED - Macie isn\'t allowed to access the object. The object\'s permissions settings prevent Macie from analyzing the object.

  • SOURCE_OBJECT_NO_LONGER_AVAILABLE - The object was deleted shortly before or when Macie attempted to analyze it.

  • TIME_CUT_OFF_REACHED - Macie started analyzing the object but additional analysis would exceed the time quota for analyzing an object.

  • UNABLE_TO_PARSE_FILE - The object is a file that contains structured data and an error occurred when Macie attempted to parse the data.

  • UNSUPPORTED_FILE_TYPE_EXCEPTION - The object is a file that uses an unsupported file or storage format.

For information about quotas, supported storage classes, and supported file and storage formats, see Quotas and Supported storage classes and formats in the Amazon Macie User Guide.

', 'ConflictException$Message' => '

The explanation of the error that occurred.

', 'CreateAllowListRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'CreateClassificationJobRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'CreateClassificationJobRequest$Description' => '

A custom description of the job. The description can contain as many as 200 characters.

', 'CreateClassificationJobRequest$Name' => '

A custom name for the job. The name can contain as many as 500 characters.

', 'CreateClassificationJobResponse$JobArn' => '

The Amazon Resource Name (ARN) of the job.

', 'CreateClassificationJobResponse$JobId' => '

The unique identifier for the job.

', 'CreateCustomDataIdentifierRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'CreateCustomDataIdentifierRequest$Description' => '

A custom description of the custom data identifier. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they\'re allowed to perform in Amazon Macie.

', 'CreateCustomDataIdentifierRequest$Name' => '

A custom name for the custom data identifier. The name can contain as many as 128 characters.

We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they\'re allowed to perform in Amazon Macie.

', 'CreateCustomDataIdentifierRequest$Regex' => '

The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

', 'CreateCustomDataIdentifierResponse$CustomDataIdentifierId' => '

The unique identifier for the custom data identifier that was created.

', 'CreateFindingsFilterRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'CreateFindingsFilterRequest$Description' => '

A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see this description, depending on the actions that they\'re allowed to perform in Amazon Macie.

', 'CreateFindingsFilterRequest$Name' => '

A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see this name, depending on the actions that they\'re allowed to perform in Amazon Macie.

', 'CreateFindingsFilterResponse$Arn' => '

The Amazon Resource Name (ARN) of the filter that was created.

', 'CreateFindingsFilterResponse$Id' => '

The unique identifier for the filter that was created.

', 'CreateInvitationsRequest$Message' => '

Custom text to include in the email message that contains the invitation. The text can contain as many as 80 alphanumeric characters.

', 'CreateMemberResponse$Arn' => '

The Amazon Resource Name (ARN) of the account that was associated with the administrator account.

', 'CustomDataIdentifierSummary$Arn' => '

The Amazon Resource Name (ARN) of the custom data identifier.

', 'CustomDataIdentifierSummary$Description' => '

The custom description of the custom data identifier.

', 'CustomDataIdentifierSummary$Id' => '

The unique identifier for the custom data identifier.

', 'CustomDataIdentifierSummary$Name' => '

The custom name of the custom data identifier.

', 'CustomDetection$Arn' => '

The unique identifier for the custom data identifier.

', 'CustomDetection$Name' => '

The name of the custom data identifier.

', 'DefaultDetection$Type' => '

The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.

', 'DescribeBucketsRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'DescribeBucketsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'DescribeClassificationJobResponse$ClientToken' => '

The token that was provided to ensure the idempotency of the request to create the job.

', 'DescribeClassificationJobResponse$Description' => '

The custom description of the job.

', 'DescribeClassificationJobResponse$JobArn' => '

The Amazon Resource Name (ARN) of the job.

', 'DescribeClassificationJobResponse$JobId' => '

The unique identifier for the job.

', 'DescribeClassificationJobResponse$Name' => '

The custom name of the job.

', 'Detection$Arn' => '

If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data. Otherwise, this value is null.

', 'Detection$Id' => '

The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data. For additional details about a specified managed data identifier, see Using managed data identifiers in the Amazon Macie User Guide.

', 'Detection$Name' => '

The name of the custom data identifier or managed data identifier that detected the sensitive data. For a managed data identifier, this value is the same as the unique identifier (id).

', 'DomainDetails$DomainName' => '

The name of the domain.

', 'EnableMacieRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'EnableOrganizationAdminAccountRequest$AdminAccountId' => '

The Amazon Web Services account ID for the account to designate as the delegated Amazon Macie administrator account for the organization.

', 'EnableOrganizationAdminAccountRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'FederatedUser$AccessKeyId' => '

The Amazon Web Services access key ID that identifies the credentials.

', 'FederatedUser$AccountId' => '

The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

', 'FederatedUser$Arn' => '

The Amazon Resource Name (ARN) of the entity that was used to get the credentials.

', 'FederatedUser$PrincipalId' => '

The unique identifier for the entity that was used to get the credentials.

', 'Finding$AccountId' => '

The unique identifier for the Amazon Web Services account that the finding applies to. This is typically the account that owns the affected resource.

', 'Finding$Description' => '

The description of the finding.

', 'Finding$Id' => '

The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

', 'Finding$Partition' => '

The Amazon Web Services partition that Amazon Macie created the finding in.

', 'Finding$Region' => '

The Amazon Web Services Region that Amazon Macie created the finding in.

', 'Finding$SchemaVersion' => '

The version of the schema that was used to define the data structures in the finding.

', 'Finding$Title' => '

The brief description of the finding.

', 'FindingsFilterListItem$Arn' => '

The Amazon Resource Name (ARN) of the filter.

', 'FindingsFilterListItem$Id' => '

The unique identifier for the filter.

', 'FindingsFilterListItem$Name' => '

The custom name of the filter.

', 'GetBucketStatisticsRequest$AccountId' => '

The unique identifier for the Amazon Web Services account.

', 'GetCustomDataIdentifierResponse$Arn' => '

The Amazon Resource Name (ARN) of the custom data identifier.

', 'GetCustomDataIdentifierResponse$Description' => '

The custom description of the custom data identifier.

', 'GetCustomDataIdentifierResponse$Id' => '

The unique identifier for the custom data identifier.

', 'GetCustomDataIdentifierResponse$Name' => '

The custom name of the custom data identifier.

', 'GetCustomDataIdentifierResponse$Regex' => '

The regular expression (regex) that defines the pattern to match.

', 'GetFindingsFilterResponse$Arn' => '

The Amazon Resource Name (ARN) of the filter.

', 'GetFindingsFilterResponse$Description' => '

The custom description of the filter.

', 'GetFindingsFilterResponse$Id' => '

The unique identifier for the filter.

', 'GetFindingsFilterResponse$Name' => '

The custom name of the filter.

', 'GetMacieSessionResponse$ServiceRole' => '

The Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze data in Amazon Web Services resources for the account.

', 'GetMemberResponse$AccountId' => '

The Amazon Web Services account ID for the account.

', 'GetMemberResponse$AdministratorAccountId' => '

The Amazon Web Services account ID for the administrator account.

', 'GetMemberResponse$Arn' => '

The Amazon Resource Name (ARN) of the account.

', 'GetMemberResponse$Email' => '

The email address for the account. This value is null if the account is associated with the administrator account through Organizations.

', 'GetMemberResponse$MasterAccountId' => '

(Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

', 'GetSensitiveDataOccurrencesResponse$Error' => '

If an error occurred when Amazon Macie attempted to retrieve occurrences of sensitive data reported by the finding, a description of the error that occurred. This value is null if the status (status) of the request is PROCESSING or SUCCESS.

', 'GetSensitivityInspectionTemplateResponse$Description' => '

The custom description of the template.

', 'GetSensitivityInspectionTemplateResponse$Name' => '

The name of the template: automated-sensitive-data-discovery.

', 'GetUsageStatisticsRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'GetUsageStatisticsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'GroupCount$GroupKey' => '

The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.

', 'IamUser$AccountId' => '

The unique identifier for the Amazon Web Services account that\'s associated with the IAM user who performed the action.

', 'IamUser$Arn' => '

The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user who performed the action.

', 'IamUser$PrincipalId' => '

The unique identifier for the IAM user who performed the action.

', 'IamUser$UserName' => '

The username of the IAM user who performed the action.

', 'InternalServerException$Message' => '

The explanation of the error that occurred.

', 'Invitation$AccountId' => '

The Amazon Web Services account ID for the account that sent the invitation.

', 'Invitation$InvitationId' => '

The unique identifier for the invitation.

', 'IpAddressDetails$IpAddressV4' => '

The Internet Protocol version 4 (IPv4) address of the device.

', 'IpCity$Name' => '

The name of the city.

', 'IpCountry$Code' => '

The two-character code, in ISO 3166-1 alpha-2 format, for the country that the IP address originated from. For example, US for the United States.

', 'IpCountry$Name' => '

The name of the country that the IP address originated from.

', 'IpOwner$Asn' => '

The autonomous system number (ASN) for the autonomous system that included the IP address.

', 'IpOwner$AsnOrg' => '

The organization identifier that\'s associated with the autonomous system number (ASN) for the autonomous system that included the IP address.

', 'IpOwner$Isp' => '

The name of the internet service provider (ISP) that owned the IP address.

', 'IpOwner$Org' => '

The name of the organization that owned the IP address.

', 'JobDetails$LastJobId' => '

The unique identifier for the job that ran most recently and is configured to analyze data in the bucket, either the latest run of a recurring job or the only run of a one-time job.

This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

', 'JobSummary$JobId' => '

The unique identifier for the job.

', 'JobSummary$Name' => '

The custom name of the job.

', 'KeyValuePair$Key' => '

One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.

', 'KeyValuePair$Value' => '

One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.

', 'ListAllowListsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListClassificationJobsRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'ListClassificationJobsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListCustomDataIdentifiersRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'ListCustomDataIdentifiersResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListFindingsFiltersResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListFindingsRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'ListFindingsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListInvitationsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListManagedDataIdentifiersRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'ListManagedDataIdentifiersResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListMembersResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListOrganizationAdminAccountsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListResourceProfileArtifactsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListResourceProfileDetectionsResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ListSensitivityInspectionTemplatesResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'ManagedDataIdentifierSummary$Id' => '

The unique identifier for the managed data identifier. This is a string that describes the type of sensitive data that the managed data identifier detects. For example: OPENSSH_PRIVATE_KEY for OpenSSH private keys, CREDIT_CARD_NUMBER for credit card numbers, or USA_PASSPORT_NUMBER for US passport numbers.

', 'MatchingBucket$AccountId' => '

The unique identifier for the Amazon Web Services account that owns the bucket.

', 'MatchingBucket$BucketName' => '

The name of the bucket.

', 'MatchingBucket$ErrorMessage' => '

A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket\'s objects. This value is null if Macie was able to retrieve and process the information.

', 'Member$AccountId' => '

The Amazon Web Services account ID for the account.

', 'Member$AdministratorAccountId' => '

The Amazon Web Services account ID for the administrator account.

', 'Member$Arn' => '

The Amazon Resource Name (ARN) of the account.

', 'Member$Email' => '

The email address for the account. This value is null if the account is associated with the administrator account through Organizations.

', 'Member$MasterAccountId' => '

(Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

', 'PutFindingsPublicationConfigurationRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'Record$JsonPath' => '

The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.

If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.

', 'ResourceNotFoundException$Message' => '

The explanation of the error that occurred.

', 'ResourceProfileArtifact$Arn' => '

The Amazon Resource Name (ARN) of the object.

', 'ResourceProfileArtifact$ClassificationResultStatus' => '

The status of the analysis. Possible values are:

  • COMPLETE - Amazon Macie successfully completed its analysis of the object.

  • PARTIAL - Macie analyzed only a subset of data in the object. For example, the object is an archive file that contains files in an unsupported format.

  • SKIPPED - Macie wasn\'t able to analyze the object. For example, the object is a malformed file.

', 'S3Bucket$Arn' => '

The Amazon Resource Name (ARN) of the bucket.

', 'S3Bucket$Name' => '

The name of the bucket.

', 'S3BucketDefinitionForJob$AccountId' => '

The unique identifier for the Amazon Web Services account that owns the buckets.

', 'S3BucketOwner$DisplayName' => '

The display name of the account that owns the bucket.

', 'S3BucketOwner$Id' => '

The canonical user ID for the account that owns the bucket.

', 'S3Destination$BucketName' => '

The name of the bucket.

', 'S3Destination$KeyPrefix' => '

The path prefix to use in the path to the location in the bucket. This prefix specifies where to store classification results in the bucket.

', 'S3Destination$KmsKeyArn' => '

The Amazon Resource Name (ARN) of the customer managed KMS key to use for encryption of the results. This must be the ARN of an existing, symmetric encryption KMS key that\'s in the same Amazon Web Services Region as the bucket.

', 'S3Object$BucketArn' => '

The Amazon Resource Name (ARN) of the bucket that contains the object.

', 'S3Object$ETag' => '

The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.

', 'S3Object$Extension' => '

The file name extension of the object. If the object doesn\'t have a file name extension, this value is "".

', 'S3Object$Key' => '

The full name (key) of the object, including the object\'s prefix if applicable.

', 'S3Object$Path' => '

The full path to the affected object, including the name of the affected bucket and the object\'s name (key).

', 'S3Object$VersionId' => '

The identifier for the affected version of the object.

', 'SearchResourcesRequest$NextToken' => '

The nextToken string that specifies which page of results to return in a paginated response.

', 'SearchResourcesResponse$NextToken' => '

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

', 'SearchResourcesTagCriterionPair$Key' => '

The value for the tag key to use in the condition.

', 'SearchResourcesTagCriterionPair$Value' => '

The tag value to use in the condition.

', 'SensitivityInspectionTemplatesEntry$Id' => '

The unique identifier for the sensitivity inspection template.

', 'SensitivityInspectionTemplatesEntry$Name' => '

The name of the sensitivity inspection template: automated-sensitive-data-discovery.

', 'ServerSideEncryption$KmsMasterKeyId' => '

The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key that\'s used to encrypt data in the bucket or the object. This value is null if an KMS key isn\'t used to encrypt the data.

', 'ServiceQuotaExceededException$Message' => '

The explanation of the error that occurred.

', 'SessionIssuer$AccountId' => '

The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

', 'SessionIssuer$Arn' => '

The Amazon Resource Name (ARN) of the source account, Identity and Access Management (IAM) user, or role that was used to get the credentials.

', 'SessionIssuer$PrincipalId' => '

The unique identifier for the entity that was used to get the credentials.

', 'SessionIssuer$Type' => '

The source of the temporary security credentials, such as Root, IAMUser, or Role.

', 'SessionIssuer$UserName' => '

The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn\'t have an alias.

', 'SortCriteria$AttributeName' => '

The name of the property to sort the results by. Valid values are: count, createdAt, policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen, resourcesAffected, severity.score, type, and updatedAt.

', 'SuppressDataIdentifier$Id' => '

The unique identifier for the custom data identifier or managed data identifier that detected the type of sensitive data to exclude or include in the score.

', 'TagCriterionPairForJob$Key' => '

The value for the tag key to use in the condition.

', 'TagCriterionPairForJob$Value' => '

The tag value to use in the condition.

', 'TagMap$member' => NULL, 'TagScopeTerm$Key' => '

The object property to use in the condition. The only valid value is TAG.

', 'TagValuePair$Key' => '

The value for the tag key to use in the condition.

', 'TagValuePair$Value' => '

The tag value, associated with the specified tag key (key), to use in the condition. To specify only a tag key for a condition, specify the tag key for the key property and set this value to an empty string.

', 'TestCustomDataIdentifierRequest$Regex' => '

The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

', 'TestCustomDataIdentifierRequest$SampleText' => '

The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

', 'ThrottlingException$Message' => '

The explanation of the error that occurred.

', 'UnprocessableEntityException$Message' => '

The type of error that occurred and prevented Amazon Macie from retrieving occurrences of sensitive data reported by the finding. Possible values are:

  • INVALID_CLASSIFICATION_RESULT - Amazon Macie can\'t verify the location of the sensitive data to retrieve. There isn\'t a corresponding sensitive data discovery result for the finding. Or the sensitive data discovery result specified by the classificationDetails.detailedResultsLocation field of the finding isn\'t available, is malformed or corrupted, or uses an unsupported storage format.

  • OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data.

  • OBJECT_UNAVAILABLE - The affected S3 object isn\'t available. The object might have been renamed, moved, or deleted. Or the object was changed after Macie created the finding.

  • UNSUPPORTED_FINDING_TYPE - The specified finding isn\'t a sensitive data finding.

  • UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Macie doesn\'t support for retrieving occurrences of sensitive data.

', 'UnprocessedAccount$AccountId' => '

The Amazon Web Services account ID for the account that the request applies to.

', 'UnprocessedAccount$ErrorMessage' => '

The reason why the request hasn\'t been processed.

', 'UpdateFindingsFilterRequest$ClientToken' => '

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

', 'UpdateFindingsFilterRequest$Description' => '

A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see this description, depending on the actions that they\'re allowed to perform in Amazon Macie.

', 'UpdateFindingsFilterRequest$Name' => '

A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see this name, depending on the actions that they\'re allowed to perform in Amazon Macie.

', 'UpdateFindingsFilterResponse$Arn' => '

The Amazon Resource Name (ARN) of the filter that was updated.

', 'UpdateFindingsFilterResponse$Id' => '

The unique identifier for the filter that was updated.

', 'UpdateSensitivityInspectionTemplateRequest$Description' => '

A custom description of the template. The description can contain as many as 200 characters.

', 'UsageByAccount$EstimatedCost' => '

The estimated value for the metric.

', 'UsageRecord$AccountId' => '

The unique identifier for the Amazon Web Services account that the data applies to.

', 'UsageTotal$EstimatedCost' => '

The estimated value for the metric.

', 'UserIdentityRoot$AccountId' => '

The unique identifier for the Amazon Web Services account.

', 'UserIdentityRoot$Arn' => '

The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user or role that performed the action.

', 'UserIdentityRoot$PrincipalId' => '

The unique identifier for the entity that performed the action.

', 'UserPausedDetails$JobImminentExpirationHealthEventArn' => '

The Amazon Resource Name (ARN) of the Health event that Amazon Macie sent to notify you of the job or job run\'s pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.

', 'ValidationException$Message' => '

The explanation of the error that occurred.

', '__listOf__string$member' => NULL, ], ], '__stringMin1Max1024PatternSS' => [ 'base' => NULL, 'refs' => [ 'AllowListStatus$Description' => '

A brief description of the status of the allow list. Amazon Macie uses this value to provide additional information about an error that occurred when Macie tried to access and use the list\'s criteria.

', 'S3WordsList$ObjectKey' => '

The full name (key) of the object.

', ], ], '__stringMin1Max128' => [ 'base' => NULL, 'refs' => [ 'DetectedDataDetails$Value' => '

An occurrence of the specified type of sensitive data. Each occurrence can contain 1-128 characters.

', ], ], '__stringMin1Max128Pattern' => [ 'base' => NULL, 'refs' => [ 'AllowListSummary$Name' => '

The custom name of the allow list.

', 'CreateAllowListRequest$Name' => '

A custom name for the allow list. The name can contain as many as 128 characters.

', 'GetAllowListResponse$Name' => '

The custom name of the allow list.

', 'UpdateAllowListRequest$Name' => '

A custom name for the allow list. The name can contain as many as 128 characters.

', ], ], '__stringMin1Max2048' => [ 'base' => NULL, 'refs' => [ 'RevealConfiguration$KmsKeyId' => '

The Amazon Resource Name (ARN), ID, or alias of the KMS key to use to encrypt sensitive data that\'s retrieved. The key must be an existing, customer managed, symmetric encryption key that\'s in the same Amazon Web Services Region as the Amazon Macie account.

If this value specifies an alias, it must include the following prefix: alias/. If this value specifies a key that\'s owned by another Amazon Web Services account, it must specify the ARN of the key or the ARN of the key\'s alias.

', ], ], '__stringMin1Max512PatternSS' => [ 'base' => NULL, 'refs' => [ 'AllowListCriteria$Regex' => '

The regular expression (regex) that defines the text pattern to ignore. The expression can contain as many as 512 characters.

', 'AllowListSummary$Description' => '

The custom description of the allow list.

', 'CreateAllowListRequest$Description' => '

A custom description of the allow list. The description can contain as many as 512 characters.

', 'GetAllowListResponse$Description' => '

The custom description of the allow list.

', 'UpdateAllowListRequest$Description' => '

A custom description of the allow list. The description can contain as many as 512 characters.

', ], ], '__stringMin22Max22PatternAZ0922' => [ 'base' => NULL, 'refs' => [ 'AllowListSummary$Id' => '

The unique identifier for the allow list.

', 'CreateAllowListResponse$Id' => '

The unique identifier for the allow list.

', 'GetAllowListResponse$Id' => '

The unique identifier for the allow list.

', 'UpdateAllowListResponse$Id' => '

The unique identifier for the allow list.

', ], ], '__stringMin3Max255PatternAZaZ093255' => [ 'base' => NULL, 'refs' => [ 'S3WordsList$BucketName' => '

The full name of the S3 bucket that contains the object.

', ], ], '__stringMin71Max89PatternArnAwsAwsCnAwsUsGovMacie2AZ19920D12AllowListAZ0922' => [ 'base' => NULL, 'refs' => [ 'AllowListSummary$Arn' => '

The Amazon Resource Name (ARN) of the allow list.

', 'CreateAllowListResponse$Arn' => '

The Amazon Resource Name (ARN) of the allow list.

', 'GetAllowListResponse$Arn' => '

The Amazon Resource Name (ARN) of the allow list.

', 'UpdateAllowListResponse$Arn' => '

The Amazon Resource Name (ARN) of the allow list.

', ], ], '__timestampIso8601' => [ 'base' => NULL, 'refs' => [ 'AllowListSummary$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.

', 'AllowListSummary$UpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the allow list\'s settings were most recently changed in Amazon Macie.

', 'ApiCallDetails$FirstSeen' => '

The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.

', 'ApiCallDetails$LastSeen' => '

The most recent date and time, in UTC and extended ISO 8601 format, when the specified operation (api) was invoked and produced the finding.

', 'BatchGetCustomDataIdentifierSummary$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

', 'BucketMetadata$BucketCreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket\'s policy were most recently made to the bucket.

', 'BucketMetadata$LastAutomatedDiscoveryTime' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed data in the bucket while performing automated sensitive data discovery for your account. This value is null if automated sensitive data discovery is currently disabled for your account.

', 'BucketMetadata$LastUpdated' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved bucket or object metadata from Amazon S3 for the bucket.

', 'CustomDataIdentifierSummary$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

', 'DescribeClassificationJobResponse$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the job was created.

', 'DescribeClassificationJobResponse$LastRunTime' => '

The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started or, if the job hasn\'t run yet, when the job was created.

', 'Finding$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.

', 'Finding$UpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last updated the finding. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new.

', 'GetAllowListResponse$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.

', 'GetAllowListResponse$UpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the allow list\'s settings were most recently changed in Amazon Macie.

', 'GetBucketStatisticsResponse$LastUpdated' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved bucket or object metadata from Amazon S3 for the buckets.

', 'GetCustomDataIdentifierResponse$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

', 'GetMacieSessionResponse$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.

', 'GetMacieSessionResponse$UpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Amazon Macie account.

', 'GetMemberResponse$InvitedAt' => '

The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie membership invitation hasn\'t been sent to the account.

', 'GetMemberResponse$UpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.

', 'GetResourceProfileResponse$ProfileUpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently recalculated sensitive data discovery statistics and details for the bucket. If the bucket\'s sensitivity score is calculated automatically, this includes the score.

', 'Invitation$InvitedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.

', 'JobDetails$LastJobRunTime' => '

The date and time, in UTC and extended ISO 8601 format, when the job (lastJobId) started. If the job is a recurring job, this value indicates when the most recent run started.

This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

', 'JobSummary$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the job was created.

', 'MatchingBucket$LastAutomatedDiscoveryTime' => '

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed data in the bucket while performing automated sensitive data discovery for your account. This value is null if automated sensitive data discovery is currently disabled for your account.

', 'Member$InvitedAt' => '

The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie membership invitation hasn\'t been sent to the account.

', 'Member$UpdatedAt' => '

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.

', 'S3Bucket$CreatedAt' => '

The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket\'s policy were most recently made to the bucket, relative to when the finding was created or last updated.

', 'S3Object$LastModified' => '

The date and time, in UTC and extended ISO 8601 format, when the object was last modified.

', 'SessionContextAttributes$CreationDate' => '

The date and time, in UTC and ISO 8601 format, when the credentials were issued.

', 'UsageRecord$AutomatedDiscoveryFreeTrialStartDate' => '

The date and time, in UTC and extended ISO 8601 format, when the free trial of automated sensitive data discovery started for the account. If the account is a member account in an organization, this value is the same as the value for the organization\'s Amazon Macie administrator account.

', 'UsageRecord$FreeTrialStartDate' => '

The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie free trial started for the account.

', 'UserPausedDetails$JobExpiresAt' => '

The date and time, in UTC and extended ISO 8601 format, when the job or job run will expire and be cancelled if you don\'t resume it first.

', 'UserPausedDetails$JobPausedAt' => '

The date and time, in UTC and extended ISO 8601 format, when you paused the job.

', ], ], ],]; diff --git a/src/data/macie2/2020-01-01/endpoint-rule-set-1.json b/src/data/macie2/2020-01-01/endpoint-rule-set-1.json index cca5913612..d8387421b1 100644 --- a/src/data/macie2/2020-01-01/endpoint-rule-set-1.json +++ b/src/data/macie2/2020-01-01/endpoint-rule-set-1.json @@ -58,52 +58,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -111,13 +115,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -127,224 +140,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://macie2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://macie2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://macie2-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://macie2-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://macie2.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://macie2.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://macie2.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://macie2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } \ No newline at end of file diff --git a/src/data/macie2/2020-01-01/endpoint-rule-set-1.json.php b/src/data/macie2/2020-01-01/endpoint-rule-set-1.json.php index ee6512a811..a2f776e97a 100644 --- a/src/data/macie2/2020-01-01/endpoint-rule-set-1.json.php +++ b/src/data/macie2/2020-01-01/endpoint-rule-set-1.json.php @@ -1,3 +1,3 @@ '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://macie2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://macie2-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://macie2.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://macie2.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], ], ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ], ], ],]; +return [ 'version' => '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://macie2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://macie2-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://macie2.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://macie2.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ],]; diff --git a/src/data/workmail/2017-10-01/api-2.json b/src/data/workmail/2017-10-01/api-2.json index f1a03d939f..88260c5e27 100644 --- a/src/data/workmail/2017-10-01/api-2.json +++ b/src/data/workmail/2017-10-01/api-2.json @@ -25,7 +25,8 @@ {"shape":"EntityStateException"}, {"shape":"InvalidParameterException"}, {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationStateException"} + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} ], "idempotent":true }, @@ -202,7 +203,8 @@ {"shape":"NameAvailabilityException"}, {"shape":"OrganizationNotFoundException"}, {"shape":"OrganizationStateException"}, - {"shape":"ReservedNameException"} + {"shape":"ReservedNameException"}, + {"shape":"UnsupportedOperationException"} ], "idempotent":true }, @@ -392,7 +394,8 @@ {"shape":"EntityStateException"}, {"shape":"InvalidParameterException"}, {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationStateException"} + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} ], "idempotent":true }, @@ -480,6 +483,22 @@ ], "idempotent":true }, + "DescribeEntity":{ + "name":"DescribeEntity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEntityRequest"}, + "output":{"shape":"DescribeEntityResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "idempotent":true + }, "DescribeGroup":{ "name":"DescribeGroup", "http":{ @@ -552,7 +571,8 @@ {"shape":"EntityNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationStateException"} + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} ], "idempotent":true }, @@ -585,7 +605,8 @@ {"shape":"EntityStateException"}, {"shape":"InvalidParameterException"}, {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationStateException"} + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} ], "idempotent":true }, @@ -698,6 +719,7 @@ "input":{"shape":"GetMailboxDetailsRequest"}, "output":{"shape":"GetMailboxDetailsResponse"}, "errors":[ + {"shape":"InvalidParameterException"}, {"shape":"OrganizationNotFoundException"}, {"shape":"OrganizationStateException"}, {"shape":"EntityNotFoundException"} @@ -810,6 +832,23 @@ ], "idempotent":true }, + "ListGroupsForEntity":{ + "name":"ListGroupsForEntity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupsForEntityRequest"}, + "output":{"shape":"ListGroupsForEntityResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"InvalidParameterException"} + ], + "idempotent":true + }, "ListImpersonationRoles":{ "name":"ListImpersonationRoles", "http":{ @@ -925,7 +964,8 @@ {"shape":"EntityStateException"}, {"shape":"InvalidParameterException"}, {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationStateException"} + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} ], "idempotent":true }, @@ -940,7 +980,8 @@ "errors":[ {"shape":"InvalidParameterException"}, {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationStateException"} + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} ], "idempotent":true }, @@ -1154,6 +1195,7 @@ "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ + {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyTagsException"}, {"shape":"OrganizationStateException"} @@ -1219,6 +1261,24 @@ ], "idempotent":true }, + "UpdateGroup":{ + "name":"UpdateGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGroupRequest"}, + "output":{"shape":"UpdateGroupResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"InvalidParameterException"} + ], + "idempotent":true + }, "UpdateImpersonationRole":{ "name":"UpdateImpersonationRole", "http":{ @@ -1311,7 +1371,29 @@ {"shape":"MailDomainStateException"}, {"shape":"NameAvailabilityException"}, {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationStateException"} + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"InvalidParameterException"} + ], + "idempotent":true + }, + "UpdateUser":{ + "name":"UpdateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserRequest"}, + "output":{"shape":"UpdateUserResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"EntityStateException"} ], "idempotent":true } @@ -1392,7 +1474,8 @@ "AmazonResourceName":{ "type":"string", "max":1011, - "min":1 + "min":1, + "pattern":"arn:aws:workmail:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}" }, "AssociateDelegateToResourceRequest":{ "type":"structure", @@ -1403,8 +1486,8 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "ResourceId":{"shape":"ResourceId"}, - "EntityId":{"shape":"WorkMailIdentifier"} + "ResourceId":{"shape":"EntityIdentifier"}, + "EntityId":{"shape":"EntityIdentifier"} } }, "AssociateDelegateToResourceResponse":{ @@ -1421,8 +1504,8 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "GroupId":{"shape":"WorkMailIdentifier"}, - "MemberId":{"shape":"WorkMailIdentifier"} + "GroupId":{"shape":"EntityIdentifier"}, + "MemberId":{"shape":"EntityIdentifier"} } }, "AssociateMemberToGroupResponse":{ @@ -1549,7 +1632,8 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "Name":{"shape":"GroupName"} + "Name":{"shape":"GroupName"}, + "HiddenFromGlobalAddressList":{"shape":"Boolean"} } }, "CreateGroupResponse":{ @@ -1647,7 +1731,9 @@ "members":{ "OrganizationId":{"shape":"OrganizationId"}, "Name":{"shape":"ResourceName"}, - "Type":{"shape":"ResourceType"} + "Type":{"shape":"ResourceType"}, + "Description":{"shape":"ResourceDescription"}, + "HiddenFromGlobalAddressList":{"shape":"Boolean"} } }, "CreateResourceResponse":{ @@ -1661,14 +1747,17 @@ "required":[ "OrganizationId", "Name", - "DisplayName", - "Password" + "DisplayName" ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, "Name":{"shape":"UserName"}, - "DisplayName":{"shape":"String"}, - "Password":{"shape":"Password"} + "DisplayName":{"shape":"UserAttribute"}, + "Password":{"shape":"Password"}, + "Role":{"shape":"UserRole"}, + "FirstName":{"shape":"UserAttribute"}, + "LastName":{"shape":"UserAttribute"}, + "HiddenFromGlobalAddressList":{"shape":"Boolean"} } }, "CreateUserResponse":{ @@ -1758,7 +1847,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "GroupId":{"shape":"WorkMailIdentifier"} + "GroupId":{"shape":"EntityIdentifier"} } }, "DeleteGroupResponse":{ @@ -1791,8 +1880,8 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "EntityId":{"shape":"WorkMailIdentifier"}, - "GranteeId":{"shape":"WorkMailIdentifier"} + "EntityId":{"shape":"EntityIdentifier"}, + "GranteeId":{"shape":"EntityIdentifier"} } }, "DeleteMailboxPermissionsResponse":{ @@ -1846,7 +1935,8 @@ "idempotencyToken":true }, "OrganizationId":{"shape":"OrganizationId"}, - "DeleteDirectory":{"shape":"Boolean"} + "DeleteDirectory":{"shape":"Boolean"}, + "ForceDelete":{"shape":"Boolean"} } }, "DeleteOrganizationResponse":{ @@ -1864,7 +1954,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "ResourceId":{"shape":"ResourceId"} + "ResourceId":{"shape":"EntityIdentifier"} } }, "DeleteResourceResponse":{ @@ -1896,7 +1986,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "UserId":{"shape":"WorkMailIdentifier"} + "UserId":{"shape":"EntityIdentifier"} } }, "DeleteUserResponse":{ @@ -1912,7 +2002,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "EntityId":{"shape":"WorkMailIdentifier"} + "EntityId":{"shape":"EntityIdentifier"} } }, "DeregisterFromWorkMailResponse":{ @@ -1950,6 +2040,25 @@ "LogGroupArn":{"shape":"LogGroupArn"} } }, + "DescribeEntityRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Email" + ], + "members":{ + "OrganizationId":{"shape":"OrganizationId"}, + "Email":{"shape":"EmailAddress"} + } + }, + "DescribeEntityResponse":{ + "type":"structure", + "members":{ + "EntityId":{"shape":"WorkMailIdentifier"}, + "Name":{"shape":"String"}, + "Type":{"shape":"EntityType"} + } + }, "DescribeGroupRequest":{ "type":"structure", "required":[ @@ -1958,7 +2067,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "GroupId":{"shape":"WorkMailIdentifier"} + "GroupId":{"shape":"EntityIdentifier"} } }, "DescribeGroupResponse":{ @@ -1969,7 +2078,8 @@ "Email":{"shape":"EmailAddress"}, "State":{"shape":"EntityState"}, "EnabledDate":{"shape":"Timestamp"}, - "DisabledDate":{"shape":"Timestamp"} + "DisabledDate":{"shape":"Timestamp"}, + "HiddenFromGlobalAddressList":{"shape":"Boolean"} } }, "DescribeInboundDmarcSettingsRequest":{ @@ -2031,7 +2141,9 @@ "DefaultMailDomain":{"shape":"String"}, "CompletedDate":{"shape":"Timestamp"}, "ErrorMessage":{"shape":"String"}, - "ARN":{"shape":"AmazonResourceName"} + "ARN":{"shape":"AmazonResourceName"}, + "MigrationAdmin":{"shape":"WorkMailIdentifier"}, + "InteroperabilityEnabled":{"shape":"Boolean"} } }, "DescribeResourceRequest":{ @@ -2042,7 +2154,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "ResourceId":{"shape":"ResourceId"} + "ResourceId":{"shape":"EntityIdentifier"} } }, "DescribeResourceResponse":{ @@ -2055,7 +2167,9 @@ "BookingOptions":{"shape":"BookingOptions"}, "State":{"shape":"EntityState"}, "EnabledDate":{"shape":"Timestamp"}, - "DisabledDate":{"shape":"Timestamp"} + "DisabledDate":{"shape":"Timestamp"}, + "Description":{"shape":"ResourceDescription"}, + "HiddenFromGlobalAddressList":{"shape":"Boolean"} } }, "DescribeUserRequest":{ @@ -2066,7 +2180,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "UserId":{"shape":"WorkMailIdentifier"} + "UserId":{"shape":"EntityIdentifier"} } }, "DescribeUserResponse":{ @@ -2075,11 +2189,26 @@ "UserId":{"shape":"WorkMailIdentifier"}, "Name":{"shape":"UserName"}, "Email":{"shape":"EmailAddress"}, - "DisplayName":{"shape":"String"}, + "DisplayName":{"shape":"UserAttribute"}, "State":{"shape":"EntityState"}, "UserRole":{"shape":"UserRole"}, "EnabledDate":{"shape":"Timestamp"}, - "DisabledDate":{"shape":"Timestamp"} + "DisabledDate":{"shape":"Timestamp"}, + "MailboxProvisionedDate":{"shape":"Timestamp"}, + "MailboxDeprovisionedDate":{"shape":"Timestamp"}, + "FirstName":{"shape":"UserAttribute"}, + "LastName":{"shape":"UserAttribute"}, + "HiddenFromGlobalAddressList":{"shape":"Boolean"}, + "Initials":{"shape":"UserAttribute"}, + "Telephone":{"shape":"UserAttribute"}, + "Street":{"shape":"UserAttribute"}, + "JobTitle":{"shape":"UserAttribute"}, + "City":{"shape":"UserAttribute"}, + "Company":{"shape":"UserAttribute"}, + "ZipCode":{"shape":"UserAttribute"}, + "Department":{"shape":"UserAttribute"}, + "Country":{"shape":"UserAttribute"}, + "Office":{"shape":"UserAttribute"} } }, "Description":{ @@ -2178,8 +2307,8 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "ResourceId":{"shape":"ResourceId"}, - "EntityId":{"shape":"WorkMailIdentifier"} + "ResourceId":{"shape":"EntityIdentifier"}, + "EntityId":{"shape":"EntityIdentifier"} } }, "DisassociateDelegateFromResourceResponse":{ @@ -2196,8 +2325,8 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "GroupId":{"shape":"WorkMailIdentifier"}, - "MemberId":{"shape":"WorkMailIdentifier"} + "GroupId":{"shape":"EntityIdentifier"}, + "MemberId":{"shape":"EntityIdentifier"} } }, "DisassociateMemberFromGroupResponse":{ @@ -2227,6 +2356,7 @@ }, "Domain":{ "type":"structure", + "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"}, "HostedZoneId":{"shape":"HostedZoneId"} @@ -2236,7 +2366,7 @@ "type":"string", "max":255, "min":3, - "pattern":"[a-zA-Z0-9.-]+\\.[a-zA-Z-]{2,}" + "pattern":"[a-zA-Z0-9.-]+" }, "Domains":{ "type":"list", @@ -2292,6 +2422,14 @@ }, "exception":true }, + "EntityType":{ + "type":"string", + "enum":[ + "GROUP", + "USER", + "RESOURCE" + ] + }, "EwsAvailabilityProvider":{ "type":"structure", "required":[ @@ -2451,7 +2589,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "UserId":{"shape":"WorkMailIdentifier"} + "UserId":{"shape":"EntityIdentifier"} } }, "GetMailboxDetailsResponse":{ @@ -2514,6 +2652,17 @@ "DisabledDate":{"shape":"Timestamp"} } }, + "GroupIdentifier":{ + "type":"structure", + "members":{ + "GroupId":{"shape":"WorkMailIdentifier"}, + "GroupName":{"shape":"GroupName"} + } + }, + "GroupIdentifiers":{ + "type":"list", + "member":{"shape":"GroupIdentifier"} + }, "GroupName":{ "type":"string", "max":256, @@ -2528,7 +2677,7 @@ "type":"string", "max":32, "min":1, - "pattern":"[\\S\\s]*" + "pattern":"[^/\\\\]*" }, "IdempotencyClientToken":{ "type":"string", @@ -2774,7 +2923,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "GroupId":{"shape":"WorkMailIdentifier"}, + "GroupId":{"shape":"EntityIdentifier"}, "NextToken":{"shape":"NextToken"}, "MaxResults":{"shape":"MaxResults"} } @@ -2786,13 +2935,49 @@ "NextToken":{"shape":"NextToken"} } }, + "ListGroupsFilters":{ + "type":"structure", + "members":{ + "NamePrefix":{"shape":"String"}, + "PrimaryEmailPrefix":{"shape":"String"}, + "State":{"shape":"EntityState"} + } + }, + "ListGroupsForEntityFilters":{ + "type":"structure", + "members":{ + "GroupNamePrefix":{"shape":"String"} + } + }, + "ListGroupsForEntityRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId" + ], + "members":{ + "OrganizationId":{"shape":"OrganizationId"}, + "EntityId":{"shape":"EntityIdentifier"}, + "Filters":{"shape":"ListGroupsForEntityFilters"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"} + } + }, + "ListGroupsForEntityResponse":{ + "type":"structure", + "members":{ + "Groups":{"shape":"GroupIdentifiers"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListGroupsRequest":{ "type":"structure", "required":["OrganizationId"], "members":{ "OrganizationId":{"shape":"OrganizationId"}, "NextToken":{"shape":"NextToken"}, - "MaxResults":{"shape":"MaxResults"} + "MaxResults":{"shape":"MaxResults"}, + "Filters":{"shape":"ListGroupsFilters"} } }, "ListGroupsResponse":{ @@ -2858,7 +3043,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "EntityId":{"shape":"WorkMailIdentifier"}, + "EntityId":{"shape":"EntityIdentifier"}, "NextToken":{"shape":"NextToken"}, "MaxResults":{"shape":"MaxResults"} } @@ -2923,7 +3108,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "ResourceId":{"shape":"WorkMailIdentifier"}, + "ResourceId":{"shape":"EntityIdentifier"}, "NextToken":{"shape":"NextToken"}, "MaxResults":{"shape":"MaxResults"} } @@ -2935,13 +3120,22 @@ "NextToken":{"shape":"NextToken"} } }, + "ListResourcesFilters":{ + "type":"structure", + "members":{ + "NamePrefix":{"shape":"String"}, + "PrimaryEmailPrefix":{"shape":"String"}, + "State":{"shape":"EntityState"} + } + }, "ListResourcesRequest":{ "type":"structure", "required":["OrganizationId"], "members":{ "OrganizationId":{"shape":"OrganizationId"}, "NextToken":{"shape":"NextToken"}, - "MaxResults":{"shape":"MaxResults"} + "MaxResults":{"shape":"MaxResults"}, + "Filters":{"shape":"ListResourcesFilters"} } }, "ListResourcesResponse":{ @@ -2964,13 +3158,23 @@ "Tags":{"shape":"TagList"} } }, + "ListUsersFilters":{ + "type":"structure", + "members":{ + "UsernamePrefix":{"shape":"String"}, + "DisplayNamePrefix":{"shape":"UserAttribute"}, + "PrimaryEmailPrefix":{"shape":"String"}, + "State":{"shape":"EntityState"} + } + }, "ListUsersRequest":{ "type":"structure", "required":["OrganizationId"], "members":{ "OrganizationId":{"shape":"OrganizationId"}, "NextToken":{"shape":"NextToken"}, - "MaxResults":{"shape":"MaxResults"} + "MaxResults":{"shape":"MaxResults"}, + "Filters":{"shape":"ListUsersFilters"} } }, "ListUsersResponse":{ @@ -3175,6 +3379,11 @@ }, "exception":true }, + "NewResourceDescription":{ + "type":"string", + "max":64, + "min":0 + }, "NextToken":{ "type":"string", "max":1024, @@ -3339,8 +3548,8 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "EntityId":{"shape":"WorkMailIdentifier"}, - "GranteeId":{"shape":"WorkMailIdentifier"}, + "EntityId":{"shape":"EntityIdentifier"}, + "GranteeId":{"shape":"EntityIdentifier"}, "PermissionValues":{"shape":"PermissionValues"} } }, @@ -3426,7 +3635,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "EntityId":{"shape":"WorkMailIdentifier"}, + "EntityId":{"shape":"EntityIdentifier"}, "Email":{"shape":"EmailAddress"} } }, @@ -3469,13 +3678,19 @@ "Type":{"shape":"ResourceType"}, "State":{"shape":"EntityState"}, "EnabledDate":{"shape":"Timestamp"}, - "DisabledDate":{"shape":"Timestamp"} + "DisabledDate":{"shape":"Timestamp"}, + "Description":{"shape":"ResourceDescription"} } }, "ResourceDelegates":{ "type":"list", "member":{"shape":"Delegate"} }, + "ResourceDescription":{ + "type":"string", + "max":64, + "min":1 + }, "ResourceId":{ "type":"string", "max":34, @@ -3523,7 +3738,8 @@ "RoleArn":{ "type":"string", "max":2048, - "min":20 + "min":20, + "pattern":"arn:aws:iam:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}" }, "S3BucketName":{ "type":"string", @@ -3560,7 +3776,7 @@ "idempotencyToken":true }, "OrganizationId":{"shape":"OrganizationId"}, - "EntityId":{"shape":"WorkMailIdentifier"}, + "EntityId":{"shape":"EntityIdentifier"}, "Description":{"shape":"Description"}, "RoleArn":{"shape":"RoleArn"}, "KmsKeyArn":{"shape":"KmsKeyArn"}, @@ -3715,6 +3931,23 @@ "members":{ } }, + "UpdateGroupRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "GroupId" + ], + "members":{ + "OrganizationId":{"shape":"OrganizationId"}, + "GroupId":{"shape":"EntityIdentifier"}, + "HiddenFromGlobalAddressList":{"shape":"BooleanObject"} + } + }, + "UpdateGroupResponse":{ + "type":"structure", + "members":{ + } + }, "UpdateImpersonationRoleRequest":{ "type":"structure", "required":[ @@ -3747,7 +3980,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "UserId":{"shape":"WorkMailIdentifier"}, + "UserId":{"shape":"EntityIdentifier"}, "MailboxQuota":{"shape":"MailboxQuota"} } }, @@ -3794,7 +4027,7 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "EntityId":{"shape":"WorkMailIdentifier"}, + "EntityId":{"shape":"EntityIdentifier"}, "Email":{"shape":"EmailAddress"} } }, @@ -3811,9 +4044,12 @@ ], "members":{ "OrganizationId":{"shape":"OrganizationId"}, - "ResourceId":{"shape":"ResourceId"}, + "ResourceId":{"shape":"EntityIdentifier"}, "Name":{"shape":"ResourceName"}, - "BookingOptions":{"shape":"BookingOptions"} + "BookingOptions":{"shape":"BookingOptions"}, + "Description":{"shape":"NewResourceDescription"}, + "Type":{"shape":"ResourceType"}, + "HiddenFromGlobalAddressList":{"shape":"BooleanObject"} } }, "UpdateResourceResponse":{ @@ -3821,6 +4057,37 @@ "members":{ } }, + "UpdateUserRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId" + ], + "members":{ + "OrganizationId":{"shape":"OrganizationId"}, + "UserId":{"shape":"EntityIdentifier"}, + "Role":{"shape":"UserRole"}, + "DisplayName":{"shape":"UserAttribute"}, + "FirstName":{"shape":"UserAttribute"}, + "LastName":{"shape":"UserAttribute"}, + "HiddenFromGlobalAddressList":{"shape":"BooleanObject"}, + "Initials":{"shape":"UserAttribute"}, + "Telephone":{"shape":"UserAttribute"}, + "Street":{"shape":"UserAttribute"}, + "JobTitle":{"shape":"UserAttribute"}, + "City":{"shape":"UserAttribute"}, + "Company":{"shape":"UserAttribute"}, + "ZipCode":{"shape":"UserAttribute"}, + "Department":{"shape":"UserAttribute"}, + "Country":{"shape":"UserAttribute"}, + "Office":{"shape":"UserAttribute"} + } + }, + "UpdateUserResponse":{ + "type":"structure", + "members":{ + } + }, "Url":{ "type":"string", "max":256, @@ -3839,6 +4106,11 @@ "DisabledDate":{"shape":"Timestamp"} } }, + "UserAttribute":{ + "type":"string", + "max":256, + "sensitive":true + }, "UserIdList":{ "type":"list", "member":{"shape":"WorkMailIdentifier"}, @@ -3856,7 +4128,8 @@ "enum":[ "USER", "RESOURCE", - "SYSTEM_USER" + "SYSTEM_USER", + "REMOTE_USER" ] }, "Users":{ @@ -3867,7 +4140,7 @@ "type":"string", "max":209, "min":3, - "pattern":"[a-zA-Z0-9.-]+\\.[a-zA-Z-]{2,}" + "pattern":"[a-zA-Z0-9.-]+" }, "WorkMailIdentifier":{ "type":"string", diff --git a/src/data/workmail/2017-10-01/api-2.json.php b/src/data/workmail/2017-10-01/api-2.json.php index 26dc10e7ae..58e6b33593 100644 --- a/src/data/workmail/2017-10-01/api-2.json.php +++ b/src/data/workmail/2017-10-01/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2017-10-01', 'endpointPrefix' => 'workmail', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'Amazon WorkMail', 'serviceId' => 'WorkMail', 'signatureVersion' => 'v4', 'targetPrefix' => 'WorkMailService', 'uid' => 'workmail-2017-10-01', ], 'operations' => [ 'AssociateDelegateToResource' => [ 'name' => 'AssociateDelegateToResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateDelegateToResourceRequest', ], 'output' => [ 'shape' => 'AssociateDelegateToResourceResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'AssociateMemberToGroup' => [ 'name' => 'AssociateMemberToGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateMemberToGroupRequest', ], 'output' => [ 'shape' => 'AssociateMemberToGroupResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'AssumeImpersonationRole' => [ 'name' => 'AssumeImpersonationRole', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssumeImpersonationRoleRequest', ], 'output' => [ 'shape' => 'AssumeImpersonationRoleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'CancelMailboxExportJob' => [ 'name' => 'CancelMailboxExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CancelMailboxExportJobRequest', ], 'output' => [ 'shape' => 'CancelMailboxExportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], ], 'idempotent' => true, ], 'CreateAlias' => [ 'name' => 'CreateAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAliasRequest', ], 'output' => [ 'shape' => 'CreateAliasResponse', ], 'errors' => [ [ 'shape' => 'EmailAddressInUseException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'MailDomainNotFoundException', ], [ 'shape' => 'MailDomainStateException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'LimitExceededException', ], ], 'idempotent' => true, ], 'CreateAvailabilityConfiguration' => [ 'name' => 'CreateAvailabilityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAvailabilityConfigurationRequest', ], 'output' => [ 'shape' => 'CreateAvailabilityConfigurationResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'NameAvailabilityException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], ], 'idempotent' => true, ], 'CreateGroup' => [ 'name' => 'CreateGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGroupRequest', ], 'output' => [ 'shape' => 'CreateGroupResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NameAvailabilityException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ReservedNameException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'CreateImpersonationRole' => [ 'name' => 'CreateImpersonationRole', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImpersonationRoleRequest', ], 'output' => [ 'shape' => 'CreateImpersonationRoleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'CreateMobileDeviceAccessRule' => [ 'name' => 'CreateMobileDeviceAccessRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMobileDeviceAccessRuleRequest', ], 'output' => [ 'shape' => 'CreateMobileDeviceAccessRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'CreateOrganization' => [ 'name' => 'CreateOrganization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateOrganizationRequest', ], 'output' => [ 'shape' => 'CreateOrganizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DirectoryInUseException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NameAvailabilityException', ], ], 'idempotent' => true, ], 'CreateResource' => [ 'name' => 'CreateResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateResourceRequest', ], 'output' => [ 'shape' => 'CreateResourceResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NameAvailabilityException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ReservedNameException', ], ], 'idempotent' => true, ], 'CreateUser' => [ 'name' => 'CreateUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserRequest', ], 'output' => [ 'shape' => 'CreateUserResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'NameAvailabilityException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ReservedNameException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'DeleteAccessControlRule' => [ 'name' => 'DeleteAccessControlRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAccessControlRuleRequest', ], 'output' => [ 'shape' => 'DeleteAccessControlRuleResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'DeleteAlias' => [ 'name' => 'DeleteAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAliasRequest', ], 'output' => [ 'shape' => 'DeleteAliasResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteAvailabilityConfiguration' => [ 'name' => 'DeleteAvailabilityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAvailabilityConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteAvailabilityConfigurationResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteEmailMonitoringConfiguration' => [ 'name' => 'DeleteEmailMonitoringConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEmailMonitoringConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteEmailMonitoringConfigurationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteGroup' => [ 'name' => 'DeleteGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGroupRequest', ], 'output' => [ 'shape' => 'DeleteGroupResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'DeleteImpersonationRole' => [ 'name' => 'DeleteImpersonationRole', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImpersonationRoleRequest', ], 'output' => [ 'shape' => 'DeleteImpersonationRoleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'DeleteMailboxPermissions' => [ 'name' => 'DeleteMailboxPermissions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMailboxPermissionsRequest', ], 'output' => [ 'shape' => 'DeleteMailboxPermissionsResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteMobileDeviceAccessOverride' => [ 'name' => 'DeleteMobileDeviceAccessOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMobileDeviceAccessOverrideRequest', ], 'output' => [ 'shape' => 'DeleteMobileDeviceAccessOverrideResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], ], ], 'DeleteMobileDeviceAccessRule' => [ 'name' => 'DeleteMobileDeviceAccessRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMobileDeviceAccessRuleRequest', ], 'output' => [ 'shape' => 'DeleteMobileDeviceAccessRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'DeleteOrganization' => [ 'name' => 'DeleteOrganization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOrganizationRequest', ], 'output' => [ 'shape' => 'DeleteOrganizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteResource' => [ 'name' => 'DeleteResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResourceRequest', ], 'output' => [ 'shape' => 'DeleteResourceResponse', ], 'errors' => [ [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteRetentionPolicy' => [ 'name' => 'DeleteRetentionPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRetentionPolicyRequest', ], 'output' => [ 'shape' => 'DeleteRetentionPolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteUser' => [ 'name' => 'DeleteUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserRequest', ], 'output' => [ 'shape' => 'DeleteUserResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'DeregisterFromWorkMail' => [ 'name' => 'DeregisterFromWorkMail', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterFromWorkMailRequest', ], 'output' => [ 'shape' => 'DeregisterFromWorkMailResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeregisterMailDomain' => [ 'name' => 'DeregisterMailDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterMailDomainRequest', ], 'output' => [ 'shape' => 'DeregisterMailDomainResponse', ], 'errors' => [ [ 'shape' => 'MailDomainInUseException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidCustomSesConfigurationException', ], ], 'idempotent' => true, ], 'DescribeEmailMonitoringConfiguration' => [ 'name' => 'DescribeEmailMonitoringConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEmailMonitoringConfigurationRequest', ], 'output' => [ 'shape' => 'DescribeEmailMonitoringConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DescribeGroup' => [ 'name' => 'DescribeGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGroupRequest', ], 'output' => [ 'shape' => 'DescribeGroupResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DescribeInboundDmarcSettings' => [ 'name' => 'DescribeInboundDmarcSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInboundDmarcSettingsRequest', ], 'output' => [ 'shape' => 'DescribeInboundDmarcSettingsResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DescribeMailboxExportJob' => [ 'name' => 'DescribeMailboxExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMailboxExportJobRequest', ], 'output' => [ 'shape' => 'DescribeMailboxExportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], ], 'idempotent' => true, ], 'DescribeOrganization' => [ 'name' => 'DescribeOrganization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrganizationRequest', ], 'output' => [ 'shape' => 'DescribeOrganizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], ], 'idempotent' => true, ], 'DescribeResource' => [ 'name' => 'DescribeResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeResourceRequest', ], 'output' => [ 'shape' => 'DescribeResourceResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DescribeUser' => [ 'name' => 'DescribeUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserRequest', ], 'output' => [ 'shape' => 'DescribeUserResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DisassociateDelegateFromResource' => [ 'name' => 'DisassociateDelegateFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateDelegateFromResourceRequest', ], 'output' => [ 'shape' => 'DisassociateDelegateFromResourceResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DisassociateMemberFromGroup' => [ 'name' => 'DisassociateMemberFromGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateMemberFromGroupRequest', ], 'output' => [ 'shape' => 'DisassociateMemberFromGroupResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'GetAccessControlEffect' => [ 'name' => 'GetAccessControlEffect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAccessControlEffectRequest', ], 'output' => [ 'shape' => 'GetAccessControlEffectResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'GetDefaultRetentionPolicy' => [ 'name' => 'GetDefaultRetentionPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDefaultRetentionPolicyRequest', ], 'output' => [ 'shape' => 'GetDefaultRetentionPolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], ], 'idempotent' => true, ], 'GetImpersonationRole' => [ 'name' => 'GetImpersonationRole', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetImpersonationRoleRequest', ], 'output' => [ 'shape' => 'GetImpersonationRoleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetImpersonationRoleEffect' => [ 'name' => 'GetImpersonationRoleEffect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetImpersonationRoleEffectRequest', ], 'output' => [ 'shape' => 'GetImpersonationRoleEffectResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], ], ], 'GetMailDomain' => [ 'name' => 'GetMailDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetMailDomainRequest', ], 'output' => [ 'shape' => 'GetMailDomainResponse', ], 'errors' => [ [ 'shape' => 'MailDomainNotFoundException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'GetMailboxDetails' => [ 'name' => 'GetMailboxDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetMailboxDetailsRequest', ], 'output' => [ 'shape' => 'GetMailboxDetailsResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], ], 'idempotent' => true, ], 'GetMobileDeviceAccessEffect' => [ 'name' => 'GetMobileDeviceAccessEffect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetMobileDeviceAccessEffectRequest', ], 'output' => [ 'shape' => 'GetMobileDeviceAccessEffectResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'GetMobileDeviceAccessOverride' => [ 'name' => 'GetMobileDeviceAccessOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetMobileDeviceAccessOverrideRequest', ], 'output' => [ 'shape' => 'GetMobileDeviceAccessOverrideResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAccessControlRules' => [ 'name' => 'ListAccessControlRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAccessControlRulesRequest', ], 'output' => [ 'shape' => 'ListAccessControlRulesResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'ListAliases' => [ 'name' => 'ListAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAliasesRequest', ], 'output' => [ 'shape' => 'ListAliasesResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListAvailabilityConfigurations' => [ 'name' => 'ListAvailabilityConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAvailabilityConfigurationsRequest', ], 'output' => [ 'shape' => 'ListAvailabilityConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'ListGroupMembers' => [ 'name' => 'ListGroupMembers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListGroupMembersRequest', ], 'output' => [ 'shape' => 'ListGroupMembersResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListGroups' => [ 'name' => 'ListGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListGroupsRequest', ], 'output' => [ 'shape' => 'ListGroupsResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListImpersonationRoles' => [ 'name' => 'ListImpersonationRoles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImpersonationRolesRequest', ], 'output' => [ 'shape' => 'ListImpersonationRolesResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'ListMailDomains' => [ 'name' => 'ListMailDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMailDomainsRequest', ], 'output' => [ 'shape' => 'ListMailDomainsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListMailboxExportJobs' => [ 'name' => 'ListMailboxExportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMailboxExportJobsRequest', ], 'output' => [ 'shape' => 'ListMailboxExportJobsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListMailboxPermissions' => [ 'name' => 'ListMailboxPermissions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMailboxPermissionsRequest', ], 'output' => [ 'shape' => 'ListMailboxPermissionsResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListMobileDeviceAccessOverrides' => [ 'name' => 'ListMobileDeviceAccessOverrides', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMobileDeviceAccessOverridesRequest', ], 'output' => [ 'shape' => 'ListMobileDeviceAccessOverridesResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], ], ], 'ListMobileDeviceAccessRules' => [ 'name' => 'ListMobileDeviceAccessRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMobileDeviceAccessRulesRequest', ], 'output' => [ 'shape' => 'ListMobileDeviceAccessRulesResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'ListOrganizations' => [ 'name' => 'ListOrganizations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListOrganizationsRequest', ], 'output' => [ 'shape' => 'ListOrganizationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'ListResourceDelegates' => [ 'name' => 'ListResourceDelegates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceDelegatesRequest', ], 'output' => [ 'shape' => 'ListResourceDelegatesResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListResources' => [ 'name' => 'ListResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourcesRequest', ], 'output' => [ 'shape' => 'ListResourcesResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListUsers' => [ 'name' => 'ListUsers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUsersRequest', ], 'output' => [ 'shape' => 'ListUsersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'PutAccessControlRule' => [ 'name' => 'PutAccessControlRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAccessControlRuleRequest', ], 'output' => [ 'shape' => 'PutAccessControlRuleResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'PutEmailMonitoringConfiguration' => [ 'name' => 'PutEmailMonitoringConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutEmailMonitoringConfigurationRequest', ], 'output' => [ 'shape' => 'PutEmailMonitoringConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'PutInboundDmarcSettings' => [ 'name' => 'PutInboundDmarcSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutInboundDmarcSettingsRequest', ], 'output' => [ 'shape' => 'PutInboundDmarcSettingsResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'PutMailboxPermissions' => [ 'name' => 'PutMailboxPermissions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutMailboxPermissionsRequest', ], 'output' => [ 'shape' => 'PutMailboxPermissionsResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'PutMobileDeviceAccessOverride' => [ 'name' => 'PutMobileDeviceAccessOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutMobileDeviceAccessOverrideRequest', ], 'output' => [ 'shape' => 'PutMobileDeviceAccessOverrideResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], ], ], 'PutRetentionPolicy' => [ 'name' => 'PutRetentionPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutRetentionPolicyRequest', ], 'output' => [ 'shape' => 'PutRetentionPolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'LimitExceededException', ], ], 'idempotent' => true, ], 'RegisterMailDomain' => [ 'name' => 'RegisterMailDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterMailDomainRequest', ], 'output' => [ 'shape' => 'RegisterMailDomainResponse', ], 'errors' => [ [ 'shape' => 'MailDomainInUseException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'RegisterToWorkMail' => [ 'name' => 'RegisterToWorkMail', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterToWorkMailRequest', ], 'output' => [ 'shape' => 'RegisterToWorkMailResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EmailAddressInUseException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'EntityAlreadyRegisteredException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'MailDomainNotFoundException', ], [ 'shape' => 'MailDomainStateException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ResetPassword' => [ 'name' => 'ResetPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetPasswordRequest', ], 'output' => [ 'shape' => 'ResetPasswordResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'StartMailboxExportJob' => [ 'name' => 'StartMailboxExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMailboxExportJobRequest', ], 'output' => [ 'shape' => 'StartMailboxExportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'LimitExceededException', ], ], 'idempotent' => true, ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'TestAvailabilityConfiguration' => [ 'name' => 'TestAvailabilityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TestAvailabilityConfigurationRequest', ], 'output' => [ 'shape' => 'TestAvailabilityConfigurationResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UpdateAvailabilityConfiguration' => [ 'name' => 'UpdateAvailabilityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateAvailabilityConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateAvailabilityConfigurationResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'UpdateDefaultMailDomain' => [ 'name' => 'UpdateDefaultMailDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDefaultMailDomainRequest', ], 'output' => [ 'shape' => 'UpdateDefaultMailDomainResponse', ], 'errors' => [ [ 'shape' => 'MailDomainNotFoundException', ], [ 'shape' => 'MailDomainStateException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'UpdateImpersonationRole' => [ 'name' => 'UpdateImpersonationRole', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImpersonationRoleRequest', ], 'output' => [ 'shape' => 'UpdateImpersonationRoleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'UpdateMailboxQuota' => [ 'name' => 'UpdateMailboxQuota', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMailboxQuotaRequest', ], 'output' => [ 'shape' => 'UpdateMailboxQuotaResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], ], 'idempotent' => true, ], 'UpdateMobileDeviceAccessRule' => [ 'name' => 'UpdateMobileDeviceAccessRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMobileDeviceAccessRuleRequest', ], 'output' => [ 'shape' => 'UpdateMobileDeviceAccessRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'UpdatePrimaryEmailAddress' => [ 'name' => 'UpdatePrimaryEmailAddress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePrimaryEmailAddressRequest', ], 'output' => [ 'shape' => 'UpdatePrimaryEmailAddressResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EmailAddressInUseException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'MailDomainNotFoundException', ], [ 'shape' => 'MailDomainStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'UpdateResource' => [ 'name' => 'UpdateResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateResourceRequest', ], 'output' => [ 'shape' => 'UpdateResourceResponse', ], 'errors' => [ [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidConfigurationException', ], [ 'shape' => 'EmailAddressInUseException', ], [ 'shape' => 'MailDomainNotFoundException', ], [ 'shape' => 'MailDomainStateException', ], [ 'shape' => 'NameAvailabilityException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], ], 'shapes' => [ 'AccessControlRule' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'AccessControlRuleName', ], 'Effect' => [ 'shape' => 'AccessControlRuleEffect', ], 'Description' => [ 'shape' => 'AccessControlRuleDescription', ], 'IpRanges' => [ 'shape' => 'IpRangeList', ], 'NotIpRanges' => [ 'shape' => 'IpRangeList', ], 'Actions' => [ 'shape' => 'ActionsList', ], 'NotActions' => [ 'shape' => 'ActionsList', ], 'UserIds' => [ 'shape' => 'UserIdList', ], 'NotUserIds' => [ 'shape' => 'UserIdList', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], 'ImpersonationRoleIds' => [ 'shape' => 'ImpersonationRoleIdList', ], 'NotImpersonationRoleIds' => [ 'shape' => 'ImpersonationRoleIdList', ], ], ], 'AccessControlRuleAction' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z]+', ], 'AccessControlRuleDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 0, 'pattern' => '[\\u0020-\\u00FF]+', ], 'AccessControlRuleEffect' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'DENY', ], ], 'AccessControlRuleName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'AccessControlRuleNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccessControlRuleName', ], 'max' => 10, 'min' => 0, ], 'AccessControlRulesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccessControlRule', ], 'max' => 10, 'min' => 0, ], 'AccessEffect' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'DENY', ], ], 'ActionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccessControlRuleAction', ], 'max' => 10, 'min' => 0, ], 'Aliases' => [ 'type' => 'list', 'member' => [ 'shape' => 'EmailAddress', ], ], 'AmazonResourceName' => [ 'type' => 'string', 'max' => 1011, 'min' => 1, ], 'AssociateDelegateToResourceRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ResourceId', 'EntityId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'AssociateDelegateToResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'AssociateMemberToGroupRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'GroupId', 'MemberId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'GroupId' => [ 'shape' => 'WorkMailIdentifier', ], 'MemberId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'AssociateMemberToGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'AssumeImpersonationRoleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ImpersonationRoleId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], ], ], 'AssumeImpersonationRoleResponse' => [ 'type' => 'structure', 'members' => [ 'Token' => [ 'shape' => 'ImpersonationToken', ], 'ExpiresIn' => [ 'shape' => 'ExpiresIn', ], ], ], 'AvailabilityConfiguration' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'ProviderType' => [ 'shape' => 'AvailabilityProviderType', ], 'EwsProvider' => [ 'shape' => 'RedactedEwsAvailabilityProvider', ], 'LambdaProvider' => [ 'shape' => 'LambdaAvailabilityProvider', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], ], ], 'AvailabilityConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityConfiguration', ], ], 'AvailabilityProviderType' => [ 'type' => 'string', 'enum' => [ 'EWS', 'LAMBDA', ], ], 'BookingOptions' => [ 'type' => 'structure', 'members' => [ 'AutoAcceptRequests' => [ 'shape' => 'Boolean', ], 'AutoDeclineRecurringRequests' => [ 'shape' => 'Boolean', ], 'AutoDeclineConflictingRequests' => [ 'shape' => 'Boolean', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanObject' => [ 'type' => 'boolean', ], 'CancelMailboxExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ClientToken', 'JobId', 'OrganizationId', ], 'members' => [ 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'JobId' => [ 'shape' => 'MailboxExportJobId', ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'CancelMailboxExportJobResponse' => [ 'type' => 'structure', 'members' => [], ], 'CreateAliasRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', 'Alias', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'Alias' => [ 'shape' => 'EmailAddress', ], ], ], 'CreateAliasResponse' => [ 'type' => 'structure', 'members' => [], ], 'CreateAvailabilityConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'EwsProvider' => [ 'shape' => 'EwsAvailabilityProvider', ], 'LambdaProvider' => [ 'shape' => 'LambdaAvailabilityProvider', ], ], ], 'CreateAvailabilityConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'CreateGroupRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Name' => [ 'shape' => 'GroupName', ], ], ], 'CreateGroupResponse' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'CreateImpersonationRoleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', 'Type', 'Rules', ], 'members' => [ 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Name' => [ 'shape' => 'ImpersonationRoleName', ], 'Type' => [ 'shape' => 'ImpersonationRoleType', ], 'Description' => [ 'shape' => 'ImpersonationRoleDescription', ], 'Rules' => [ 'shape' => 'ImpersonationRuleList', ], ], ], 'CreateImpersonationRoleResponse' => [ 'type' => 'structure', 'members' => [ 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], ], ], 'CreateMobileDeviceAccessRuleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', 'Effect', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'Name' => [ 'shape' => 'MobileDeviceAccessRuleName', ], 'Description' => [ 'shape' => 'MobileDeviceAccessRuleDescription', ], 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'DeviceTypes' => [ 'shape' => 'DeviceTypeList', ], 'NotDeviceTypes' => [ 'shape' => 'DeviceTypeList', ], 'DeviceModels' => [ 'shape' => 'DeviceModelList', ], 'NotDeviceModels' => [ 'shape' => 'DeviceModelList', ], 'DeviceOperatingSystems' => [ 'shape' => 'DeviceOperatingSystemList', ], 'NotDeviceOperatingSystems' => [ 'shape' => 'DeviceOperatingSystemList', ], 'DeviceUserAgents' => [ 'shape' => 'DeviceUserAgentList', ], 'NotDeviceUserAgents' => [ 'shape' => 'DeviceUserAgentList', ], ], ], 'CreateMobileDeviceAccessRuleResponse' => [ 'type' => 'structure', 'members' => [ 'MobileDeviceAccessRuleId' => [ 'shape' => 'MobileDeviceAccessRuleId', ], ], ], 'CreateOrganizationRequest' => [ 'type' => 'structure', 'required' => [ 'Alias', ], 'members' => [ 'DirectoryId' => [ 'shape' => 'DirectoryId', ], 'Alias' => [ 'shape' => 'OrganizationName', ], 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'Domains' => [ 'shape' => 'Domains', ], 'KmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'EnableInteroperability' => [ 'shape' => 'Boolean', ], ], ], 'CreateOrganizationResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'CreateResourceRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', 'Type', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'Type' => [ 'shape' => 'ResourceType', ], ], ], 'CreateResourceResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'CreateUserRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', 'DisplayName', 'Password', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Name' => [ 'shape' => 'UserName', ], 'DisplayName' => [ 'shape' => 'String', ], 'Password' => [ 'shape' => 'Password', ], ], ], 'CreateUserResponse' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'Delegate' => [ 'type' => 'structure', 'required' => [ 'Id', 'Type', ], 'members' => [ 'Id' => [ 'shape' => 'String', ], 'Type' => [ 'shape' => 'MemberType', ], ], ], 'DeleteAccessControlRuleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Name' => [ 'shape' => 'AccessControlRuleName', ], ], ], 'DeleteAccessControlRuleResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteAliasRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', 'Alias', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'Alias' => [ 'shape' => 'EmailAddress', ], ], ], 'DeleteAliasResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteAvailabilityConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'DomainName', ], ], ], 'DeleteAvailabilityConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteEmailMonitoringConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'DeleteEmailMonitoringConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteGroupRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'GroupId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'GroupId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'DeleteGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteImpersonationRoleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ImpersonationRoleId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], ], ], 'DeleteImpersonationRoleResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteMailboxPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', 'GranteeId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'GranteeId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'DeleteMailboxPermissionsResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteMobileDeviceAccessOverrideRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', 'DeviceId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], ], ], 'DeleteMobileDeviceAccessOverrideResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteMobileDeviceAccessRuleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'MobileDeviceAccessRuleId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'MobileDeviceAccessRuleId' => [ 'shape' => 'MobileDeviceAccessRuleId', ], ], ], 'DeleteMobileDeviceAccessRuleResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteOrganizationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DeleteDirectory', ], 'members' => [ 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DeleteDirectory' => [ 'shape' => 'Boolean', ], ], ], 'DeleteOrganizationResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'State' => [ 'shape' => 'String', ], ], ], 'DeleteResourceRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ResourceId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'DeleteResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRetentionPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Id', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Id' => [ 'shape' => 'ShortString', ], ], ], 'DeleteRetentionPolicyResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteUserRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'DeleteUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeregisterFromWorkMailRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'DeregisterFromWorkMailResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeregisterMailDomainRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'WorkMailDomainName', ], ], ], 'DeregisterMailDomainResponse' => [ 'type' => 'structure', 'members' => [], ], 'DescribeEmailMonitoringConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'DescribeEmailMonitoringConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LogGroupArn' => [ 'shape' => 'LogGroupArn', ], ], ], 'DescribeGroupRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'GroupId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'GroupId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'DescribeGroupResponse' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => 'WorkMailIdentifier', ], 'Name' => [ 'shape' => 'GroupName', ], 'Email' => [ 'shape' => 'EmailAddress', ], 'State' => [ 'shape' => 'EntityState', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeInboundDmarcSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'DescribeInboundDmarcSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'Enforced' => [ 'shape' => 'Boolean', ], ], ], 'DescribeMailboxExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobId', 'OrganizationId', ], 'members' => [ 'JobId' => [ 'shape' => 'MailboxExportJobId', ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'DescribeMailboxExportJobResponse' => [ 'type' => 'structure', 'members' => [ 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'Description' => [ 'shape' => 'Description', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'S3BucketName' => [ 'shape' => 'S3BucketName', ], 'S3Prefix' => [ 'shape' => 'S3ObjectKey', ], 'S3Path' => [ 'shape' => 'S3ObjectKey', ], 'EstimatedProgress' => [ 'shape' => 'Percentage', ], 'State' => [ 'shape' => 'MailboxExportJobState', ], 'ErrorInfo' => [ 'shape' => 'MailboxExportErrorInfo', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeOrganizationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'DescribeOrganizationResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Alias' => [ 'shape' => 'OrganizationName', ], 'State' => [ 'shape' => 'String', ], 'DirectoryId' => [ 'shape' => 'String', ], 'DirectoryType' => [ 'shape' => 'String', ], 'DefaultMailDomain' => [ 'shape' => 'String', ], 'CompletedDate' => [ 'shape' => 'Timestamp', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'ARN' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DescribeResourceRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ResourceId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'DescribeResourceResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Email' => [ 'shape' => 'EmailAddress', ], 'Name' => [ 'shape' => 'ResourceName', ], 'Type' => [ 'shape' => 'ResourceType', ], 'BookingOptions' => [ 'shape' => 'BookingOptions', ], 'State' => [ 'shape' => 'EntityState', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeUserRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'DescribeUserResponse' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], 'Name' => [ 'shape' => 'UserName', ], 'Email' => [ 'shape' => 'EmailAddress', ], 'DisplayName' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'EntityState', ], 'UserRole' => [ 'shape' => 'UserRole', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 1023, 'min' => 0, 'pattern' => '[\\S\\s]*', ], 'DeviceId' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '[A-Za-z0-9]+', ], 'DeviceModel' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'DeviceModelList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceModel', ], 'max' => 10, 'min' => 1, ], 'DeviceOperatingSystem' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'DeviceOperatingSystemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceOperatingSystem', ], 'max' => 10, 'min' => 1, ], 'DeviceType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'DeviceTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceType', ], 'max' => 10, 'min' => 1, ], 'DeviceUserAgent' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'DeviceUserAgentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceUserAgent', ], 'max' => 10, 'min' => 1, ], 'DirectoryId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^d-[0-9a-f]{10}$', ], 'DirectoryInUseException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'DirectoryServiceAuthenticationFailedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'DirectoryUnavailableException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'DisassociateDelegateFromResourceRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ResourceId', 'EntityId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'DisassociateDelegateFromResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateMemberFromGroupRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'GroupId', 'MemberId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'GroupId' => [ 'shape' => 'WorkMailIdentifier', ], 'MemberId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'DisassociateMemberFromGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DnsRecord' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'Hostname' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'DnsRecordVerificationStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'VERIFIED', 'FAILED', ], ], 'DnsRecords' => [ 'type' => 'list', 'member' => [ 'shape' => 'DnsRecord', ], ], 'Domain' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'HostedZoneId' => [ 'shape' => 'HostedZoneId', ], ], ], 'DomainName' => [ 'type' => 'string', 'max' => 255, 'min' => 3, 'pattern' => '[a-zA-Z0-9.-]+\\.[a-zA-Z-]{2,}', ], 'Domains' => [ 'type' => 'list', 'member' => [ 'shape' => 'Domain', ], 'max' => 5, 'min' => 0, ], 'EmailAddress' => [ 'type' => 'string', 'max' => 254, 'min' => 1, 'pattern' => '[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\\.[a-zA-Z-]{2,}', ], 'EmailAddressInUseException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'EntityAlreadyRegisteredException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'EntityIdentifier' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9._%+@-]+', ], 'EntityNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'EntityState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', 'DELETED', ], ], 'EntityStateException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'EwsAvailabilityProvider' => [ 'type' => 'structure', 'required' => [ 'EwsEndpoint', 'EwsUsername', 'EwsPassword', ], 'members' => [ 'EwsEndpoint' => [ 'shape' => 'Url', ], 'EwsUsername' => [ 'shape' => 'ExternalUserName', ], 'EwsPassword' => [ 'shape' => 'Password', ], ], ], 'ExpiresIn' => [ 'type' => 'long', 'box' => true, ], 'ExternalUserName' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\u0020-\\u00FF]+', ], 'FolderConfiguration' => [ 'type' => 'structure', 'required' => [ 'Name', 'Action', ], 'members' => [ 'Name' => [ 'shape' => 'FolderName', ], 'Action' => [ 'shape' => 'RetentionAction', ], 'Period' => [ 'shape' => 'RetentionPeriod', ], ], ], 'FolderConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'FolderConfiguration', ], ], 'FolderName' => [ 'type' => 'string', 'enum' => [ 'INBOX', 'DELETED_ITEMS', 'SENT_ITEMS', 'DRAFTS', 'JUNK_EMAIL', ], ], 'GetAccessControlEffectRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'IpAddress', 'Action', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], 'Action' => [ 'shape' => 'AccessControlRuleAction', ], 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], ], ], 'GetAccessControlEffectResponse' => [ 'type' => 'structure', 'members' => [ 'Effect' => [ 'shape' => 'AccessControlRuleEffect', ], 'MatchedRules' => [ 'shape' => 'AccessControlRuleNameList', ], ], ], 'GetDefaultRetentionPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'GetDefaultRetentionPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ShortString', ], 'Name' => [ 'shape' => 'ShortString', ], 'Description' => [ 'shape' => 'String', ], 'FolderConfigurations' => [ 'shape' => 'FolderConfigurations', ], ], ], 'GetImpersonationRoleEffectRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ImpersonationRoleId', 'TargetUser', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], 'TargetUser' => [ 'shape' => 'EntityIdentifier', ], ], ], 'GetImpersonationRoleEffectResponse' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ImpersonationRoleType', ], 'Effect' => [ 'shape' => 'AccessEffect', ], 'MatchedRules' => [ 'shape' => 'ImpersonationMatchedRuleList', ], ], ], 'GetImpersonationRoleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ImpersonationRoleId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], ], ], 'GetImpersonationRoleResponse' => [ 'type' => 'structure', 'members' => [ 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], 'Name' => [ 'shape' => 'ImpersonationRoleName', ], 'Type' => [ 'shape' => 'ImpersonationRoleType', ], 'Description' => [ 'shape' => 'ImpersonationRoleDescription', ], 'Rules' => [ 'shape' => 'ImpersonationRuleList', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], ], ], 'GetMailDomainRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'WorkMailDomainName', ], ], ], 'GetMailDomainResponse' => [ 'type' => 'structure', 'members' => [ 'Records' => [ 'shape' => 'DnsRecords', ], 'IsTestDomain' => [ 'shape' => 'Boolean', ], 'IsDefault' => [ 'shape' => 'Boolean', ], 'OwnershipVerificationStatus' => [ 'shape' => 'DnsRecordVerificationStatus', ], 'DkimVerificationStatus' => [ 'shape' => 'DnsRecordVerificationStatus', ], ], ], 'GetMailboxDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'GetMailboxDetailsResponse' => [ 'type' => 'structure', 'members' => [ 'MailboxQuota' => [ 'shape' => 'MailboxQuota', ], 'MailboxSize' => [ 'shape' => 'MailboxSize', ], ], ], 'GetMobileDeviceAccessEffectRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DeviceType' => [ 'shape' => 'DeviceType', ], 'DeviceModel' => [ 'shape' => 'DeviceModel', ], 'DeviceOperatingSystem' => [ 'shape' => 'DeviceOperatingSystem', ], 'DeviceUserAgent' => [ 'shape' => 'DeviceUserAgent', ], ], ], 'GetMobileDeviceAccessEffectResponse' => [ 'type' => 'structure', 'members' => [ 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'MatchedRules' => [ 'shape' => 'MobileDeviceAccessMatchedRuleList', ], ], ], 'GetMobileDeviceAccessOverrideRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', 'DeviceId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], ], ], 'GetMobileDeviceAccessOverrideResponse' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'Description' => [ 'shape' => 'MobileDeviceAccessRuleDescription', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], ], ], 'Group' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'WorkMailIdentifier', ], 'Email' => [ 'shape' => 'EmailAddress', ], 'Name' => [ 'shape' => 'GroupName', ], 'State' => [ 'shape' => 'EntityState', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], ], ], 'GroupName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'Groups' => [ 'type' => 'list', 'member' => [ 'shape' => 'Group', ], ], 'HostedZoneId' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '[\\S\\s]*', ], 'IdempotencyClientToken' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\x21-\\x7e]+', ], 'ImpersonationMatchedRule' => [ 'type' => 'structure', 'members' => [ 'ImpersonationRuleId' => [ 'shape' => 'ImpersonationRuleId', ], 'Name' => [ 'shape' => 'ImpersonationRuleName', ], ], ], 'ImpersonationMatchedRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImpersonationMatchedRule', ], 'max' => 10, 'min' => 0, ], 'ImpersonationRole' => [ 'type' => 'structure', 'members' => [ 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], 'Name' => [ 'shape' => 'ImpersonationRoleName', ], 'Type' => [ 'shape' => 'ImpersonationRoleType', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], ], ], 'ImpersonationRoleDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F\\x3C\\x3E\\x5C]+', ], 'ImpersonationRoleId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'ImpersonationRoleIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImpersonationRoleId', ], 'max' => 10, 'min' => 0, ], 'ImpersonationRoleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImpersonationRole', ], 'max' => 20, 'min' => 0, ], 'ImpersonationRoleName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[^\\x00-\\x1F\\x7F\\x3C\\x3E\\x5C]+', ], 'ImpersonationRoleType' => [ 'type' => 'string', 'enum' => [ 'FULL_ACCESS', 'READ_ONLY', ], ], 'ImpersonationRule' => [ 'type' => 'structure', 'required' => [ 'ImpersonationRuleId', 'Effect', ], 'members' => [ 'ImpersonationRuleId' => [ 'shape' => 'ImpersonationRuleId', ], 'Name' => [ 'shape' => 'ImpersonationRuleName', ], 'Description' => [ 'shape' => 'ImpersonationRuleDescription', ], 'Effect' => [ 'shape' => 'AccessEffect', ], 'TargetUsers' => [ 'shape' => 'TargetUsers', ], 'NotTargetUsers' => [ 'shape' => 'TargetUsers', ], ], ], 'ImpersonationRuleDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F\\x3C\\x3E\\x5C]+', ], 'ImpersonationRuleId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'ImpersonationRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImpersonationRule', ], 'max' => 10, 'min' => 0, ], 'ImpersonationRuleName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[^\\x00-\\x1F\\x7F\\x3C\\x3E\\x5C]+', ], 'ImpersonationToken' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\x21-\\x7e]+', ], 'InvalidConfigurationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidCustomSesConfigurationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidPasswordException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'IpAddress' => [ 'type' => 'string', 'max' => 15, 'min' => 1, '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])$', ], 'IpRange' => [ 'type' => 'string', 'max' => 18, 'min' => 1, '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])/([0-9]|[12][0-9]|3[0-2])$', ], 'IpRangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IpRange', ], 'max' => 1024, 'min' => 0, ], 'Jobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MailboxExportJob', ], ], 'KmsKeyArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws:kms:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}', ], 'LambdaArn' => [ 'type' => 'string', 'max' => 256, 'min' => 49, 'pattern' => 'arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9\\-_\\.]+(:(\\$LATEST|[a-zA-Z0-9\\-_]+))?', ], 'LambdaAvailabilityProvider' => [ 'type' => 'structure', 'required' => [ 'LambdaArn', ], 'members' => [ 'LambdaArn' => [ 'shape' => 'LambdaArn', ], ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ListAccessControlRulesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'ListAccessControlRulesResponse' => [ 'type' => 'structure', 'members' => [ 'Rules' => [ 'shape' => 'AccessControlRulesList', ], ], ], 'ListAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'Aliases' => [ 'shape' => 'Aliases', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAvailabilityConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAvailabilityConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'AvailabilityConfigurations' => [ 'shape' => 'AvailabilityConfigurationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListGroupMembersRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'GroupId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'GroupId' => [ 'shape' => 'WorkMailIdentifier', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListGroupMembersResponse' => [ 'type' => 'structure', 'members' => [ 'Members' => [ 'shape' => 'Members', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'Groups', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImpersonationRolesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListImpersonationRolesResponse' => [ 'type' => 'structure', 'members' => [ 'Roles' => [ 'shape' => 'ImpersonationRoleList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMailDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMailDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'MailDomains' => [ 'shape' => 'MailDomains', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMailboxExportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMailboxExportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'Jobs' => [ 'shape' => 'Jobs', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMailboxPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMailboxPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'Permissions' => [ 'shape' => 'Permissions', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMobileDeviceAccessOverridesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMobileDeviceAccessOverridesResponse' => [ 'type' => 'structure', 'members' => [ 'Overrides' => [ 'shape' => 'MobileDeviceAccessOverridesList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMobileDeviceAccessRulesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'ListMobileDeviceAccessRulesResponse' => [ 'type' => 'structure', 'members' => [ 'Rules' => [ 'shape' => 'MobileDeviceAccessRulesList', ], ], ], 'ListOrganizationsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListOrganizationsResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationSummaries' => [ 'shape' => 'OrganizationSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceDelegatesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ResourceId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ResourceId' => [ 'shape' => 'WorkMailIdentifier', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListResourceDelegatesResponse' => [ 'type' => 'structure', 'members' => [ 'Delegates' => [ 'shape' => 'ResourceDelegates', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListResourcesResponse' => [ 'type' => 'structure', 'members' => [ 'Resources' => [ 'shape' => 'Resources', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'AmazonResourceName', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ListUsersRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListUsersResponse' => [ 'type' => 'structure', 'members' => [ 'Users' => [ 'shape' => 'Users', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'LogGroupArn' => [ 'type' => 'string', 'max' => 562, 'min' => 47, 'pattern' => 'arn:aws:logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([\\.\\-_/#A-Za-z0-9]+):\\*$', ], 'MailDomainInUseException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'MailDomainNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'MailDomainStateException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'MailDomainSummary' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'DefaultDomain' => [ 'shape' => 'Boolean', ], ], ], 'MailDomains' => [ 'type' => 'list', 'member' => [ 'shape' => 'MailDomainSummary', ], ], 'MailboxExportErrorInfo' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\S\\s]*', ], 'MailboxExportJob' => [ 'type' => 'structure', 'members' => [ 'JobId' => [ 'shape' => 'MailboxExportJobId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'Description' => [ 'shape' => 'Description', ], 'S3BucketName' => [ 'shape' => 'S3BucketName', ], 'S3Path' => [ 'shape' => 'S3ObjectKey', ], 'EstimatedProgress' => [ 'shape' => 'Percentage', ], 'State' => [ 'shape' => 'MailboxExportJobState', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'MailboxExportJobId' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[A-Za-z0-9-]+', ], 'MailboxExportJobState' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'COMPLETED', 'FAILED', 'CANCELLED', ], ], 'MailboxQuota' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'MailboxSize' => [ 'type' => 'double', 'min' => 0, ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'Member' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'String', ], 'Name' => [ 'shape' => 'String', ], 'Type' => [ 'shape' => 'MemberType', ], 'State' => [ 'shape' => 'EntityState', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], ], ], 'MemberType' => [ 'type' => 'string', 'enum' => [ 'GROUP', 'USER', ], ], 'Members' => [ 'type' => 'list', 'member' => [ 'shape' => 'Member', ], ], 'MobileDeviceAccessMatchedRule' => [ 'type' => 'structure', 'members' => [ 'MobileDeviceAccessRuleId' => [ 'shape' => 'MobileDeviceAccessRuleId', ], 'Name' => [ 'shape' => 'MobileDeviceAccessRuleName', ], ], ], 'MobileDeviceAccessMatchedRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MobileDeviceAccessMatchedRule', ], 'max' => 10, 'min' => 0, ], 'MobileDeviceAccessOverride' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'Description' => [ 'shape' => 'MobileDeviceAccessRuleDescription', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], ], ], 'MobileDeviceAccessOverridesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MobileDeviceAccessOverride', ], ], 'MobileDeviceAccessRule' => [ 'type' => 'structure', 'members' => [ 'MobileDeviceAccessRuleId' => [ 'shape' => 'MobileDeviceAccessRuleId', ], 'Name' => [ 'shape' => 'MobileDeviceAccessRuleName', ], 'Description' => [ 'shape' => 'MobileDeviceAccessRuleDescription', ], 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'DeviceTypes' => [ 'shape' => 'DeviceTypeList', ], 'NotDeviceTypes' => [ 'shape' => 'DeviceTypeList', ], 'DeviceModels' => [ 'shape' => 'DeviceModelList', ], 'NotDeviceModels' => [ 'shape' => 'DeviceModelList', ], 'DeviceOperatingSystems' => [ 'shape' => 'DeviceOperatingSystemList', ], 'NotDeviceOperatingSystems' => [ 'shape' => 'DeviceOperatingSystemList', ], 'DeviceUserAgents' => [ 'shape' => 'DeviceUserAgentList', ], 'NotDeviceUserAgents' => [ 'shape' => 'DeviceUserAgentList', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], ], ], 'MobileDeviceAccessRuleDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'MobileDeviceAccessRuleEffect' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'DENY', ], ], 'MobileDeviceAccessRuleId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'MobileDeviceAccessRuleName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'MobileDeviceAccessRulesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MobileDeviceAccessRule', ], 'max' => 10, 'min' => 0, ], 'NameAvailabilityException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'NextToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\S\\s]*|[a-zA-Z0-9/+=]{1,1024}', ], 'OrganizationId' => [ 'type' => 'string', 'max' => 34, 'min' => 34, 'pattern' => '^m-[0-9a-f]{32}$', ], 'OrganizationName' => [ 'type' => 'string', 'max' => 62, 'min' => 1, 'pattern' => '^(?!d-)([\\da-zA-Z]+)([-][\\da-zA-Z]+)*', ], 'OrganizationNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'OrganizationStateException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'OrganizationSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationSummary', ], ], 'OrganizationSummary' => [ 'type' => 'structure', 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Alias' => [ 'shape' => 'OrganizationName', ], 'DefaultMailDomain' => [ 'shape' => 'DomainName', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'String', ], ], ], 'Password' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\u0020-\\u00FF]+', 'sensitive' => true, ], 'Percentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'Permission' => [ 'type' => 'structure', 'required' => [ 'GranteeId', 'GranteeType', 'PermissionValues', ], 'members' => [ 'GranteeId' => [ 'shape' => 'WorkMailIdentifier', ], 'GranteeType' => [ 'shape' => 'MemberType', ], 'PermissionValues' => [ 'shape' => 'PermissionValues', ], ], ], 'PermissionType' => [ 'type' => 'string', 'enum' => [ 'FULL_ACCESS', 'SEND_AS', 'SEND_ON_BEHALF', ], ], 'PermissionValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'PermissionType', ], ], 'Permissions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Permission', ], ], 'PolicyDescription' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\w\\d\\s\\S\\-!?=,.;:\'_]+', 'sensitive' => true, ], 'PutAccessControlRuleRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Effect', 'Description', 'OrganizationId', ], 'members' => [ 'Name' => [ 'shape' => 'AccessControlRuleName', ], 'Effect' => [ 'shape' => 'AccessControlRuleEffect', ], 'Description' => [ 'shape' => 'AccessControlRuleDescription', ], 'IpRanges' => [ 'shape' => 'IpRangeList', ], 'NotIpRanges' => [ 'shape' => 'IpRangeList', ], 'Actions' => [ 'shape' => 'ActionsList', ], 'NotActions' => [ 'shape' => 'ActionsList', ], 'UserIds' => [ 'shape' => 'UserIdList', ], 'NotUserIds' => [ 'shape' => 'UserIdList', ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ImpersonationRoleIds' => [ 'shape' => 'ImpersonationRoleIdList', ], 'NotImpersonationRoleIds' => [ 'shape' => 'ImpersonationRoleIdList', ], ], ], 'PutAccessControlRuleResponse' => [ 'type' => 'structure', 'members' => [], ], 'PutEmailMonitoringConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'RoleArn', 'LogGroupArn', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LogGroupArn' => [ 'shape' => 'LogGroupArn', ], ], ], 'PutEmailMonitoringConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'PutInboundDmarcSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Enforced', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Enforced' => [ 'shape' => 'BooleanObject', ], ], ], 'PutInboundDmarcSettingsResponse' => [ 'type' => 'structure', 'members' => [], ], 'PutMailboxPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', 'GranteeId', 'PermissionValues', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'GranteeId' => [ 'shape' => 'WorkMailIdentifier', ], 'PermissionValues' => [ 'shape' => 'PermissionValues', ], ], ], 'PutMailboxPermissionsResponse' => [ 'type' => 'structure', 'members' => [], ], 'PutMobileDeviceAccessOverrideRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', 'DeviceId', 'Effect', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'Description' => [ 'shape' => 'MobileDeviceAccessRuleDescription', ], ], ], 'PutMobileDeviceAccessOverrideResponse' => [ 'type' => 'structure', 'members' => [], ], 'PutRetentionPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', 'FolderConfigurations', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Id' => [ 'shape' => 'ShortString', ], 'Name' => [ 'shape' => 'ShortString', ], 'Description' => [ 'shape' => 'PolicyDescription', ], 'FolderConfigurations' => [ 'shape' => 'FolderConfigurations', ], ], ], 'PutRetentionPolicyResponse' => [ 'type' => 'structure', 'members' => [], ], 'RedactedEwsAvailabilityProvider' => [ 'type' => 'structure', 'members' => [ 'EwsEndpoint' => [ 'shape' => 'Url', ], 'EwsUsername' => [ 'shape' => 'ExternalUserName', ], ], ], 'RegisterMailDomainRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'WorkMailDomainName', ], ], ], 'RegisterMailDomainResponse' => [ 'type' => 'structure', 'members' => [], ], 'RegisterToWorkMailRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', 'Email', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'Email' => [ 'shape' => 'EmailAddress', ], ], ], 'RegisterToWorkMailResponse' => [ 'type' => 'structure', 'members' => [], ], 'ReservedNameException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResetPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', 'Password', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], 'Password' => [ 'shape' => 'Password', ], ], ], 'ResetPasswordResponse' => [ 'type' => 'structure', 'members' => [], ], 'Resource' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'WorkMailIdentifier', ], 'Email' => [ 'shape' => 'EmailAddress', ], 'Name' => [ 'shape' => 'ResourceName', ], 'Type' => [ 'shape' => 'ResourceType', ], 'State' => [ 'shape' => 'EntityState', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], ], ], 'ResourceDelegates' => [ 'type' => 'list', 'member' => [ 'shape' => 'Delegate', ], ], 'ResourceId' => [ 'type' => 'string', 'max' => 34, 'min' => 34, 'pattern' => '^r-[0-9a-f]{32}$', ], 'ResourceName' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9-]{2,})?', ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'ROOM', 'EQUIPMENT', ], ], 'Resources' => [ 'type' => 'list', 'member' => [ 'shape' => 'Resource', ], ], 'RetentionAction' => [ 'type' => 'string', 'enum' => [ 'NONE', 'DELETE', 'PERMANENTLY_DELETE', ], ], 'RetentionPeriod' => [ 'type' => 'integer', 'box' => true, 'max' => 730, 'min' => 1, ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[A-Za-z0-9.-]+', ], 'S3ObjectKey' => [ 'type' => 'string', 'max' => 1023, 'min' => 1, 'pattern' => '[A-Za-z0-9!_.*\'()/-]+', ], 'ShortString' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'StartMailboxExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ClientToken', 'OrganizationId', 'EntityId', 'RoleArn', 'KmsKeyArn', 'S3BucketName', 'S3Prefix', ], 'members' => [ 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'Description' => [ 'shape' => 'Description', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'S3BucketName' => [ 'shape' => 'S3BucketName', ], 'S3Prefix' => [ 'shape' => 'S3ObjectKey', ], ], ], 'StartMailboxExportJobResponse' => [ 'type' => 'structure', 'members' => [ 'JobId' => [ 'shape' => 'MailboxExportJobId', ], ], ], 'String' => [ 'type' => 'string', 'max' => 256, ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 0, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'Tags', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'AmazonResourceName', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TargetUsers' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntityIdentifier', ], 'max' => 10, 'min' => 1, ], 'TestAvailabilityConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'EwsProvider' => [ 'shape' => 'EwsAvailabilityProvider', ], 'LambdaProvider' => [ 'shape' => 'LambdaAvailabilityProvider', ], ], ], 'TestAvailabilityConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'TestPassed' => [ 'shape' => 'Boolean', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TooManyTagsException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'UnsupportedOperationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'TagKeys', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'AmazonResourceName', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateAvailabilityConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'EwsProvider' => [ 'shape' => 'EwsAvailabilityProvider', ], 'LambdaProvider' => [ 'shape' => 'LambdaAvailabilityProvider', ], ], ], 'UpdateAvailabilityConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateDefaultMailDomainRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'WorkMailDomainName', ], ], ], 'UpdateDefaultMailDomainResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateImpersonationRoleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ImpersonationRoleId', 'Name', 'Type', 'Rules', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], 'Name' => [ 'shape' => 'ImpersonationRoleName', ], 'Type' => [ 'shape' => 'ImpersonationRoleType', ], 'Description' => [ 'shape' => 'ImpersonationRoleDescription', ], 'Rules' => [ 'shape' => 'ImpersonationRuleList', ], ], ], 'UpdateImpersonationRoleResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateMailboxQuotaRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', 'MailboxQuota', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], 'MailboxQuota' => [ 'shape' => 'MailboxQuota', ], ], ], 'UpdateMailboxQuotaResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateMobileDeviceAccessRuleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'MobileDeviceAccessRuleId', 'Name', 'Effect', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'MobileDeviceAccessRuleId' => [ 'shape' => 'MobileDeviceAccessRuleId', ], 'Name' => [ 'shape' => 'MobileDeviceAccessRuleName', ], 'Description' => [ 'shape' => 'MobileDeviceAccessRuleDescription', ], 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'DeviceTypes' => [ 'shape' => 'DeviceTypeList', ], 'NotDeviceTypes' => [ 'shape' => 'DeviceTypeList', ], 'DeviceModels' => [ 'shape' => 'DeviceModelList', ], 'NotDeviceModels' => [ 'shape' => 'DeviceModelList', ], 'DeviceOperatingSystems' => [ 'shape' => 'DeviceOperatingSystemList', ], 'NotDeviceOperatingSystems' => [ 'shape' => 'DeviceOperatingSystemList', ], 'DeviceUserAgents' => [ 'shape' => 'DeviceUserAgentList', ], 'NotDeviceUserAgents' => [ 'shape' => 'DeviceUserAgentList', ], ], ], 'UpdateMobileDeviceAccessRuleResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePrimaryEmailAddressRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', 'Email', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'Email' => [ 'shape' => 'EmailAddress', ], ], ], 'UpdatePrimaryEmailAddressResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateResourceRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ResourceId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'BookingOptions' => [ 'shape' => 'BookingOptions', ], ], ], 'UpdateResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'Url' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'https?://[A-Za-z0-9.-]+(:[0-9]+)?/.*', ], 'User' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'WorkMailIdentifier', ], 'Email' => [ 'shape' => 'EmailAddress', ], 'Name' => [ 'shape' => 'UserName', ], 'DisplayName' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'EntityState', ], 'UserRole' => [ 'shape' => 'UserRole', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], ], ], 'UserIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkMailIdentifier', ], 'max' => 10, 'min' => 0, ], 'UserName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9-]{2,})?', ], 'UserRole' => [ 'type' => 'string', 'enum' => [ 'USER', 'RESOURCE', 'SYSTEM_USER', ], ], 'Users' => [ 'type' => 'list', 'member' => [ 'shape' => 'User', ], ], 'WorkMailDomainName' => [ 'type' => 'string', 'max' => 209, 'min' => 3, 'pattern' => '[a-zA-Z0-9.-]+\\.[a-zA-Z-]{2,}', ], 'WorkMailIdentifier' => [ 'type' => 'string', 'max' => 256, 'min' => 12, ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2017-10-01', 'endpointPrefix' => 'workmail', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'Amazon WorkMail', 'serviceId' => 'WorkMail', 'signatureVersion' => 'v4', 'targetPrefix' => 'WorkMailService', 'uid' => 'workmail-2017-10-01', ], 'operations' => [ 'AssociateDelegateToResource' => [ 'name' => 'AssociateDelegateToResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateDelegateToResourceRequest', ], 'output' => [ 'shape' => 'AssociateDelegateToResourceResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'AssociateMemberToGroup' => [ 'name' => 'AssociateMemberToGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateMemberToGroupRequest', ], 'output' => [ 'shape' => 'AssociateMemberToGroupResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'AssumeImpersonationRole' => [ 'name' => 'AssumeImpersonationRole', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssumeImpersonationRoleRequest', ], 'output' => [ 'shape' => 'AssumeImpersonationRoleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'CancelMailboxExportJob' => [ 'name' => 'CancelMailboxExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CancelMailboxExportJobRequest', ], 'output' => [ 'shape' => 'CancelMailboxExportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], ], 'idempotent' => true, ], 'CreateAlias' => [ 'name' => 'CreateAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAliasRequest', ], 'output' => [ 'shape' => 'CreateAliasResponse', ], 'errors' => [ [ 'shape' => 'EmailAddressInUseException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'MailDomainNotFoundException', ], [ 'shape' => 'MailDomainStateException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'LimitExceededException', ], ], 'idempotent' => true, ], 'CreateAvailabilityConfiguration' => [ 'name' => 'CreateAvailabilityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateAvailabilityConfigurationRequest', ], 'output' => [ 'shape' => 'CreateAvailabilityConfigurationResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'NameAvailabilityException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], ], 'idempotent' => true, ], 'CreateGroup' => [ 'name' => 'CreateGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGroupRequest', ], 'output' => [ 'shape' => 'CreateGroupResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NameAvailabilityException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ReservedNameException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'CreateImpersonationRole' => [ 'name' => 'CreateImpersonationRole', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateImpersonationRoleRequest', ], 'output' => [ 'shape' => 'CreateImpersonationRoleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'CreateMobileDeviceAccessRule' => [ 'name' => 'CreateMobileDeviceAccessRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateMobileDeviceAccessRuleRequest', ], 'output' => [ 'shape' => 'CreateMobileDeviceAccessRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'CreateOrganization' => [ 'name' => 'CreateOrganization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateOrganizationRequest', ], 'output' => [ 'shape' => 'CreateOrganizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'DirectoryInUseException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'NameAvailabilityException', ], ], 'idempotent' => true, ], 'CreateResource' => [ 'name' => 'CreateResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateResourceRequest', ], 'output' => [ 'shape' => 'CreateResourceResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'NameAvailabilityException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ReservedNameException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'CreateUser' => [ 'name' => 'CreateUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserRequest', ], 'output' => [ 'shape' => 'CreateUserResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'NameAvailabilityException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ReservedNameException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'DeleteAccessControlRule' => [ 'name' => 'DeleteAccessControlRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAccessControlRuleRequest', ], 'output' => [ 'shape' => 'DeleteAccessControlRuleResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'DeleteAlias' => [ 'name' => 'DeleteAlias', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAliasRequest', ], 'output' => [ 'shape' => 'DeleteAliasResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteAvailabilityConfiguration' => [ 'name' => 'DeleteAvailabilityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteAvailabilityConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteAvailabilityConfigurationResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteEmailMonitoringConfiguration' => [ 'name' => 'DeleteEmailMonitoringConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteEmailMonitoringConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteEmailMonitoringConfigurationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteGroup' => [ 'name' => 'DeleteGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGroupRequest', ], 'output' => [ 'shape' => 'DeleteGroupResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'DeleteImpersonationRole' => [ 'name' => 'DeleteImpersonationRole', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteImpersonationRoleRequest', ], 'output' => [ 'shape' => 'DeleteImpersonationRoleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'DeleteMailboxPermissions' => [ 'name' => 'DeleteMailboxPermissions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMailboxPermissionsRequest', ], 'output' => [ 'shape' => 'DeleteMailboxPermissionsResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteMobileDeviceAccessOverride' => [ 'name' => 'DeleteMobileDeviceAccessOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMobileDeviceAccessOverrideRequest', ], 'output' => [ 'shape' => 'DeleteMobileDeviceAccessOverrideResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], ], ], 'DeleteMobileDeviceAccessRule' => [ 'name' => 'DeleteMobileDeviceAccessRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteMobileDeviceAccessRuleRequest', ], 'output' => [ 'shape' => 'DeleteMobileDeviceAccessRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'DeleteOrganization' => [ 'name' => 'DeleteOrganization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteOrganizationRequest', ], 'output' => [ 'shape' => 'DeleteOrganizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteResource' => [ 'name' => 'DeleteResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteResourceRequest', ], 'output' => [ 'shape' => 'DeleteResourceResponse', ], 'errors' => [ [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'DeleteRetentionPolicy' => [ 'name' => 'DeleteRetentionPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRetentionPolicyRequest', ], 'output' => [ 'shape' => 'DeleteRetentionPolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeleteUser' => [ 'name' => 'DeleteUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserRequest', ], 'output' => [ 'shape' => 'DeleteUserResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'DeregisterFromWorkMail' => [ 'name' => 'DeregisterFromWorkMail', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterFromWorkMailRequest', ], 'output' => [ 'shape' => 'DeregisterFromWorkMailResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DeregisterMailDomain' => [ 'name' => 'DeregisterMailDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeregisterMailDomainRequest', ], 'output' => [ 'shape' => 'DeregisterMailDomainResponse', ], 'errors' => [ [ 'shape' => 'MailDomainInUseException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidCustomSesConfigurationException', ], ], 'idempotent' => true, ], 'DescribeEmailMonitoringConfiguration' => [ 'name' => 'DescribeEmailMonitoringConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEmailMonitoringConfigurationRequest', ], 'output' => [ 'shape' => 'DescribeEmailMonitoringConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DescribeEntity' => [ 'name' => 'DescribeEntity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEntityRequest', ], 'output' => [ 'shape' => 'DescribeEntityResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DescribeGroup' => [ 'name' => 'DescribeGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGroupRequest', ], 'output' => [ 'shape' => 'DescribeGroupResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DescribeInboundDmarcSettings' => [ 'name' => 'DescribeInboundDmarcSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInboundDmarcSettingsRequest', ], 'output' => [ 'shape' => 'DescribeInboundDmarcSettingsResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DescribeMailboxExportJob' => [ 'name' => 'DescribeMailboxExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeMailboxExportJobRequest', ], 'output' => [ 'shape' => 'DescribeMailboxExportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], ], 'idempotent' => true, ], 'DescribeOrganization' => [ 'name' => 'DescribeOrganization', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeOrganizationRequest', ], 'output' => [ 'shape' => 'DescribeOrganizationResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], ], 'idempotent' => true, ], 'DescribeResource' => [ 'name' => 'DescribeResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeResourceRequest', ], 'output' => [ 'shape' => 'DescribeResourceResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'DescribeUser' => [ 'name' => 'DescribeUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserRequest', ], 'output' => [ 'shape' => 'DescribeUserResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'DisassociateDelegateFromResource' => [ 'name' => 'DisassociateDelegateFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateDelegateFromResourceRequest', ], 'output' => [ 'shape' => 'DisassociateDelegateFromResourceResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'DisassociateMemberFromGroup' => [ 'name' => 'DisassociateMemberFromGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateMemberFromGroupRequest', ], 'output' => [ 'shape' => 'DisassociateMemberFromGroupResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'GetAccessControlEffect' => [ 'name' => 'GetAccessControlEffect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAccessControlEffectRequest', ], 'output' => [ 'shape' => 'GetAccessControlEffectResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'GetDefaultRetentionPolicy' => [ 'name' => 'GetDefaultRetentionPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDefaultRetentionPolicyRequest', ], 'output' => [ 'shape' => 'GetDefaultRetentionPolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], ], 'idempotent' => true, ], 'GetImpersonationRole' => [ 'name' => 'GetImpersonationRole', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetImpersonationRoleRequest', ], 'output' => [ 'shape' => 'GetImpersonationRoleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetImpersonationRoleEffect' => [ 'name' => 'GetImpersonationRoleEffect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetImpersonationRoleEffectRequest', ], 'output' => [ 'shape' => 'GetImpersonationRoleEffectResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], ], ], 'GetMailDomain' => [ 'name' => 'GetMailDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetMailDomainRequest', ], 'output' => [ 'shape' => 'GetMailDomainResponse', ], 'errors' => [ [ 'shape' => 'MailDomainNotFoundException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'GetMailboxDetails' => [ 'name' => 'GetMailboxDetails', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetMailboxDetailsRequest', ], 'output' => [ 'shape' => 'GetMailboxDetailsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], ], 'idempotent' => true, ], 'GetMobileDeviceAccessEffect' => [ 'name' => 'GetMobileDeviceAccessEffect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetMobileDeviceAccessEffectRequest', ], 'output' => [ 'shape' => 'GetMobileDeviceAccessEffectResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'GetMobileDeviceAccessOverride' => [ 'name' => 'GetMobileDeviceAccessOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetMobileDeviceAccessOverrideRequest', ], 'output' => [ 'shape' => 'GetMobileDeviceAccessOverrideResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListAccessControlRules' => [ 'name' => 'ListAccessControlRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAccessControlRulesRequest', ], 'output' => [ 'shape' => 'ListAccessControlRulesResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'ListAliases' => [ 'name' => 'ListAliases', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAliasesRequest', ], 'output' => [ 'shape' => 'ListAliasesResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListAvailabilityConfigurations' => [ 'name' => 'ListAvailabilityConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAvailabilityConfigurationsRequest', ], 'output' => [ 'shape' => 'ListAvailabilityConfigurationsResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'ListGroupMembers' => [ 'name' => 'ListGroupMembers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListGroupMembersRequest', ], 'output' => [ 'shape' => 'ListGroupMembersResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListGroups' => [ 'name' => 'ListGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListGroupsRequest', ], 'output' => [ 'shape' => 'ListGroupsResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListGroupsForEntity' => [ 'name' => 'ListGroupsForEntity', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListGroupsForEntityRequest', ], 'output' => [ 'shape' => 'ListGroupsForEntityResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'ListImpersonationRoles' => [ 'name' => 'ListImpersonationRoles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListImpersonationRolesRequest', ], 'output' => [ 'shape' => 'ListImpersonationRolesResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'ListMailDomains' => [ 'name' => 'ListMailDomains', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMailDomainsRequest', ], 'output' => [ 'shape' => 'ListMailDomainsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListMailboxExportJobs' => [ 'name' => 'ListMailboxExportJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMailboxExportJobsRequest', ], 'output' => [ 'shape' => 'ListMailboxExportJobsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListMailboxPermissions' => [ 'name' => 'ListMailboxPermissions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMailboxPermissionsRequest', ], 'output' => [ 'shape' => 'ListMailboxPermissionsResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ListMobileDeviceAccessOverrides' => [ 'name' => 'ListMobileDeviceAccessOverrides', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMobileDeviceAccessOverridesRequest', ], 'output' => [ 'shape' => 'ListMobileDeviceAccessOverridesResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], ], ], 'ListMobileDeviceAccessRules' => [ 'name' => 'ListMobileDeviceAccessRules', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListMobileDeviceAccessRulesRequest', ], 'output' => [ 'shape' => 'ListMobileDeviceAccessRulesResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'ListOrganizations' => [ 'name' => 'ListOrganizations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListOrganizationsRequest', ], 'output' => [ 'shape' => 'ListOrganizationsResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'ListResourceDelegates' => [ 'name' => 'ListResourceDelegates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourceDelegatesRequest', ], 'output' => [ 'shape' => 'ListResourceDelegatesResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'ListResources' => [ 'name' => 'ListResources', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListResourcesRequest', ], 'output' => [ 'shape' => 'ListResourcesResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListUsers' => [ 'name' => 'ListUsers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUsersRequest', ], 'output' => [ 'shape' => 'ListUsersResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'PutAccessControlRule' => [ 'name' => 'PutAccessControlRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutAccessControlRuleRequest', ], 'output' => [ 'shape' => 'PutAccessControlRuleResponse', ], 'errors' => [ [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'PutEmailMonitoringConfiguration' => [ 'name' => 'PutEmailMonitoringConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutEmailMonitoringConfigurationRequest', ], 'output' => [ 'shape' => 'PutEmailMonitoringConfigurationResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'PutInboundDmarcSettings' => [ 'name' => 'PutInboundDmarcSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutInboundDmarcSettingsRequest', ], 'output' => [ 'shape' => 'PutInboundDmarcSettingsResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'PutMailboxPermissions' => [ 'name' => 'PutMailboxPermissions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutMailboxPermissionsRequest', ], 'output' => [ 'shape' => 'PutMailboxPermissionsResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'PutMobileDeviceAccessOverride' => [ 'name' => 'PutMobileDeviceAccessOverride', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutMobileDeviceAccessOverrideRequest', ], 'output' => [ 'shape' => 'PutMobileDeviceAccessOverrideResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], ], ], 'PutRetentionPolicy' => [ 'name' => 'PutRetentionPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PutRetentionPolicyRequest', ], 'output' => [ 'shape' => 'PutRetentionPolicyResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'LimitExceededException', ], ], 'idempotent' => true, ], 'RegisterMailDomain' => [ 'name' => 'RegisterMailDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterMailDomainRequest', ], 'output' => [ 'shape' => 'RegisterMailDomainResponse', ], 'errors' => [ [ 'shape' => 'MailDomainInUseException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'RegisterToWorkMail' => [ 'name' => 'RegisterToWorkMail', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RegisterToWorkMailRequest', ], 'output' => [ 'shape' => 'RegisterToWorkMailResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EmailAddressInUseException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'EntityAlreadyRegisteredException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'MailDomainNotFoundException', ], [ 'shape' => 'MailDomainStateException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], 'idempotent' => true, ], 'ResetPassword' => [ 'name' => 'ResetPassword', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetPasswordRequest', ], 'output' => [ 'shape' => 'ResetPasswordResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'InvalidPasswordException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'StartMailboxExportJob' => [ 'name' => 'StartMailboxExportJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMailboxExportJobRequest', ], 'output' => [ 'shape' => 'StartMailboxExportJobResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'LimitExceededException', ], ], 'idempotent' => true, ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'TestAvailabilityConfiguration' => [ 'name' => 'TestAvailabilityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TestAvailabilityConfigurationRequest', ], 'output' => [ 'shape' => 'TestAvailabilityConfigurationResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UpdateAvailabilityConfiguration' => [ 'name' => 'UpdateAvailabilityConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateAvailabilityConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateAvailabilityConfigurationResponse', ], 'errors' => [ [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'UpdateDefaultMailDomain' => [ 'name' => 'UpdateDefaultMailDomain', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDefaultMailDomainRequest', ], 'output' => [ 'shape' => 'UpdateDefaultMailDomainResponse', ], 'errors' => [ [ 'shape' => 'MailDomainNotFoundException', ], [ 'shape' => 'MailDomainStateException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'UpdateGroup' => [ 'name' => 'UpdateGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateGroupRequest', ], 'output' => [ 'shape' => 'UpdateGroupResponse', ], 'errors' => [ [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'UpdateImpersonationRole' => [ 'name' => 'UpdateImpersonationRole', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateImpersonationRoleRequest', ], 'output' => [ 'shape' => 'UpdateImpersonationRoleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'LimitExceededException', ], ], ], 'UpdateMailboxQuota' => [ 'name' => 'UpdateMailboxQuota', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMailboxQuotaRequest', ], 'output' => [ 'shape' => 'UpdateMailboxQuotaResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], ], 'idempotent' => true, ], 'UpdateMobileDeviceAccessRule' => [ 'name' => 'UpdateMobileDeviceAccessRule', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateMobileDeviceAccessRuleRequest', ], 'output' => [ 'shape' => 'UpdateMobileDeviceAccessRuleResponse', ], 'errors' => [ [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], ], ], 'UpdatePrimaryEmailAddress' => [ 'name' => 'UpdatePrimaryEmailAddress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdatePrimaryEmailAddressRequest', ], 'output' => [ 'shape' => 'UpdatePrimaryEmailAddressResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EmailAddressInUseException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'MailDomainNotFoundException', ], [ 'shape' => 'MailDomainStateException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], ], 'idempotent' => true, ], 'UpdateResource' => [ 'name' => 'UpdateResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateResourceRequest', ], 'output' => [ 'shape' => 'UpdateResourceResponse', ], 'errors' => [ [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'EntityStateException', ], [ 'shape' => 'InvalidConfigurationException', ], [ 'shape' => 'EmailAddressInUseException', ], [ 'shape' => 'MailDomainNotFoundException', ], [ 'shape' => 'MailDomainStateException', ], [ 'shape' => 'NameAvailabilityException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], [ 'shape' => 'InvalidParameterException', ], ], 'idempotent' => true, ], 'UpdateUser' => [ 'name' => 'UpdateUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUserRequest', ], 'output' => [ 'shape' => 'UpdateUserResponse', ], 'errors' => [ [ 'shape' => 'DirectoryServiceAuthenticationFailedException', ], [ 'shape' => 'DirectoryUnavailableException', ], [ 'shape' => 'EntityNotFoundException', ], [ 'shape' => 'InvalidParameterException', ], [ 'shape' => 'OrganizationNotFoundException', ], [ 'shape' => 'OrganizationStateException', ], [ 'shape' => 'UnsupportedOperationException', ], [ 'shape' => 'EntityStateException', ], ], 'idempotent' => true, ], ], 'shapes' => [ 'AccessControlRule' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'AccessControlRuleName', ], 'Effect' => [ 'shape' => 'AccessControlRuleEffect', ], 'Description' => [ 'shape' => 'AccessControlRuleDescription', ], 'IpRanges' => [ 'shape' => 'IpRangeList', ], 'NotIpRanges' => [ 'shape' => 'IpRangeList', ], 'Actions' => [ 'shape' => 'ActionsList', ], 'NotActions' => [ 'shape' => 'ActionsList', ], 'UserIds' => [ 'shape' => 'UserIdList', ], 'NotUserIds' => [ 'shape' => 'UserIdList', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], 'ImpersonationRoleIds' => [ 'shape' => 'ImpersonationRoleIdList', ], 'NotImpersonationRoleIds' => [ 'shape' => 'ImpersonationRoleIdList', ], ], ], 'AccessControlRuleAction' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z]+', ], 'AccessControlRuleDescription' => [ 'type' => 'string', 'max' => 255, 'min' => 0, 'pattern' => '[\\u0020-\\u00FF]+', ], 'AccessControlRuleEffect' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'DENY', ], ], 'AccessControlRuleName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'AccessControlRuleNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccessControlRuleName', ], 'max' => 10, 'min' => 0, ], 'AccessControlRulesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccessControlRule', ], 'max' => 10, 'min' => 0, ], 'AccessEffect' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'DENY', ], ], 'ActionsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccessControlRuleAction', ], 'max' => 10, 'min' => 0, ], 'Aliases' => [ 'type' => 'list', 'member' => [ 'shape' => 'EmailAddress', ], ], 'AmazonResourceName' => [ 'type' => 'string', 'max' => 1011, 'min' => 1, 'pattern' => 'arn:aws:workmail:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}', ], 'AssociateDelegateToResourceRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ResourceId', 'EntityId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ResourceId' => [ 'shape' => 'EntityIdentifier', ], 'EntityId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'AssociateDelegateToResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'AssociateMemberToGroupRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'GroupId', 'MemberId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'GroupId' => [ 'shape' => 'EntityIdentifier', ], 'MemberId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'AssociateMemberToGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'AssumeImpersonationRoleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ImpersonationRoleId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], ], ], 'AssumeImpersonationRoleResponse' => [ 'type' => 'structure', 'members' => [ 'Token' => [ 'shape' => 'ImpersonationToken', ], 'ExpiresIn' => [ 'shape' => 'ExpiresIn', ], ], ], 'AvailabilityConfiguration' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'ProviderType' => [ 'shape' => 'AvailabilityProviderType', ], 'EwsProvider' => [ 'shape' => 'RedactedEwsAvailabilityProvider', ], 'LambdaProvider' => [ 'shape' => 'LambdaAvailabilityProvider', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], ], ], 'AvailabilityConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AvailabilityConfiguration', ], ], 'AvailabilityProviderType' => [ 'type' => 'string', 'enum' => [ 'EWS', 'LAMBDA', ], ], 'BookingOptions' => [ 'type' => 'structure', 'members' => [ 'AutoAcceptRequests' => [ 'shape' => 'Boolean', ], 'AutoDeclineRecurringRequests' => [ 'shape' => 'Boolean', ], 'AutoDeclineConflictingRequests' => [ 'shape' => 'Boolean', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanObject' => [ 'type' => 'boolean', ], 'CancelMailboxExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ClientToken', 'JobId', 'OrganizationId', ], 'members' => [ 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'JobId' => [ 'shape' => 'MailboxExportJobId', ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'CancelMailboxExportJobResponse' => [ 'type' => 'structure', 'members' => [], ], 'CreateAliasRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', 'Alias', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'Alias' => [ 'shape' => 'EmailAddress', ], ], ], 'CreateAliasResponse' => [ 'type' => 'structure', 'members' => [], ], 'CreateAvailabilityConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'EwsProvider' => [ 'shape' => 'EwsAvailabilityProvider', ], 'LambdaProvider' => [ 'shape' => 'LambdaAvailabilityProvider', ], ], ], 'CreateAvailabilityConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'CreateGroupRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Name' => [ 'shape' => 'GroupName', ], 'HiddenFromGlobalAddressList' => [ 'shape' => 'Boolean', ], ], ], 'CreateGroupResponse' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'CreateImpersonationRoleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', 'Type', 'Rules', ], 'members' => [ 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Name' => [ 'shape' => 'ImpersonationRoleName', ], 'Type' => [ 'shape' => 'ImpersonationRoleType', ], 'Description' => [ 'shape' => 'ImpersonationRoleDescription', ], 'Rules' => [ 'shape' => 'ImpersonationRuleList', ], ], ], 'CreateImpersonationRoleResponse' => [ 'type' => 'structure', 'members' => [ 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], ], ], 'CreateMobileDeviceAccessRuleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', 'Effect', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'Name' => [ 'shape' => 'MobileDeviceAccessRuleName', ], 'Description' => [ 'shape' => 'MobileDeviceAccessRuleDescription', ], 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'DeviceTypes' => [ 'shape' => 'DeviceTypeList', ], 'NotDeviceTypes' => [ 'shape' => 'DeviceTypeList', ], 'DeviceModels' => [ 'shape' => 'DeviceModelList', ], 'NotDeviceModels' => [ 'shape' => 'DeviceModelList', ], 'DeviceOperatingSystems' => [ 'shape' => 'DeviceOperatingSystemList', ], 'NotDeviceOperatingSystems' => [ 'shape' => 'DeviceOperatingSystemList', ], 'DeviceUserAgents' => [ 'shape' => 'DeviceUserAgentList', ], 'NotDeviceUserAgents' => [ 'shape' => 'DeviceUserAgentList', ], ], ], 'CreateMobileDeviceAccessRuleResponse' => [ 'type' => 'structure', 'members' => [ 'MobileDeviceAccessRuleId' => [ 'shape' => 'MobileDeviceAccessRuleId', ], ], ], 'CreateOrganizationRequest' => [ 'type' => 'structure', 'required' => [ 'Alias', ], 'members' => [ 'DirectoryId' => [ 'shape' => 'DirectoryId', ], 'Alias' => [ 'shape' => 'OrganizationName', ], 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'Domains' => [ 'shape' => 'Domains', ], 'KmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'EnableInteroperability' => [ 'shape' => 'Boolean', ], ], ], 'CreateOrganizationResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'CreateResourceRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', 'Type', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Name' => [ 'shape' => 'ResourceName', ], 'Type' => [ 'shape' => 'ResourceType', ], 'Description' => [ 'shape' => 'ResourceDescription', ], 'HiddenFromGlobalAddressList' => [ 'shape' => 'Boolean', ], ], ], 'CreateResourceResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], ], ], 'CreateUserRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', 'DisplayName', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Name' => [ 'shape' => 'UserName', ], 'DisplayName' => [ 'shape' => 'UserAttribute', ], 'Password' => [ 'shape' => 'Password', ], 'Role' => [ 'shape' => 'UserRole', ], 'FirstName' => [ 'shape' => 'UserAttribute', ], 'LastName' => [ 'shape' => 'UserAttribute', ], 'HiddenFromGlobalAddressList' => [ 'shape' => 'Boolean', ], ], ], 'CreateUserResponse' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], ], ], 'Delegate' => [ 'type' => 'structure', 'required' => [ 'Id', 'Type', ], 'members' => [ 'Id' => [ 'shape' => 'String', ], 'Type' => [ 'shape' => 'MemberType', ], ], ], 'DeleteAccessControlRuleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Name' => [ 'shape' => 'AccessControlRuleName', ], ], ], 'DeleteAccessControlRuleResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteAliasRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', 'Alias', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'Alias' => [ 'shape' => 'EmailAddress', ], ], ], 'DeleteAliasResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteAvailabilityConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'DomainName', ], ], ], 'DeleteAvailabilityConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteEmailMonitoringConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'DeleteEmailMonitoringConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteGroupRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'GroupId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'GroupId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'DeleteGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteImpersonationRoleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ImpersonationRoleId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], ], ], 'DeleteImpersonationRoleResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteMailboxPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', 'GranteeId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'EntityIdentifier', ], 'GranteeId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'DeleteMailboxPermissionsResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteMobileDeviceAccessOverrideRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', 'DeviceId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], ], ], 'DeleteMobileDeviceAccessOverrideResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteMobileDeviceAccessRuleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'MobileDeviceAccessRuleId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'MobileDeviceAccessRuleId' => [ 'shape' => 'MobileDeviceAccessRuleId', ], ], ], 'DeleteMobileDeviceAccessRuleResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteOrganizationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DeleteDirectory', ], 'members' => [ 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DeleteDirectory' => [ 'shape' => 'Boolean', ], 'ForceDelete' => [ 'shape' => 'Boolean', ], ], ], 'DeleteOrganizationResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'State' => [ 'shape' => 'String', ], ], ], 'DeleteResourceRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ResourceId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ResourceId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'DeleteResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRetentionPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Id', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Id' => [ 'shape' => 'ShortString', ], ], ], 'DeleteRetentionPolicyResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteUserRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'DeleteUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeregisterFromWorkMailRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'DeregisterFromWorkMailResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeregisterMailDomainRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'WorkMailDomainName', ], ], ], 'DeregisterMailDomainResponse' => [ 'type' => 'structure', 'members' => [], ], 'DescribeEmailMonitoringConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'DescribeEmailMonitoringConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LogGroupArn' => [ 'shape' => 'LogGroupArn', ], ], ], 'DescribeEntityRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Email', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Email' => [ 'shape' => 'EmailAddress', ], ], ], 'DescribeEntityResponse' => [ 'type' => 'structure', 'members' => [ 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'Name' => [ 'shape' => 'String', ], 'Type' => [ 'shape' => 'EntityType', ], ], ], 'DescribeGroupRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'GroupId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'GroupId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'DescribeGroupResponse' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => 'WorkMailIdentifier', ], 'Name' => [ 'shape' => 'GroupName', ], 'Email' => [ 'shape' => 'EmailAddress', ], 'State' => [ 'shape' => 'EntityState', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], 'HiddenFromGlobalAddressList' => [ 'shape' => 'Boolean', ], ], ], 'DescribeInboundDmarcSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'DescribeInboundDmarcSettingsResponse' => [ 'type' => 'structure', 'members' => [ 'Enforced' => [ 'shape' => 'Boolean', ], ], ], 'DescribeMailboxExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'JobId', 'OrganizationId', ], 'members' => [ 'JobId' => [ 'shape' => 'MailboxExportJobId', ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'DescribeMailboxExportJobResponse' => [ 'type' => 'structure', 'members' => [ 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'Description' => [ 'shape' => 'Description', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'S3BucketName' => [ 'shape' => 'S3BucketName', ], 'S3Prefix' => [ 'shape' => 'S3ObjectKey', ], 'S3Path' => [ 'shape' => 'S3ObjectKey', ], 'EstimatedProgress' => [ 'shape' => 'Percentage', ], 'State' => [ 'shape' => 'MailboxExportJobState', ], 'ErrorInfo' => [ 'shape' => 'MailboxExportErrorInfo', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'DescribeOrganizationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'DescribeOrganizationResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Alias' => [ 'shape' => 'OrganizationName', ], 'State' => [ 'shape' => 'String', ], 'DirectoryId' => [ 'shape' => 'String', ], 'DirectoryType' => [ 'shape' => 'String', ], 'DefaultMailDomain' => [ 'shape' => 'String', ], 'CompletedDate' => [ 'shape' => 'Timestamp', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'ARN' => [ 'shape' => 'AmazonResourceName', ], 'MigrationAdmin' => [ 'shape' => 'WorkMailIdentifier', ], 'InteroperabilityEnabled' => [ 'shape' => 'Boolean', ], ], ], 'DescribeResourceRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ResourceId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ResourceId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'DescribeResourceResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceId' => [ 'shape' => 'ResourceId', ], 'Email' => [ 'shape' => 'EmailAddress', ], 'Name' => [ 'shape' => 'ResourceName', ], 'Type' => [ 'shape' => 'ResourceType', ], 'BookingOptions' => [ 'shape' => 'BookingOptions', ], 'State' => [ 'shape' => 'EntityState', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ResourceDescription', ], 'HiddenFromGlobalAddressList' => [ 'shape' => 'Boolean', ], ], ], 'DescribeUserRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'DescribeUserResponse' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], 'Name' => [ 'shape' => 'UserName', ], 'Email' => [ 'shape' => 'EmailAddress', ], 'DisplayName' => [ 'shape' => 'UserAttribute', ], 'State' => [ 'shape' => 'EntityState', ], 'UserRole' => [ 'shape' => 'UserRole', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], 'MailboxProvisionedDate' => [ 'shape' => 'Timestamp', ], 'MailboxDeprovisionedDate' => [ 'shape' => 'Timestamp', ], 'FirstName' => [ 'shape' => 'UserAttribute', ], 'LastName' => [ 'shape' => 'UserAttribute', ], 'HiddenFromGlobalAddressList' => [ 'shape' => 'Boolean', ], 'Initials' => [ 'shape' => 'UserAttribute', ], 'Telephone' => [ 'shape' => 'UserAttribute', ], 'Street' => [ 'shape' => 'UserAttribute', ], 'JobTitle' => [ 'shape' => 'UserAttribute', ], 'City' => [ 'shape' => 'UserAttribute', ], 'Company' => [ 'shape' => 'UserAttribute', ], 'ZipCode' => [ 'shape' => 'UserAttribute', ], 'Department' => [ 'shape' => 'UserAttribute', ], 'Country' => [ 'shape' => 'UserAttribute', ], 'Office' => [ 'shape' => 'UserAttribute', ], ], ], 'Description' => [ 'type' => 'string', 'max' => 1023, 'min' => 0, 'pattern' => '[\\S\\s]*', ], 'DeviceId' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '[A-Za-z0-9]+', ], 'DeviceModel' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'DeviceModelList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceModel', ], 'max' => 10, 'min' => 1, ], 'DeviceOperatingSystem' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'DeviceOperatingSystemList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceOperatingSystem', ], 'max' => 10, 'min' => 1, ], 'DeviceType' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'DeviceTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceType', ], 'max' => 10, 'min' => 1, ], 'DeviceUserAgent' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'DeviceUserAgentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceUserAgent', ], 'max' => 10, 'min' => 1, ], 'DirectoryId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '^d-[0-9a-f]{10}$', ], 'DirectoryInUseException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'DirectoryServiceAuthenticationFailedException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'DirectoryUnavailableException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'DisassociateDelegateFromResourceRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ResourceId', 'EntityId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ResourceId' => [ 'shape' => 'EntityIdentifier', ], 'EntityId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'DisassociateDelegateFromResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'DisassociateMemberFromGroupRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'GroupId', 'MemberId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'GroupId' => [ 'shape' => 'EntityIdentifier', ], 'MemberId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'DisassociateMemberFromGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'DnsRecord' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'String', ], 'Hostname' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'DnsRecordVerificationStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'VERIFIED', 'FAILED', ], ], 'DnsRecords' => [ 'type' => 'list', 'member' => [ 'shape' => 'DnsRecord', ], ], 'Domain' => [ 'type' => 'structure', 'required' => [ 'DomainName', ], 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'HostedZoneId' => [ 'shape' => 'HostedZoneId', ], ], ], 'DomainName' => [ 'type' => 'string', 'max' => 255, 'min' => 3, 'pattern' => '[a-zA-Z0-9.-]+', ], 'Domains' => [ 'type' => 'list', 'member' => [ 'shape' => 'Domain', ], 'max' => 5, 'min' => 0, ], 'EmailAddress' => [ 'type' => 'string', 'max' => 254, 'min' => 1, 'pattern' => '[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\\.[a-zA-Z-]{2,}', ], 'EmailAddressInUseException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'EntityAlreadyRegisteredException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'EntityIdentifier' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[a-zA-Z0-9._%+@-]+', ], 'EntityNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'EntityState' => [ 'type' => 'string', 'enum' => [ 'ENABLED', 'DISABLED', 'DELETED', ], ], 'EntityStateException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'EntityType' => [ 'type' => 'string', 'enum' => [ 'GROUP', 'USER', 'RESOURCE', ], ], 'EwsAvailabilityProvider' => [ 'type' => 'structure', 'required' => [ 'EwsEndpoint', 'EwsUsername', 'EwsPassword', ], 'members' => [ 'EwsEndpoint' => [ 'shape' => 'Url', ], 'EwsUsername' => [ 'shape' => 'ExternalUserName', ], 'EwsPassword' => [ 'shape' => 'Password', ], ], ], 'ExpiresIn' => [ 'type' => 'long', 'box' => true, ], 'ExternalUserName' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\u0020-\\u00FF]+', ], 'FolderConfiguration' => [ 'type' => 'structure', 'required' => [ 'Name', 'Action', ], 'members' => [ 'Name' => [ 'shape' => 'FolderName', ], 'Action' => [ 'shape' => 'RetentionAction', ], 'Period' => [ 'shape' => 'RetentionPeriod', ], ], ], 'FolderConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'FolderConfiguration', ], ], 'FolderName' => [ 'type' => 'string', 'enum' => [ 'INBOX', 'DELETED_ITEMS', 'SENT_ITEMS', 'DRAFTS', 'JUNK_EMAIL', ], ], 'GetAccessControlEffectRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'IpAddress', 'Action', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'IpAddress' => [ 'shape' => 'IpAddress', ], 'Action' => [ 'shape' => 'AccessControlRuleAction', ], 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], ], ], 'GetAccessControlEffectResponse' => [ 'type' => 'structure', 'members' => [ 'Effect' => [ 'shape' => 'AccessControlRuleEffect', ], 'MatchedRules' => [ 'shape' => 'AccessControlRuleNameList', ], ], ], 'GetDefaultRetentionPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'GetDefaultRetentionPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'ShortString', ], 'Name' => [ 'shape' => 'ShortString', ], 'Description' => [ 'shape' => 'String', ], 'FolderConfigurations' => [ 'shape' => 'FolderConfigurations', ], ], ], 'GetImpersonationRoleEffectRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ImpersonationRoleId', 'TargetUser', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], 'TargetUser' => [ 'shape' => 'EntityIdentifier', ], ], ], 'GetImpersonationRoleEffectResponse' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ImpersonationRoleType', ], 'Effect' => [ 'shape' => 'AccessEffect', ], 'MatchedRules' => [ 'shape' => 'ImpersonationMatchedRuleList', ], ], ], 'GetImpersonationRoleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ImpersonationRoleId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], ], ], 'GetImpersonationRoleResponse' => [ 'type' => 'structure', 'members' => [ 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], 'Name' => [ 'shape' => 'ImpersonationRoleName', ], 'Type' => [ 'shape' => 'ImpersonationRoleType', ], 'Description' => [ 'shape' => 'ImpersonationRoleDescription', ], 'Rules' => [ 'shape' => 'ImpersonationRuleList', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], ], ], 'GetMailDomainRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'WorkMailDomainName', ], ], ], 'GetMailDomainResponse' => [ 'type' => 'structure', 'members' => [ 'Records' => [ 'shape' => 'DnsRecords', ], 'IsTestDomain' => [ 'shape' => 'Boolean', ], 'IsDefault' => [ 'shape' => 'Boolean', ], 'OwnershipVerificationStatus' => [ 'shape' => 'DnsRecordVerificationStatus', ], 'DkimVerificationStatus' => [ 'shape' => 'DnsRecordVerificationStatus', ], ], ], 'GetMailboxDetailsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], ], ], 'GetMailboxDetailsResponse' => [ 'type' => 'structure', 'members' => [ 'MailboxQuota' => [ 'shape' => 'MailboxQuota', ], 'MailboxSize' => [ 'shape' => 'MailboxSize', ], ], ], 'GetMobileDeviceAccessEffectRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DeviceType' => [ 'shape' => 'DeviceType', ], 'DeviceModel' => [ 'shape' => 'DeviceModel', ], 'DeviceOperatingSystem' => [ 'shape' => 'DeviceOperatingSystem', ], 'DeviceUserAgent' => [ 'shape' => 'DeviceUserAgent', ], ], ], 'GetMobileDeviceAccessEffectResponse' => [ 'type' => 'structure', 'members' => [ 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'MatchedRules' => [ 'shape' => 'MobileDeviceAccessMatchedRuleList', ], ], ], 'GetMobileDeviceAccessOverrideRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', 'DeviceId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], ], ], 'GetMobileDeviceAccessOverrideResponse' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'Description' => [ 'shape' => 'MobileDeviceAccessRuleDescription', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], ], ], 'Group' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'WorkMailIdentifier', ], 'Email' => [ 'shape' => 'EmailAddress', ], 'Name' => [ 'shape' => 'GroupName', ], 'State' => [ 'shape' => 'EntityState', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], ], ], 'GroupIdentifier' => [ 'type' => 'structure', 'members' => [ 'GroupId' => [ 'shape' => 'WorkMailIdentifier', ], 'GroupName' => [ 'shape' => 'GroupName', ], ], ], 'GroupIdentifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'GroupIdentifier', ], ], 'GroupName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\u0020-\\u00FF]+', ], 'Groups' => [ 'type' => 'list', 'member' => [ 'shape' => 'Group', ], ], 'HostedZoneId' => [ 'type' => 'string', 'max' => 32, 'min' => 1, 'pattern' => '[^/\\\\]*', ], 'IdempotencyClientToken' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[\\x21-\\x7e]+', ], 'ImpersonationMatchedRule' => [ 'type' => 'structure', 'members' => [ 'ImpersonationRuleId' => [ 'shape' => 'ImpersonationRuleId', ], 'Name' => [ 'shape' => 'ImpersonationRuleName', ], ], ], 'ImpersonationMatchedRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImpersonationMatchedRule', ], 'max' => 10, 'min' => 0, ], 'ImpersonationRole' => [ 'type' => 'structure', 'members' => [ 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], 'Name' => [ 'shape' => 'ImpersonationRoleName', ], 'Type' => [ 'shape' => 'ImpersonationRoleType', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], ], ], 'ImpersonationRoleDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F\\x3C\\x3E\\x5C]+', ], 'ImpersonationRoleId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'ImpersonationRoleIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImpersonationRoleId', ], 'max' => 10, 'min' => 0, ], 'ImpersonationRoleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImpersonationRole', ], 'max' => 20, 'min' => 0, ], 'ImpersonationRoleName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[^\\x00-\\x1F\\x7F\\x3C\\x3E\\x5C]+', ], 'ImpersonationRoleType' => [ 'type' => 'string', 'enum' => [ 'FULL_ACCESS', 'READ_ONLY', ], ], 'ImpersonationRule' => [ 'type' => 'structure', 'required' => [ 'ImpersonationRuleId', 'Effect', ], 'members' => [ 'ImpersonationRuleId' => [ 'shape' => 'ImpersonationRuleId', ], 'Name' => [ 'shape' => 'ImpersonationRuleName', ], 'Description' => [ 'shape' => 'ImpersonationRuleDescription', ], 'Effect' => [ 'shape' => 'AccessEffect', ], 'TargetUsers' => [ 'shape' => 'TargetUsers', ], 'NotTargetUsers' => [ 'shape' => 'TargetUsers', ], ], ], 'ImpersonationRuleDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F\\x3C\\x3E\\x5C]+', ], 'ImpersonationRuleId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'ImpersonationRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ImpersonationRule', ], 'max' => 10, 'min' => 0, ], 'ImpersonationRuleName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[^\\x00-\\x1F\\x7F\\x3C\\x3E\\x5C]+', ], 'ImpersonationToken' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\x21-\\x7e]+', ], 'InvalidConfigurationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidCustomSesConfigurationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidParameterException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'InvalidPasswordException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'IpAddress' => [ 'type' => 'string', 'max' => 15, 'min' => 1, '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])$', ], 'IpRange' => [ 'type' => 'string', 'max' => 18, 'min' => 1, '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])/([0-9]|[12][0-9]|3[0-2])$', ], 'IpRangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IpRange', ], 'max' => 1024, 'min' => 0, ], 'Jobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'MailboxExportJob', ], ], 'KmsKeyArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws:kms:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}', ], 'LambdaArn' => [ 'type' => 'string', 'max' => 256, 'min' => 49, 'pattern' => 'arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9\\-_\\.]+(:(\\$LATEST|[a-zA-Z0-9\\-_]+))?', ], 'LambdaAvailabilityProvider' => [ 'type' => 'structure', 'required' => [ 'LambdaArn', ], 'members' => [ 'LambdaArn' => [ 'shape' => 'LambdaArn', ], ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ListAccessControlRulesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'ListAccessControlRulesResponse' => [ 'type' => 'structure', 'members' => [ 'Rules' => [ 'shape' => 'AccessControlRulesList', ], ], ], 'ListAliasesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListAliasesResponse' => [ 'type' => 'structure', 'members' => [ 'Aliases' => [ 'shape' => 'Aliases', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAvailabilityConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListAvailabilityConfigurationsResponse' => [ 'type' => 'structure', 'members' => [ 'AvailabilityConfigurations' => [ 'shape' => 'AvailabilityConfigurationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListGroupMembersRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'GroupId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'GroupId' => [ 'shape' => 'EntityIdentifier', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListGroupMembersResponse' => [ 'type' => 'structure', 'members' => [ 'Members' => [ 'shape' => 'Members', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListGroupsFilters' => [ 'type' => 'structure', 'members' => [ 'NamePrefix' => [ 'shape' => 'String', ], 'PrimaryEmailPrefix' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'EntityState', ], ], ], 'ListGroupsForEntityFilters' => [ 'type' => 'structure', 'members' => [ 'GroupNamePrefix' => [ 'shape' => 'String', ], ], ], 'ListGroupsForEntityRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'EntityIdentifier', ], 'Filters' => [ 'shape' => 'ListGroupsForEntityFilters', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListGroupsForEntityResponse' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'GroupIdentifiers', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListGroupsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'Filters' => [ 'shape' => 'ListGroupsFilters', ], ], ], 'ListGroupsResponse' => [ 'type' => 'structure', 'members' => [ 'Groups' => [ 'shape' => 'Groups', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListImpersonationRolesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListImpersonationRolesResponse' => [ 'type' => 'structure', 'members' => [ 'Roles' => [ 'shape' => 'ImpersonationRoleList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMailDomainsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMailDomainsResponse' => [ 'type' => 'structure', 'members' => [ 'MailDomains' => [ 'shape' => 'MailDomains', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMailboxExportJobsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMailboxExportJobsResponse' => [ 'type' => 'structure', 'members' => [ 'Jobs' => [ 'shape' => 'Jobs', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMailboxPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'EntityIdentifier', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMailboxPermissionsResponse' => [ 'type' => 'structure', 'members' => [ 'Permissions' => [ 'shape' => 'Permissions', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMobileDeviceAccessOverridesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListMobileDeviceAccessOverridesResponse' => [ 'type' => 'structure', 'members' => [ 'Overrides' => [ 'shape' => 'MobileDeviceAccessOverridesList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListMobileDeviceAccessRulesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], ], ], 'ListMobileDeviceAccessRulesResponse' => [ 'type' => 'structure', 'members' => [ 'Rules' => [ 'shape' => 'MobileDeviceAccessRulesList', ], ], ], 'ListOrganizationsRequest' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListOrganizationsResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationSummaries' => [ 'shape' => 'OrganizationSummaries', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourceDelegatesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ResourceId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ResourceId' => [ 'shape' => 'EntityIdentifier', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], ], ], 'ListResourceDelegatesResponse' => [ 'type' => 'structure', 'members' => [ 'Delegates' => [ 'shape' => 'ResourceDelegates', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListResourcesFilters' => [ 'type' => 'structure', 'members' => [ 'NamePrefix' => [ 'shape' => 'String', ], 'PrimaryEmailPrefix' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'EntityState', ], ], ], 'ListResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'Filters' => [ 'shape' => 'ListResourcesFilters', ], ], ], 'ListResourcesResponse' => [ 'type' => 'structure', 'members' => [ 'Resources' => [ 'shape' => 'Resources', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'AmazonResourceName', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ListUsersFilters' => [ 'type' => 'structure', 'members' => [ 'UsernamePrefix' => [ 'shape' => 'String', ], 'DisplayNamePrefix' => [ 'shape' => 'UserAttribute', ], 'PrimaryEmailPrefix' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'EntityState', ], ], ], 'ListUsersRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'NextToken' => [ 'shape' => 'NextToken', ], 'MaxResults' => [ 'shape' => 'MaxResults', ], 'Filters' => [ 'shape' => 'ListUsersFilters', ], ], ], 'ListUsersResponse' => [ 'type' => 'structure', 'members' => [ 'Users' => [ 'shape' => 'Users', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'LogGroupArn' => [ 'type' => 'string', 'max' => 562, 'min' => 47, 'pattern' => 'arn:aws:logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([\\.\\-_/#A-Za-z0-9]+):\\*$', ], 'MailDomainInUseException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'MailDomainNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'MailDomainStateException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'MailDomainSummary' => [ 'type' => 'structure', 'members' => [ 'DomainName' => [ 'shape' => 'DomainName', ], 'DefaultDomain' => [ 'shape' => 'Boolean', ], ], ], 'MailDomains' => [ 'type' => 'list', 'member' => [ 'shape' => 'MailDomainSummary', ], ], 'MailboxExportErrorInfo' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\S\\s]*', ], 'MailboxExportJob' => [ 'type' => 'structure', 'members' => [ 'JobId' => [ 'shape' => 'MailboxExportJobId', ], 'EntityId' => [ 'shape' => 'WorkMailIdentifier', ], 'Description' => [ 'shape' => 'Description', ], 'S3BucketName' => [ 'shape' => 'S3BucketName', ], 'S3Path' => [ 'shape' => 'S3ObjectKey', ], 'EstimatedProgress' => [ 'shape' => 'Percentage', ], 'State' => [ 'shape' => 'MailboxExportJobState', ], 'StartTime' => [ 'shape' => 'Timestamp', ], 'EndTime' => [ 'shape' => 'Timestamp', ], ], ], 'MailboxExportJobId' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[A-Za-z0-9-]+', ], 'MailboxExportJobState' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'COMPLETED', 'FAILED', 'CANCELLED', ], ], 'MailboxQuota' => [ 'type' => 'integer', 'box' => true, 'min' => 1, ], 'MailboxSize' => [ 'type' => 'double', 'min' => 0, ], 'MaxResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'Member' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'String', ], 'Name' => [ 'shape' => 'String', ], 'Type' => [ 'shape' => 'MemberType', ], 'State' => [ 'shape' => 'EntityState', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], ], ], 'MemberType' => [ 'type' => 'string', 'enum' => [ 'GROUP', 'USER', ], ], 'Members' => [ 'type' => 'list', 'member' => [ 'shape' => 'Member', ], ], 'MobileDeviceAccessMatchedRule' => [ 'type' => 'structure', 'members' => [ 'MobileDeviceAccessRuleId' => [ 'shape' => 'MobileDeviceAccessRuleId', ], 'Name' => [ 'shape' => 'MobileDeviceAccessRuleName', ], ], ], 'MobileDeviceAccessMatchedRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MobileDeviceAccessMatchedRule', ], 'max' => 10, 'min' => 0, ], 'MobileDeviceAccessOverride' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'Description' => [ 'shape' => 'MobileDeviceAccessRuleDescription', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], ], ], 'MobileDeviceAccessOverridesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MobileDeviceAccessOverride', ], ], 'MobileDeviceAccessRule' => [ 'type' => 'structure', 'members' => [ 'MobileDeviceAccessRuleId' => [ 'shape' => 'MobileDeviceAccessRuleId', ], 'Name' => [ 'shape' => 'MobileDeviceAccessRuleName', ], 'Description' => [ 'shape' => 'MobileDeviceAccessRuleDescription', ], 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'DeviceTypes' => [ 'shape' => 'DeviceTypeList', ], 'NotDeviceTypes' => [ 'shape' => 'DeviceTypeList', ], 'DeviceModels' => [ 'shape' => 'DeviceModelList', ], 'NotDeviceModels' => [ 'shape' => 'DeviceModelList', ], 'DeviceOperatingSystems' => [ 'shape' => 'DeviceOperatingSystemList', ], 'NotDeviceOperatingSystems' => [ 'shape' => 'DeviceOperatingSystemList', ], 'DeviceUserAgents' => [ 'shape' => 'DeviceUserAgentList', ], 'NotDeviceUserAgents' => [ 'shape' => 'DeviceUserAgentList', ], 'DateCreated' => [ 'shape' => 'Timestamp', ], 'DateModified' => [ 'shape' => 'Timestamp', ], ], ], 'MobileDeviceAccessRuleDescription' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'MobileDeviceAccessRuleEffect' => [ 'type' => 'string', 'enum' => [ 'ALLOW', 'DENY', ], ], 'MobileDeviceAccessRuleId' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'MobileDeviceAccessRuleName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[\\S\\s]+', ], 'MobileDeviceAccessRulesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MobileDeviceAccessRule', ], 'max' => 10, 'min' => 0, ], 'NameAvailabilityException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'NewResourceDescription' => [ 'type' => 'string', 'max' => 64, 'min' => 0, ], 'NextToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, 'pattern' => '[\\S\\s]*|[a-zA-Z0-9/+=]{1,1024}', ], 'OrganizationId' => [ 'type' => 'string', 'max' => 34, 'min' => 34, 'pattern' => '^m-[0-9a-f]{32}$', ], 'OrganizationName' => [ 'type' => 'string', 'max' => 62, 'min' => 1, 'pattern' => '^(?!d-)([\\da-zA-Z]+)([-][\\da-zA-Z]+)*', ], 'OrganizationNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'OrganizationStateException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'OrganizationSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'OrganizationSummary', ], ], 'OrganizationSummary' => [ 'type' => 'structure', 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Alias' => [ 'shape' => 'OrganizationName', ], 'DefaultMailDomain' => [ 'shape' => 'DomainName', ], 'ErrorMessage' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'String', ], ], ], 'Password' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\u0020-\\u00FF]+', 'sensitive' => true, ], 'Percentage' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'Permission' => [ 'type' => 'structure', 'required' => [ 'GranteeId', 'GranteeType', 'PermissionValues', ], 'members' => [ 'GranteeId' => [ 'shape' => 'WorkMailIdentifier', ], 'GranteeType' => [ 'shape' => 'MemberType', ], 'PermissionValues' => [ 'shape' => 'PermissionValues', ], ], ], 'PermissionType' => [ 'type' => 'string', 'enum' => [ 'FULL_ACCESS', 'SEND_AS', 'SEND_ON_BEHALF', ], ], 'PermissionValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'PermissionType', ], ], 'Permissions' => [ 'type' => 'list', 'member' => [ 'shape' => 'Permission', ], ], 'PolicyDescription' => [ 'type' => 'string', 'max' => 256, 'pattern' => '[\\w\\d\\s\\S\\-!?=,.;:\'_]+', 'sensitive' => true, ], 'PutAccessControlRuleRequest' => [ 'type' => 'structure', 'required' => [ 'Name', 'Effect', 'Description', 'OrganizationId', ], 'members' => [ 'Name' => [ 'shape' => 'AccessControlRuleName', ], 'Effect' => [ 'shape' => 'AccessControlRuleEffect', ], 'Description' => [ 'shape' => 'AccessControlRuleDescription', ], 'IpRanges' => [ 'shape' => 'IpRangeList', ], 'NotIpRanges' => [ 'shape' => 'IpRangeList', ], 'Actions' => [ 'shape' => 'ActionsList', ], 'NotActions' => [ 'shape' => 'ActionsList', ], 'UserIds' => [ 'shape' => 'UserIdList', ], 'NotUserIds' => [ 'shape' => 'UserIdList', ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ImpersonationRoleIds' => [ 'shape' => 'ImpersonationRoleIdList', ], 'NotImpersonationRoleIds' => [ 'shape' => 'ImpersonationRoleIdList', ], ], ], 'PutAccessControlRuleResponse' => [ 'type' => 'structure', 'members' => [], ], 'PutEmailMonitoringConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'RoleArn', 'LogGroupArn', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'LogGroupArn' => [ 'shape' => 'LogGroupArn', ], ], ], 'PutEmailMonitoringConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'PutInboundDmarcSettingsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Enforced', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Enforced' => [ 'shape' => 'BooleanObject', ], ], ], 'PutInboundDmarcSettingsResponse' => [ 'type' => 'structure', 'members' => [], ], 'PutMailboxPermissionsRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', 'GranteeId', 'PermissionValues', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'EntityIdentifier', ], 'GranteeId' => [ 'shape' => 'EntityIdentifier', ], 'PermissionValues' => [ 'shape' => 'PermissionValues', ], ], ], 'PutMailboxPermissionsResponse' => [ 'type' => 'structure', 'members' => [], ], 'PutMobileDeviceAccessOverrideRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', 'DeviceId', 'Effect', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'Description' => [ 'shape' => 'MobileDeviceAccessRuleDescription', ], ], ], 'PutMobileDeviceAccessOverrideResponse' => [ 'type' => 'structure', 'members' => [], ], 'PutRetentionPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'Name', 'FolderConfigurations', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'Id' => [ 'shape' => 'ShortString', ], 'Name' => [ 'shape' => 'ShortString', ], 'Description' => [ 'shape' => 'PolicyDescription', ], 'FolderConfigurations' => [ 'shape' => 'FolderConfigurations', ], ], ], 'PutRetentionPolicyResponse' => [ 'type' => 'structure', 'members' => [], ], 'RedactedEwsAvailabilityProvider' => [ 'type' => 'structure', 'members' => [ 'EwsEndpoint' => [ 'shape' => 'Url', ], 'EwsUsername' => [ 'shape' => 'ExternalUserName', ], ], ], 'RegisterMailDomainRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'WorkMailDomainName', ], ], ], 'RegisterMailDomainResponse' => [ 'type' => 'structure', 'members' => [], ], 'RegisterToWorkMailRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', 'Email', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'EntityIdentifier', ], 'Email' => [ 'shape' => 'EmailAddress', ], ], ], 'RegisterToWorkMailResponse' => [ 'type' => 'structure', 'members' => [], ], 'ReservedNameException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResetPasswordRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', 'Password', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'WorkMailIdentifier', ], 'Password' => [ 'shape' => 'Password', ], ], ], 'ResetPasswordResponse' => [ 'type' => 'structure', 'members' => [], ], 'Resource' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'WorkMailIdentifier', ], 'Email' => [ 'shape' => 'EmailAddress', ], 'Name' => [ 'shape' => 'ResourceName', ], 'Type' => [ 'shape' => 'ResourceType', ], 'State' => [ 'shape' => 'EntityState', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], 'Description' => [ 'shape' => 'ResourceDescription', ], ], ], 'ResourceDelegates' => [ 'type' => 'list', 'member' => [ 'shape' => 'Delegate', ], ], 'ResourceDescription' => [ 'type' => 'string', 'max' => 64, 'min' => 1, ], 'ResourceId' => [ 'type' => 'string', 'max' => 34, 'min' => 34, 'pattern' => '^r-[0-9a-f]{32}$', ], 'ResourceName' => [ 'type' => 'string', 'max' => 20, 'min' => 1, 'pattern' => '[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9-]{2,})?', ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'ResourceType' => [ 'type' => 'string', 'enum' => [ 'ROOM', 'EQUIPMENT', ], ], 'Resources' => [ 'type' => 'list', 'member' => [ 'shape' => 'Resource', ], ], 'RetentionAction' => [ 'type' => 'string', 'enum' => [ 'NONE', 'DELETE', 'PERMANENTLY_DELETE', ], ], 'RetentionPeriod' => [ 'type' => 'integer', 'box' => true, 'max' => 730, 'min' => 1, ], 'RoleArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 20, 'pattern' => 'arn:aws:iam:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}', ], 'S3BucketName' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[A-Za-z0-9.-]+', ], 'S3ObjectKey' => [ 'type' => 'string', 'max' => 1023, 'min' => 1, 'pattern' => '[A-Za-z0-9!_.*\'()/-]+', ], 'ShortString' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[a-zA-Z0-9_-]+', ], 'StartMailboxExportJobRequest' => [ 'type' => 'structure', 'required' => [ 'ClientToken', 'OrganizationId', 'EntityId', 'RoleArn', 'KmsKeyArn', 'S3BucketName', 'S3Prefix', ], 'members' => [ 'ClientToken' => [ 'shape' => 'IdempotencyClientToken', 'idempotencyToken' => true, ], 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'EntityIdentifier', ], 'Description' => [ 'shape' => 'Description', ], 'RoleArn' => [ 'shape' => 'RoleArn', ], 'KmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], 'S3BucketName' => [ 'shape' => 'S3BucketName', ], 'S3Prefix' => [ 'shape' => 'S3ObjectKey', ], ], ], 'StartMailboxExportJobResponse' => [ 'type' => 'structure', 'members' => [ 'JobId' => [ 'shape' => 'MailboxExportJobId', ], ], ], 'String' => [ 'type' => 'string', 'max' => 256, ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 50, 'min' => 0, ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'max' => 50, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'Tags', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'AmazonResourceName', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'TargetUsers' => [ 'type' => 'list', 'member' => [ 'shape' => 'EntityIdentifier', ], 'max' => 10, 'min' => 1, ], 'TestAvailabilityConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'EwsProvider' => [ 'shape' => 'EwsAvailabilityProvider', ], 'LambdaProvider' => [ 'shape' => 'LambdaAvailabilityProvider', ], ], ], 'TestAvailabilityConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'TestPassed' => [ 'shape' => 'Boolean', ], 'FailureReason' => [ 'shape' => 'String', ], ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'TooManyTagsException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'UnsupportedOperationException' => [ 'type' => 'structure', 'members' => [ 'Message' => [ 'shape' => 'String', ], ], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceARN', 'TagKeys', ], 'members' => [ 'ResourceARN' => [ 'shape' => 'AmazonResourceName', ], 'TagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateAvailabilityConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'DomainName', ], 'EwsProvider' => [ 'shape' => 'EwsAvailabilityProvider', ], 'LambdaProvider' => [ 'shape' => 'LambdaAvailabilityProvider', ], ], ], 'UpdateAvailabilityConfigurationResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateDefaultMailDomainRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'DomainName', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'DomainName' => [ 'shape' => 'WorkMailDomainName', ], ], ], 'UpdateDefaultMailDomainResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateGroupRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'GroupId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'GroupId' => [ 'shape' => 'EntityIdentifier', ], 'HiddenFromGlobalAddressList' => [ 'shape' => 'BooleanObject', ], ], ], 'UpdateGroupResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateImpersonationRoleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ImpersonationRoleId', 'Name', 'Type', 'Rules', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ImpersonationRoleId' => [ 'shape' => 'ImpersonationRoleId', ], 'Name' => [ 'shape' => 'ImpersonationRoleName', ], 'Type' => [ 'shape' => 'ImpersonationRoleType', ], 'Description' => [ 'shape' => 'ImpersonationRoleDescription', ], 'Rules' => [ 'shape' => 'ImpersonationRuleList', ], ], ], 'UpdateImpersonationRoleResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateMailboxQuotaRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', 'MailboxQuota', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], 'MailboxQuota' => [ 'shape' => 'MailboxQuota', ], ], ], 'UpdateMailboxQuotaResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateMobileDeviceAccessRuleRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'MobileDeviceAccessRuleId', 'Name', 'Effect', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'MobileDeviceAccessRuleId' => [ 'shape' => 'MobileDeviceAccessRuleId', ], 'Name' => [ 'shape' => 'MobileDeviceAccessRuleName', ], 'Description' => [ 'shape' => 'MobileDeviceAccessRuleDescription', ], 'Effect' => [ 'shape' => 'MobileDeviceAccessRuleEffect', ], 'DeviceTypes' => [ 'shape' => 'DeviceTypeList', ], 'NotDeviceTypes' => [ 'shape' => 'DeviceTypeList', ], 'DeviceModels' => [ 'shape' => 'DeviceModelList', ], 'NotDeviceModels' => [ 'shape' => 'DeviceModelList', ], 'DeviceOperatingSystems' => [ 'shape' => 'DeviceOperatingSystemList', ], 'NotDeviceOperatingSystems' => [ 'shape' => 'DeviceOperatingSystemList', ], 'DeviceUserAgents' => [ 'shape' => 'DeviceUserAgentList', ], 'NotDeviceUserAgents' => [ 'shape' => 'DeviceUserAgentList', ], ], ], 'UpdateMobileDeviceAccessRuleResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdatePrimaryEmailAddressRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'EntityId', 'Email', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'EntityId' => [ 'shape' => 'EntityIdentifier', ], 'Email' => [ 'shape' => 'EmailAddress', ], ], ], 'UpdatePrimaryEmailAddressResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateResourceRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'ResourceId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'ResourceId' => [ 'shape' => 'EntityIdentifier', ], 'Name' => [ 'shape' => 'ResourceName', ], 'BookingOptions' => [ 'shape' => 'BookingOptions', ], 'Description' => [ 'shape' => 'NewResourceDescription', ], 'Type' => [ 'shape' => 'ResourceType', ], 'HiddenFromGlobalAddressList' => [ 'shape' => 'BooleanObject', ], ], ], 'UpdateResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateUserRequest' => [ 'type' => 'structure', 'required' => [ 'OrganizationId', 'UserId', ], 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'UserId' => [ 'shape' => 'EntityIdentifier', ], 'Role' => [ 'shape' => 'UserRole', ], 'DisplayName' => [ 'shape' => 'UserAttribute', ], 'FirstName' => [ 'shape' => 'UserAttribute', ], 'LastName' => [ 'shape' => 'UserAttribute', ], 'HiddenFromGlobalAddressList' => [ 'shape' => 'BooleanObject', ], 'Initials' => [ 'shape' => 'UserAttribute', ], 'Telephone' => [ 'shape' => 'UserAttribute', ], 'Street' => [ 'shape' => 'UserAttribute', ], 'JobTitle' => [ 'shape' => 'UserAttribute', ], 'City' => [ 'shape' => 'UserAttribute', ], 'Company' => [ 'shape' => 'UserAttribute', ], 'ZipCode' => [ 'shape' => 'UserAttribute', ], 'Department' => [ 'shape' => 'UserAttribute', ], 'Country' => [ 'shape' => 'UserAttribute', ], 'Office' => [ 'shape' => 'UserAttribute', ], ], ], 'UpdateUserResponse' => [ 'type' => 'structure', 'members' => [], ], 'Url' => [ 'type' => 'string', 'max' => 256, 'pattern' => 'https?://[A-Za-z0-9.-]+(:[0-9]+)?/.*', ], 'User' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'WorkMailIdentifier', ], 'Email' => [ 'shape' => 'EmailAddress', ], 'Name' => [ 'shape' => 'UserName', ], 'DisplayName' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'EntityState', ], 'UserRole' => [ 'shape' => 'UserRole', ], 'EnabledDate' => [ 'shape' => 'Timestamp', ], 'DisabledDate' => [ 'shape' => 'Timestamp', ], ], ], 'UserAttribute' => [ 'type' => 'string', 'max' => 256, 'sensitive' => true, ], 'UserIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkMailIdentifier', ], 'max' => 10, 'min' => 0, ], 'UserName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9-]{2,})?', ], 'UserRole' => [ 'type' => 'string', 'enum' => [ 'USER', 'RESOURCE', 'SYSTEM_USER', 'REMOTE_USER', ], ], 'Users' => [ 'type' => 'list', 'member' => [ 'shape' => 'User', ], ], 'WorkMailDomainName' => [ 'type' => 'string', 'max' => 209, 'min' => 3, 'pattern' => '[a-zA-Z0-9.-]+', ], 'WorkMailIdentifier' => [ 'type' => 'string', 'max' => 256, 'min' => 12, ], ],]; diff --git a/src/data/workmail/2017-10-01/docs-2.json b/src/data/workmail/2017-10-01/docs-2.json index d7f8573079..64cd936d08 100644 --- a/src/data/workmail/2017-10-01/docs-2.json +++ b/src/data/workmail/2017-10-01/docs-2.json @@ -30,6 +30,7 @@ "DeregisterFromWorkMail": "

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

", "DeregisterMailDomain": "

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

", "DescribeEmailMonitoringConfiguration": "

Describes the current email monitoring configuration for a specified organization.

", + "DescribeEntity": "

Returns basic details about an entity in WorkMail.

", "DescribeGroup": "

Returns the data available for the group.

", "DescribeInboundDmarcSettings": "

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

", "DescribeMailboxExportJob": "

Describes the current status of a mailbox export job.

", @@ -51,6 +52,7 @@ "ListAvailabilityConfigurations": "

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

", "ListGroupMembers": "

Returns an overview of the members of a group. Users and groups can be members of a group.

", "ListGroups": "

Returns summaries of the organization's groups.

", + "ListGroupsForEntity": "

Returns all the groups to which an entity belongs.

", "ListImpersonationRoles": "

Lists all the impersonation roles for the given WorkMail organization.

", "ListMailDomains": "

Lists the mail domains in a given WorkMail organization.

", "ListMailboxExportJobs": "

Lists the mailbox export jobs started for the specified organization within the last seven days.

", @@ -77,11 +79,13 @@ "UntagResource": "

Untags the specified tags from the specified WorkMail organization resource.

", "UpdateAvailabilityConfiguration": "

Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.

", "UpdateDefaultMailDomain": "

Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.

", + "UpdateGroup": "

Updates attibutes in a group.

", "UpdateImpersonationRole": "

Updates an impersonation role for the given WorkMail organization.

", "UpdateMailboxQuota": "

Updates a user's current mailbox quota for a specified organization and user.

", "UpdateMobileDeviceAccessRule": "

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

", "UpdatePrimaryEmailAddress": "

Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

", - "UpdateResource": "

Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.

" + "UpdateResource": "

Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.

", + "UpdateUser": "

Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another DescribeUser call.

" }, "shapes": { "AccessControlRule": { @@ -225,9 +229,17 @@ "BookingOptions$AutoAcceptRequests": "

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

", "BookingOptions$AutoDeclineRecurringRequests": "

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

", "BookingOptions$AutoDeclineConflictingRequests": "

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

", + "CreateGroupRequest$HiddenFromGlobalAddressList": "

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

", "CreateOrganizationRequest$EnableInteroperability": "

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

", + "CreateResourceRequest$HiddenFromGlobalAddressList": "

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

", + "CreateUserRequest$HiddenFromGlobalAddressList": "

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

", "DeleteOrganizationRequest$DeleteDirectory": "

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

", + "DeleteOrganizationRequest$ForceDelete": "

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

", + "DescribeGroupResponse$HiddenFromGlobalAddressList": "

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

", "DescribeInboundDmarcSettingsResponse$Enforced": "

Lists the enforcement setting of the applied policy.

", + "DescribeOrganizationResponse$InteroperabilityEnabled": "

Indicates if interoperability is enabled for this organization.

", + "DescribeResourceResponse$HiddenFromGlobalAddressList": "

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

", + "DescribeUserResponse$HiddenFromGlobalAddressList": "

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

", "GetMailDomainResponse$IsTestDomain": "

Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.

", "GetMailDomainResponse$IsDefault": "

Specifies whether the domain is the default domain for your organization.

", "MailDomainSummary$DefaultDomain": "

Whether the domain is default or not.

", @@ -237,7 +249,10 @@ "BooleanObject": { "base": null, "refs": { - "PutInboundDmarcSettingsRequest$Enforced": "

Enforces or suspends a policy after it's applied.

" + "PutInboundDmarcSettingsRequest$Enforced": "

Enforces or suspends a policy after it's applied.

", + "UpdateGroupRequest$HiddenFromGlobalAddressList": "

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

", + "UpdateResourceRequest$HiddenFromGlobalAddressList": "

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

", + "UpdateUserRequest$HiddenFromGlobalAddressList": "

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

" } }, "CancelMailboxExportJobRequest": { @@ -496,6 +511,16 @@ "refs": { } }, + "DescribeEntityRequest": { + "base": null, + "refs": { + } + }, + "DescribeEntityResponse": { + "base": null, + "refs": { + } + }, "DescribeGroupRequest": { "base": null, "refs": { @@ -738,6 +763,7 @@ "Aliases$member": null, "CreateAliasRequest$Alias": "

The alias to add to the member set.

", "DeleteAliasRequest$Alias": "

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).

", + "DescribeEntityRequest$Email": "

The email under which the entity exists.

", "DescribeGroupResponse$Email": "

The email of the described group.

", "DescribeResourceResponse$Email": "

The email of the described resource.

", "DescribeUserResponse$Email": "

The email of the user.

", @@ -761,12 +787,43 @@ "EntityIdentifier": { "base": null, "refs": { + "AssociateDelegateToResourceRequest$ResourceId": "

The resource for which members (users or groups) are associated.

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

", + "AssociateDelegateToResourceRequest$EntityId": "

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

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

", + "AssociateMemberToGroupRequest$GroupId": "

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

", + "AssociateMemberToGroupRequest$MemberId": "

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

", + "DeleteGroupRequest$GroupId": "

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

", + "DeleteMailboxPermissionsRequest$EntityId": "

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

", + "DeleteMailboxPermissionsRequest$GranteeId": "

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

", "DeleteMobileDeviceAccessOverrideRequest$UserId": "

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

", + "DeleteResourceRequest$ResourceId": "

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

", + "DeleteUserRequest$UserId": "

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

", + "DeregisterFromWorkMailRequest$EntityId": "

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

", + "DescribeGroupRequest$GroupId": "

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

", + "DescribeResourceRequest$ResourceId": "

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

", + "DescribeUserRequest$UserId": "

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

", + "DisassociateDelegateFromResourceRequest$ResourceId": "

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

", + "DisassociateDelegateFromResourceRequest$EntityId": "

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

", + "DisassociateMemberFromGroupRequest$GroupId": "

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

", + "DisassociateMemberFromGroupRequest$MemberId": "

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

", "GetImpersonationRoleEffectRequest$TargetUser": "

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

", + "GetMailboxDetailsRequest$UserId": "

The identifier for the user whose mailbox details are being requested.

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

", "GetMobileDeviceAccessOverrideRequest$UserId": "

Identifies the WorkMail user for 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

", + "ListGroupMembersRequest$GroupId": "

The identifier for the group to which the members (users or groups) are 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

", + "ListGroupsForEntityRequest$EntityId": "

The identifier for the entity.

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

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

  • Email address: entity@domain.tld

  • Entity name: entity

", + "ListMailboxPermissionsRequest$EntityId": "

The identifier of the user, or resource for which to list mailbox permissions.

The entity ID can accept UserId or ResourceId, Username or Resourcename, or email.

  • Entity ID: 12345678-1234-1234-1234-123456789012, or r-0123456789a0123456789b0123456789

  • Email address: entity@domain.tld

  • Entity name: entity

", "ListMobileDeviceAccessOverridesRequest$UserId": "

The WorkMail user under which you list the mobile device access overrides. 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

", + "ListResourceDelegatesRequest$ResourceId": "

The identifier for the resource whose delegates are listed.

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

", + "PutMailboxPermissionsRequest$EntityId": "

The identifier of the user or resource for which to update mailbox permissions.

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

", + "PutMailboxPermissionsRequest$GranteeId": "

The identifier of the user, group, or resource to which to grant the permissions.

The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, 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

", "PutMobileDeviceAccessOverrideRequest$UserId": "

The WorkMail user for which you create 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

", - "TargetUsers$member": null + "RegisterToWorkMailRequest$EntityId": "

The identifier for the user, group, or resource to be updated.

The identifier can accept UserId, ResourceId, or GroupId, or Username, Resourcename, or Groupname. The following identity formats are available:

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

  • Entity name: entity

", + "StartMailboxExportJobRequest$EntityId": "

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

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

  • 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

", + "TargetUsers$member": null, + "UpdateGroupRequest$GroupId": "

The identifier for the group to be updated.

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

", + "UpdateMailboxQuotaRequest$UserId": "

The identifer for the user for whom to update the mailbox quota.

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

", + "UpdatePrimaryEmailAddressRequest$EntityId": "

The user, group, or resource to update.

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

  • 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

", + "UpdateResourceRequest$ResourceId": "

The identifier of the resource to be updated.

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

", + "UpdateUserRequest$UserId": "

The identifier for the user to be updated.

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

" } }, "EntityNotFoundException": { @@ -781,6 +838,9 @@ "DescribeResourceResponse$State": "

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

", "DescribeUserResponse$State": "

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

", "Group$State": "

The state of the group, which can be ENABLED, DISABLED, or DELETED.

", + "ListGroupsFilters$State": "

Filters only groups with the provided state.

", + "ListResourcesFilters$State": "

Filters only resource with the provided state.

", + "ListUsersFilters$State": "

Filters only users with the provided state.

", "Member$State": "

The state of the member, which can be ENABLED, DISABLED, or DELETED.

", "Resource$State": "

The state of the resource, which can be ENABLED, DISABLED, or DELETED.

", "User$State": "

The state of the user, which can be ENABLED, DISABLED, or DELETED.

" @@ -791,6 +851,12 @@ "refs": { } }, + "EntityType": { + "base": null, + "refs": { + "DescribeEntityResponse$Type": "

Entity type.

" + } + }, "EwsAvailabilityProvider": { "base": "

Describes an EWS based availability provider. This is only used as input to the service.

", "refs": { @@ -917,12 +983,25 @@ "Groups$member": null } }, + "GroupIdentifier": { + "base": "

The identifier that contains the Group ID and name of a group.

", + "refs": { + "GroupIdentifiers$member": null + } + }, + "GroupIdentifiers": { + "base": null, + "refs": { + "ListGroupsForEntityResponse$Groups": "

The overview of groups in an organization.

" + } + }, "GroupName": { "base": null, "refs": { "CreateGroupRequest$Name": "

The name of the group.

", "DescribeGroupResponse$Name": "

The name of the described group.

", - "Group$Name": "

The name of the group.

" + "Group$Name": "

The name of the group.

", + "GroupIdentifier$GroupName": "

Group name that matched the group.

" } }, "Groups": { @@ -1180,6 +1259,28 @@ "refs": { } }, + "ListGroupsFilters": { + "base": "

Filtering options for ListGroups operation. This is only used as input to Operation.

", + "refs": { + "ListGroupsRequest$Filters": "

Limit the search results based on the filter criteria. Only one filter per request is supported.

" + } + }, + "ListGroupsForEntityFilters": { + "base": "

Filtering options for ListGroupsForEntity operation. This is only used as input to Operation.

", + "refs": { + "ListGroupsForEntityRequest$Filters": "

Limit the search results based on the filter criteria.

" + } + }, + "ListGroupsForEntityRequest": { + "base": null, + "refs": { + } + }, + "ListGroupsForEntityResponse": { + "base": null, + "refs": { + } + }, "ListGroupsRequest": { "base": null, "refs": { @@ -1270,6 +1371,12 @@ "refs": { } }, + "ListResourcesFilters": { + "base": "

Filtering options for ListResources operation. This is only used as input to Operation.

", + "refs": { + "ListResourcesRequest$Filters": "

Limit the resource search results based on the filter criteria. You can only use one filter per request.

" + } + }, "ListResourcesRequest": { "base": null, "refs": { @@ -1290,6 +1397,12 @@ "refs": { } }, + "ListUsersFilters": { + "base": "

Filtering options for ListUsers operation. This is only used as input to Operation.

", + "refs": { + "ListUsersRequest$Filters": "

Limit the user search results based on the filter criteria. You can only use one filter per request.

" + } + }, "ListUsersRequest": { "base": null, "refs": { @@ -1381,6 +1494,7 @@ "ListAliasesRequest$MaxResults": "

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

", "ListAvailabilityConfigurationsRequest$MaxResults": "

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

", "ListGroupMembersRequest$MaxResults": "

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

", + "ListGroupsForEntityRequest$MaxResults": "

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

", "ListGroupsRequest$MaxResults": "

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

", "ListImpersonationRolesRequest$MaxResults": "

The maximum number of results returned in a single call.

", "ListMailDomainsRequest$MaxResults": "

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

", @@ -1496,6 +1610,12 @@ "refs": { } }, + "NewResourceDescription": { + "base": null, + "refs": { + "UpdateResourceRequest$Description": "

Updates the resource description.

" + } + }, "NextToken": { "base": null, "refs": { @@ -1505,6 +1625,8 @@ "ListAvailabilityConfigurationsResponse$NextToken": "

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

", "ListGroupMembersRequest$NextToken": "

The token to use to retrieve the next page of results. The first call does not contain any tokens.

", "ListGroupMembersResponse$NextToken": "

The token to use to retrieve the next page of results. The first call does not contain any tokens.

", + "ListGroupsForEntityRequest$NextToken": "

The token to use to retrieve the next page of results. The first call does not contain any tokens.

", + "ListGroupsForEntityResponse$NextToken": "

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

", "ListGroupsRequest$NextToken": "

The token to use to retrieve the next page of results. The first call does not contain any tokens.

", "ListGroupsResponse$NextToken": "

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

", "ListImpersonationRolesRequest$NextToken": "

The token used to retrieve the next page of results. The first call doesn't require a token.

", @@ -1559,6 +1681,7 @@ "DeregisterFromWorkMailRequest$OrganizationId": "

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

", "DeregisterMailDomainRequest$OrganizationId": "

The WorkMail organization for which the domain will be deregistered.

", "DescribeEmailMonitoringConfigurationRequest$OrganizationId": "

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

", + "DescribeEntityRequest$OrganizationId": "

The identifier for the organization under which the entity exists.

", "DescribeGroupRequest$OrganizationId": "

The identifier for the organization under which the group exists.

", "DescribeInboundDmarcSettingsRequest$OrganizationId": "

Lists the ID of the given organization.

", "DescribeMailboxExportJobRequest$OrganizationId": "

The organization ID.

", @@ -1580,6 +1703,7 @@ "ListAliasesRequest$OrganizationId": "

The identifier for the organization under which the entity exists.

", "ListAvailabilityConfigurationsRequest$OrganizationId": "

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

", "ListGroupMembersRequest$OrganizationId": "

The identifier for the organization under which the group exists.

", + "ListGroupsForEntityRequest$OrganizationId": "

The identifier for the organization under which the entity exists.

", "ListGroupsRequest$OrganizationId": "

The identifier for the organization under which the groups exist.

", "ListImpersonationRolesRequest$OrganizationId": "

The WorkMail organization to which the listed impersonation roles belong.

", "ListMailDomainsRequest$OrganizationId": "

The WorkMail organization for which to list domains.

", @@ -1604,11 +1728,13 @@ "TestAvailabilityConfigurationRequest$OrganizationId": "

The WorkMail organization where the availability provider will be tested.

", "UpdateAvailabilityConfigurationRequest$OrganizationId": "

The WorkMail organization for which the AvailabilityConfiguration will be updated.

", "UpdateDefaultMailDomainRequest$OrganizationId": "

The WorkMail organization for which to list domains.

", + "UpdateGroupRequest$OrganizationId": "

The identifier for the organization under which the group exists.

", "UpdateImpersonationRoleRequest$OrganizationId": "

The WorkMail organization that contains the impersonation role to update.

", "UpdateMailboxQuotaRequest$OrganizationId": "

The identifier for the organization that contains the user for whom to update the mailbox quota.

", "UpdateMobileDeviceAccessRuleRequest$OrganizationId": "

The WorkMail organization under which the rule will be updated.

", "UpdatePrimaryEmailAddressRequest$OrganizationId": "

The organization that contains the user, group, or resource to update.

", - "UpdateResourceRequest$OrganizationId": "

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

" + "UpdateResourceRequest$OrganizationId": "

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

", + "UpdateUserRequest$OrganizationId": "

The identifier for the organization under which the user exists.

" } }, "OrganizationName": { @@ -1800,16 +1926,19 @@ "ListResourceDelegatesResponse$Delegates": "

One page of the resource's delegates.

" } }, + "ResourceDescription": { + "base": null, + "refs": { + "CreateResourceRequest$Description": "

Resource description.

", + "DescribeResourceResponse$Description": "

Description of the resource.

", + "Resource$Description": "

Resource description.

" + } + }, "ResourceId": { "base": null, "refs": { - "AssociateDelegateToResourceRequest$ResourceId": "

The resource for which members (users or groups) are associated.

", "CreateResourceResponse$ResourceId": "

The identifier of the new resource.

", - "DeleteResourceRequest$ResourceId": "

The identifier of the resource to be deleted.

", - "DescribeResourceRequest$ResourceId": "

The identifier of the resource to be described.

", - "DescribeResourceResponse$ResourceId": "

The identifier of the described resource.

", - "DisassociateDelegateFromResourceRequest$ResourceId": "

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

", - "UpdateResourceRequest$ResourceId": "

The identifier of the resource to be updated.

" + "DescribeResourceResponse$ResourceId": "

The identifier of the described resource.

" } }, "ResourceName": { @@ -1831,7 +1960,8 @@ "refs": { "CreateResourceRequest$Type": "

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

", "DescribeResourceResponse$Type": "

The type of the described resource.

", - "Resource$Type": "

The type of the resource: equipment or room.

" + "Resource$Type": "

The type of the resource: equipment or room.

", + "UpdateResourceRequest$Type": "

Updates the resource type.

" } }, "Resources": { @@ -1901,15 +2031,14 @@ "String": { "base": null, "refs": { - "CreateUserRequest$DisplayName": "

The display name for the new user.

", "Delegate$Id": "

The identifier for the user or group associated as the resource's delegate.

", "DeleteOrganizationResponse$State": "

The state of the organization.

", + "DescribeEntityResponse$Name": "

Username, GroupName, or ResourceName based on entity type.

", "DescribeOrganizationResponse$State": "

The state of an organization.

", "DescribeOrganizationResponse$DirectoryId": "

The identifier for the directory associated with an WorkMail organization.

", "DescribeOrganizationResponse$DirectoryType": "

The type of directory associated with the WorkMail organization.

", "DescribeOrganizationResponse$DefaultMailDomain": "

The default mail domain associated with the organization.

", "DescribeOrganizationResponse$ErrorMessage": "

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

", - "DescribeUserResponse$DisplayName": "

The display name of the user.

", "DirectoryInUseException$Message": null, "DirectoryServiceAuthenticationFailedException$Message": null, "DirectoryUnavailableException$Message": null, @@ -1926,6 +2055,13 @@ "InvalidParameterException$Message": null, "InvalidPasswordException$Message": null, "LimitExceededException$Message": null, + "ListGroupsFilters$NamePrefix": "

Filters only groups with the provided name prefix.

", + "ListGroupsFilters$PrimaryEmailPrefix": "

Filters only groups with the provided primary email prefix.

", + "ListGroupsForEntityFilters$GroupNamePrefix": "

Filters only group names that start with the provided name prefix.

", + "ListResourcesFilters$NamePrefix": "

Filters only resource that start with the entered name prefix .

", + "ListResourcesFilters$PrimaryEmailPrefix": "

Filters only resource with the provided primary email prefix.

", + "ListUsersFilters$UsernamePrefix": "

Filters only users with the provided username prefix.

", + "ListUsersFilters$PrimaryEmailPrefix": "

Filters only users with the provided email prefix.

", "MailDomainInUseException$Message": null, "MailDomainNotFoundException$Message": null, "MailDomainStateException$Message": null, @@ -2019,6 +2155,8 @@ "DescribeResourceResponse$DisabledDate": "

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

", "DescribeUserResponse$EnabledDate": "

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

", "DescribeUserResponse$DisabledDate": "

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

", + "DescribeUserResponse$MailboxProvisionedDate": "

The date when the mailbox was created for the user.

", + "DescribeUserResponse$MailboxDeprovisionedDate": "

The date when the mailbox was removed for the user.

", "GetImpersonationRoleResponse$DateCreated": "

The date when the impersonation role was created.

", "GetImpersonationRoleResponse$DateModified": "

The date when the impersonation role was last modified.

", "GetMobileDeviceAccessOverrideResponse$DateCreated": "

The date the override was first created.

", @@ -2081,6 +2219,16 @@ "refs": { } }, + "UpdateGroupRequest": { + "base": null, + "refs": { + } + }, + "UpdateGroupResponse": { + "base": null, + "refs": { + } + }, "UpdateImpersonationRoleRequest": { "base": null, "refs": { @@ -2131,6 +2279,16 @@ "refs": { } }, + "UpdateUserRequest": { + "base": null, + "refs": { + } + }, + "UpdateUserResponse": { + "base": null, + "refs": { + } + }, "Url": { "base": null, "refs": { @@ -2144,6 +2302,41 @@ "Users$member": null } }, + "UserAttribute": { + "base": null, + "refs": { + "CreateUserRequest$DisplayName": "

The display name for the new user.

", + "CreateUserRequest$FirstName": "

The first name of the new user.

", + "CreateUserRequest$LastName": "

The last name of the new user.

", + "DescribeUserResponse$DisplayName": "

The display name of the user.

", + "DescribeUserResponse$FirstName": "

First name of the user.

", + "DescribeUserResponse$LastName": "

Last name of the user.

", + "DescribeUserResponse$Initials": "

Initials of the user.

", + "DescribeUserResponse$Telephone": "

User's contact number.

", + "DescribeUserResponse$Street": "

Street where the user is located.

", + "DescribeUserResponse$JobTitle": "

Job title of the user.

", + "DescribeUserResponse$City": "

City where the user is located.

", + "DescribeUserResponse$Company": "

Company of the user.

", + "DescribeUserResponse$ZipCode": "

Zip code of the user.

", + "DescribeUserResponse$Department": "

Department of the user.

", + "DescribeUserResponse$Country": "

Country where the user is located.

", + "DescribeUserResponse$Office": "

Office where the user is located.

", + "ListUsersFilters$DisplayNamePrefix": "

Filters only users with the provided display name prefix.

", + "UpdateUserRequest$DisplayName": "

Updates the display name of the user.

", + "UpdateUserRequest$FirstName": "

Updates the user's first name.

", + "UpdateUserRequest$LastName": "

Updates the user's last name.

", + "UpdateUserRequest$Initials": "

Updates the user's initials.

", + "UpdateUserRequest$Telephone": "

Updates the user's contact details.

", + "UpdateUserRequest$Street": "

Updates the user's street address.

", + "UpdateUserRequest$JobTitle": "

Updates the user's job title.

", + "UpdateUserRequest$City": "

Updates the user's city.

", + "UpdateUserRequest$Company": "

Updates the user's company.

", + "UpdateUserRequest$ZipCode": "

Updates the user's zipcode.

", + "UpdateUserRequest$Department": "

Updates the user's department.

", + "UpdateUserRequest$Country": "

Updates the user's country.

", + "UpdateUserRequest$Office": "

Updates the user's office.

" + } + }, "UserIdList": { "base": null, "refs": { @@ -2164,7 +2357,9 @@ "UserRole": { "base": null, "refs": { - "DescribeUserResponse$UserRole": "

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, and SYSTEM_USER.

", + "CreateUserRequest$Role": "

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.

", + "DescribeUserResponse$UserRole": "

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.

", + "UpdateUserRequest$Role": "

Updates the user role.

You cannot pass SYSTEM_USER or RESOURCE.

", "User$UserRole": "

The role of the user.

" } }, @@ -2186,45 +2381,25 @@ "WorkMailIdentifier": { "base": null, "refs": { - "AssociateDelegateToResourceRequest$EntityId": "

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

", - "AssociateMemberToGroupRequest$GroupId": "

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

", - "AssociateMemberToGroupRequest$MemberId": "

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

", "CreateAliasRequest$EntityId": "

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

", "CreateGroupResponse$GroupId": "

The identifier of the group.

", "CreateUserResponse$UserId": "

The identifier for the new user.

", "DeleteAliasRequest$EntityId": "

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

", - "DeleteGroupRequest$GroupId": "

The identifier of the group to be deleted.

", - "DeleteMailboxPermissionsRequest$EntityId": "

The identifier of the member (user or group) that owns the mailbox.

", - "DeleteMailboxPermissionsRequest$GranteeId": "

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

", - "DeleteUserRequest$UserId": "

The identifier of the user to be deleted.

", - "DeregisterFromWorkMailRequest$EntityId": "

The identifier for the member (user or group) to be updated.

", - "DescribeGroupRequest$GroupId": "

The identifier for the group to be described.

", + "DescribeEntityResponse$EntityId": "

The entity ID under which the entity exists.

", "DescribeGroupResponse$GroupId": "

The identifier of the described group.

", "DescribeMailboxExportJobResponse$EntityId": "

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

", - "DescribeUserRequest$UserId": "

The identifier for the user to be described.

", + "DescribeOrganizationResponse$MigrationAdmin": "

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

", "DescribeUserResponse$UserId": "

The identifier for the described user.

", - "DisassociateDelegateFromResourceRequest$EntityId": "

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

", - "DisassociateMemberFromGroupRequest$GroupId": "

The identifier for the group from which members are removed.

", - "DisassociateMemberFromGroupRequest$MemberId": "

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

", "GetAccessControlEffectRequest$UserId": "

The user ID.

", - "GetMailboxDetailsRequest$UserId": "

The identifier for the user whose mailbox details are being requested.

", "GetMobileDeviceAccessOverrideResponse$UserId": "

The WorkMail user to which the access override applies.

", "Group$Id": "

The identifier of the group.

", + "GroupIdentifier$GroupId": "

Group ID that matched the group.

", "ListAliasesRequest$EntityId": "

The identifier for the entity for which to list the aliases.

", - "ListGroupMembersRequest$GroupId": "

The identifier for the group to which the members (users or groups) are associated.

", - "ListMailboxPermissionsRequest$EntityId": "

The identifier of the user, group, or resource for which to list mailbox permissions.

", - "ListResourceDelegatesRequest$ResourceId": "

The identifier for the resource whose delegates are listed.

", "MailboxExportJob$EntityId": "

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

", "MobileDeviceAccessOverride$UserId": "

The WorkMail user to which the access override applies.

", "Permission$GranteeId": "

The identifier of the user, group, or resource to which the permissions are granted.

", - "PutMailboxPermissionsRequest$EntityId": "

The identifier of the user, group, or resource for which to update mailbox permissions.

", - "PutMailboxPermissionsRequest$GranteeId": "

The identifier of the user, group, or resource to which to grant the permissions.

", - "RegisterToWorkMailRequest$EntityId": "

The identifier for the user, group, or resource to be updated.

", "ResetPasswordRequest$UserId": "

The identifier of the user for whom the password is reset.

", "Resource$Id": "

The identifier of the resource.

", - "StartMailboxExportJobRequest$EntityId": "

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

", - "UpdateMailboxQuotaRequest$UserId": "

The identifer for the user for whom to update the mailbox quota.

", - "UpdatePrimaryEmailAddressRequest$EntityId": "

The user, group, or resource to update.

", "User$Id": "

The identifier of the user.

", "UserIdList$member": null } diff --git a/src/data/workmail/2017-10-01/docs-2.json.php b/src/data/workmail/2017-10-01/docs-2.json.php index 71aac55b8f..52006ca003 100644 --- a/src/data/workmail/2017-10-01/docs-2.json.php +++ b/src/data/workmail/2017-10-01/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.

The WorkMail API is designed for the following scenarios:

  • Listing and describing organizations

  • Managing users

  • Managing groups

  • Managing resources

All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.

', 'operations' => [ 'AssociateDelegateToResource' => '

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

', 'AssociateMemberToGroup' => '

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

', 'AssumeImpersonationRole' => '

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

', 'CancelMailboxExportJob' => '

Cancels a mailbox export job.

If the mailbox export job is near completion, it might not be possible to cancel it.

', 'CreateAlias' => '

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

', 'CreateAvailabilityConfiguration' => '

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

', 'CreateGroup' => '

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

', 'CreateImpersonationRole' => '

Creates an impersonation role for the given WorkMail organization.

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

', 'CreateMobileDeviceAccessRule' => '

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

', 'CreateOrganization' => '

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

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

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

', 'CreateResource' => '

Creates a new WorkMail resource.

', 'CreateUser' => '

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

', 'DeleteAccessControlRule' => '

Deletes an access control rule for the specified WorkMail organization.

Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

', 'DeleteAlias' => '

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

', 'DeleteAvailabilityConfiguration' => '

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

', 'DeleteEmailMonitoringConfiguration' => '

Deletes the email monitoring configuration for a specified organization.

', 'DeleteGroup' => '

Deletes a group from WorkMail.

', 'DeleteImpersonationRole' => '

Deletes an impersonation role for the given WorkMail organization.

', 'DeleteMailboxPermissions' => '

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

', 'DeleteMobileDeviceAccessOverride' => '

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

Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

', 'DeleteMobileDeviceAccessRule' => '

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

Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

', 'DeleteOrganization' => '

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

', 'DeleteResource' => '

Deletes the specified resource.

', 'DeleteRetentionPolicy' => '

Deletes the specified retention policy from the specified organization.

', 'DeleteUser' => '

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

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

', 'DeregisterFromWorkMail' => '

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

', 'DeregisterMailDomain' => '

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

', 'DescribeEmailMonitoringConfiguration' => '

Describes the current email monitoring configuration for a specified organization.

', 'DescribeGroup' => '

Returns the data available for the group.

', 'DescribeInboundDmarcSettings' => '

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

', 'DescribeMailboxExportJob' => '

Describes the current status of a mailbox export job.

', 'DescribeOrganization' => '

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

', 'DescribeResource' => '

Returns the data available for the resource.

', 'DescribeUser' => '

Provides information regarding the user.

', 'DisassociateDelegateFromResource' => '

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

', 'DisassociateMemberFromGroup' => '

Removes a member from a group.

', 'GetAccessControlEffect' => '

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

', 'GetDefaultRetentionPolicy' => '

Gets the default retention policy details for the specified organization.

', 'GetImpersonationRole' => '

Gets the impersonation role details for the given WorkMail organization.

', 'GetImpersonationRoleEffect' => '

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

', 'GetMailDomain' => '

Gets details for a mail domain, including domain records required to configure your domain with recommended security.

', 'GetMailboxDetails' => '

Requests a user\'s mailbox details for a specified organization and user.

', 'GetMobileDeviceAccessEffect' => '

Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user\'s attributes.

', 'GetMobileDeviceAccessOverride' => '

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

', 'ListAccessControlRules' => '

Lists the access control rules for the specified organization.

', 'ListAliases' => '

Creates a paginated call to list the aliases associated with a given entity.

', 'ListAvailabilityConfigurations' => '

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

', 'ListGroupMembers' => '

Returns an overview of the members of a group. Users and groups can be members of a group.

', 'ListGroups' => '

Returns summaries of the organization\'s groups.

', 'ListImpersonationRoles' => '

Lists all the impersonation roles for the given WorkMail organization.

', 'ListMailDomains' => '

Lists the mail domains in a given WorkMail organization.

', 'ListMailboxExportJobs' => '

Lists the mailbox export jobs started for the specified organization within the last seven days.

', 'ListMailboxPermissions' => '

Lists the mailbox permissions associated with a user, group, or resource mailbox.

', 'ListMobileDeviceAccessOverrides' => '

Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.

', 'ListMobileDeviceAccessRules' => '

Lists the mobile device access rules for the specified WorkMail organization.

', 'ListOrganizations' => '

Returns summaries of the customer\'s organizations.

', 'ListResourceDelegates' => '

Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

', 'ListResources' => '

Returns summaries of the organization\'s resources.

', 'ListTagsForResource' => '

Lists the tags applied to an WorkMail organization resource.

', 'ListUsers' => '

Returns summaries of the organization\'s users.

', 'PutAccessControlRule' => '

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

', 'PutEmailMonitoringConfiguration' => '

Creates or updates the email monitoring configuration for a specified organization.

', 'PutInboundDmarcSettings' => '

Enables or disables a DMARC policy for a given organization.

', 'PutMailboxPermissions' => '

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

', 'PutMobileDeviceAccessOverride' => '

Creates or updates a mobile device access override for the given WorkMail organization, user, and device.

', 'PutRetentionPolicy' => '

Puts a retention policy to the specified organization.

', 'RegisterMailDomain' => '

Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users\' emails.

', 'RegisterToWorkMail' => '

Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.

Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

', 'ResetPassword' => '

Allows the administrator to reset the password for a user.

', 'StartMailboxExportJob' => '

Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.

', 'TagResource' => '

Applies the specified tags to the specified WorkMailorganization resource.

', 'TestAvailabilityConfiguration' => '

Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header.

The request must contain either one provider definition (EwsProvider or LambdaProvider) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested.

', 'UntagResource' => '

Untags the specified tags from the specified WorkMail organization resource.

', 'UpdateAvailabilityConfiguration' => '

Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.

', 'UpdateDefaultMailDomain' => '

Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.

', 'UpdateImpersonationRole' => '

Updates an impersonation role for the given WorkMail organization.

', 'UpdateMailboxQuota' => '

Updates a user\'s current mailbox quota for a specified organization and user.

', 'UpdateMobileDeviceAccessRule' => '

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

', 'UpdatePrimaryEmailAddress' => '

Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

', 'UpdateResource' => '

Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.

', ], 'shapes' => [ 'AccessControlRule' => [ 'base' => '

A rule that controls access to an WorkMail organization.

', 'refs' => [ 'AccessControlRulesList$member' => NULL, ], ], 'AccessControlRuleAction' => [ 'base' => NULL, 'refs' => [ 'ActionsList$member' => NULL, 'GetAccessControlEffectRequest$Action' => '

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

', ], ], 'AccessControlRuleDescription' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$Description' => '

The rule description.

', 'PutAccessControlRuleRequest$Description' => '

The rule description.

', ], ], 'AccessControlRuleEffect' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$Effect' => '

The rule effect.

', 'GetAccessControlEffectResponse$Effect' => '

The rule effect.

', 'PutAccessControlRuleRequest$Effect' => '

The rule effect.

', ], ], 'AccessControlRuleName' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$Name' => '

The rule name.

', 'AccessControlRuleNameList$member' => NULL, 'DeleteAccessControlRuleRequest$Name' => '

The name of the access control rule.

', 'PutAccessControlRuleRequest$Name' => '

The rule name.

', ], ], 'AccessControlRuleNameList' => [ 'base' => NULL, 'refs' => [ 'GetAccessControlEffectResponse$MatchedRules' => '

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

', ], ], 'AccessControlRulesList' => [ 'base' => NULL, 'refs' => [ 'ListAccessControlRulesResponse$Rules' => '

The access control rules.

', ], ], 'AccessEffect' => [ 'base' => NULL, 'refs' => [ 'GetImpersonationRoleEffectResponse$Effect' => '

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

', 'ImpersonationRule$Effect' => '

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

', ], ], 'ActionsList' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$Actions' => '

Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

', 'AccessControlRule$NotActions' => '

Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

', 'PutAccessControlRuleRequest$Actions' => '

Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

', 'PutAccessControlRuleRequest$NotActions' => '

Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

', ], ], 'Aliases' => [ 'base' => NULL, 'refs' => [ 'ListAliasesResponse$Aliases' => '

The entity\'s paginated aliases.

', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationResponse$ARN' => '

The Amazon Resource Name (ARN) of the organization.

', 'ListTagsForResourceRequest$ResourceARN' => '

The resource ARN.

', 'TagResourceRequest$ResourceARN' => '

The resource ARN.

', 'UntagResourceRequest$ResourceARN' => '

The resource ARN.

', ], ], 'AssociateDelegateToResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateDelegateToResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateMemberToGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateMemberToGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssumeImpersonationRoleRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssumeImpersonationRoleResponse' => [ 'base' => NULL, 'refs' => [], ], 'AvailabilityConfiguration' => [ 'base' => '

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

', 'refs' => [ 'AvailabilityConfigurationList$member' => NULL, ], ], 'AvailabilityConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListAvailabilityConfigurationsResponse$AvailabilityConfigurations' => '

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

', ], ], 'AvailabilityProviderType' => [ 'base' => NULL, 'refs' => [ 'AvailabilityConfiguration$ProviderType' => '

Displays the provider type that applies to this domain.

', ], ], 'BookingOptions' => [ 'base' => '

At least one delegate must be associated to the resource to disable automatic replies from the resource.

', 'refs' => [ 'DescribeResourceResponse$BookingOptions' => '

The booking options for the described resource.

', 'UpdateResourceRequest$BookingOptions' => '

The resource\'s booking options to be updated.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'BookingOptions$AutoAcceptRequests' => '

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

', 'BookingOptions$AutoDeclineRecurringRequests' => '

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

', 'BookingOptions$AutoDeclineConflictingRequests' => '

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

', 'CreateOrganizationRequest$EnableInteroperability' => '

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

', 'DeleteOrganizationRequest$DeleteDirectory' => '

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

', 'DescribeInboundDmarcSettingsResponse$Enforced' => '

Lists the enforcement setting of the applied policy.

', 'GetMailDomainResponse$IsTestDomain' => '

Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.

', 'GetMailDomainResponse$IsDefault' => '

Specifies whether the domain is the default domain for your organization.

', 'MailDomainSummary$DefaultDomain' => '

Whether the domain is default or not.

', 'TestAvailabilityConfigurationResponse$TestPassed' => '

Boolean indicating whether the test passed or failed.

', ], ], 'BooleanObject' => [ 'base' => NULL, 'refs' => [ 'PutInboundDmarcSettingsRequest$Enforced' => '

Enforces or suspends a policy after it\'s applied.

', ], ], 'CancelMailboxExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelMailboxExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAvailabilityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAvailabilityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImpersonationRoleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImpersonationRoleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateMobileDeviceAccessRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMobileDeviceAccessRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateOrganizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateOrganizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'Delegate' => [ 'base' => '

The name of the attribute, which is one of the values defined in the UserAttribute enumeration.

', 'refs' => [ 'ResourceDelegates$member' => NULL, ], ], 'DeleteAccessControlRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccessControlRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAvailabilityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAvailabilityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEmailMonitoringConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEmailMonitoringConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImpersonationRoleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImpersonationRoleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMailboxPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMailboxPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMobileDeviceAccessOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMobileDeviceAccessOverrideResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMobileDeviceAccessRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMobileDeviceAccessRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOrganizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOrganizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRetentionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRetentionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterFromWorkMailRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterFromWorkMailResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterMailDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterMailDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEmailMonitoringConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEmailMonitoringConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInboundDmarcSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInboundDmarcSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMailboxExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMailboxExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'DescribeMailboxExportJobResponse$Description' => '

The mailbox export job description.

', 'MailboxExportJob$Description' => '

The mailbox export job description.

', 'StartMailboxExportJobRequest$Description' => '

The mailbox export job description.

', ], ], 'DeviceId' => [ 'base' => NULL, 'refs' => [ 'DeleteMobileDeviceAccessOverrideRequest$DeviceId' => '

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

', 'GetMobileDeviceAccessOverrideRequest$DeviceId' => '

The mobile device to which the override applies. DeviceId is case insensitive.

', 'GetMobileDeviceAccessOverrideResponse$DeviceId' => '

The device to which the access override applies.

', 'ListMobileDeviceAccessOverridesRequest$DeviceId' => '

The mobile device to which the access override applies.

', 'MobileDeviceAccessOverride$DeviceId' => '

The device to which the override applies.

', 'PutMobileDeviceAccessOverrideRequest$DeviceId' => '

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

', ], ], 'DeviceModel' => [ 'base' => NULL, 'refs' => [ 'DeviceModelList$member' => NULL, 'GetMobileDeviceAccessEffectRequest$DeviceModel' => '

Device model the simulated user will report.

', ], ], 'DeviceModelList' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$DeviceModels' => '

Device models that the rule will match.

', 'CreateMobileDeviceAccessRuleRequest$NotDeviceModels' => '

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

', 'MobileDeviceAccessRule$DeviceModels' => '

Device models that a rule will match.

', 'MobileDeviceAccessRule$NotDeviceModels' => '

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

', 'UpdateMobileDeviceAccessRuleRequest$DeviceModels' => '

Device models that the updated rule will match.

', 'UpdateMobileDeviceAccessRuleRequest$NotDeviceModels' => '

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

', ], ], 'DeviceOperatingSystem' => [ 'base' => NULL, 'refs' => [ 'DeviceOperatingSystemList$member' => NULL, 'GetMobileDeviceAccessEffectRequest$DeviceOperatingSystem' => '

Device operating system the simulated user will report.

', ], ], 'DeviceOperatingSystemList' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$DeviceOperatingSystems' => '

Device operating systems that the rule will match.

', 'CreateMobileDeviceAccessRuleRequest$NotDeviceOperatingSystems' => '

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

', 'MobileDeviceAccessRule$DeviceOperatingSystems' => '

Device operating systems that a rule will match.

', 'MobileDeviceAccessRule$NotDeviceOperatingSystems' => '

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

', 'UpdateMobileDeviceAccessRuleRequest$DeviceOperatingSystems' => '

Device operating systems that the updated rule will match.

', 'UpdateMobileDeviceAccessRuleRequest$NotDeviceOperatingSystems' => '

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

', ], ], 'DeviceType' => [ 'base' => NULL, 'refs' => [ 'DeviceTypeList$member' => NULL, 'GetMobileDeviceAccessEffectRequest$DeviceType' => '

Device type the simulated user will report.

', ], ], 'DeviceTypeList' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$DeviceTypes' => '

Device types that the rule will match.

', 'CreateMobileDeviceAccessRuleRequest$NotDeviceTypes' => '

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

', 'MobileDeviceAccessRule$DeviceTypes' => '

Device types that a rule will match.

', 'MobileDeviceAccessRule$NotDeviceTypes' => '

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

', 'UpdateMobileDeviceAccessRuleRequest$DeviceTypes' => '

Device types that the updated rule will match.

', 'UpdateMobileDeviceAccessRuleRequest$NotDeviceTypes' => '

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

', ], ], 'DeviceUserAgent' => [ 'base' => NULL, 'refs' => [ 'DeviceUserAgentList$member' => NULL, 'GetMobileDeviceAccessEffectRequest$DeviceUserAgent' => '

Device user agent the simulated user will report.

', ], ], 'DeviceUserAgentList' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$DeviceUserAgents' => '

Device user agents that the rule will match.

', 'CreateMobileDeviceAccessRuleRequest$NotDeviceUserAgents' => '

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

', 'MobileDeviceAccessRule$DeviceUserAgents' => '

Device user agents that a rule will match.

', 'MobileDeviceAccessRule$NotDeviceUserAgents' => '

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

', 'UpdateMobileDeviceAccessRuleRequest$DeviceUserAgents' => '

User agents that the updated rule will match.

', 'UpdateMobileDeviceAccessRuleRequest$NotDeviceUserAgents' => '

User agents that the updated rule will not match. All other user agents will match.

', ], ], 'DirectoryId' => [ 'base' => NULL, 'refs' => [ 'CreateOrganizationRequest$DirectoryId' => '

The AWS Directory Service directory ID.

', ], ], 'DirectoryInUseException' => [ 'base' => '

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

', 'refs' => [], ], 'DirectoryServiceAuthenticationFailedException' => [ 'base' => '

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

', 'refs' => [], ], 'DirectoryUnavailableException' => [ 'base' => '

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

', 'refs' => [], ], 'DisassociateDelegateFromResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateDelegateFromResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateMemberFromGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateMemberFromGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DnsRecord' => [ 'base' => '

A DNS record uploaded to your DNS provider.

', 'refs' => [ 'DnsRecords$member' => NULL, ], ], 'DnsRecordVerificationStatus' => [ 'base' => NULL, 'refs' => [ 'GetMailDomainResponse$OwnershipVerificationStatus' => '

Indicates the status of the domain ownership verification.

', 'GetMailDomainResponse$DkimVerificationStatus' => '

Indicates the status of a DKIM verification.

', ], ], 'DnsRecords' => [ 'base' => NULL, 'refs' => [ 'GetMailDomainResponse$Records' => '

A list of the DNS records that 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.

', ], ], 'Domain' => [ 'base' => '

The domain to associate with an WorkMail organization.

When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the WorkMail Administrator Guide.

', 'refs' => [ 'Domains$member' => NULL, ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'AvailabilityConfiguration$DomainName' => '

Displays the domain to which the provider applies.

', 'CreateAvailabilityConfigurationRequest$DomainName' => '

The domain to which the provider applies.

', 'DeleteAvailabilityConfigurationRequest$DomainName' => '

The domain for which the AvailabilityConfiguration will be deleted.

', 'Domain$DomainName' => '

The fully qualified domain name.

', 'MailDomainSummary$DomainName' => '

The domain name.

', 'OrganizationSummary$DefaultMailDomain' => '

The default email domain associated with the organization.

', 'TestAvailabilityConfigurationRequest$DomainName' => '

The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested.

', 'UpdateAvailabilityConfigurationRequest$DomainName' => '

The domain to which the provider applies the availability configuration.

', ], ], 'Domains' => [ 'base' => NULL, 'refs' => [ 'CreateOrganizationRequest$Domains' => '

The email domains to associate with the organization.

', ], ], 'EmailAddress' => [ 'base' => NULL, 'refs' => [ 'Aliases$member' => NULL, 'CreateAliasRequest$Alias' => '

The alias to add to the member set.

', 'DeleteAliasRequest$Alias' => '

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).

', 'DescribeGroupResponse$Email' => '

The email of the described group.

', 'DescribeResourceResponse$Email' => '

The email of the described resource.

', 'DescribeUserResponse$Email' => '

The email of the user.

', 'Group$Email' => '

The email of the group.

', 'RegisterToWorkMailRequest$Email' => '

The email for the user, group, or resource to be updated.

', 'Resource$Email' => '

The email of the resource.

', 'UpdatePrimaryEmailAddressRequest$Email' => '

The value of the email to be updated as primary.

', 'User$Email' => '

The email of the user.

', ], ], 'EmailAddressInUseException' => [ 'base' => '

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

', 'refs' => [], ], 'EntityAlreadyRegisteredException' => [ 'base' => '

The user, group, or resource that you\'re trying to register is already registered.

', 'refs' => [], ], 'EntityIdentifier' => [ 'base' => NULL, 'refs' => [ 'DeleteMobileDeviceAccessOverrideRequest$UserId' => '

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

', 'GetImpersonationRoleEffectRequest$TargetUser' => '

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

', 'GetMobileDeviceAccessOverrideRequest$UserId' => '

Identifies the WorkMail user for 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

', 'ListMobileDeviceAccessOverridesRequest$UserId' => '

The WorkMail user under which you list the mobile device access overrides. 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

', 'PutMobileDeviceAccessOverrideRequest$UserId' => '

The WorkMail user for which you create 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

', 'TargetUsers$member' => NULL, ], ], 'EntityNotFoundException' => [ 'base' => '

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

', 'refs' => [], ], 'EntityState' => [ 'base' => NULL, 'refs' => [ 'DescribeGroupResponse$State' => '

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

', 'DescribeResourceResponse$State' => '

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

', 'DescribeUserResponse$State' => '

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

', 'Group$State' => '

The state of the group, which can be ENABLED, DISABLED, or DELETED.

', 'Member$State' => '

The state of the member, which can be ENABLED, DISABLED, or DELETED.

', 'Resource$State' => '

The state of the resource, which can be ENABLED, DISABLED, or DELETED.

', 'User$State' => '

The state of the user, which can be ENABLED, DISABLED, or DELETED.

', ], ], 'EntityStateException' => [ 'base' => '

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.

', 'refs' => [], ], 'EwsAvailabilityProvider' => [ 'base' => '

Describes an EWS based availability provider. This is only used as input to the service.

', 'refs' => [ 'CreateAvailabilityConfigurationRequest$EwsProvider' => '

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

', 'TestAvailabilityConfigurationRequest$EwsProvider' => NULL, 'UpdateAvailabilityConfigurationRequest$EwsProvider' => '

The EWS availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. The previously stored provider will be overridden by the one provided.

', ], ], 'ExpiresIn' => [ 'base' => NULL, 'refs' => [ 'AssumeImpersonationRoleResponse$ExpiresIn' => '

The authentication token\'s validity, in seconds.

', ], ], 'ExternalUserName' => [ 'base' => NULL, 'refs' => [ 'EwsAvailabilityProvider$EwsUsername' => '

The username used to authenticate the remote EWS server.

', 'RedactedEwsAvailabilityProvider$EwsUsername' => '

The username used to authenticate the remote EWS server.

', ], ], 'FolderConfiguration' => [ 'base' => '

The configuration applied to an organization\'s folders by its retention policy.

', 'refs' => [ 'FolderConfigurations$member' => NULL, ], ], 'FolderConfigurations' => [ 'base' => NULL, 'refs' => [ 'GetDefaultRetentionPolicyResponse$FolderConfigurations' => '

The retention policy folder configurations.

', 'PutRetentionPolicyRequest$FolderConfigurations' => '

The retention policy folder configurations.

', ], ], 'FolderName' => [ 'base' => NULL, 'refs' => [ 'FolderConfiguration$Name' => '

The folder name.

', ], ], 'GetAccessControlEffectRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAccessControlEffectResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDefaultRetentionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDefaultRetentionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetImpersonationRoleEffectRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetImpersonationRoleEffectResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetImpersonationRoleRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetImpersonationRoleResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMailDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMailDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMailboxDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMailboxDetailsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMobileDeviceAccessEffectRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMobileDeviceAccessEffectResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMobileDeviceAccessOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMobileDeviceAccessOverrideResponse' => [ 'base' => NULL, 'refs' => [], ], 'Group' => [ 'base' => '

The representation of an WorkMail group.

', 'refs' => [ 'Groups$member' => NULL, ], ], 'GroupName' => [ 'base' => NULL, 'refs' => [ 'CreateGroupRequest$Name' => '

The name of the group.

', 'DescribeGroupResponse$Name' => '

The name of the described group.

', 'Group$Name' => '

The name of the group.

', ], ], 'Groups' => [ 'base' => NULL, 'refs' => [ 'ListGroupsResponse$Groups' => '

The overview of groups for an organization.

', ], ], 'HostedZoneId' => [ 'base' => NULL, 'refs' => [ 'Domain$HostedZoneId' => '

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

', ], ], 'IdempotencyClientToken' => [ 'base' => NULL, 'refs' => [ 'CancelMailboxExportJobRequest$ClientToken' => '

The idempotency token for the client request.

', 'CreateAvailabilityConfigurationRequest$ClientToken' => '

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

', 'CreateImpersonationRoleRequest$ClientToken' => '

The idempotency token for the client request.

', 'CreateMobileDeviceAccessRuleRequest$ClientToken' => '

The idempotency token for the client request.

', 'CreateOrganizationRequest$ClientToken' => '

The idempotency token associated with the request.

', 'DeleteOrganizationRequest$ClientToken' => '

The idempotency token associated with the request.

', 'RegisterMailDomainRequest$ClientToken' => '

Idempotency token used when retrying requests.

', 'StartMailboxExportJobRequest$ClientToken' => '

The idempotency token for the client request.

', ], ], 'ImpersonationMatchedRule' => [ 'base' => '

The impersonation rule that matched the input.

', 'refs' => [ 'ImpersonationMatchedRuleList$member' => NULL, ], ], 'ImpersonationMatchedRuleList' => [ 'base' => NULL, 'refs' => [ 'GetImpersonationRoleEffectResponse$MatchedRules' => '

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

', ], ], 'ImpersonationRole' => [ 'base' => '

An impersonation role for the given WorkMail organization.

', 'refs' => [ 'ImpersonationRoleList$member' => NULL, ], ], 'ImpersonationRoleDescription' => [ 'base' => NULL, 'refs' => [ 'CreateImpersonationRoleRequest$Description' => '

The description of the new impersonation role.

', 'GetImpersonationRoleResponse$Description' => '

The impersonation role description.

', 'UpdateImpersonationRoleRequest$Description' => '

The updated impersonation role description.

', ], ], 'ImpersonationRoleId' => [ 'base' => NULL, 'refs' => [ 'AssumeImpersonationRoleRequest$ImpersonationRoleId' => '

The impersonation role ID to assume.

', 'CreateImpersonationRoleResponse$ImpersonationRoleId' => '

The new impersonation role ID.

', 'DeleteImpersonationRoleRequest$ImpersonationRoleId' => '

The ID of the impersonation role to delete.

', 'GetAccessControlEffectRequest$ImpersonationRoleId' => '

The impersonation role ID.

', 'GetImpersonationRoleEffectRequest$ImpersonationRoleId' => '

The impersonation role ID to test.

', 'GetImpersonationRoleRequest$ImpersonationRoleId' => '

The impersonation role ID to retrieve.

', 'GetImpersonationRoleResponse$ImpersonationRoleId' => '

The impersonation role ID.

', 'ImpersonationRole$ImpersonationRoleId' => '

The identifier of the impersonation role.

', 'ImpersonationRoleIdList$member' => NULL, 'UpdateImpersonationRoleRequest$ImpersonationRoleId' => '

The ID of the impersonation role to update.

', ], ], 'ImpersonationRoleIdList' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$ImpersonationRoleIds' => '

Impersonation role IDs to include in the rule.

', 'AccessControlRule$NotImpersonationRoleIds' => '

Impersonation role IDs to exclude from the rule.

', 'PutAccessControlRuleRequest$ImpersonationRoleIds' => '

Impersonation role IDs to include in the rule.

', 'PutAccessControlRuleRequest$NotImpersonationRoleIds' => '

Impersonation role IDs to exclude from the rule.

', ], ], 'ImpersonationRoleList' => [ 'base' => NULL, 'refs' => [ 'ListImpersonationRolesResponse$Roles' => '

The list of impersonation roles under the given WorkMail organization.

', ], ], 'ImpersonationRoleName' => [ 'base' => NULL, 'refs' => [ 'CreateImpersonationRoleRequest$Name' => '

The name of the new impersonation role.

', 'GetImpersonationRoleResponse$Name' => '

The impersonation role name.

', 'ImpersonationRole$Name' => '

The impersonation role name.

', 'UpdateImpersonationRoleRequest$Name' => '

The updated impersonation role name.

', ], ], 'ImpersonationRoleType' => [ 'base' => NULL, 'refs' => [ 'CreateImpersonationRoleRequest$Type' => '

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

', 'GetImpersonationRoleEffectResponse$Type' => '

The impersonation role type.

', 'GetImpersonationRoleResponse$Type' => '

The impersonation role type.

', 'ImpersonationRole$Type' => '

The impersonation role type.

', 'UpdateImpersonationRoleRequest$Type' => '

The updated impersonation role type.

', ], ], 'ImpersonationRule' => [ 'base' => '

The rules for the given impersonation role.

', 'refs' => [ 'ImpersonationRuleList$member' => NULL, ], ], 'ImpersonationRuleDescription' => [ 'base' => NULL, 'refs' => [ 'ImpersonationRule$Description' => '

The rule description.

', ], ], 'ImpersonationRuleId' => [ 'base' => NULL, 'refs' => [ 'ImpersonationMatchedRule$ImpersonationRuleId' => '

The ID of the rule that matched the input

', 'ImpersonationRule$ImpersonationRuleId' => '

The identifier of the rule.

', ], ], 'ImpersonationRuleList' => [ 'base' => NULL, 'refs' => [ 'CreateImpersonationRoleRequest$Rules' => '

The list of rules for the impersonation role.

', 'GetImpersonationRoleResponse$Rules' => '

The list of rules for the given impersonation role.

', 'UpdateImpersonationRoleRequest$Rules' => '

The updated list of rules.

', ], ], 'ImpersonationRuleName' => [ 'base' => NULL, 'refs' => [ 'ImpersonationMatchedRule$Name' => '

The name of the rule that matched the input.

', 'ImpersonationRule$Name' => '

The rule name.

', ], ], 'ImpersonationToken' => [ 'base' => NULL, 'refs' => [ 'AssumeImpersonationRoleResponse$Token' => '

The authentication token for the impersonation role.

', ], ], 'InvalidConfigurationException' => [ 'base' => '

The configuration for a resource isn\'t valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.

', 'refs' => [], ], 'InvalidCustomSesConfigurationException' => [ 'base' => '

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

', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => '

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

', 'refs' => [], ], 'InvalidPasswordException' => [ 'base' => '

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

', 'refs' => [], ], 'IpAddress' => [ 'base' => NULL, 'refs' => [ 'GetAccessControlEffectRequest$IpAddress' => '

The IPv4 address.

', ], ], 'IpRange' => [ 'base' => NULL, 'refs' => [ 'IpRangeList$member' => NULL, ], ], 'IpRangeList' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$IpRanges' => '

IPv4 CIDR ranges to include in the rule.

', 'AccessControlRule$NotIpRanges' => '

IPv4 CIDR ranges to exclude from the rule.

', 'PutAccessControlRuleRequest$IpRanges' => '

IPv4 CIDR ranges to include in the rule.

', 'PutAccessControlRuleRequest$NotIpRanges' => '

IPv4 CIDR ranges to exclude from the rule.

', ], ], 'Jobs' => [ 'base' => NULL, 'refs' => [ 'ListMailboxExportJobsResponse$Jobs' => '

The mailbox export job details.

', ], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'CreateOrganizationRequest$KmsKeyArn' => '

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

', 'DescribeMailboxExportJobResponse$KmsKeyArn' => '

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

', 'StartMailboxExportJobRequest$KmsKeyArn' => '

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

', ], ], 'LambdaArn' => [ 'base' => NULL, 'refs' => [ 'LambdaAvailabilityProvider$LambdaArn' => '

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

', ], ], 'LambdaAvailabilityProvider' => [ 'base' => '

Describes a Lambda based availability provider.

', 'refs' => [ 'AvailabilityConfiguration$LambdaProvider' => '

If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider. Otherwise, it is not required.

', 'CreateAvailabilityConfigurationRequest$LambdaProvider' => '

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

', 'TestAvailabilityConfigurationRequest$LambdaProvider' => NULL, 'UpdateAvailabilityConfigurationRequest$LambdaProvider' => '

The Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. The previously stored provider will be overridden by the one provided.

', ], ], 'LimitExceededException' => [ 'base' => '

The request exceeds the limit of the resource.

', 'refs' => [], ], 'ListAccessControlRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAccessControlRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailabilityConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailabilityConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupMembersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupMembersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImpersonationRolesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImpersonationRolesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMailDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMailDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMailboxExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMailboxExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMailboxPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMailboxPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMobileDeviceAccessOverridesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMobileDeviceAccessOverridesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMobileDeviceAccessRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMobileDeviceAccessRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListOrganizationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListOrganizationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceDelegatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceDelegatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogGroupArn' => [ 'base' => NULL, 'refs' => [ 'DescribeEmailMonitoringConfigurationResponse$LogGroupArn' => '

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

', 'PutEmailMonitoringConfigurationRequest$LogGroupArn' => '

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

', ], ], 'MailDomainInUseException' => [ 'base' => '

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

', 'refs' => [], ], 'MailDomainNotFoundException' => [ 'base' => '

The domain specified is not found in your organization.

', 'refs' => [], ], 'MailDomainStateException' => [ 'base' => '

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

', 'refs' => [], ], 'MailDomainSummary' => [ 'base' => '

The data for a given domain.

', 'refs' => [ 'MailDomains$member' => NULL, ], ], 'MailDomains' => [ 'base' => NULL, 'refs' => [ 'ListMailDomainsResponse$MailDomains' => '

The list of mail domain summaries, specifying domains that exist in the specified WorkMail organization, along with the information about whether the domain is or isn\'t the default.

', ], ], 'MailboxExportErrorInfo' => [ 'base' => NULL, 'refs' => [ 'DescribeMailboxExportJobResponse$ErrorInfo' => '

Error information for failed mailbox export jobs.

', ], ], 'MailboxExportJob' => [ 'base' => '

The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.

', 'refs' => [ 'Jobs$member' => NULL, ], ], 'MailboxExportJobId' => [ 'base' => NULL, 'refs' => [ 'CancelMailboxExportJobRequest$JobId' => '

The job ID.

', 'DescribeMailboxExportJobRequest$JobId' => '

The mailbox export job ID.

', 'MailboxExportJob$JobId' => '

The identifier of the mailbox export job.

', 'StartMailboxExportJobResponse$JobId' => '

The job ID.

', ], ], 'MailboxExportJobState' => [ 'base' => NULL, 'refs' => [ 'DescribeMailboxExportJobResponse$State' => '

The state of the mailbox export job.

', 'MailboxExportJob$State' => '

The state of the mailbox export job.

', ], ], 'MailboxQuota' => [ 'base' => NULL, 'refs' => [ 'GetMailboxDetailsResponse$MailboxQuota' => '

The maximum allowed mailbox size, in MB, for the specified user.

', 'UpdateMailboxQuotaRequest$MailboxQuota' => '

The updated mailbox quota, in MB, for the specified user.

', ], ], 'MailboxSize' => [ 'base' => NULL, 'refs' => [ 'GetMailboxDetailsResponse$MailboxSize' => '

The current mailbox size, in MB, for the specified user.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAliasesRequest$MaxResults' => '

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

', 'ListAvailabilityConfigurationsRequest$MaxResults' => '

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

', 'ListGroupMembersRequest$MaxResults' => '

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

', 'ListGroupsRequest$MaxResults' => '

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

', 'ListImpersonationRolesRequest$MaxResults' => '

The maximum number of results returned in a single call.

', 'ListMailDomainsRequest$MaxResults' => '

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

', 'ListMailboxExportJobsRequest$MaxResults' => '

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

', 'ListMailboxPermissionsRequest$MaxResults' => '

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

', 'ListMobileDeviceAccessOverridesRequest$MaxResults' => '

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

', 'ListOrganizationsRequest$MaxResults' => '

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

', 'ListResourceDelegatesRequest$MaxResults' => '

The number of maximum results in a page.

', 'ListResourcesRequest$MaxResults' => '

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

', 'ListUsersRequest$MaxResults' => '

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

', ], ], 'Member' => [ 'base' => '

The representation of a user or group.

', 'refs' => [ 'Members$member' => NULL, ], ], 'MemberType' => [ 'base' => NULL, 'refs' => [ 'Delegate$Type' => '

The type of the delegate: user or group.

', 'Member$Type' => '

A member can be a user or group.

', 'Permission$GranteeType' => '

The type of user, group, or resource referred to in GranteeId.

', ], ], 'Members' => [ 'base' => NULL, 'refs' => [ 'ListGroupMembersResponse$Members' => '

The members associated to the group.

', ], ], 'MobileDeviceAccessMatchedRule' => [ 'base' => '

The rule that a simulated user matches.

', 'refs' => [ 'MobileDeviceAccessMatchedRuleList$member' => NULL, ], ], 'MobileDeviceAccessMatchedRuleList' => [ 'base' => NULL, 'refs' => [ 'GetMobileDeviceAccessEffectResponse$MatchedRules' => '

A list of the rules which matched the simulated user input and produced the effect.

', ], ], 'MobileDeviceAccessOverride' => [ 'base' => '

The override object.

', 'refs' => [ 'MobileDeviceAccessOverridesList$member' => NULL, ], ], 'MobileDeviceAccessOverridesList' => [ 'base' => NULL, 'refs' => [ 'ListMobileDeviceAccessOverridesResponse$Overrides' => '

The list of mobile device access overrides that exist for the specified WorkMail organization and user.

', ], ], 'MobileDeviceAccessRule' => [ 'base' => '

A rule that controls access to mobile devices for an WorkMail group.

', 'refs' => [ 'MobileDeviceAccessRulesList$member' => NULL, ], ], 'MobileDeviceAccessRuleDescription' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$Description' => '

The rule description.

', 'GetMobileDeviceAccessOverrideResponse$Description' => '

A description of the override.

', 'MobileDeviceAccessOverride$Description' => '

A description of the override.

', 'MobileDeviceAccessRule$Description' => '

The description of a mobile access rule.

', 'PutMobileDeviceAccessOverrideRequest$Description' => '

A description of the override.

', 'UpdateMobileDeviceAccessRuleRequest$Description' => '

The updated rule description.

', ], ], 'MobileDeviceAccessRuleEffect' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$Effect' => '

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

', 'GetMobileDeviceAccessEffectResponse$Effect' => '

The effect of the simulated access, ALLOW or DENY, after evaluating mobile device access rules in the WorkMail organization for the simulated user parameters.

', 'GetMobileDeviceAccessOverrideResponse$Effect' => '

The effect of the override, ALLOW or DENY.

', 'MobileDeviceAccessOverride$Effect' => '

The effect of the override, ALLOW or DENY.

', 'MobileDeviceAccessRule$Effect' => '

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

', 'PutMobileDeviceAccessOverrideRequest$Effect' => '

The effect of the override, ALLOW or DENY.

', 'UpdateMobileDeviceAccessRuleRequest$Effect' => '

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

', ], ], 'MobileDeviceAccessRuleId' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleResponse$MobileDeviceAccessRuleId' => '

The identifier for the newly created mobile device access rule.

', 'DeleteMobileDeviceAccessRuleRequest$MobileDeviceAccessRuleId' => '

The identifier of the rule to be deleted.

', 'MobileDeviceAccessMatchedRule$MobileDeviceAccessRuleId' => '

Identifier of the rule that a simulated user matches.

', 'MobileDeviceAccessRule$MobileDeviceAccessRuleId' => '

The ID assigned to a mobile access rule.

', 'UpdateMobileDeviceAccessRuleRequest$MobileDeviceAccessRuleId' => '

The identifier of the rule to be updated.

', ], ], 'MobileDeviceAccessRuleName' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$Name' => '

The rule name.

', 'MobileDeviceAccessMatchedRule$Name' => '

Name of a rule that a simulated user matches.

', 'MobileDeviceAccessRule$Name' => '

The name of a mobile access rule.

', 'UpdateMobileDeviceAccessRuleRequest$Name' => '

The updated rule name.

', ], ], 'MobileDeviceAccessRulesList' => [ 'base' => NULL, 'refs' => [ 'ListMobileDeviceAccessRulesResponse$Rules' => '

The list of mobile device access rules that exist under the specified WorkMail organization.

', ], ], 'NameAvailabilityException' => [ 'base' => '

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

', 'refs' => [], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListAliasesRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListAliasesResponse$NextToken' => '

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

', 'ListAvailabilityConfigurationsRequest$NextToken' => '

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

', 'ListAvailabilityConfigurationsResponse$NextToken' => '

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

', 'ListGroupMembersRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListGroupMembersResponse$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListGroupsRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListGroupsResponse$NextToken' => '

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

', 'ListImpersonationRolesRequest$NextToken' => '

The token used to retrieve the next page of results. The first call doesn\'t require a token.

', 'ListImpersonationRolesResponse$NextToken' => '

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

', 'ListMailDomainsRequest$NextToken' => '

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

', 'ListMailDomainsResponse$NextToken' => '

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

', 'ListMailboxExportJobsRequest$NextToken' => '

The token to use to retrieve the next page of results.

', 'ListMailboxExportJobsResponse$NextToken' => '

The token to use to retrieve the next page of results.

', 'ListMailboxPermissionsRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListMailboxPermissionsResponse$NextToken' => '

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

', 'ListMobileDeviceAccessOverridesRequest$NextToken' => '

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

', 'ListMobileDeviceAccessOverridesResponse$NextToken' => '

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

', 'ListOrganizationsRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListOrganizationsResponse$NextToken' => '

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

', 'ListResourceDelegatesRequest$NextToken' => '

The token used to paginate through the delegates associated with a resource.

', 'ListResourceDelegatesResponse$NextToken' => '

The token used to paginate through the delegates associated with a resource. While results are still available, it has an associated value. When the last page is reached, the token is empty.

', 'ListResourcesRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListResourcesResponse$NextToken' => '

The token used to paginate through all the organization\'s resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.

', 'ListUsersRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListUsersResponse$NextToken' => '

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

', ], ], 'OrganizationId' => [ 'base' => NULL, 'refs' => [ 'AssociateDelegateToResourceRequest$OrganizationId' => '

The organization under which the resource exists.

', 'AssociateMemberToGroupRequest$OrganizationId' => '

The organization under which the group exists.

', 'AssumeImpersonationRoleRequest$OrganizationId' => '

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

', 'CancelMailboxExportJobRequest$OrganizationId' => '

The organization ID.

', 'CreateAliasRequest$OrganizationId' => '

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

', 'CreateAvailabilityConfigurationRequest$OrganizationId' => '

The WorkMail organization for which the AvailabilityConfiguration will be created.

', 'CreateGroupRequest$OrganizationId' => '

The organization under which the group is to be created.

', 'CreateImpersonationRoleRequest$OrganizationId' => '

The WorkMail organization to create the new impersonation role within.

', 'CreateMobileDeviceAccessRuleRequest$OrganizationId' => '

The WorkMail organization under which the rule will be created.

', 'CreateOrganizationResponse$OrganizationId' => '

The organization ID.

', 'CreateResourceRequest$OrganizationId' => '

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

', 'CreateUserRequest$OrganizationId' => '

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

', 'DeleteAccessControlRuleRequest$OrganizationId' => '

The identifier for the organization.

', 'DeleteAliasRequest$OrganizationId' => '

The identifier for the organization under which the user exists.

', 'DeleteAvailabilityConfigurationRequest$OrganizationId' => '

The WorkMail organization for which the AvailabilityConfiguration will be deleted.

', 'DeleteEmailMonitoringConfigurationRequest$OrganizationId' => '

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

', 'DeleteGroupRequest$OrganizationId' => '

The organization that contains the group.

', 'DeleteImpersonationRoleRequest$OrganizationId' => '

The WorkMail organization from which to delete the impersonation role.

', 'DeleteMailboxPermissionsRequest$OrganizationId' => '

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

', 'DeleteMobileDeviceAccessOverrideRequest$OrganizationId' => '

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

', 'DeleteMobileDeviceAccessRuleRequest$OrganizationId' => '

The WorkMail organization under which the rule will be deleted.

', 'DeleteOrganizationRequest$OrganizationId' => '

The organization ID.

', 'DeleteOrganizationResponse$OrganizationId' => '

The organization ID.

', 'DeleteResourceRequest$OrganizationId' => '

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

', 'DeleteRetentionPolicyRequest$OrganizationId' => '

The organization ID.

', 'DeleteUserRequest$OrganizationId' => '

The organization that contains the user to be deleted.

', 'DeregisterFromWorkMailRequest$OrganizationId' => '

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

', 'DeregisterMailDomainRequest$OrganizationId' => '

The WorkMail organization for which the domain will be deregistered.

', 'DescribeEmailMonitoringConfigurationRequest$OrganizationId' => '

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

', 'DescribeGroupRequest$OrganizationId' => '

The identifier for the organization under which the group exists.

', 'DescribeInboundDmarcSettingsRequest$OrganizationId' => '

Lists the ID of the given organization.

', 'DescribeMailboxExportJobRequest$OrganizationId' => '

The organization ID.

', 'DescribeOrganizationRequest$OrganizationId' => '

The identifier for the organization to be described.

', 'DescribeOrganizationResponse$OrganizationId' => '

The identifier of an organization.

', 'DescribeResourceRequest$OrganizationId' => '

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

', 'DescribeUserRequest$OrganizationId' => '

The identifier for the organization under which the user exists.

', 'DisassociateDelegateFromResourceRequest$OrganizationId' => '

The identifier for the organization under which the resource exists.

', 'DisassociateMemberFromGroupRequest$OrganizationId' => '

The identifier for the organization under which the group exists.

', 'GetAccessControlEffectRequest$OrganizationId' => '

The identifier for the organization.

', 'GetDefaultRetentionPolicyRequest$OrganizationId' => '

The organization ID.

', 'GetImpersonationRoleEffectRequest$OrganizationId' => '

The WorkMail organization where the impersonation role is defined.

', 'GetImpersonationRoleRequest$OrganizationId' => '

The WorkMail organization from which to retrieve the impersonation role.

', 'GetMailDomainRequest$OrganizationId' => '

The WorkMail organization for which the domain is retrieved.

', 'GetMailboxDetailsRequest$OrganizationId' => '

The identifier for the organization that contains the user whose mailbox details are being requested.

', 'GetMobileDeviceAccessEffectRequest$OrganizationId' => '

The WorkMail organization to simulate the access effect for.

', 'GetMobileDeviceAccessOverrideRequest$OrganizationId' => '

The WorkMail organization to which you want to apply the override.

', 'ListAccessControlRulesRequest$OrganizationId' => '

The identifier for the organization.

', 'ListAliasesRequest$OrganizationId' => '

The identifier for the organization under which the entity exists.

', 'ListAvailabilityConfigurationsRequest$OrganizationId' => '

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

', 'ListGroupMembersRequest$OrganizationId' => '

The identifier for the organization under which the group exists.

', 'ListGroupsRequest$OrganizationId' => '

The identifier for the organization under which the groups exist.

', 'ListImpersonationRolesRequest$OrganizationId' => '

The WorkMail organization to which the listed impersonation roles belong.

', 'ListMailDomainsRequest$OrganizationId' => '

The WorkMail organization for which to list domains.

', 'ListMailboxExportJobsRequest$OrganizationId' => '

The organization ID.

', 'ListMailboxPermissionsRequest$OrganizationId' => '

The identifier of the organization under which the user, group, or resource exists.

', 'ListMobileDeviceAccessOverridesRequest$OrganizationId' => '

The WorkMail organization under which to list mobile device access overrides.

', 'ListMobileDeviceAccessRulesRequest$OrganizationId' => '

The WorkMail organization for which to list the rules.

', 'ListResourceDelegatesRequest$OrganizationId' => '

The identifier for the organization that contains the resource for which delegates are listed.

', 'ListResourcesRequest$OrganizationId' => '

The identifier for the organization under which the resources exist.

', 'ListUsersRequest$OrganizationId' => '

The identifier for the organization under which the users exist.

', 'OrganizationSummary$OrganizationId' => '

The identifier associated with the organization.

', 'PutAccessControlRuleRequest$OrganizationId' => '

The identifier of the organization.

', 'PutEmailMonitoringConfigurationRequest$OrganizationId' => '

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

', 'PutInboundDmarcSettingsRequest$OrganizationId' => '

The ID of the organization that you are applying the DMARC policy to.

', 'PutMailboxPermissionsRequest$OrganizationId' => '

The identifier of the organization under which the user, group, or resource exists.

', 'PutMobileDeviceAccessOverrideRequest$OrganizationId' => '

Identifies the WorkMail organization for which you create the override.

', 'PutRetentionPolicyRequest$OrganizationId' => '

The organization ID.

', 'RegisterMailDomainRequest$OrganizationId' => '

The WorkMail organization under which you\'re creating the domain.

', 'RegisterToWorkMailRequest$OrganizationId' => '

The identifier for the organization under which the user, group, or resource exists.

', 'ResetPasswordRequest$OrganizationId' => '

The identifier of the organization that contains the user for which the password is reset.

', 'StartMailboxExportJobRequest$OrganizationId' => '

The identifier associated with the organization.

', 'TestAvailabilityConfigurationRequest$OrganizationId' => '

The WorkMail organization where the availability provider will be tested.

', 'UpdateAvailabilityConfigurationRequest$OrganizationId' => '

The WorkMail organization for which the AvailabilityConfiguration will be updated.

', 'UpdateDefaultMailDomainRequest$OrganizationId' => '

The WorkMail organization for which to list domains.

', 'UpdateImpersonationRoleRequest$OrganizationId' => '

The WorkMail organization that contains the impersonation role to update.

', 'UpdateMailboxQuotaRequest$OrganizationId' => '

The identifier for the organization that contains the user for whom to update the mailbox quota.

', 'UpdateMobileDeviceAccessRuleRequest$OrganizationId' => '

The WorkMail organization under which the rule will be updated.

', 'UpdatePrimaryEmailAddressRequest$OrganizationId' => '

The organization that contains the user, group, or resource to update.

', 'UpdateResourceRequest$OrganizationId' => '

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

', ], ], 'OrganizationName' => [ 'base' => NULL, 'refs' => [ 'CreateOrganizationRequest$Alias' => '

The organization alias.

', 'DescribeOrganizationResponse$Alias' => '

The alias for an organization.

', 'OrganizationSummary$Alias' => '

The alias associated with the organization.

', ], ], 'OrganizationNotFoundException' => [ 'base' => '

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

', 'refs' => [], ], 'OrganizationStateException' => [ 'base' => '

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

', 'refs' => [], ], 'OrganizationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListOrganizationsResponse$OrganizationSummaries' => '

The overview of owned organizations presented as a list of organization summaries.

', ], ], 'OrganizationSummary' => [ 'base' => '

The representation of an organization.

', 'refs' => [ 'OrganizationSummaries$member' => NULL, ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$Password' => '

The password for the new user.

', 'EwsAvailabilityProvider$EwsPassword' => '

The password used to authenticate the remote EWS server.

', 'ResetPasswordRequest$Password' => '

The new password for the user.

', ], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'DescribeMailboxExportJobResponse$EstimatedProgress' => '

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

', 'MailboxExportJob$EstimatedProgress' => '

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

', ], ], 'Permission' => [ 'base' => '

Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.

', 'refs' => [ 'Permissions$member' => NULL, ], ], 'PermissionType' => [ 'base' => NULL, 'refs' => [ 'PermissionValues$member' => NULL, ], ], 'PermissionValues' => [ 'base' => NULL, 'refs' => [ 'Permission$PermissionValues' => '

The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

', 'PutMailboxPermissionsRequest$PermissionValues' => '

The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

', ], ], 'Permissions' => [ 'base' => NULL, 'refs' => [ 'ListMailboxPermissionsResponse$Permissions' => '

One page of the user, group, or resource mailbox permissions.

', ], ], 'PolicyDescription' => [ 'base' => NULL, 'refs' => [ 'PutRetentionPolicyRequest$Description' => '

The retention policy description.

', ], ], 'PutAccessControlRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccessControlRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutEmailMonitoringConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutEmailMonitoringConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutInboundDmarcSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutInboundDmarcSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutMailboxPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutMailboxPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutMobileDeviceAccessOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutMobileDeviceAccessOverrideResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutRetentionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRetentionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'RedactedEwsAvailabilityProvider' => [ 'base' => '

Describes an EWS based availability provider when returned from the service. It does not contain the password of the endpoint.

', 'refs' => [ 'AvailabilityConfiguration$EwsProvider' => '

If ProviderType is EWS, then this field contains RedactedEwsAvailabilityProvider. Otherwise, it is not required.

', ], ], 'RegisterMailDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterMailDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterToWorkMailRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterToWorkMailResponse' => [ 'base' => NULL, 'refs' => [], ], 'ReservedNameException' => [ 'base' => '

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

', 'refs' => [], ], 'ResetPasswordRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResetPasswordResponse' => [ 'base' => NULL, 'refs' => [], ], 'Resource' => [ 'base' => '

The representation of a resource.

', 'refs' => [ 'Resources$member' => NULL, ], ], 'ResourceDelegates' => [ 'base' => NULL, 'refs' => [ 'ListResourceDelegatesResponse$Delegates' => '

One page of the resource\'s delegates.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'AssociateDelegateToResourceRequest$ResourceId' => '

The resource for which members (users or groups) are associated.

', 'CreateResourceResponse$ResourceId' => '

The identifier of the new resource.

', 'DeleteResourceRequest$ResourceId' => '

The identifier of the resource to be deleted.

', 'DescribeResourceRequest$ResourceId' => '

The identifier of the resource to be described.

', 'DescribeResourceResponse$ResourceId' => '

The identifier of the described resource.

', 'DisassociateDelegateFromResourceRequest$ResourceId' => '

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

', 'UpdateResourceRequest$ResourceId' => '

The identifier of the resource to be updated.

', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'CreateResourceRequest$Name' => '

The name of the new resource.

', 'DescribeResourceResponse$Name' => '

The name of the described resource.

', 'Resource$Name' => '

The name of the resource.

', 'UpdateResourceRequest$Name' => '

The name of the resource to be updated.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

The resource cannot be found.

', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'CreateResourceRequest$Type' => '

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

', 'DescribeResourceResponse$Type' => '

The type of the described resource.

', 'Resource$Type' => '

The type of the resource: equipment or room.

', ], ], 'Resources' => [ 'base' => NULL, 'refs' => [ 'ListResourcesResponse$Resources' => '

One page of the organization\'s resource representation.

', ], ], 'RetentionAction' => [ 'base' => NULL, 'refs' => [ 'FolderConfiguration$Action' => '

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

', ], ], 'RetentionPeriod' => [ 'base' => NULL, 'refs' => [ 'FolderConfiguration$Period' => '

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

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'DescribeEmailMonitoringConfigurationResponse$RoleArn' => '

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

', 'DescribeMailboxExportJobResponse$RoleArn' => '

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

', 'PutEmailMonitoringConfigurationRequest$RoleArn' => '

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

', 'StartMailboxExportJobRequest$RoleArn' => '

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

', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'DescribeMailboxExportJobResponse$S3BucketName' => '

The name of the S3 bucket.

', 'MailboxExportJob$S3BucketName' => '

The name of the S3 bucket.

', 'StartMailboxExportJobRequest$S3BucketName' => '

The name of the S3 bucket.

', ], ], 'S3ObjectKey' => [ 'base' => NULL, 'refs' => [ 'DescribeMailboxExportJobResponse$S3Prefix' => '

The S3 bucket prefix.

', 'DescribeMailboxExportJobResponse$S3Path' => '

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

', 'MailboxExportJob$S3Path' => '

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

', 'StartMailboxExportJobRequest$S3Prefix' => '

The S3 bucket prefix.

', ], ], 'ShortString' => [ 'base' => NULL, 'refs' => [ 'DeleteRetentionPolicyRequest$Id' => '

The retention policy ID.

', 'GetDefaultRetentionPolicyResponse$Id' => '

The retention policy ID.

', 'GetDefaultRetentionPolicyResponse$Name' => '

The retention policy name.

', 'PutRetentionPolicyRequest$Id' => '

The retention policy ID.

', 'PutRetentionPolicyRequest$Name' => '

The retention policy name.

', ], ], 'StartMailboxExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartMailboxExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$DisplayName' => '

The display name for the new user.

', 'Delegate$Id' => '

The identifier for the user or group associated as the resource\'s delegate.

', 'DeleteOrganizationResponse$State' => '

The state of the organization.

', 'DescribeOrganizationResponse$State' => '

The state of an organization.

', 'DescribeOrganizationResponse$DirectoryId' => '

The identifier for the directory associated with an WorkMail organization.

', 'DescribeOrganizationResponse$DirectoryType' => '

The type of directory associated with the WorkMail organization.

', 'DescribeOrganizationResponse$DefaultMailDomain' => '

The default mail domain associated with the organization.

', 'DescribeOrganizationResponse$ErrorMessage' => '

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

', 'DescribeUserResponse$DisplayName' => '

The display name of the user.

', 'DirectoryInUseException$Message' => NULL, 'DirectoryServiceAuthenticationFailedException$Message' => NULL, 'DirectoryUnavailableException$Message' => NULL, 'DnsRecord$Type' => '

The RFC 1035 record type. Possible values: CNAME, A, MX.

', 'DnsRecord$Hostname' => '

The DNS hostname.- For example, domain.example.com.

', 'DnsRecord$Value' => '

The value returned by the DNS for a query to that hostname and record type.

', 'EmailAddressInUseException$Message' => NULL, 'EntityAlreadyRegisteredException$Message' => NULL, 'EntityNotFoundException$Message' => NULL, 'EntityStateException$Message' => NULL, 'GetDefaultRetentionPolicyResponse$Description' => '

The retention policy description.

', 'InvalidConfigurationException$Message' => NULL, 'InvalidCustomSesConfigurationException$Message' => NULL, 'InvalidParameterException$Message' => NULL, 'InvalidPasswordException$Message' => NULL, 'LimitExceededException$Message' => NULL, 'MailDomainInUseException$Message' => NULL, 'MailDomainNotFoundException$Message' => NULL, 'MailDomainStateException$Message' => NULL, 'Member$Id' => '

The identifier of the member.

', 'Member$Name' => '

The name of the member.

', 'NameAvailabilityException$Message' => NULL, 'OrganizationNotFoundException$Message' => NULL, 'OrganizationStateException$Message' => NULL, 'OrganizationSummary$ErrorMessage' => '

The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior.

', 'OrganizationSummary$State' => '

The state associated with the organization.

', 'ReservedNameException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'TestAvailabilityConfigurationResponse$FailureReason' => '

String containing the reason for a failed test if TestPassed is false.

', 'TooManyTagsException$Message' => NULL, 'UnsupportedOperationException$Message' => NULL, 'User$DisplayName' => '

The display name of the user.

', ], ], 'Tag' => [ 'base' => '

Describes a tag applied to a resource.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The key of the tag.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The tag keys.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceResponse$Tags' => '

A list of tag key-value pairs.

', 'TagResourceRequest$Tags' => '

The tag key-value pairs.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The value of the tag.

', ], ], 'TargetUsers' => [ 'base' => NULL, 'refs' => [ 'ImpersonationRule$TargetUsers' => '

A list of user IDs that match the rule.

', 'ImpersonationRule$NotTargetUsers' => '

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

', ], ], 'TestAvailabilityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'TestAvailabilityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$DateCreated' => '

The date that the rule was created.

', 'AccessControlRule$DateModified' => '

The date that the rule was modified.

', 'AvailabilityConfiguration$DateCreated' => '

The date and time at which the availability configuration was created.

', 'AvailabilityConfiguration$DateModified' => '

The date and time at which the availability configuration was last modified.

', 'DescribeGroupResponse$EnabledDate' => '

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

', 'DescribeGroupResponse$DisabledDate' => '

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

', 'DescribeMailboxExportJobResponse$StartTime' => '

The mailbox export job start timestamp.

', 'DescribeMailboxExportJobResponse$EndTime' => '

The mailbox export job end timestamp.

', 'DescribeOrganizationResponse$CompletedDate' => '

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

', 'DescribeResourceResponse$EnabledDate' => '

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

', 'DescribeResourceResponse$DisabledDate' => '

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

', 'DescribeUserResponse$EnabledDate' => '

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

', 'DescribeUserResponse$DisabledDate' => '

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

', 'GetImpersonationRoleResponse$DateCreated' => '

The date when the impersonation role was created.

', 'GetImpersonationRoleResponse$DateModified' => '

The date when the impersonation role was last modified.

', 'GetMobileDeviceAccessOverrideResponse$DateCreated' => '

The date the override was first created.

', 'GetMobileDeviceAccessOverrideResponse$DateModified' => '

The date the description was last modified.

', 'Group$EnabledDate' => '

The date indicating when the group was enabled for WorkMail use.

', 'Group$DisabledDate' => '

The date indicating when the group was disabled from WorkMail use.

', 'ImpersonationRole$DateCreated' => '

The date when the impersonation role was created.

', 'ImpersonationRole$DateModified' => '

The date when the impersonation role was last modified.

', 'MailboxExportJob$StartTime' => '

The mailbox export job start timestamp.

', 'MailboxExportJob$EndTime' => '

The mailbox export job end timestamp.

', 'Member$EnabledDate' => '

The date indicating when the member was enabled for WorkMail use.

', 'Member$DisabledDate' => '

The date indicating when the member was disabled from WorkMail use.

', 'MobileDeviceAccessOverride$DateCreated' => '

The date the override was first created.

', 'MobileDeviceAccessOverride$DateModified' => '

The date the override was last modified.

', 'MobileDeviceAccessRule$DateCreated' => '

The date and time at which an access rule was created.

', 'MobileDeviceAccessRule$DateModified' => '

The date and time at which an access rule was modified.

', 'Resource$EnabledDate' => '

The date indicating when the resource was enabled for WorkMail use.

', 'Resource$DisabledDate' => '

The date indicating when the resource was disabled from WorkMail use.

', 'User$EnabledDate' => '

The date indicating when the user was enabled for WorkMail use.

', 'User$DisabledDate' => '

The date indicating when the user was disabled from WorkMail use.

', ], ], 'TooManyTagsException' => [ 'base' => '

The resource can have up to 50 user-applied tags.

', 'refs' => [], ], 'UnsupportedOperationException' => [ 'base' => '

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

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAvailabilityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAvailabilityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDefaultMailDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDefaultMailDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImpersonationRoleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImpersonationRoleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMailboxQuotaRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMailboxQuotaResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMobileDeviceAccessRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMobileDeviceAccessRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePrimaryEmailAddressRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePrimaryEmailAddressResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'EwsAvailabilityProvider$EwsEndpoint' => '

The endpoint of the remote EWS server.

', 'RedactedEwsAvailabilityProvider$EwsEndpoint' => '

The endpoint of the remote EWS server.

', ], ], 'User' => [ 'base' => '

The representation of an WorkMail user.

', 'refs' => [ 'Users$member' => NULL, ], ], 'UserIdList' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$UserIds' => '

User IDs to include in the rule.

', 'AccessControlRule$NotUserIds' => '

User IDs to exclude from the rule.

', 'PutAccessControlRuleRequest$UserIds' => '

User IDs to include in the rule.

', 'PutAccessControlRuleRequest$NotUserIds' => '

User IDs to exclude from the rule.

', ], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$Name' => '

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

', 'DescribeUserResponse$Name' => '

The name for the user.

', 'User$Name' => '

The name of the user.

', ], ], 'UserRole' => [ 'base' => NULL, 'refs' => [ 'DescribeUserResponse$UserRole' => '

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, and SYSTEM_USER.

', 'User$UserRole' => '

The role of the user.

', ], ], 'Users' => [ 'base' => NULL, 'refs' => [ 'ListUsersResponse$Users' => '

The overview of users for an organization.

', ], ], 'WorkMailDomainName' => [ 'base' => NULL, 'refs' => [ 'DeregisterMailDomainRequest$DomainName' => '

The domain to deregister in WorkMail and SES.

', 'GetMailDomainRequest$DomainName' => '

The domain from which you want to retrieve details.

', 'RegisterMailDomainRequest$DomainName' => '

The name of the mail domain to create in WorkMail and SES.

', 'UpdateDefaultMailDomainRequest$DomainName' => '

The domain name that will become the default domain.

', ], ], 'WorkMailIdentifier' => [ 'base' => NULL, 'refs' => [ 'AssociateDelegateToResourceRequest$EntityId' => '

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

', 'AssociateMemberToGroupRequest$GroupId' => '

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

', 'AssociateMemberToGroupRequest$MemberId' => '

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

', 'CreateAliasRequest$EntityId' => '

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

', 'CreateGroupResponse$GroupId' => '

The identifier of the group.

', 'CreateUserResponse$UserId' => '

The identifier for the new user.

', 'DeleteAliasRequest$EntityId' => '

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

', 'DeleteGroupRequest$GroupId' => '

The identifier of the group to be deleted.

', 'DeleteMailboxPermissionsRequest$EntityId' => '

The identifier of the member (user or group) that owns the mailbox.

', 'DeleteMailboxPermissionsRequest$GranteeId' => '

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

', 'DeleteUserRequest$UserId' => '

The identifier of the user to be deleted.

', 'DeregisterFromWorkMailRequest$EntityId' => '

The identifier for the member (user or group) to be updated.

', 'DescribeGroupRequest$GroupId' => '

The identifier for the group to be described.

', 'DescribeGroupResponse$GroupId' => '

The identifier of the described group.

', 'DescribeMailboxExportJobResponse$EntityId' => '

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

', 'DescribeUserRequest$UserId' => '

The identifier for the user to be described.

', 'DescribeUserResponse$UserId' => '

The identifier for the described user.

', 'DisassociateDelegateFromResourceRequest$EntityId' => '

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

', 'DisassociateMemberFromGroupRequest$GroupId' => '

The identifier for the group from which members are removed.

', 'DisassociateMemberFromGroupRequest$MemberId' => '

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

', 'GetAccessControlEffectRequest$UserId' => '

The user ID.

', 'GetMailboxDetailsRequest$UserId' => '

The identifier for the user whose mailbox details are being requested.

', 'GetMobileDeviceAccessOverrideResponse$UserId' => '

The WorkMail user to which the access override applies.

', 'Group$Id' => '

The identifier of the group.

', 'ListAliasesRequest$EntityId' => '

The identifier for the entity for which to list the aliases.

', 'ListGroupMembersRequest$GroupId' => '

The identifier for the group to which the members (users or groups) are associated.

', 'ListMailboxPermissionsRequest$EntityId' => '

The identifier of the user, group, or resource for which to list mailbox permissions.

', 'ListResourceDelegatesRequest$ResourceId' => '

The identifier for the resource whose delegates are listed.

', 'MailboxExportJob$EntityId' => '

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

', 'MobileDeviceAccessOverride$UserId' => '

The WorkMail user to which the access override applies.

', 'Permission$GranteeId' => '

The identifier of the user, group, or resource to which the permissions are granted.

', 'PutMailboxPermissionsRequest$EntityId' => '

The identifier of the user, group, or resource for which to update mailbox permissions.

', 'PutMailboxPermissionsRequest$GranteeId' => '

The identifier of the user, group, or resource to which to grant the permissions.

', 'RegisterToWorkMailRequest$EntityId' => '

The identifier for the user, group, or resource to be updated.

', 'ResetPasswordRequest$UserId' => '

The identifier of the user for whom the password is reset.

', 'Resource$Id' => '

The identifier of the resource.

', 'StartMailboxExportJobRequest$EntityId' => '

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

', 'UpdateMailboxQuotaRequest$UserId' => '

The identifer for the user for whom to update the mailbox quota.

', 'UpdatePrimaryEmailAddressRequest$EntityId' => '

The user, group, or resource to update.

', 'User$Id' => '

The identifier of the user.

', 'UserIdList$member' => NULL, ], ], ],]; +return [ 'version' => '2.0', 'service' => '

WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.

The WorkMail API is designed for the following scenarios:

  • Listing and describing organizations

  • Managing users

  • Managing groups

  • Managing resources

All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.

', 'operations' => [ 'AssociateDelegateToResource' => '

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

', 'AssociateMemberToGroup' => '

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

', 'AssumeImpersonationRole' => '

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

', 'CancelMailboxExportJob' => '

Cancels a mailbox export job.

If the mailbox export job is near completion, it might not be possible to cancel it.

', 'CreateAlias' => '

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

', 'CreateAvailabilityConfiguration' => '

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

', 'CreateGroup' => '

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

', 'CreateImpersonationRole' => '

Creates an impersonation role for the given WorkMail organization.

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

', 'CreateMobileDeviceAccessRule' => '

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

', 'CreateOrganization' => '

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

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

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

', 'CreateResource' => '

Creates a new WorkMail resource.

', 'CreateUser' => '

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

', 'DeleteAccessControlRule' => '

Deletes an access control rule for the specified WorkMail organization.

Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

', 'DeleteAlias' => '

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

', 'DeleteAvailabilityConfiguration' => '

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

', 'DeleteEmailMonitoringConfiguration' => '

Deletes the email monitoring configuration for a specified organization.

', 'DeleteGroup' => '

Deletes a group from WorkMail.

', 'DeleteImpersonationRole' => '

Deletes an impersonation role for the given WorkMail organization.

', 'DeleteMailboxPermissions' => '

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

', 'DeleteMobileDeviceAccessOverride' => '

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

Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

', 'DeleteMobileDeviceAccessRule' => '

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

Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

', 'DeleteOrganization' => '

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

', 'DeleteResource' => '

Deletes the specified resource.

', 'DeleteRetentionPolicy' => '

Deletes the specified retention policy from the specified organization.

', 'DeleteUser' => '

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

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

', 'DeregisterFromWorkMail' => '

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

', 'DeregisterMailDomain' => '

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

', 'DescribeEmailMonitoringConfiguration' => '

Describes the current email monitoring configuration for a specified organization.

', 'DescribeEntity' => '

Returns basic details about an entity in WorkMail.

', 'DescribeGroup' => '

Returns the data available for the group.

', 'DescribeInboundDmarcSettings' => '

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

', 'DescribeMailboxExportJob' => '

Describes the current status of a mailbox export job.

', 'DescribeOrganization' => '

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

', 'DescribeResource' => '

Returns the data available for the resource.

', 'DescribeUser' => '

Provides information regarding the user.

', 'DisassociateDelegateFromResource' => '

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

', 'DisassociateMemberFromGroup' => '

Removes a member from a group.

', 'GetAccessControlEffect' => '

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

', 'GetDefaultRetentionPolicy' => '

Gets the default retention policy details for the specified organization.

', 'GetImpersonationRole' => '

Gets the impersonation role details for the given WorkMail organization.

', 'GetImpersonationRoleEffect' => '

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

', 'GetMailDomain' => '

Gets details for a mail domain, including domain records required to configure your domain with recommended security.

', 'GetMailboxDetails' => '

Requests a user\'s mailbox details for a specified organization and user.

', 'GetMobileDeviceAccessEffect' => '

Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user\'s attributes.

', 'GetMobileDeviceAccessOverride' => '

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

', 'ListAccessControlRules' => '

Lists the access control rules for the specified organization.

', 'ListAliases' => '

Creates a paginated call to list the aliases associated with a given entity.

', 'ListAvailabilityConfigurations' => '

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

', 'ListGroupMembers' => '

Returns an overview of the members of a group. Users and groups can be members of a group.

', 'ListGroups' => '

Returns summaries of the organization\'s groups.

', 'ListGroupsForEntity' => '

Returns all the groups to which an entity belongs.

', 'ListImpersonationRoles' => '

Lists all the impersonation roles for the given WorkMail organization.

', 'ListMailDomains' => '

Lists the mail domains in a given WorkMail organization.

', 'ListMailboxExportJobs' => '

Lists the mailbox export jobs started for the specified organization within the last seven days.

', 'ListMailboxPermissions' => '

Lists the mailbox permissions associated with a user, group, or resource mailbox.

', 'ListMobileDeviceAccessOverrides' => '

Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.

', 'ListMobileDeviceAccessRules' => '

Lists the mobile device access rules for the specified WorkMail organization.

', 'ListOrganizations' => '

Returns summaries of the customer\'s organizations.

', 'ListResourceDelegates' => '

Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

', 'ListResources' => '

Returns summaries of the organization\'s resources.

', 'ListTagsForResource' => '

Lists the tags applied to an WorkMail organization resource.

', 'ListUsers' => '

Returns summaries of the organization\'s users.

', 'PutAccessControlRule' => '

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

', 'PutEmailMonitoringConfiguration' => '

Creates or updates the email monitoring configuration for a specified organization.

', 'PutInboundDmarcSettings' => '

Enables or disables a DMARC policy for a given organization.

', 'PutMailboxPermissions' => '

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

', 'PutMobileDeviceAccessOverride' => '

Creates or updates a mobile device access override for the given WorkMail organization, user, and device.

', 'PutRetentionPolicy' => '

Puts a retention policy to the specified organization.

', 'RegisterMailDomain' => '

Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users\' emails.

', 'RegisterToWorkMail' => '

Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.

Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

', 'ResetPassword' => '

Allows the administrator to reset the password for a user.

', 'StartMailboxExportJob' => '

Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.

', 'TagResource' => '

Applies the specified tags to the specified WorkMailorganization resource.

', 'TestAvailabilityConfiguration' => '

Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header.

The request must contain either one provider definition (EwsProvider or LambdaProvider) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested.

', 'UntagResource' => '

Untags the specified tags from the specified WorkMail organization resource.

', 'UpdateAvailabilityConfiguration' => '

Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.

', 'UpdateDefaultMailDomain' => '

Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.

', 'UpdateGroup' => '

Updates attibutes in a group.

', 'UpdateImpersonationRole' => '

Updates an impersonation role for the given WorkMail organization.

', 'UpdateMailboxQuota' => '

Updates a user\'s current mailbox quota for a specified organization and user.

', 'UpdateMobileDeviceAccessRule' => '

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

', 'UpdatePrimaryEmailAddress' => '

Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

', 'UpdateResource' => '

Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.

', 'UpdateUser' => '

Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another DescribeUser call.

', ], 'shapes' => [ 'AccessControlRule' => [ 'base' => '

A rule that controls access to an WorkMail organization.

', 'refs' => [ 'AccessControlRulesList$member' => NULL, ], ], 'AccessControlRuleAction' => [ 'base' => NULL, 'refs' => [ 'ActionsList$member' => NULL, 'GetAccessControlEffectRequest$Action' => '

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

', ], ], 'AccessControlRuleDescription' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$Description' => '

The rule description.

', 'PutAccessControlRuleRequest$Description' => '

The rule description.

', ], ], 'AccessControlRuleEffect' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$Effect' => '

The rule effect.

', 'GetAccessControlEffectResponse$Effect' => '

The rule effect.

', 'PutAccessControlRuleRequest$Effect' => '

The rule effect.

', ], ], 'AccessControlRuleName' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$Name' => '

The rule name.

', 'AccessControlRuleNameList$member' => NULL, 'DeleteAccessControlRuleRequest$Name' => '

The name of the access control rule.

', 'PutAccessControlRuleRequest$Name' => '

The rule name.

', ], ], 'AccessControlRuleNameList' => [ 'base' => NULL, 'refs' => [ 'GetAccessControlEffectResponse$MatchedRules' => '

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

', ], ], 'AccessControlRulesList' => [ 'base' => NULL, 'refs' => [ 'ListAccessControlRulesResponse$Rules' => '

The access control rules.

', ], ], 'AccessEffect' => [ 'base' => NULL, 'refs' => [ 'GetImpersonationRoleEffectResponse$Effect' => '

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

', 'ImpersonationRule$Effect' => '

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

', ], ], 'ActionsList' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$Actions' => '

Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

', 'AccessControlRule$NotActions' => '

Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

', 'PutAccessControlRuleRequest$Actions' => '

Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

', 'PutAccessControlRuleRequest$NotActions' => '

Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

', ], ], 'Aliases' => [ 'base' => NULL, 'refs' => [ 'ListAliasesResponse$Aliases' => '

The entity\'s paginated aliases.

', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationResponse$ARN' => '

The Amazon Resource Name (ARN) of the organization.

', 'ListTagsForResourceRequest$ResourceARN' => '

The resource ARN.

', 'TagResourceRequest$ResourceARN' => '

The resource ARN.

', 'UntagResourceRequest$ResourceARN' => '

The resource ARN.

', ], ], 'AssociateDelegateToResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateDelegateToResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateMemberToGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateMemberToGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssumeImpersonationRoleRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssumeImpersonationRoleResponse' => [ 'base' => NULL, 'refs' => [], ], 'AvailabilityConfiguration' => [ 'base' => '

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

', 'refs' => [ 'AvailabilityConfigurationList$member' => NULL, ], ], 'AvailabilityConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListAvailabilityConfigurationsResponse$AvailabilityConfigurations' => '

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

', ], ], 'AvailabilityProviderType' => [ 'base' => NULL, 'refs' => [ 'AvailabilityConfiguration$ProviderType' => '

Displays the provider type that applies to this domain.

', ], ], 'BookingOptions' => [ 'base' => '

At least one delegate must be associated to the resource to disable automatic replies from the resource.

', 'refs' => [ 'DescribeResourceResponse$BookingOptions' => '

The booking options for the described resource.

', 'UpdateResourceRequest$BookingOptions' => '

The resource\'s booking options to be updated.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'BookingOptions$AutoAcceptRequests' => '

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

', 'BookingOptions$AutoDeclineRecurringRequests' => '

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

', 'BookingOptions$AutoDeclineConflictingRequests' => '

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

', 'CreateGroupRequest$HiddenFromGlobalAddressList' => '

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

', 'CreateOrganizationRequest$EnableInteroperability' => '

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

', 'CreateResourceRequest$HiddenFromGlobalAddressList' => '

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

', 'CreateUserRequest$HiddenFromGlobalAddressList' => '

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

', 'DeleteOrganizationRequest$DeleteDirectory' => '

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

', 'DeleteOrganizationRequest$ForceDelete' => '

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

', 'DescribeGroupResponse$HiddenFromGlobalAddressList' => '

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

', 'DescribeInboundDmarcSettingsResponse$Enforced' => '

Lists the enforcement setting of the applied policy.

', 'DescribeOrganizationResponse$InteroperabilityEnabled' => '

Indicates if interoperability is enabled for this organization.

', 'DescribeResourceResponse$HiddenFromGlobalAddressList' => '

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

', 'DescribeUserResponse$HiddenFromGlobalAddressList' => '

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

', 'GetMailDomainResponse$IsTestDomain' => '

Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.

', 'GetMailDomainResponse$IsDefault' => '

Specifies whether the domain is the default domain for your organization.

', 'MailDomainSummary$DefaultDomain' => '

Whether the domain is default or not.

', 'TestAvailabilityConfigurationResponse$TestPassed' => '

Boolean indicating whether the test passed or failed.

', ], ], 'BooleanObject' => [ 'base' => NULL, 'refs' => [ 'PutInboundDmarcSettingsRequest$Enforced' => '

Enforces or suspends a policy after it\'s applied.

', 'UpdateGroupRequest$HiddenFromGlobalAddressList' => '

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

', 'UpdateResourceRequest$HiddenFromGlobalAddressList' => '

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

', 'UpdateUserRequest$HiddenFromGlobalAddressList' => '

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

', ], ], 'CancelMailboxExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelMailboxExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAvailabilityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAvailabilityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateImpersonationRoleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateImpersonationRoleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateMobileDeviceAccessRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMobileDeviceAccessRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateOrganizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateOrganizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'Delegate' => [ 'base' => '

The name of the attribute, which is one of the values defined in the UserAttribute enumeration.

', 'refs' => [ 'ResourceDelegates$member' => NULL, ], ], 'DeleteAccessControlRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccessControlRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAliasRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAliasResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAvailabilityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAvailabilityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEmailMonitoringConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteEmailMonitoringConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImpersonationRoleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteImpersonationRoleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMailboxPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMailboxPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMobileDeviceAccessOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMobileDeviceAccessOverrideResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMobileDeviceAccessRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMobileDeviceAccessRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOrganizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteOrganizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRetentionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRetentionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterFromWorkMailRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterFromWorkMailResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterMailDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterMailDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEmailMonitoringConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEmailMonitoringConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEntityRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEntityResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInboundDmarcSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInboundDmarcSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMailboxExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeMailboxExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'DescribeMailboxExportJobResponse$Description' => '

The mailbox export job description.

', 'MailboxExportJob$Description' => '

The mailbox export job description.

', 'StartMailboxExportJobRequest$Description' => '

The mailbox export job description.

', ], ], 'DeviceId' => [ 'base' => NULL, 'refs' => [ 'DeleteMobileDeviceAccessOverrideRequest$DeviceId' => '

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

', 'GetMobileDeviceAccessOverrideRequest$DeviceId' => '

The mobile device to which the override applies. DeviceId is case insensitive.

', 'GetMobileDeviceAccessOverrideResponse$DeviceId' => '

The device to which the access override applies.

', 'ListMobileDeviceAccessOverridesRequest$DeviceId' => '

The mobile device to which the access override applies.

', 'MobileDeviceAccessOverride$DeviceId' => '

The device to which the override applies.

', 'PutMobileDeviceAccessOverrideRequest$DeviceId' => '

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

', ], ], 'DeviceModel' => [ 'base' => NULL, 'refs' => [ 'DeviceModelList$member' => NULL, 'GetMobileDeviceAccessEffectRequest$DeviceModel' => '

Device model the simulated user will report.

', ], ], 'DeviceModelList' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$DeviceModels' => '

Device models that the rule will match.

', 'CreateMobileDeviceAccessRuleRequest$NotDeviceModels' => '

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

', 'MobileDeviceAccessRule$DeviceModels' => '

Device models that a rule will match.

', 'MobileDeviceAccessRule$NotDeviceModels' => '

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

', 'UpdateMobileDeviceAccessRuleRequest$DeviceModels' => '

Device models that the updated rule will match.

', 'UpdateMobileDeviceAccessRuleRequest$NotDeviceModels' => '

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

', ], ], 'DeviceOperatingSystem' => [ 'base' => NULL, 'refs' => [ 'DeviceOperatingSystemList$member' => NULL, 'GetMobileDeviceAccessEffectRequest$DeviceOperatingSystem' => '

Device operating system the simulated user will report.

', ], ], 'DeviceOperatingSystemList' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$DeviceOperatingSystems' => '

Device operating systems that the rule will match.

', 'CreateMobileDeviceAccessRuleRequest$NotDeviceOperatingSystems' => '

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

', 'MobileDeviceAccessRule$DeviceOperatingSystems' => '

Device operating systems that a rule will match.

', 'MobileDeviceAccessRule$NotDeviceOperatingSystems' => '

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

', 'UpdateMobileDeviceAccessRuleRequest$DeviceOperatingSystems' => '

Device operating systems that the updated rule will match.

', 'UpdateMobileDeviceAccessRuleRequest$NotDeviceOperatingSystems' => '

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

', ], ], 'DeviceType' => [ 'base' => NULL, 'refs' => [ 'DeviceTypeList$member' => NULL, 'GetMobileDeviceAccessEffectRequest$DeviceType' => '

Device type the simulated user will report.

', ], ], 'DeviceTypeList' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$DeviceTypes' => '

Device types that the rule will match.

', 'CreateMobileDeviceAccessRuleRequest$NotDeviceTypes' => '

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

', 'MobileDeviceAccessRule$DeviceTypes' => '

Device types that a rule will match.

', 'MobileDeviceAccessRule$NotDeviceTypes' => '

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

', 'UpdateMobileDeviceAccessRuleRequest$DeviceTypes' => '

Device types that the updated rule will match.

', 'UpdateMobileDeviceAccessRuleRequest$NotDeviceTypes' => '

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

', ], ], 'DeviceUserAgent' => [ 'base' => NULL, 'refs' => [ 'DeviceUserAgentList$member' => NULL, 'GetMobileDeviceAccessEffectRequest$DeviceUserAgent' => '

Device user agent the simulated user will report.

', ], ], 'DeviceUserAgentList' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$DeviceUserAgents' => '

Device user agents that the rule will match.

', 'CreateMobileDeviceAccessRuleRequest$NotDeviceUserAgents' => '

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

', 'MobileDeviceAccessRule$DeviceUserAgents' => '

Device user agents that a rule will match.

', 'MobileDeviceAccessRule$NotDeviceUserAgents' => '

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

', 'UpdateMobileDeviceAccessRuleRequest$DeviceUserAgents' => '

User agents that the updated rule will match.

', 'UpdateMobileDeviceAccessRuleRequest$NotDeviceUserAgents' => '

User agents that the updated rule will not match. All other user agents will match.

', ], ], 'DirectoryId' => [ 'base' => NULL, 'refs' => [ 'CreateOrganizationRequest$DirectoryId' => '

The AWS Directory Service directory ID.

', ], ], 'DirectoryInUseException' => [ 'base' => '

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

', 'refs' => [], ], 'DirectoryServiceAuthenticationFailedException' => [ 'base' => '

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

', 'refs' => [], ], 'DirectoryUnavailableException' => [ 'base' => '

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

', 'refs' => [], ], 'DisassociateDelegateFromResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateDelegateFromResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateMemberFromGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateMemberFromGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DnsRecord' => [ 'base' => '

A DNS record uploaded to your DNS provider.

', 'refs' => [ 'DnsRecords$member' => NULL, ], ], 'DnsRecordVerificationStatus' => [ 'base' => NULL, 'refs' => [ 'GetMailDomainResponse$OwnershipVerificationStatus' => '

Indicates the status of the domain ownership verification.

', 'GetMailDomainResponse$DkimVerificationStatus' => '

Indicates the status of a DKIM verification.

', ], ], 'DnsRecords' => [ 'base' => NULL, 'refs' => [ 'GetMailDomainResponse$Records' => '

A list of the DNS records that 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.

', ], ], 'Domain' => [ 'base' => '

The domain to associate with an WorkMail organization.

When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the WorkMail Administrator Guide.

', 'refs' => [ 'Domains$member' => NULL, ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'AvailabilityConfiguration$DomainName' => '

Displays the domain to which the provider applies.

', 'CreateAvailabilityConfigurationRequest$DomainName' => '

The domain to which the provider applies.

', 'DeleteAvailabilityConfigurationRequest$DomainName' => '

The domain for which the AvailabilityConfiguration will be deleted.

', 'Domain$DomainName' => '

The fully qualified domain name.

', 'MailDomainSummary$DomainName' => '

The domain name.

', 'OrganizationSummary$DefaultMailDomain' => '

The default email domain associated with the organization.

', 'TestAvailabilityConfigurationRequest$DomainName' => '

The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested.

', 'UpdateAvailabilityConfigurationRequest$DomainName' => '

The domain to which the provider applies the availability configuration.

', ], ], 'Domains' => [ 'base' => NULL, 'refs' => [ 'CreateOrganizationRequest$Domains' => '

The email domains to associate with the organization.

', ], ], 'EmailAddress' => [ 'base' => NULL, 'refs' => [ 'Aliases$member' => NULL, 'CreateAliasRequest$Alias' => '

The alias to add to the member set.

', 'DeleteAliasRequest$Alias' => '

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).

', 'DescribeEntityRequest$Email' => '

The email under which the entity exists.

', 'DescribeGroupResponse$Email' => '

The email of the described group.

', 'DescribeResourceResponse$Email' => '

The email of the described resource.

', 'DescribeUserResponse$Email' => '

The email of the user.

', 'Group$Email' => '

The email of the group.

', 'RegisterToWorkMailRequest$Email' => '

The email for the user, group, or resource to be updated.

', 'Resource$Email' => '

The email of the resource.

', 'UpdatePrimaryEmailAddressRequest$Email' => '

The value of the email to be updated as primary.

', 'User$Email' => '

The email of the user.

', ], ], 'EmailAddressInUseException' => [ 'base' => '

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

', 'refs' => [], ], 'EntityAlreadyRegisteredException' => [ 'base' => '

The user, group, or resource that you\'re trying to register is already registered.

', 'refs' => [], ], 'EntityIdentifier' => [ 'base' => NULL, 'refs' => [ 'AssociateDelegateToResourceRequest$ResourceId' => '

The resource for which members (users or groups) are associated.

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

', 'AssociateDelegateToResourceRequest$EntityId' => '

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

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

', 'AssociateMemberToGroupRequest$GroupId' => '

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

', 'AssociateMemberToGroupRequest$MemberId' => '

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

', 'DeleteGroupRequest$GroupId' => '

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

', 'DeleteMailboxPermissionsRequest$EntityId' => '

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

', 'DeleteMailboxPermissionsRequest$GranteeId' => '

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

', 'DeleteMobileDeviceAccessOverrideRequest$UserId' => '

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

', 'DeleteResourceRequest$ResourceId' => '

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

', 'DeleteUserRequest$UserId' => '

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

', 'DeregisterFromWorkMailRequest$EntityId' => '

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

', 'DescribeGroupRequest$GroupId' => '

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

', 'DescribeResourceRequest$ResourceId' => '

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

', 'DescribeUserRequest$UserId' => '

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

', 'DisassociateDelegateFromResourceRequest$ResourceId' => '

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

', 'DisassociateDelegateFromResourceRequest$EntityId' => '

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

', 'DisassociateMemberFromGroupRequest$GroupId' => '

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

', 'DisassociateMemberFromGroupRequest$MemberId' => '

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

', 'GetImpersonationRoleEffectRequest$TargetUser' => '

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

', 'GetMailboxDetailsRequest$UserId' => '

The identifier for the user whose mailbox details are being requested.

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

', 'GetMobileDeviceAccessOverrideRequest$UserId' => '

Identifies the WorkMail user for 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

', 'ListGroupMembersRequest$GroupId' => '

The identifier for the group to which the members (users or groups) are 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

', 'ListGroupsForEntityRequest$EntityId' => '

The identifier for the entity.

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

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

  • Email address: entity@domain.tld

  • Entity name: entity

', 'ListMailboxPermissionsRequest$EntityId' => '

The identifier of the user, or resource for which to list mailbox permissions.

The entity ID can accept UserId or ResourceId, Username or Resourcename, or email.

  • Entity ID: 12345678-1234-1234-1234-123456789012, or r-0123456789a0123456789b0123456789

  • Email address: entity@domain.tld

  • Entity name: entity

', 'ListMobileDeviceAccessOverridesRequest$UserId' => '

The WorkMail user under which you list the mobile device access overrides. 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

', 'ListResourceDelegatesRequest$ResourceId' => '

The identifier for the resource whose delegates are listed.

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

', 'PutMailboxPermissionsRequest$EntityId' => '

The identifier of the user or resource for which to update mailbox permissions.

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

', 'PutMailboxPermissionsRequest$GranteeId' => '

The identifier of the user, group, or resource to which to grant the permissions.

The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, 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

', 'PutMobileDeviceAccessOverrideRequest$UserId' => '

The WorkMail user for which you create 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

', 'RegisterToWorkMailRequest$EntityId' => '

The identifier for the user, group, or resource to be updated.

The identifier can accept UserId, ResourceId, or GroupId, or Username, Resourcename, or Groupname. The following identity formats are available:

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

  • Entity name: entity

', 'StartMailboxExportJobRequest$EntityId' => '

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

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

  • 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

', 'TargetUsers$member' => NULL, 'UpdateGroupRequest$GroupId' => '

The identifier for the group to be updated.

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

', 'UpdateMailboxQuotaRequest$UserId' => '

The identifer for the user for whom to update the mailbox quota.

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

', 'UpdatePrimaryEmailAddressRequest$EntityId' => '

The user, group, or resource to update.

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

  • 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

', 'UpdateResourceRequest$ResourceId' => '

The identifier of the resource to be updated.

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

', 'UpdateUserRequest$UserId' => '

The identifier for the user to be updated.

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

', ], ], 'EntityNotFoundException' => [ 'base' => '

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

', 'refs' => [], ], 'EntityState' => [ 'base' => NULL, 'refs' => [ 'DescribeGroupResponse$State' => '

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

', 'DescribeResourceResponse$State' => '

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

', 'DescribeUserResponse$State' => '

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

', 'Group$State' => '

The state of the group, which can be ENABLED, DISABLED, or DELETED.

', 'ListGroupsFilters$State' => '

Filters only groups with the provided state.

', 'ListResourcesFilters$State' => '

Filters only resource with the provided state.

', 'ListUsersFilters$State' => '

Filters only users with the provided state.

', 'Member$State' => '

The state of the member, which can be ENABLED, DISABLED, or DELETED.

', 'Resource$State' => '

The state of the resource, which can be ENABLED, DISABLED, or DELETED.

', 'User$State' => '

The state of the user, which can be ENABLED, DISABLED, or DELETED.

', ], ], 'EntityStateException' => [ 'base' => '

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.

', 'refs' => [], ], 'EntityType' => [ 'base' => NULL, 'refs' => [ 'DescribeEntityResponse$Type' => '

Entity type.

', ], ], 'EwsAvailabilityProvider' => [ 'base' => '

Describes an EWS based availability provider. This is only used as input to the service.

', 'refs' => [ 'CreateAvailabilityConfigurationRequest$EwsProvider' => '

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

', 'TestAvailabilityConfigurationRequest$EwsProvider' => NULL, 'UpdateAvailabilityConfigurationRequest$EwsProvider' => '

The EWS availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. The previously stored provider will be overridden by the one provided.

', ], ], 'ExpiresIn' => [ 'base' => NULL, 'refs' => [ 'AssumeImpersonationRoleResponse$ExpiresIn' => '

The authentication token\'s validity, in seconds.

', ], ], 'ExternalUserName' => [ 'base' => NULL, 'refs' => [ 'EwsAvailabilityProvider$EwsUsername' => '

The username used to authenticate the remote EWS server.

', 'RedactedEwsAvailabilityProvider$EwsUsername' => '

The username used to authenticate the remote EWS server.

', ], ], 'FolderConfiguration' => [ 'base' => '

The configuration applied to an organization\'s folders by its retention policy.

', 'refs' => [ 'FolderConfigurations$member' => NULL, ], ], 'FolderConfigurations' => [ 'base' => NULL, 'refs' => [ 'GetDefaultRetentionPolicyResponse$FolderConfigurations' => '

The retention policy folder configurations.

', 'PutRetentionPolicyRequest$FolderConfigurations' => '

The retention policy folder configurations.

', ], ], 'FolderName' => [ 'base' => NULL, 'refs' => [ 'FolderConfiguration$Name' => '

The folder name.

', ], ], 'GetAccessControlEffectRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAccessControlEffectResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDefaultRetentionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDefaultRetentionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetImpersonationRoleEffectRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetImpersonationRoleEffectResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetImpersonationRoleRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetImpersonationRoleResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMailDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMailDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMailboxDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMailboxDetailsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMobileDeviceAccessEffectRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMobileDeviceAccessEffectResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetMobileDeviceAccessOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetMobileDeviceAccessOverrideResponse' => [ 'base' => NULL, 'refs' => [], ], 'Group' => [ 'base' => '

The representation of an WorkMail group.

', 'refs' => [ 'Groups$member' => NULL, ], ], 'GroupIdentifier' => [ 'base' => '

The identifier that contains the Group ID and name of a group.

', 'refs' => [ 'GroupIdentifiers$member' => NULL, ], ], 'GroupIdentifiers' => [ 'base' => NULL, 'refs' => [ 'ListGroupsForEntityResponse$Groups' => '

The overview of groups in an organization.

', ], ], 'GroupName' => [ 'base' => NULL, 'refs' => [ 'CreateGroupRequest$Name' => '

The name of the group.

', 'DescribeGroupResponse$Name' => '

The name of the described group.

', 'Group$Name' => '

The name of the group.

', 'GroupIdentifier$GroupName' => '

Group name that matched the group.

', ], ], 'Groups' => [ 'base' => NULL, 'refs' => [ 'ListGroupsResponse$Groups' => '

The overview of groups for an organization.

', ], ], 'HostedZoneId' => [ 'base' => NULL, 'refs' => [ 'Domain$HostedZoneId' => '

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

', ], ], 'IdempotencyClientToken' => [ 'base' => NULL, 'refs' => [ 'CancelMailboxExportJobRequest$ClientToken' => '

The idempotency token for the client request.

', 'CreateAvailabilityConfigurationRequest$ClientToken' => '

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

', 'CreateImpersonationRoleRequest$ClientToken' => '

The idempotency token for the client request.

', 'CreateMobileDeviceAccessRuleRequest$ClientToken' => '

The idempotency token for the client request.

', 'CreateOrganizationRequest$ClientToken' => '

The idempotency token associated with the request.

', 'DeleteOrganizationRequest$ClientToken' => '

The idempotency token associated with the request.

', 'RegisterMailDomainRequest$ClientToken' => '

Idempotency token used when retrying requests.

', 'StartMailboxExportJobRequest$ClientToken' => '

The idempotency token for the client request.

', ], ], 'ImpersonationMatchedRule' => [ 'base' => '

The impersonation rule that matched the input.

', 'refs' => [ 'ImpersonationMatchedRuleList$member' => NULL, ], ], 'ImpersonationMatchedRuleList' => [ 'base' => NULL, 'refs' => [ 'GetImpersonationRoleEffectResponse$MatchedRules' => '

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

', ], ], 'ImpersonationRole' => [ 'base' => '

An impersonation role for the given WorkMail organization.

', 'refs' => [ 'ImpersonationRoleList$member' => NULL, ], ], 'ImpersonationRoleDescription' => [ 'base' => NULL, 'refs' => [ 'CreateImpersonationRoleRequest$Description' => '

The description of the new impersonation role.

', 'GetImpersonationRoleResponse$Description' => '

The impersonation role description.

', 'UpdateImpersonationRoleRequest$Description' => '

The updated impersonation role description.

', ], ], 'ImpersonationRoleId' => [ 'base' => NULL, 'refs' => [ 'AssumeImpersonationRoleRequest$ImpersonationRoleId' => '

The impersonation role ID to assume.

', 'CreateImpersonationRoleResponse$ImpersonationRoleId' => '

The new impersonation role ID.

', 'DeleteImpersonationRoleRequest$ImpersonationRoleId' => '

The ID of the impersonation role to delete.

', 'GetAccessControlEffectRequest$ImpersonationRoleId' => '

The impersonation role ID.

', 'GetImpersonationRoleEffectRequest$ImpersonationRoleId' => '

The impersonation role ID to test.

', 'GetImpersonationRoleRequest$ImpersonationRoleId' => '

The impersonation role ID to retrieve.

', 'GetImpersonationRoleResponse$ImpersonationRoleId' => '

The impersonation role ID.

', 'ImpersonationRole$ImpersonationRoleId' => '

The identifier of the impersonation role.

', 'ImpersonationRoleIdList$member' => NULL, 'UpdateImpersonationRoleRequest$ImpersonationRoleId' => '

The ID of the impersonation role to update.

', ], ], 'ImpersonationRoleIdList' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$ImpersonationRoleIds' => '

Impersonation role IDs to include in the rule.

', 'AccessControlRule$NotImpersonationRoleIds' => '

Impersonation role IDs to exclude from the rule.

', 'PutAccessControlRuleRequest$ImpersonationRoleIds' => '

Impersonation role IDs to include in the rule.

', 'PutAccessControlRuleRequest$NotImpersonationRoleIds' => '

Impersonation role IDs to exclude from the rule.

', ], ], 'ImpersonationRoleList' => [ 'base' => NULL, 'refs' => [ 'ListImpersonationRolesResponse$Roles' => '

The list of impersonation roles under the given WorkMail organization.

', ], ], 'ImpersonationRoleName' => [ 'base' => NULL, 'refs' => [ 'CreateImpersonationRoleRequest$Name' => '

The name of the new impersonation role.

', 'GetImpersonationRoleResponse$Name' => '

The impersonation role name.

', 'ImpersonationRole$Name' => '

The impersonation role name.

', 'UpdateImpersonationRoleRequest$Name' => '

The updated impersonation role name.

', ], ], 'ImpersonationRoleType' => [ 'base' => NULL, 'refs' => [ 'CreateImpersonationRoleRequest$Type' => '

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

', 'GetImpersonationRoleEffectResponse$Type' => '

The impersonation role type.

', 'GetImpersonationRoleResponse$Type' => '

The impersonation role type.

', 'ImpersonationRole$Type' => '

The impersonation role type.

', 'UpdateImpersonationRoleRequest$Type' => '

The updated impersonation role type.

', ], ], 'ImpersonationRule' => [ 'base' => '

The rules for the given impersonation role.

', 'refs' => [ 'ImpersonationRuleList$member' => NULL, ], ], 'ImpersonationRuleDescription' => [ 'base' => NULL, 'refs' => [ 'ImpersonationRule$Description' => '

The rule description.

', ], ], 'ImpersonationRuleId' => [ 'base' => NULL, 'refs' => [ 'ImpersonationMatchedRule$ImpersonationRuleId' => '

The ID of the rule that matched the input

', 'ImpersonationRule$ImpersonationRuleId' => '

The identifier of the rule.

', ], ], 'ImpersonationRuleList' => [ 'base' => NULL, 'refs' => [ 'CreateImpersonationRoleRequest$Rules' => '

The list of rules for the impersonation role.

', 'GetImpersonationRoleResponse$Rules' => '

The list of rules for the given impersonation role.

', 'UpdateImpersonationRoleRequest$Rules' => '

The updated list of rules.

', ], ], 'ImpersonationRuleName' => [ 'base' => NULL, 'refs' => [ 'ImpersonationMatchedRule$Name' => '

The name of the rule that matched the input.

', 'ImpersonationRule$Name' => '

The rule name.

', ], ], 'ImpersonationToken' => [ 'base' => NULL, 'refs' => [ 'AssumeImpersonationRoleResponse$Token' => '

The authentication token for the impersonation role.

', ], ], 'InvalidConfigurationException' => [ 'base' => '

The configuration for a resource isn\'t valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.

', 'refs' => [], ], 'InvalidCustomSesConfigurationException' => [ 'base' => '

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

', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => '

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

', 'refs' => [], ], 'InvalidPasswordException' => [ 'base' => '

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

', 'refs' => [], ], 'IpAddress' => [ 'base' => NULL, 'refs' => [ 'GetAccessControlEffectRequest$IpAddress' => '

The IPv4 address.

', ], ], 'IpRange' => [ 'base' => NULL, 'refs' => [ 'IpRangeList$member' => NULL, ], ], 'IpRangeList' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$IpRanges' => '

IPv4 CIDR ranges to include in the rule.

', 'AccessControlRule$NotIpRanges' => '

IPv4 CIDR ranges to exclude from the rule.

', 'PutAccessControlRuleRequest$IpRanges' => '

IPv4 CIDR ranges to include in the rule.

', 'PutAccessControlRuleRequest$NotIpRanges' => '

IPv4 CIDR ranges to exclude from the rule.

', ], ], 'Jobs' => [ 'base' => NULL, 'refs' => [ 'ListMailboxExportJobsResponse$Jobs' => '

The mailbox export job details.

', ], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'CreateOrganizationRequest$KmsKeyArn' => '

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

', 'DescribeMailboxExportJobResponse$KmsKeyArn' => '

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

', 'StartMailboxExportJobRequest$KmsKeyArn' => '

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

', ], ], 'LambdaArn' => [ 'base' => NULL, 'refs' => [ 'LambdaAvailabilityProvider$LambdaArn' => '

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

', ], ], 'LambdaAvailabilityProvider' => [ 'base' => '

Describes a Lambda based availability provider.

', 'refs' => [ 'AvailabilityConfiguration$LambdaProvider' => '

If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider. Otherwise, it is not required.

', 'CreateAvailabilityConfigurationRequest$LambdaProvider' => '

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

', 'TestAvailabilityConfigurationRequest$LambdaProvider' => NULL, 'UpdateAvailabilityConfigurationRequest$LambdaProvider' => '

The Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. The previously stored provider will be overridden by the one provided.

', ], ], 'LimitExceededException' => [ 'base' => '

The request exceeds the limit of the resource.

', 'refs' => [], ], 'ListAccessControlRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAccessControlRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAliasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailabilityConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAvailabilityConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupMembersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupMembersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsFilters' => [ 'base' => '

Filtering options for ListGroups operation. This is only used as input to Operation.

', 'refs' => [ 'ListGroupsRequest$Filters' => '

Limit the search results based on the filter criteria. Only one filter per request is supported.

', ], ], 'ListGroupsForEntityFilters' => [ 'base' => '

Filtering options for ListGroupsForEntity operation. This is only used as input to Operation.

', 'refs' => [ 'ListGroupsForEntityRequest$Filters' => '

Limit the search results based on the filter criteria.

', ], ], 'ListGroupsForEntityRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsForEntityResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListImpersonationRolesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListImpersonationRolesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMailDomainsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMailDomainsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMailboxExportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMailboxExportJobsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMailboxPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMailboxPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMobileDeviceAccessOverridesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMobileDeviceAccessOverridesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListMobileDeviceAccessRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMobileDeviceAccessRulesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListOrganizationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListOrganizationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceDelegatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceDelegatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListResourcesFilters' => [ 'base' => '

Filtering options for ListResources operation. This is only used as input to Operation.

', 'refs' => [ 'ListResourcesRequest$Filters' => '

Limit the resource search results based on the filter criteria. You can only use one filter per request.

', ], ], 'ListResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersFilters' => [ 'base' => '

Filtering options for ListUsers operation. This is only used as input to Operation.

', 'refs' => [ 'ListUsersRequest$Filters' => '

Limit the user search results based on the filter criteria. You can only use one filter per request.

', ], ], 'ListUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogGroupArn' => [ 'base' => NULL, 'refs' => [ 'DescribeEmailMonitoringConfigurationResponse$LogGroupArn' => '

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

', 'PutEmailMonitoringConfigurationRequest$LogGroupArn' => '

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

', ], ], 'MailDomainInUseException' => [ 'base' => '

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

', 'refs' => [], ], 'MailDomainNotFoundException' => [ 'base' => '

The domain specified is not found in your organization.

', 'refs' => [], ], 'MailDomainStateException' => [ 'base' => '

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

', 'refs' => [], ], 'MailDomainSummary' => [ 'base' => '

The data for a given domain.

', 'refs' => [ 'MailDomains$member' => NULL, ], ], 'MailDomains' => [ 'base' => NULL, 'refs' => [ 'ListMailDomainsResponse$MailDomains' => '

The list of mail domain summaries, specifying domains that exist in the specified WorkMail organization, along with the information about whether the domain is or isn\'t the default.

', ], ], 'MailboxExportErrorInfo' => [ 'base' => NULL, 'refs' => [ 'DescribeMailboxExportJobResponse$ErrorInfo' => '

Error information for failed mailbox export jobs.

', ], ], 'MailboxExportJob' => [ 'base' => '

The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.

', 'refs' => [ 'Jobs$member' => NULL, ], ], 'MailboxExportJobId' => [ 'base' => NULL, 'refs' => [ 'CancelMailboxExportJobRequest$JobId' => '

The job ID.

', 'DescribeMailboxExportJobRequest$JobId' => '

The mailbox export job ID.

', 'MailboxExportJob$JobId' => '

The identifier of the mailbox export job.

', 'StartMailboxExportJobResponse$JobId' => '

The job ID.

', ], ], 'MailboxExportJobState' => [ 'base' => NULL, 'refs' => [ 'DescribeMailboxExportJobResponse$State' => '

The state of the mailbox export job.

', 'MailboxExportJob$State' => '

The state of the mailbox export job.

', ], ], 'MailboxQuota' => [ 'base' => NULL, 'refs' => [ 'GetMailboxDetailsResponse$MailboxQuota' => '

The maximum allowed mailbox size, in MB, for the specified user.

', 'UpdateMailboxQuotaRequest$MailboxQuota' => '

The updated mailbox quota, in MB, for the specified user.

', ], ], 'MailboxSize' => [ 'base' => NULL, 'refs' => [ 'GetMailboxDetailsResponse$MailboxSize' => '

The current mailbox size, in MB, for the specified user.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAliasesRequest$MaxResults' => '

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

', 'ListAvailabilityConfigurationsRequest$MaxResults' => '

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

', 'ListGroupMembersRequest$MaxResults' => '

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

', 'ListGroupsForEntityRequest$MaxResults' => '

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

', 'ListGroupsRequest$MaxResults' => '

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

', 'ListImpersonationRolesRequest$MaxResults' => '

The maximum number of results returned in a single call.

', 'ListMailDomainsRequest$MaxResults' => '

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

', 'ListMailboxExportJobsRequest$MaxResults' => '

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

', 'ListMailboxPermissionsRequest$MaxResults' => '

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

', 'ListMobileDeviceAccessOverridesRequest$MaxResults' => '

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

', 'ListOrganizationsRequest$MaxResults' => '

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

', 'ListResourceDelegatesRequest$MaxResults' => '

The number of maximum results in a page.

', 'ListResourcesRequest$MaxResults' => '

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

', 'ListUsersRequest$MaxResults' => '

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

', ], ], 'Member' => [ 'base' => '

The representation of a user or group.

', 'refs' => [ 'Members$member' => NULL, ], ], 'MemberType' => [ 'base' => NULL, 'refs' => [ 'Delegate$Type' => '

The type of the delegate: user or group.

', 'Member$Type' => '

A member can be a user or group.

', 'Permission$GranteeType' => '

The type of user, group, or resource referred to in GranteeId.

', ], ], 'Members' => [ 'base' => NULL, 'refs' => [ 'ListGroupMembersResponse$Members' => '

The members associated to the group.

', ], ], 'MobileDeviceAccessMatchedRule' => [ 'base' => '

The rule that a simulated user matches.

', 'refs' => [ 'MobileDeviceAccessMatchedRuleList$member' => NULL, ], ], 'MobileDeviceAccessMatchedRuleList' => [ 'base' => NULL, 'refs' => [ 'GetMobileDeviceAccessEffectResponse$MatchedRules' => '

A list of the rules which matched the simulated user input and produced the effect.

', ], ], 'MobileDeviceAccessOverride' => [ 'base' => '

The override object.

', 'refs' => [ 'MobileDeviceAccessOverridesList$member' => NULL, ], ], 'MobileDeviceAccessOverridesList' => [ 'base' => NULL, 'refs' => [ 'ListMobileDeviceAccessOverridesResponse$Overrides' => '

The list of mobile device access overrides that exist for the specified WorkMail organization and user.

', ], ], 'MobileDeviceAccessRule' => [ 'base' => '

A rule that controls access to mobile devices for an WorkMail group.

', 'refs' => [ 'MobileDeviceAccessRulesList$member' => NULL, ], ], 'MobileDeviceAccessRuleDescription' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$Description' => '

The rule description.

', 'GetMobileDeviceAccessOverrideResponse$Description' => '

A description of the override.

', 'MobileDeviceAccessOverride$Description' => '

A description of the override.

', 'MobileDeviceAccessRule$Description' => '

The description of a mobile access rule.

', 'PutMobileDeviceAccessOverrideRequest$Description' => '

A description of the override.

', 'UpdateMobileDeviceAccessRuleRequest$Description' => '

The updated rule description.

', ], ], 'MobileDeviceAccessRuleEffect' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$Effect' => '

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

', 'GetMobileDeviceAccessEffectResponse$Effect' => '

The effect of the simulated access, ALLOW or DENY, after evaluating mobile device access rules in the WorkMail organization for the simulated user parameters.

', 'GetMobileDeviceAccessOverrideResponse$Effect' => '

The effect of the override, ALLOW or DENY.

', 'MobileDeviceAccessOverride$Effect' => '

The effect of the override, ALLOW or DENY.

', 'MobileDeviceAccessRule$Effect' => '

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

', 'PutMobileDeviceAccessOverrideRequest$Effect' => '

The effect of the override, ALLOW or DENY.

', 'UpdateMobileDeviceAccessRuleRequest$Effect' => '

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

', ], ], 'MobileDeviceAccessRuleId' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleResponse$MobileDeviceAccessRuleId' => '

The identifier for the newly created mobile device access rule.

', 'DeleteMobileDeviceAccessRuleRequest$MobileDeviceAccessRuleId' => '

The identifier of the rule to be deleted.

', 'MobileDeviceAccessMatchedRule$MobileDeviceAccessRuleId' => '

Identifier of the rule that a simulated user matches.

', 'MobileDeviceAccessRule$MobileDeviceAccessRuleId' => '

The ID assigned to a mobile access rule.

', 'UpdateMobileDeviceAccessRuleRequest$MobileDeviceAccessRuleId' => '

The identifier of the rule to be updated.

', ], ], 'MobileDeviceAccessRuleName' => [ 'base' => NULL, 'refs' => [ 'CreateMobileDeviceAccessRuleRequest$Name' => '

The rule name.

', 'MobileDeviceAccessMatchedRule$Name' => '

Name of a rule that a simulated user matches.

', 'MobileDeviceAccessRule$Name' => '

The name of a mobile access rule.

', 'UpdateMobileDeviceAccessRuleRequest$Name' => '

The updated rule name.

', ], ], 'MobileDeviceAccessRulesList' => [ 'base' => NULL, 'refs' => [ 'ListMobileDeviceAccessRulesResponse$Rules' => '

The list of mobile device access rules that exist under the specified WorkMail organization.

', ], ], 'NameAvailabilityException' => [ 'base' => '

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

', 'refs' => [], ], 'NewResourceDescription' => [ 'base' => NULL, 'refs' => [ 'UpdateResourceRequest$Description' => '

Updates the resource description.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListAliasesRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListAliasesResponse$NextToken' => '

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

', 'ListAvailabilityConfigurationsRequest$NextToken' => '

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

', 'ListAvailabilityConfigurationsResponse$NextToken' => '

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

', 'ListGroupMembersRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListGroupMembersResponse$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListGroupsForEntityRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListGroupsForEntityResponse$NextToken' => '

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

', 'ListGroupsRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListGroupsResponse$NextToken' => '

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

', 'ListImpersonationRolesRequest$NextToken' => '

The token used to retrieve the next page of results. The first call doesn\'t require a token.

', 'ListImpersonationRolesResponse$NextToken' => '

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

', 'ListMailDomainsRequest$NextToken' => '

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

', 'ListMailDomainsResponse$NextToken' => '

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

', 'ListMailboxExportJobsRequest$NextToken' => '

The token to use to retrieve the next page of results.

', 'ListMailboxExportJobsResponse$NextToken' => '

The token to use to retrieve the next page of results.

', 'ListMailboxPermissionsRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListMailboxPermissionsResponse$NextToken' => '

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

', 'ListMobileDeviceAccessOverridesRequest$NextToken' => '

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

', 'ListMobileDeviceAccessOverridesResponse$NextToken' => '

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

', 'ListOrganizationsRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListOrganizationsResponse$NextToken' => '

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

', 'ListResourceDelegatesRequest$NextToken' => '

The token used to paginate through the delegates associated with a resource.

', 'ListResourceDelegatesResponse$NextToken' => '

The token used to paginate through the delegates associated with a resource. While results are still available, it has an associated value. When the last page is reached, the token is empty.

', 'ListResourcesRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListResourcesResponse$NextToken' => '

The token used to paginate through all the organization\'s resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.

', 'ListUsersRequest$NextToken' => '

The token to use to retrieve the next page of results. The first call does not contain any tokens.

', 'ListUsersResponse$NextToken' => '

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

', ], ], 'OrganizationId' => [ 'base' => NULL, 'refs' => [ 'AssociateDelegateToResourceRequest$OrganizationId' => '

The organization under which the resource exists.

', 'AssociateMemberToGroupRequest$OrganizationId' => '

The organization under which the group exists.

', 'AssumeImpersonationRoleRequest$OrganizationId' => '

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

', 'CancelMailboxExportJobRequest$OrganizationId' => '

The organization ID.

', 'CreateAliasRequest$OrganizationId' => '

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

', 'CreateAvailabilityConfigurationRequest$OrganizationId' => '

The WorkMail organization for which the AvailabilityConfiguration will be created.

', 'CreateGroupRequest$OrganizationId' => '

The organization under which the group is to be created.

', 'CreateImpersonationRoleRequest$OrganizationId' => '

The WorkMail organization to create the new impersonation role within.

', 'CreateMobileDeviceAccessRuleRequest$OrganizationId' => '

The WorkMail organization under which the rule will be created.

', 'CreateOrganizationResponse$OrganizationId' => '

The organization ID.

', 'CreateResourceRequest$OrganizationId' => '

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

', 'CreateUserRequest$OrganizationId' => '

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

', 'DeleteAccessControlRuleRequest$OrganizationId' => '

The identifier for the organization.

', 'DeleteAliasRequest$OrganizationId' => '

The identifier for the organization under which the user exists.

', 'DeleteAvailabilityConfigurationRequest$OrganizationId' => '

The WorkMail organization for which the AvailabilityConfiguration will be deleted.

', 'DeleteEmailMonitoringConfigurationRequest$OrganizationId' => '

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

', 'DeleteGroupRequest$OrganizationId' => '

The organization that contains the group.

', 'DeleteImpersonationRoleRequest$OrganizationId' => '

The WorkMail organization from which to delete the impersonation role.

', 'DeleteMailboxPermissionsRequest$OrganizationId' => '

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

', 'DeleteMobileDeviceAccessOverrideRequest$OrganizationId' => '

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

', 'DeleteMobileDeviceAccessRuleRequest$OrganizationId' => '

The WorkMail organization under which the rule will be deleted.

', 'DeleteOrganizationRequest$OrganizationId' => '

The organization ID.

', 'DeleteOrganizationResponse$OrganizationId' => '

The organization ID.

', 'DeleteResourceRequest$OrganizationId' => '

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

', 'DeleteRetentionPolicyRequest$OrganizationId' => '

The organization ID.

', 'DeleteUserRequest$OrganizationId' => '

The organization that contains the user to be deleted.

', 'DeregisterFromWorkMailRequest$OrganizationId' => '

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

', 'DeregisterMailDomainRequest$OrganizationId' => '

The WorkMail organization for which the domain will be deregistered.

', 'DescribeEmailMonitoringConfigurationRequest$OrganizationId' => '

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

', 'DescribeEntityRequest$OrganizationId' => '

The identifier for the organization under which the entity exists.

', 'DescribeGroupRequest$OrganizationId' => '

The identifier for the organization under which the group exists.

', 'DescribeInboundDmarcSettingsRequest$OrganizationId' => '

Lists the ID of the given organization.

', 'DescribeMailboxExportJobRequest$OrganizationId' => '

The organization ID.

', 'DescribeOrganizationRequest$OrganizationId' => '

The identifier for the organization to be described.

', 'DescribeOrganizationResponse$OrganizationId' => '

The identifier of an organization.

', 'DescribeResourceRequest$OrganizationId' => '

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

', 'DescribeUserRequest$OrganizationId' => '

The identifier for the organization under which the user exists.

', 'DisassociateDelegateFromResourceRequest$OrganizationId' => '

The identifier for the organization under which the resource exists.

', 'DisassociateMemberFromGroupRequest$OrganizationId' => '

The identifier for the organization under which the group exists.

', 'GetAccessControlEffectRequest$OrganizationId' => '

The identifier for the organization.

', 'GetDefaultRetentionPolicyRequest$OrganizationId' => '

The organization ID.

', 'GetImpersonationRoleEffectRequest$OrganizationId' => '

The WorkMail organization where the impersonation role is defined.

', 'GetImpersonationRoleRequest$OrganizationId' => '

The WorkMail organization from which to retrieve the impersonation role.

', 'GetMailDomainRequest$OrganizationId' => '

The WorkMail organization for which the domain is retrieved.

', 'GetMailboxDetailsRequest$OrganizationId' => '

The identifier for the organization that contains the user whose mailbox details are being requested.

', 'GetMobileDeviceAccessEffectRequest$OrganizationId' => '

The WorkMail organization to simulate the access effect for.

', 'GetMobileDeviceAccessOverrideRequest$OrganizationId' => '

The WorkMail organization to which you want to apply the override.

', 'ListAccessControlRulesRequest$OrganizationId' => '

The identifier for the organization.

', 'ListAliasesRequest$OrganizationId' => '

The identifier for the organization under which the entity exists.

', 'ListAvailabilityConfigurationsRequest$OrganizationId' => '

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

', 'ListGroupMembersRequest$OrganizationId' => '

The identifier for the organization under which the group exists.

', 'ListGroupsForEntityRequest$OrganizationId' => '

The identifier for the organization under which the entity exists.

', 'ListGroupsRequest$OrganizationId' => '

The identifier for the organization under which the groups exist.

', 'ListImpersonationRolesRequest$OrganizationId' => '

The WorkMail organization to which the listed impersonation roles belong.

', 'ListMailDomainsRequest$OrganizationId' => '

The WorkMail organization for which to list domains.

', 'ListMailboxExportJobsRequest$OrganizationId' => '

The organization ID.

', 'ListMailboxPermissionsRequest$OrganizationId' => '

The identifier of the organization under which the user, group, or resource exists.

', 'ListMobileDeviceAccessOverridesRequest$OrganizationId' => '

The WorkMail organization under which to list mobile device access overrides.

', 'ListMobileDeviceAccessRulesRequest$OrganizationId' => '

The WorkMail organization for which to list the rules.

', 'ListResourceDelegatesRequest$OrganizationId' => '

The identifier for the organization that contains the resource for which delegates are listed.

', 'ListResourcesRequest$OrganizationId' => '

The identifier for the organization under which the resources exist.

', 'ListUsersRequest$OrganizationId' => '

The identifier for the organization under which the users exist.

', 'OrganizationSummary$OrganizationId' => '

The identifier associated with the organization.

', 'PutAccessControlRuleRequest$OrganizationId' => '

The identifier of the organization.

', 'PutEmailMonitoringConfigurationRequest$OrganizationId' => '

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

', 'PutInboundDmarcSettingsRequest$OrganizationId' => '

The ID of the organization that you are applying the DMARC policy to.

', 'PutMailboxPermissionsRequest$OrganizationId' => '

The identifier of the organization under which the user, group, or resource exists.

', 'PutMobileDeviceAccessOverrideRequest$OrganizationId' => '

Identifies the WorkMail organization for which you create the override.

', 'PutRetentionPolicyRequest$OrganizationId' => '

The organization ID.

', 'RegisterMailDomainRequest$OrganizationId' => '

The WorkMail organization under which you\'re creating the domain.

', 'RegisterToWorkMailRequest$OrganizationId' => '

The identifier for the organization under which the user, group, or resource exists.

', 'ResetPasswordRequest$OrganizationId' => '

The identifier of the organization that contains the user for which the password is reset.

', 'StartMailboxExportJobRequest$OrganizationId' => '

The identifier associated with the organization.

', 'TestAvailabilityConfigurationRequest$OrganizationId' => '

The WorkMail organization where the availability provider will be tested.

', 'UpdateAvailabilityConfigurationRequest$OrganizationId' => '

The WorkMail organization for which the AvailabilityConfiguration will be updated.

', 'UpdateDefaultMailDomainRequest$OrganizationId' => '

The WorkMail organization for which to list domains.

', 'UpdateGroupRequest$OrganizationId' => '

The identifier for the organization under which the group exists.

', 'UpdateImpersonationRoleRequest$OrganizationId' => '

The WorkMail organization that contains the impersonation role to update.

', 'UpdateMailboxQuotaRequest$OrganizationId' => '

The identifier for the organization that contains the user for whom to update the mailbox quota.

', 'UpdateMobileDeviceAccessRuleRequest$OrganizationId' => '

The WorkMail organization under which the rule will be updated.

', 'UpdatePrimaryEmailAddressRequest$OrganizationId' => '

The organization that contains the user, group, or resource to update.

', 'UpdateResourceRequest$OrganizationId' => '

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

', 'UpdateUserRequest$OrganizationId' => '

The identifier for the organization under which the user exists.

', ], ], 'OrganizationName' => [ 'base' => NULL, 'refs' => [ 'CreateOrganizationRequest$Alias' => '

The organization alias.

', 'DescribeOrganizationResponse$Alias' => '

The alias for an organization.

', 'OrganizationSummary$Alias' => '

The alias associated with the organization.

', ], ], 'OrganizationNotFoundException' => [ 'base' => '

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

', 'refs' => [], ], 'OrganizationStateException' => [ 'base' => '

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

', 'refs' => [], ], 'OrganizationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListOrganizationsResponse$OrganizationSummaries' => '

The overview of owned organizations presented as a list of organization summaries.

', ], ], 'OrganizationSummary' => [ 'base' => '

The representation of an organization.

', 'refs' => [ 'OrganizationSummaries$member' => NULL, ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$Password' => '

The password for the new user.

', 'EwsAvailabilityProvider$EwsPassword' => '

The password used to authenticate the remote EWS server.

', 'ResetPasswordRequest$Password' => '

The new password for the user.

', ], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'DescribeMailboxExportJobResponse$EstimatedProgress' => '

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

', 'MailboxExportJob$EstimatedProgress' => '

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

', ], ], 'Permission' => [ 'base' => '

Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.

', 'refs' => [ 'Permissions$member' => NULL, ], ], 'PermissionType' => [ 'base' => NULL, 'refs' => [ 'PermissionValues$member' => NULL, ], ], 'PermissionValues' => [ 'base' => NULL, 'refs' => [ 'Permission$PermissionValues' => '

The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

', 'PutMailboxPermissionsRequest$PermissionValues' => '

The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

', ], ], 'Permissions' => [ 'base' => NULL, 'refs' => [ 'ListMailboxPermissionsResponse$Permissions' => '

One page of the user, group, or resource mailbox permissions.

', ], ], 'PolicyDescription' => [ 'base' => NULL, 'refs' => [ 'PutRetentionPolicyRequest$Description' => '

The retention policy description.

', ], ], 'PutAccessControlRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccessControlRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutEmailMonitoringConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutEmailMonitoringConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutInboundDmarcSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutInboundDmarcSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutMailboxPermissionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutMailboxPermissionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutMobileDeviceAccessOverrideRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutMobileDeviceAccessOverrideResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutRetentionPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutRetentionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'RedactedEwsAvailabilityProvider' => [ 'base' => '

Describes an EWS based availability provider when returned from the service. It does not contain the password of the endpoint.

', 'refs' => [ 'AvailabilityConfiguration$EwsProvider' => '

If ProviderType is EWS, then this field contains RedactedEwsAvailabilityProvider. Otherwise, it is not required.

', ], ], 'RegisterMailDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterMailDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterToWorkMailRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterToWorkMailResponse' => [ 'base' => NULL, 'refs' => [], ], 'ReservedNameException' => [ 'base' => '

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

', 'refs' => [], ], 'ResetPasswordRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResetPasswordResponse' => [ 'base' => NULL, 'refs' => [], ], 'Resource' => [ 'base' => '

The representation of a resource.

', 'refs' => [ 'Resources$member' => NULL, ], ], 'ResourceDelegates' => [ 'base' => NULL, 'refs' => [ 'ListResourceDelegatesResponse$Delegates' => '

One page of the resource\'s delegates.

', ], ], 'ResourceDescription' => [ 'base' => NULL, 'refs' => [ 'CreateResourceRequest$Description' => '

Resource description.

', 'DescribeResourceResponse$Description' => '

Description of the resource.

', 'Resource$Description' => '

Resource description.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'CreateResourceResponse$ResourceId' => '

The identifier of the new resource.

', 'DescribeResourceResponse$ResourceId' => '

The identifier of the described resource.

', ], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'CreateResourceRequest$Name' => '

The name of the new resource.

', 'DescribeResourceResponse$Name' => '

The name of the described resource.

', 'Resource$Name' => '

The name of the resource.

', 'UpdateResourceRequest$Name' => '

The name of the resource to be updated.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

The resource cannot be found.

', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'CreateResourceRequest$Type' => '

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

', 'DescribeResourceResponse$Type' => '

The type of the described resource.

', 'Resource$Type' => '

The type of the resource: equipment or room.

', 'UpdateResourceRequest$Type' => '

Updates the resource type.

', ], ], 'Resources' => [ 'base' => NULL, 'refs' => [ 'ListResourcesResponse$Resources' => '

One page of the organization\'s resource representation.

', ], ], 'RetentionAction' => [ 'base' => NULL, 'refs' => [ 'FolderConfiguration$Action' => '

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

', ], ], 'RetentionPeriod' => [ 'base' => NULL, 'refs' => [ 'FolderConfiguration$Period' => '

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

', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'DescribeEmailMonitoringConfigurationResponse$RoleArn' => '

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

', 'DescribeMailboxExportJobResponse$RoleArn' => '

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

', 'PutEmailMonitoringConfigurationRequest$RoleArn' => '

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

', 'StartMailboxExportJobRequest$RoleArn' => '

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

', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'DescribeMailboxExportJobResponse$S3BucketName' => '

The name of the S3 bucket.

', 'MailboxExportJob$S3BucketName' => '

The name of the S3 bucket.

', 'StartMailboxExportJobRequest$S3BucketName' => '

The name of the S3 bucket.

', ], ], 'S3ObjectKey' => [ 'base' => NULL, 'refs' => [ 'DescribeMailboxExportJobResponse$S3Prefix' => '

The S3 bucket prefix.

', 'DescribeMailboxExportJobResponse$S3Path' => '

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

', 'MailboxExportJob$S3Path' => '

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

', 'StartMailboxExportJobRequest$S3Prefix' => '

The S3 bucket prefix.

', ], ], 'ShortString' => [ 'base' => NULL, 'refs' => [ 'DeleteRetentionPolicyRequest$Id' => '

The retention policy ID.

', 'GetDefaultRetentionPolicyResponse$Id' => '

The retention policy ID.

', 'GetDefaultRetentionPolicyResponse$Name' => '

The retention policy name.

', 'PutRetentionPolicyRequest$Id' => '

The retention policy ID.

', 'PutRetentionPolicyRequest$Name' => '

The retention policy name.

', ], ], 'StartMailboxExportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartMailboxExportJobResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Delegate$Id' => '

The identifier for the user or group associated as the resource\'s delegate.

', 'DeleteOrganizationResponse$State' => '

The state of the organization.

', 'DescribeEntityResponse$Name' => '

Username, GroupName, or ResourceName based on entity type.

', 'DescribeOrganizationResponse$State' => '

The state of an organization.

', 'DescribeOrganizationResponse$DirectoryId' => '

The identifier for the directory associated with an WorkMail organization.

', 'DescribeOrganizationResponse$DirectoryType' => '

The type of directory associated with the WorkMail organization.

', 'DescribeOrganizationResponse$DefaultMailDomain' => '

The default mail domain associated with the organization.

', 'DescribeOrganizationResponse$ErrorMessage' => '

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

', 'DirectoryInUseException$Message' => NULL, 'DirectoryServiceAuthenticationFailedException$Message' => NULL, 'DirectoryUnavailableException$Message' => NULL, 'DnsRecord$Type' => '

The RFC 1035 record type. Possible values: CNAME, A, MX.

', 'DnsRecord$Hostname' => '

The DNS hostname.- For example, domain.example.com.

', 'DnsRecord$Value' => '

The value returned by the DNS for a query to that hostname and record type.

', 'EmailAddressInUseException$Message' => NULL, 'EntityAlreadyRegisteredException$Message' => NULL, 'EntityNotFoundException$Message' => NULL, 'EntityStateException$Message' => NULL, 'GetDefaultRetentionPolicyResponse$Description' => '

The retention policy description.

', 'InvalidConfigurationException$Message' => NULL, 'InvalidCustomSesConfigurationException$Message' => NULL, 'InvalidParameterException$Message' => NULL, 'InvalidPasswordException$Message' => NULL, 'LimitExceededException$Message' => NULL, 'ListGroupsFilters$NamePrefix' => '

Filters only groups with the provided name prefix.

', 'ListGroupsFilters$PrimaryEmailPrefix' => '

Filters only groups with the provided primary email prefix.

', 'ListGroupsForEntityFilters$GroupNamePrefix' => '

Filters only group names that start with the provided name prefix.

', 'ListResourcesFilters$NamePrefix' => '

Filters only resource that start with the entered name prefix .

', 'ListResourcesFilters$PrimaryEmailPrefix' => '

Filters only resource with the provided primary email prefix.

', 'ListUsersFilters$UsernamePrefix' => '

Filters only users with the provided username prefix.

', 'ListUsersFilters$PrimaryEmailPrefix' => '

Filters only users with the provided email prefix.

', 'MailDomainInUseException$Message' => NULL, 'MailDomainNotFoundException$Message' => NULL, 'MailDomainStateException$Message' => NULL, 'Member$Id' => '

The identifier of the member.

', 'Member$Name' => '

The name of the member.

', 'NameAvailabilityException$Message' => NULL, 'OrganizationNotFoundException$Message' => NULL, 'OrganizationStateException$Message' => NULL, 'OrganizationSummary$ErrorMessage' => '

The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior.

', 'OrganizationSummary$State' => '

The state associated with the organization.

', 'ReservedNameException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'TestAvailabilityConfigurationResponse$FailureReason' => '

String containing the reason for a failed test if TestPassed is false.

', 'TooManyTagsException$Message' => NULL, 'UnsupportedOperationException$Message' => NULL, 'User$DisplayName' => '

The display name of the user.

', ], ], 'Tag' => [ 'base' => '

Describes a tag applied to a resource.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The key of the tag.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The tag keys.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceResponse$Tags' => '

A list of tag key-value pairs.

', 'TagResourceRequest$Tags' => '

The tag key-value pairs.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The value of the tag.

', ], ], 'TargetUsers' => [ 'base' => NULL, 'refs' => [ 'ImpersonationRule$TargetUsers' => '

A list of user IDs that match the rule.

', 'ImpersonationRule$NotTargetUsers' => '

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

', ], ], 'TestAvailabilityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'TestAvailabilityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$DateCreated' => '

The date that the rule was created.

', 'AccessControlRule$DateModified' => '

The date that the rule was modified.

', 'AvailabilityConfiguration$DateCreated' => '

The date and time at which the availability configuration was created.

', 'AvailabilityConfiguration$DateModified' => '

The date and time at which the availability configuration was last modified.

', 'DescribeGroupResponse$EnabledDate' => '

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

', 'DescribeGroupResponse$DisabledDate' => '

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

', 'DescribeMailboxExportJobResponse$StartTime' => '

The mailbox export job start timestamp.

', 'DescribeMailboxExportJobResponse$EndTime' => '

The mailbox export job end timestamp.

', 'DescribeOrganizationResponse$CompletedDate' => '

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

', 'DescribeResourceResponse$EnabledDate' => '

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

', 'DescribeResourceResponse$DisabledDate' => '

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

', 'DescribeUserResponse$EnabledDate' => '

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

', 'DescribeUserResponse$DisabledDate' => '

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

', 'DescribeUserResponse$MailboxProvisionedDate' => '

The date when the mailbox was created for the user.

', 'DescribeUserResponse$MailboxDeprovisionedDate' => '

The date when the mailbox was removed for the user.

', 'GetImpersonationRoleResponse$DateCreated' => '

The date when the impersonation role was created.

', 'GetImpersonationRoleResponse$DateModified' => '

The date when the impersonation role was last modified.

', 'GetMobileDeviceAccessOverrideResponse$DateCreated' => '

The date the override was first created.

', 'GetMobileDeviceAccessOverrideResponse$DateModified' => '

The date the description was last modified.

', 'Group$EnabledDate' => '

The date indicating when the group was enabled for WorkMail use.

', 'Group$DisabledDate' => '

The date indicating when the group was disabled from WorkMail use.

', 'ImpersonationRole$DateCreated' => '

The date when the impersonation role was created.

', 'ImpersonationRole$DateModified' => '

The date when the impersonation role was last modified.

', 'MailboxExportJob$StartTime' => '

The mailbox export job start timestamp.

', 'MailboxExportJob$EndTime' => '

The mailbox export job end timestamp.

', 'Member$EnabledDate' => '

The date indicating when the member was enabled for WorkMail use.

', 'Member$DisabledDate' => '

The date indicating when the member was disabled from WorkMail use.

', 'MobileDeviceAccessOverride$DateCreated' => '

The date the override was first created.

', 'MobileDeviceAccessOverride$DateModified' => '

The date the override was last modified.

', 'MobileDeviceAccessRule$DateCreated' => '

The date and time at which an access rule was created.

', 'MobileDeviceAccessRule$DateModified' => '

The date and time at which an access rule was modified.

', 'Resource$EnabledDate' => '

The date indicating when the resource was enabled for WorkMail use.

', 'Resource$DisabledDate' => '

The date indicating when the resource was disabled from WorkMail use.

', 'User$EnabledDate' => '

The date indicating when the user was enabled for WorkMail use.

', 'User$DisabledDate' => '

The date indicating when the user was disabled from WorkMail use.

', ], ], 'TooManyTagsException' => [ 'base' => '

The resource can have up to 50 user-applied tags.

', 'refs' => [], ], 'UnsupportedOperationException' => [ 'base' => '

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

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAvailabilityConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAvailabilityConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDefaultMailDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDefaultMailDomainResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImpersonationRoleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateImpersonationRoleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMailboxQuotaRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMailboxQuotaResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMobileDeviceAccessRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateMobileDeviceAccessRuleResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePrimaryEmailAddressRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePrimaryEmailAddressResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'EwsAvailabilityProvider$EwsEndpoint' => '

The endpoint of the remote EWS server.

', 'RedactedEwsAvailabilityProvider$EwsEndpoint' => '

The endpoint of the remote EWS server.

', ], ], 'User' => [ 'base' => '

The representation of an WorkMail user.

', 'refs' => [ 'Users$member' => NULL, ], ], 'UserAttribute' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$DisplayName' => '

The display name for the new user.

', 'CreateUserRequest$FirstName' => '

The first name of the new user.

', 'CreateUserRequest$LastName' => '

The last name of the new user.

', 'DescribeUserResponse$DisplayName' => '

The display name of the user.

', 'DescribeUserResponse$FirstName' => '

First name of the user.

', 'DescribeUserResponse$LastName' => '

Last name of the user.

', 'DescribeUserResponse$Initials' => '

Initials of the user.

', 'DescribeUserResponse$Telephone' => '

User\'s contact number.

', 'DescribeUserResponse$Street' => '

Street where the user is located.

', 'DescribeUserResponse$JobTitle' => '

Job title of the user.

', 'DescribeUserResponse$City' => '

City where the user is located.

', 'DescribeUserResponse$Company' => '

Company of the user.

', 'DescribeUserResponse$ZipCode' => '

Zip code of the user.

', 'DescribeUserResponse$Department' => '

Department of the user.

', 'DescribeUserResponse$Country' => '

Country where the user is located.

', 'DescribeUserResponse$Office' => '

Office where the user is located.

', 'ListUsersFilters$DisplayNamePrefix' => '

Filters only users with the provided display name prefix.

', 'UpdateUserRequest$DisplayName' => '

Updates the display name of the user.

', 'UpdateUserRequest$FirstName' => '

Updates the user\'s first name.

', 'UpdateUserRequest$LastName' => '

Updates the user\'s last name.

', 'UpdateUserRequest$Initials' => '

Updates the user\'s initials.

', 'UpdateUserRequest$Telephone' => '

Updates the user\'s contact details.

', 'UpdateUserRequest$Street' => '

Updates the user\'s street address.

', 'UpdateUserRequest$JobTitle' => '

Updates the user\'s job title.

', 'UpdateUserRequest$City' => '

Updates the user\'s city.

', 'UpdateUserRequest$Company' => '

Updates the user\'s company.

', 'UpdateUserRequest$ZipCode' => '

Updates the user\'s zipcode.

', 'UpdateUserRequest$Department' => '

Updates the user\'s department.

', 'UpdateUserRequest$Country' => '

Updates the user\'s country.

', 'UpdateUserRequest$Office' => '

Updates the user\'s office.

', ], ], 'UserIdList' => [ 'base' => NULL, 'refs' => [ 'AccessControlRule$UserIds' => '

User IDs to include in the rule.

', 'AccessControlRule$NotUserIds' => '

User IDs to exclude from the rule.

', 'PutAccessControlRuleRequest$UserIds' => '

User IDs to include in the rule.

', 'PutAccessControlRuleRequest$NotUserIds' => '

User IDs to exclude from the rule.

', ], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$Name' => '

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

', 'DescribeUserResponse$Name' => '

The name for the user.

', 'User$Name' => '

The name of the user.

', ], ], 'UserRole' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$Role' => '

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.

', 'DescribeUserResponse$UserRole' => '

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.

', 'UpdateUserRequest$Role' => '

Updates the user role.

You cannot pass SYSTEM_USER or RESOURCE.

', 'User$UserRole' => '

The role of the user.

', ], ], 'Users' => [ 'base' => NULL, 'refs' => [ 'ListUsersResponse$Users' => '

The overview of users for an organization.

', ], ], 'WorkMailDomainName' => [ 'base' => NULL, 'refs' => [ 'DeregisterMailDomainRequest$DomainName' => '

The domain to deregister in WorkMail and SES.

', 'GetMailDomainRequest$DomainName' => '

The domain from which you want to retrieve details.

', 'RegisterMailDomainRequest$DomainName' => '

The name of the mail domain to create in WorkMail and SES.

', 'UpdateDefaultMailDomainRequest$DomainName' => '

The domain name that will become the default domain.

', ], ], 'WorkMailIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateAliasRequest$EntityId' => '

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

', 'CreateGroupResponse$GroupId' => '

The identifier of the group.

', 'CreateUserResponse$UserId' => '

The identifier for the new user.

', 'DeleteAliasRequest$EntityId' => '

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

', 'DescribeEntityResponse$EntityId' => '

The entity ID under which the entity exists.

', 'DescribeGroupResponse$GroupId' => '

The identifier of the described group.

', 'DescribeMailboxExportJobResponse$EntityId' => '

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

', 'DescribeOrganizationResponse$MigrationAdmin' => '

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

', 'DescribeUserResponse$UserId' => '

The identifier for the described user.

', 'GetAccessControlEffectRequest$UserId' => '

The user ID.

', 'GetMobileDeviceAccessOverrideResponse$UserId' => '

The WorkMail user to which the access override applies.

', 'Group$Id' => '

The identifier of the group.

', 'GroupIdentifier$GroupId' => '

Group ID that matched the group.

', 'ListAliasesRequest$EntityId' => '

The identifier for the entity for which to list the aliases.

', 'MailboxExportJob$EntityId' => '

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

', 'MobileDeviceAccessOverride$UserId' => '

The WorkMail user to which the access override applies.

', 'Permission$GranteeId' => '

The identifier of the user, group, or resource to which the permissions are granted.

', 'ResetPasswordRequest$UserId' => '

The identifier of the user for whom the password is reset.

', 'Resource$Id' => '

The identifier of the resource.

', 'User$Id' => '

The identifier of the user.

', 'UserIdList$member' => NULL, ], ], ],]; diff --git a/src/data/workmail/2017-10-01/endpoint-rule-set-1.json b/src/data/workmail/2017-10-01/endpoint-rule-set-1.json index cab5481b11..a0b2c379c0 100644 --- a/src/data/workmail/2017-10-01/endpoint-rule-set-1.json +++ b/src/data/workmail/2017-10-01/endpoint-rule-set-1.json @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,21 +45,69 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ { - "fn": "parseURL", + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", "argv": [ { - "ref": "Endpoint" + "ref": "Region" } ], - "assign": "url" + "assign": "PartitionResult" } ], "type": "tree", @@ -75,13 +122,17 @@ }, true ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], "type": "tree", "rules": [ { @@ -89,143 +140,86 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ + true, { - "ref": "PartitionResult" - }, - "supportsFIPS" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } ] } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + ], + "type": "tree", + "rules": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "conditions": [], + "endpoint": { + "url": "https://workmail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], - "endpoint": { - "url": "https://workmail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } + "ref": "UseFIPS" + }, + true ] } ], "type": "tree", "rules": [ { - "conditions": [], + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], "type": "tree", "rules": [ { @@ -238,78 +232,83 @@ "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } + "ref": "UseDualStack" + }, + true ] } ], "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://workmail.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, { "conditions": [], - "endpoint": { - "url": "https://workmail.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] }, { "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "endpoint": { + "url": "https://workmail.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://workmail.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } \ No newline at end of file diff --git a/src/data/workmail/2017-10-01/endpoint-rule-set-1.json.php b/src/data/workmail/2017-10-01/endpoint-rule-set-1.json.php index 7ba0483f26..26ab7bf2a0 100644 --- a/src/data/workmail/2017-10-01/endpoint-rule-set-1.json.php +++ b/src/data/workmail/2017-10-01/endpoint-rule-set-1.json.php @@ -1,3 +1,3 @@ '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], [ 'fn' => 'parseURL', 'argv' => [ [ 'ref' => 'Endpoint', ], ], 'assign' => 'url', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://workmail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://workmail-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://workmail.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://workmail.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ],]; +return [ 'version' => '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://workmail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://workmail-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://workmail.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://workmail.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ],]; diff --git a/src/data/workmail/2017-10-01/endpoint-tests-1.json b/src/data/workmail/2017-10-01/endpoint-tests-1.json index 64b066c8a7..be70fbc373 100644 --- a/src/data/workmail/2017-10-01/endpoint-tests-1.json +++ b/src/data/workmail/2017-10-01/endpoint-tests-1.json @@ -1,163 +1,285 @@ { "testCases": [ { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://workmail-fips.us-west-2.api.aws" + "url": "https://workmail.eu-west-1.amazonaws.com" } }, "params": { - "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://workmail-fips.us-west-2.amazonaws.com" + "url": "https://workmail.us-east-1.amazonaws.com" } }, "params": { - "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://workmail.us-west-2.api.aws" + "url": "https://workmail.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://workmail.us-west-2.amazonaws.com" + "url": "https://workmail-fips.us-east-1.api.aws" } }, "params": { - "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://workmail-fips.eu-west-1.api.aws" + "url": "https://workmail-fips.us-east-1.amazonaws.com" } }, "params": { - "Region": "eu-west-1", - "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://workmail-fips.eu-west-1.amazonaws.com" + "url": "https://workmail.us-east-1.api.aws" } }, "params": { - "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://workmail.eu-west-1.api.aws" + "url": "https://workmail-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "Region": "eu-west-1", - "UseDualStack": true, - "UseFIPS": false + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://workmail.eu-west-1.amazonaws.com" + "url": "https://workmail-fips.cn-north-1.amazonaws.com.cn" } }, "params": { - "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://workmail-fips.us-east-1.api.aws" + "url": "https://workmail.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://workmail-fips.us-east-1.amazonaws.com" + "url": "https://workmail.cn-north-1.amazonaws.com.cn" } }, "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://workmail.us-east-1.api.aws" + "url": "https://workmail-fips.us-gov-east-1.api.aws" } }, "params": { - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://workmail.us-east-1.amazonaws.com" + "url": "https://workmail-fips.us-gov-east-1.amazonaws.com" } }, "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://workmail.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://workmail.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://workmail-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://workmail.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://workmail-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://workmail.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -165,8 +287,21 @@ }, "params": { "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -177,8 +312,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -189,10 +324,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/src/data/workmail/2017-10-01/endpoint-tests-1.json.php b/src/data/workmail/2017-10-01/endpoint-tests-1.json.php index 8112da967c..378beb853e 100644 --- a/src/data/workmail/2017-10-01/endpoint-tests-1.json.php +++ b/src/data/workmail/2017-10-01/endpoint-tests-1.json.php @@ -1,3 +1,3 @@ [ [ 'documentation' => 'For region us-west-2 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.us-west-2.api.aws', ], ], 'params' => [ 'Region' => 'us-west-2', 'UseDualStack' => true, 'UseFIPS' => true, ], ], [ 'documentation' => 'For region us-west-2 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.us-west-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-west-2', 'UseDualStack' => false, 'UseFIPS' => true, ], ], [ 'documentation' => 'For region us-west-2 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.us-west-2.api.aws', ], ], 'params' => [ 'Region' => 'us-west-2', 'UseDualStack' => true, 'UseFIPS' => false, ], ], [ 'documentation' => 'For region us-west-2 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.us-west-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-west-2', 'UseDualStack' => false, 'UseFIPS' => false, ], ], [ 'documentation' => 'For region eu-west-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.eu-west-1.api.aws', ], ], 'params' => [ 'Region' => 'eu-west-1', 'UseDualStack' => true, 'UseFIPS' => true, ], ], [ 'documentation' => 'For region eu-west-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.eu-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-west-1', 'UseDualStack' => false, 'UseFIPS' => true, ], ], [ 'documentation' => 'For region eu-west-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.eu-west-1.api.aws', ], ], 'params' => [ 'Region' => 'eu-west-1', 'UseDualStack' => true, 'UseFIPS' => false, ], ], [ 'documentation' => 'For region eu-west-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.eu-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-west-1', 'UseDualStack' => false, 'UseFIPS' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseDualStack' => true, 'UseFIPS' => true, ], ], [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseDualStack' => false, 'UseFIPS' => true, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseDualStack' => true, 'UseFIPS' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseDualStack' => false, 'UseFIPS' => false, ], ], [ 'documentation' => 'For custom endpoint with fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseDualStack' => false, 'UseFIPS' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips enabled and dualstack disabled', 'expect' => [ 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseDualStack' => false, 'UseFIPS' => true, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips disabled and dualstack enabled', 'expect' => [ 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseDualStack' => true, 'UseFIPS' => false, 'Endpoint' => 'https://example.com', ], ], ], 'version' => '1.0',]; +return [ 'testCases' => [ [ 'documentation' => 'For region eu-west-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.eu-west-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'eu-west-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-west-2 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.us-west-2.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-west-2', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.cn-north-1.api.amazonwebservices.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.cn-north-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.cn-north-1.api.amazonwebservices.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.cn-north-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.us-gov-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.us-gov-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.us-gov-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.us-gov-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.us-iso-east-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'error' => 'DualStack is enabled but this partition does not support DualStack', ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.us-iso-east-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail-fips.us-isob-east-1.sc2s.sgov.gov', ], ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'error' => 'DualStack is enabled but this partition does not support DualStack', ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://workmail.us-isob-east-1.sc2s.sgov.gov', ], ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For custom endpoint with region set and fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with region not set and fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'UseFIPS' => false, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips enabled and dualstack disabled', 'expect' => [ 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips disabled and dualstack enabled', 'expect' => [ 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => true, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'Missing region', 'expect' => [ 'error' => 'Invalid Configuration: Missing Region', ], ], ], 'version' => '1.0',]; diff --git a/src/data/workmail/2017-10-01/paginators-1.json b/src/data/workmail/2017-10-01/paginators-1.json index 6b71db44da..f4305ce7e1 100644 --- a/src/data/workmail/2017-10-01/paginators-1.json +++ b/src/data/workmail/2017-10-01/paginators-1.json @@ -21,6 +21,11 @@ "output_token": "NextToken", "limit_key": "MaxResults" }, + "ListGroupsForEntity": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, "ListImpersonationRoles": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/src/data/workmail/2017-10-01/paginators-1.json.php b/src/data/workmail/2017-10-01/paginators-1.json.php index b184abf8b9..a0bd27a2e6 100644 --- a/src/data/workmail/2017-10-01/paginators-1.json.php +++ b/src/data/workmail/2017-10-01/paginators-1.json.php @@ -1,3 +1,3 @@ [ 'ListAliases' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListAvailabilityConfigurations' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'AvailabilityConfigurations', ], 'ListGroupMembers' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListGroups' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListImpersonationRoles' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListMailDomains' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListMailboxExportJobs' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListMailboxPermissions' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListMobileDeviceAccessOverrides' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListOrganizations' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListResourceDelegates' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListResources' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListUsers' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], ],]; +return [ 'pagination' => [ 'ListAliases' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListAvailabilityConfigurations' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', 'result_key' => 'AvailabilityConfigurations', ], 'ListGroupMembers' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListGroups' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListGroupsForEntity' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListImpersonationRoles' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListMailDomains' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListMailboxExportJobs' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListMailboxPermissions' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListMobileDeviceAccessOverrides' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListOrganizations' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListResourceDelegates' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListResources' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], 'ListUsers' => [ 'input_token' => 'NextToken', 'output_token' => 'NextToken', 'limit_key' => 'MaxResults', ], ],];