AWS SDK for PHP 3.x
  • Namespace
  • Class
Did this page help you? SUBMIT FEEDBACK!

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • Batch
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchLogs
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodeGuruProfiler
      • Exception
    • CodeGuruReviewer
      • Exception
    • CodePipeline
      • Exception
    • CodeStar
      • Exception
    • CodeStarconnections
      • Exception
    • CodeStarNotifications
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoIdentityProvider
      • Exception
    • CognitoSync
      • Exception
    • Comprehend
      • Exception
    • ComprehendMedical
      • Exception
    • ComputeOptimizer
      • Exception
    • ConfigService
      • Exception
    • Connect
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • Exception
    • DynamoDb
      • Exception
    • DynamoDbStreams
      • Exception
    • EBS
      • Exception
    • Ec2
      • Exception
    • EC2InstanceConnect
      • Exception
    • Ecr
      • Exception
    • ECRPublic
      • Exception
    • Ecs
      • Exception
    • Efs
      • Exception
    • EKS
      • Exception
    • ElastiCache
      • Exception
    • ElasticBeanstalk
      • Exception
    • ElasticInference
      • Exception
    • ElasticLoadBalancing
      • Exception
    • ElasticLoadBalancingV2
      • Exception
    • ElasticsearchService
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Exception
    • EMRContainers
      • Exception
    • Endpoint
    • EndpointDiscovery
      • Exception
    • EventBridge
      • Exception
    • Exception
    • Firehose
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • Exception
    • Glacier
      • Exception
    • GlobalAccelerator
      • Exception
    • Glue
      • Exception
    • GlueDataBrew
      • Exception
    • Greengrass
      • Exception
    • GreengrassV2
      • Exception
    • GroundStation
      • Exception
    • GuardDuty
      • Exception
    • Handler
      • GuzzleV5
      • GuzzleV6
    • Health
      • Exception
    • HealthLake
      • Exception
    • Honeycode
      • Exception
    • Iam
      • Exception
    • IdentityStore
      • Exception
    • imagebuilder
      • Exception
    • ImportExport
      • Exception
    • Inspector
      • Exception
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTDeviceAdvisor
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTFleetHub
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • Kafka
      • Exception
    • kendra
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexRuntimeService
      • Exception
    • LicenseManager
      • Exception
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • LookoutforVision
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • ManagedBlockchain
      • Exception
    • MarketplaceCatalog
      • Exception
    • MarketplaceCommerceAnalytics
      • Exception
    • MarketplaceEntitlementService
      • Exception
    • MarketplaceMetering
      • Exception
    • MediaConnect
      • Exception
    • MediaConvert
      • Exception
    • MediaLive
      • Exception
    • MediaPackage
      • Exception
    • MediaPackageVod
      • Exception
    • MediaStore
      • Exception
    • MediaStoreData
      • Exception
    • MediaTailor
      • Exception
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrometheusService
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • Rekognition
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • Route53Resolver
      • Exception
    • S3
      • Crypto
      • Exception
      • RegionalEndpoint
        • Exception
      • UseArnRegion
        • Exception
    • S3Control
      • Exception
    • S3Outposts
      • Exception
    • SageMaker
      • Exception
    • SagemakerEdgeManager
      • Exception
    • SageMakerFeatureStoreRuntime
      • Exception
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • Schemas
      • Exception
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSO
      • Exception
    • SSOAdmin
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • Swf
      • Exception
    • Synthetics
      • Exception
    • Textract
      • Exception
    • TimestreamQuery
      • Exception
    • TimestreamWrite
      • Exception
    • TranscribeService
      • Exception
    • Transfer
      • Exception
    • Translate
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • Aws\Api\AbstractModel
  • Aws\Api\ApiProvider
  • Aws\Api\DateTimeResult
  • Aws\Api\DocModel
  • Aws\Api\ErrorParser\AbstractErrorParser
  • Aws\Api\ErrorParser\JsonRpcErrorParser
  • Aws\Api\ErrorParser\RestJsonErrorParser
  • Aws\Api\ErrorParser\XmlErrorParser
  • Aws\Api\ListShape
  • Aws\Api\MapShape
  • Aws\Api\Operation
  • Aws\Api\Parser\Crc32ValidatingParser
  • Aws\Api\Parser\DecodingEventStreamIterator
  • Aws\Api\Parser\EventParsingIterator
  • Aws\Api\Parser\JsonParser
  • Aws\Api\Parser\JsonRpcParser
  • Aws\Api\Parser\QueryParser
  • Aws\Api\Parser\RestJsonParser
  • Aws\Api\Parser\RestXmlParser
  • Aws\Api\Parser\XmlParser
  • Aws\Api\Serializer\XmlBody
  • Aws\Api\Service
  • Aws\Api\Shape
  • Aws\Api\ShapeMap
  • Aws\Api\StructureShape
  • Aws\Api\TimestampShape
  • Aws\Api\Validator
  • Aws\ApiGateway\ApiGatewayClient
  • Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient
  • Aws\ApiGatewayV2\ApiGatewayV2Client
  • Aws\AppConfig\AppConfigClient
  • Aws\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\Athena\AthenaClient
  • Aws\AuditManager\AuditManagerClient
  • Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\Batch\BatchClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudDirectory\CloudDirectoryClient
  • Aws\CloudFormation\CloudFormationClient
  • Aws\CloudFront\CloudFrontClient
  • Aws\CloudFront\CookieSigner
  • Aws\CloudFront\UrlSigner
  • Aws\CloudHsm\CloudHsmClient
  • Aws\CloudHSMV2\CloudHSMV2Client
  • Aws\CloudSearch\CloudSearchClient
  • Aws\CloudSearchDomain\CloudSearchDomainClient
  • Aws\CloudTrail\CloudTrailClient
  • Aws\CloudTrail\LogFileIterator
  • Aws\CloudTrail\LogFileReader
  • Aws\CloudTrail\LogRecordIterator
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCommit\CodeCommitClient
  • Aws\CodeDeploy\CodeDeployClient
  • Aws\CodeGuruProfiler\CodeGuruProfilerClient
  • Aws\CodeGuruReviewer\CodeGuruReviewerClient
  • Aws\CodePipeline\CodePipelineClient
  • Aws\CodeStar\CodeStarClient
  • Aws\CodeStarconnections\CodeStarconnectionsClient
  • Aws\CodeStarNotifications\CodeStarNotificationsClient
  • Aws\CognitoIdentity\CognitoIdentityClient
  • Aws\CognitoIdentity\CognitoIdentityProvider
  • Aws\CognitoIdentityProvider\CognitoIdentityProviderClient
  • Aws\CognitoSync\CognitoSyncClient
  • Aws\Command
  • Aws\CommandPool
  • Aws\Comprehend\ComprehendClient
  • Aws\ComprehendMedical\ComprehendMedicalClient
  • Aws\ComputeOptimizer\ComputeOptimizerClient
  • Aws\ConfigService\ConfigServiceClient
  • Aws\Connect\ConnectClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\CostandUsageReportService\CostandUsageReportServiceClient
  • Aws\CostExplorer\CostExplorerClient
  • Aws\Credentials\AssumeRoleCredentialProvider
  • Aws\Credentials\AssumeRoleWithWebIdentityCredentialProvider
  • Aws\Credentials\CredentialProvider
  • Aws\Credentials\Credentials
  • Aws\Credentials\EcsCredentialProvider
  • Aws\Credentials\InstanceProfileProvider
  • Aws\Crypto\AesDecryptingStream
  • Aws\Crypto\AesEncryptingStream
  • Aws\Crypto\AesGcmDecryptingStream
  • Aws\Crypto\AesGcmEncryptingStream
  • Aws\Crypto\Cipher\Cbc
  • Aws\Crypto\KmsMaterialsProvider
  • Aws\Crypto\KmsMaterialsProviderV2
  • Aws\Crypto\MaterialsProvider
  • Aws\Crypto\MaterialsProviderV2
  • Aws\Crypto\Polyfill\AesGcm
  • Aws\Crypto\Polyfill\ByteArray
  • Aws\Crypto\Polyfill\Gmac
  • Aws\Crypto\Polyfill\Key
  • Aws\CustomerProfiles\CustomerProfilesClient
  • Aws\DatabaseMigrationService\DatabaseMigrationServiceClient
  • Aws\DataExchange\DataExchangeClient
  • Aws\DataPipeline\DataPipelineClient
  • Aws\DataSync\DataSyncClient
  • Aws\DAX\DAXClient
  • Aws\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DoctrineCacheAdapter
  • Aws\DynamoDb\BinaryValue
  • Aws\DynamoDb\DynamoDbClient
  • Aws\DynamoDb\LockingSessionConnection
  • Aws\DynamoDb\Marshaler
  • Aws\DynamoDb\NumberValue
  • Aws\DynamoDb\SessionHandler
  • Aws\DynamoDb\SetValue
  • Aws\DynamoDb\StandardSessionConnection
  • Aws\DynamoDb\WriteRequestBatch
  • Aws\DynamoDbStreams\DynamoDbStreamsClient
  • Aws\EBS\EBSClient
  • Aws\Ec2\Ec2Client
  • Aws\EC2InstanceConnect\EC2InstanceConnectClient
  • Aws\Ecr\EcrClient
  • Aws\ECRPublic\ECRPublicClient
  • Aws\Ecs\EcsClient
  • Aws\Efs\EfsClient
  • Aws\EKS\EKSClient
  • Aws\ElastiCache\ElastiCacheClient
  • Aws\ElasticBeanstalk\ElasticBeanstalkClient
  • Aws\ElasticInference\ElasticInferenceClient
  • Aws\ElasticLoadBalancing\ElasticLoadBalancingClient
  • Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client
  • Aws\ElasticsearchService\ElasticsearchServiceClient
  • Aws\ElasticTranscoder\ElasticTranscoderClient
  • Aws\Emr\EmrClient
  • Aws\EMRContainers\EMRContainersClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EventBridge\EventBridgeClient
  • Aws\Firehose\FirehoseClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • Aws\Glacier\GlacierClient
  • Aws\Glacier\MultipartUploader
  • Aws\Glacier\TreeHash
  • Aws\GlobalAccelerator\GlobalAcceleratorClient
  • Aws\Glue\GlueClient
  • Aws\GlueDataBrew\GlueDataBrewClient
  • Aws\Greengrass\GreengrassClient
  • Aws\GreengrassV2\GreengrassV2Client
  • Aws\GroundStation\GroundStationClient
  • Aws\GuardDuty\GuardDutyClient
  • Aws\Handler\GuzzleV5\GuzzleHandler
  • Aws\Handler\GuzzleV5\GuzzleStream
  • Aws\Handler\GuzzleV5\PsrStream
  • Aws\Handler\GuzzleV6\GuzzleHandler
  • Aws\HandlerList
  • Aws\HashingStream
  • Aws\Health\HealthClient
  • Aws\HealthLake\HealthLakeClient
  • Aws\History
  • Aws\Honeycode\HoneycodeClient
  • Aws\Iam\IamClient
  • Aws\IdempotencyTokenMiddleware
  • Aws\IdentityStore\IdentityStoreClient
  • Aws\imagebuilder\imagebuilderClient
  • Aws\ImportExport\ImportExportClient
  • Aws\Inspector\InspectorClient
  • Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
  • Aws\IoT1ClickProjects\IoT1ClickProjectsClient
  • Aws\Iot\IotClient
  • Aws\IoTAnalytics\IoTAnalyticsClient
  • Aws\IotDataPlane\IotDataPlaneClient
  • Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient
  • Aws\IoTEvents\IoTEventsClient
  • Aws\IoTEventsData\IoTEventsDataClient
  • Aws\IoTFleetHub\IoTFleetHubClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\kendra\kendraClient
  • Aws\Kinesis\KinesisClient
  • Aws\KinesisAnalytics\KinesisAnalyticsClient
  • Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
  • Aws\KinesisVideo\KinesisVideoClient
  • Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
  • Aws\KinesisVideoMedia\KinesisVideoMediaClient
  • Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
  • Aws\Kms\KmsClient
  • Aws\LakeFormation\LakeFormationClient
  • Aws\Lambda\LambdaClient
  • Aws\LexModelBuildingService\LexModelBuildingServiceClient
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LicenseManager\LicenseManagerClient
  • Aws\Lightsail\LightsailClient
  • Aws\LocationService\LocationServiceClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • Aws\MarketplaceCatalog\MarketplaceCatalogClient
  • Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
  • Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
  • Aws\MarketplaceMetering\MarketplaceMeteringClient
  • Aws\MediaConnect\MediaConnectClient
  • Aws\MediaConvert\MediaConvertClient
  • Aws\MediaLive\MediaLiveClient
  • Aws\MediaPackage\MediaPackageClient
  • Aws\MediaPackageVod\MediaPackageVodClient
  • Aws\MediaStore\MediaStoreClient
  • Aws\MediaStoreData\MediaStoreDataClient
  • Aws\MediaTailor\MediaTailorClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • Aws\Mobile\MobileClient
  • Aws\MockHandler
  • Aws\MQ\MQClient
  • Aws\MTurk\MTurkClient
  • Aws\Multipart\UploadState
  • Aws\MultiRegionClient
  • Aws\MWAA\MWAAClient
  • Aws\Neptune\NeptuneClient
  • Aws\NetworkFirewall\NetworkFirewallClient
  • Aws\NetworkManager\NetworkManagerClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrometheusService\PrometheusServiceClient
  • Aws\Psr16CacheAdapter
  • Aws\PsrCacheAdapter
  • Aws\QLDB\QLDBClient
  • Aws\QLDBSession\QLDBSessionClient
  • Aws\QuickSight\QuickSightClient
  • Aws\RAM\RAMClient
  • Aws\Rds\AuthTokenGenerator
  • Aws\Rds\RdsClient
  • Aws\RDSDataService\RDSDataServiceClient
  • Aws\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\Retry\Configuration
  • Aws\Retry\ConfigurationProvider
  • Aws\RoboMaker\RoboMakerClient
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\Route53Resolver\Route53ResolverClient
  • Aws\S3\BatchDelete
  • Aws\S3\Crypto\HeadersMetadataStrategy
  • Aws\S3\Crypto\InstructionFileMetadataStrategy
  • Aws\S3\Crypto\S3EncryptionClient
  • Aws\S3\Crypto\S3EncryptionClientV2
  • Aws\S3\Crypto\S3EncryptionMultipartUploader
  • Aws\S3\Crypto\S3EncryptionMultipartUploaderV2
  • Aws\S3\GetBucketLocationParser
  • Aws\S3\MultipartUploader
  • Aws\S3\ObjectCopier
  • Aws\S3\ObjectUploader
  • Aws\S3\PostObject
  • Aws\S3\PostObjectV4
  • Aws\S3\RegionalEndpoint\Configuration
  • Aws\S3\RegionalEndpoint\ConfigurationProvider
  • Aws\S3\S3Client
  • Aws\S3\S3MultiRegionClient
  • Aws\S3\S3UriParser
  • Aws\S3\StreamWrapper
  • Aws\S3\Transfer
  • Aws\S3\UseArnRegion\Configuration
  • Aws\S3\UseArnRegion\ConfigurationProvider
  • Aws\S3Control\S3ControlClient
  • Aws\S3Outposts\S3OutpostsClient
  • Aws\SageMaker\SageMakerClient
  • Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
  • Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Schemas\SchemasClient
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
  • Aws\ServiceCatalog\ServiceCatalogClient
  • Aws\ServiceDiscovery\ServiceDiscoveryClient
  • Aws\ServiceQuotas\ServiceQuotasClient
  • Aws\Ses\SesClient
  • Aws\SesV2\SesV2Client
  • Aws\Sfn\SfnClient
  • Aws\Shield\ShieldClient
  • Aws\Signature\AnonymousSignature
  • Aws\Signature\S3SignatureV4
  • Aws\Signature\SignatureProvider
  • Aws\Signature\SignatureV4
  • Aws\signer\signerClient
  • Aws\Sms\SmsClient
  • Aws\SnowBall\SnowBallClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSO\SSOClient
  • Aws\SSOAdmin\SSOAdminClient
  • Aws\SSOOIDC\SSOOIDCClient
  • Aws\StorageGateway\StorageGatewayClient
  • Aws\Sts\RegionalEndpoints\Configuration
  • Aws\Sts\RegionalEndpoints\ConfigurationProvider
  • Aws\Sts\StsClient
  • Aws\Support\SupportClient
  • Aws\Swf\SwfClient
  • Aws\Synthetics\SyntheticsClient
  • Aws\Textract\TextractClient
  • Aws\TimestreamQuery\TimestreamQueryClient
  • Aws\TimestreamWrite\TimestreamWriteClient
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Transfer\TransferClient
  • Aws\Translate\TranslateClient
  • Aws\Waf\WafClient
  • Aws\WafRegional\WafRegionalClient
  • Aws\WAFV2\WAFV2Client
  • Aws\Waiter
  • Aws\WellArchitected\WellArchitectedClient
  • Aws\WorkDocs\WorkDocsClient
  • Aws\WorkLink\WorkLinkClient
  • Aws\WorkMail\WorkMailClient
  • Aws\WorkMailMessageFlow\WorkMailMessageFlowClient
  • Aws\WorkSpaces\WorkSpacesClient
  • Aws\WrappedHttpHandler
  • Aws\XRay\XRayClient

Interfaces

  • Aws\AwsClientInterface
  • Aws\CacheInterface
  • Aws\ClientSideMonitoring\ConfigurationInterface
  • Aws\CommandInterface
  • Aws\ConfigurationProviderInterface
  • Aws\Credentials\CredentialsInterface
  • Aws\Crypto\AesStreamInterface
  • Aws\Crypto\AesStreamInterfaceV2
  • Aws\Crypto\Cipher\CipherMethod
  • Aws\Crypto\MaterialsProviderInterface
  • Aws\Crypto\MaterialsProviderInterfaceV2
  • Aws\Crypto\MetadataStrategyInterface
  • Aws\DynamoDb\SessionConnectionInterface
  • Aws\Endpoint\PartitionInterface
  • Aws\EndpointDiscovery\ConfigurationInterface
  • Aws\HashInterface
  • Aws\MonitoringEventsInterface
  • Aws\ResponseContainerInterface
  • Aws\ResultInterface
  • Aws\Retry\ConfigurationInterface
  • Aws\S3\RegionalEndpoint\ConfigurationInterface
  • Aws\S3\S3ClientInterface
  • Aws\S3\UseArnRegion\ConfigurationInterface
  • Aws\Signature\SignatureInterface
  • Aws\Sts\RegionalEndpoints\ConfigurationInterface

Traits

  • Aws\Api\ErrorParser\JsonParserTrait
  • Aws\Api\Parser\MetadataParserTrait
  • Aws\Api\Parser\PayloadParserTrait
  • Aws\AwsClientTrait
  • Aws\Crypto\Cipher\CipherBuilderTrait
  • Aws\Crypto\DecryptionTrait
  • Aws\Crypto\DecryptionTraitV2
  • Aws\Crypto\EncryptionTrait
  • Aws\Crypto\EncryptionTraitV2
  • Aws\Crypto\Polyfill\NeedsTrait
  • Aws\DynamoDb\SessionConnectionConfigTrait
  • Aws\HasDataTrait
  • Aws\HasMonitoringEventsTrait
  • Aws\Retry\RetryHelperTrait
  • Aws\S3\Crypto\CryptoParamsTrait
  • Aws\S3\Crypto\CryptoParamsTraitV2
  • Aws\S3\Crypto\UserAgentTrait
  • Aws\S3\MultipartUploadingTrait
  • Aws\S3\S3ClientTrait
  • Aws\Signature\SignatureTrait

Exceptions

  • Aws\AccessAnalyzer\Exception\AccessAnalyzerException
  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • Aws\Appstream\Exception\AppstreamException
  • Aws\AppSync\Exception\AppSyncException
  • Aws\Arn\Exception\InvalidArnException
  • Aws\Athena\Exception\AthenaException
  • Aws\AuditManager\Exception\AuditManagerException
  • Aws\AugmentedAIRuntime\Exception\AugmentedAIRuntimeException
  • Aws\AutoScaling\Exception\AutoScalingException
  • Aws\AutoScalingPlans\Exception\AutoScalingPlansException
  • Aws\Backup\Exception\BackupException
  • Aws\Batch\Exception\BatchException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudDirectory\Exception\CloudDirectoryException
  • Aws\CloudFormation\Exception\CloudFormationException
  • Aws\CloudFront\Exception\CloudFrontException
  • Aws\CloudHsm\Exception\CloudHsmException
  • Aws\CloudHSMV2\Exception\CloudHSMV2Exception
  • Aws\CloudSearch\Exception\CloudSearchException
  • Aws\CloudSearchDomain\Exception\CloudSearchDomainException
  • Aws\CloudTrail\Exception\CloudTrailException
  • Aws\CloudWatch\Exception\CloudWatchException
  • Aws\CloudWatchEvents\Exception\CloudWatchEventsException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CodeArtifact\Exception\CodeArtifactException
  • Aws\CodeBuild\Exception\CodeBuildException
  • Aws\CodeCommit\Exception\CodeCommitException
  • Aws\CodeDeploy\Exception\CodeDeployException
  • Aws\CodeGuruProfiler\Exception\CodeGuruProfilerException
  • Aws\CodeGuruReviewer\Exception\CodeGuruReviewerException
  • Aws\CodePipeline\Exception\CodePipelineException
  • Aws\CodeStar\Exception\CodeStarException
  • Aws\CodeStarconnections\Exception\CodeStarconnectionsException
  • Aws\CodeStarNotifications\Exception\CodeStarNotificationsException
  • Aws\CognitoIdentity\Exception\CognitoIdentityException
  • Aws\CognitoIdentityProvider\Exception\CognitoIdentityProviderException
  • Aws\CognitoSync\Exception\CognitoSyncException
  • Aws\Comprehend\Exception\ComprehendException
  • Aws\ComprehendMedical\Exception\ComprehendMedicalException
  • Aws\ComputeOptimizer\Exception\ComputeOptimizerException
  • Aws\ConfigService\Exception\ConfigServiceException
  • Aws\Connect\Exception\ConnectException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\CostandUsageReportService\Exception\CostandUsageReportServiceException
  • Aws\CostExplorer\Exception\CostExplorerException
  • Aws\CustomerProfiles\Exception\CustomerProfilesException
  • Aws\DatabaseMigrationService\Exception\DatabaseMigrationServiceException
  • Aws\DataExchange\Exception\DataExchangeException
  • Aws\DataPipeline\Exception\DataPipelineException
  • Aws\DataSync\Exception\DataSyncException
  • Aws\DAX\Exception\DAXException
  • Aws\Detective\Exception\DetectiveException
  • Aws\DeviceFarm\Exception\DeviceFarmException
  • Aws\DevOpsGuru\Exception\DevOpsGuruException
  • Aws\DirectConnect\Exception\DirectConnectException
  • Aws\DirectoryService\Exception\DirectoryServiceException
  • Aws\DLM\Exception\DLMException
  • Aws\DocDB\Exception\DocDBException
  • Aws\DynamoDb\Exception\DynamoDbException
  • Aws\DynamoDbStreams\Exception\DynamoDbStreamsException
  • Aws\EBS\Exception\EBSException
  • Aws\Ec2\Exception\Ec2Exception
  • Aws\EC2InstanceConnect\Exception\EC2InstanceConnectException
  • Aws\Ecr\Exception\EcrException
  • Aws\ECRPublic\Exception\ECRPublicException
  • Aws\Ecs\Exception\EcsException
  • Aws\Efs\Exception\EfsException
  • Aws\EKS\Exception\EKSException
  • Aws\ElastiCache\Exception\ElastiCacheException
  • Aws\ElasticBeanstalk\Exception\ElasticBeanstalkException
  • Aws\ElasticInference\Exception\ElasticInferenceException
  • Aws\ElasticLoadBalancing\Exception\ElasticLoadBalancingException
  • Aws\ElasticLoadBalancingV2\Exception\ElasticLoadBalancingV2Exception
  • Aws\ElasticsearchService\Exception\ElasticsearchServiceException
  • Aws\ElasticTranscoder\Exception\ElasticTranscoderException
  • Aws\Emr\Exception\EmrException
  • Aws\EMRContainers\Exception\EMRContainersException
  • Aws\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CouldNotCreateChecksumException
  • Aws\Exception\CredentialsException
  • Aws\Exception\CryptoException
  • Aws\Exception\CryptoPolyfillException
  • Aws\Exception\EventStreamDataException
  • Aws\Exception\IncalculablePayloadException
  • Aws\Exception\InvalidJsonException
  • Aws\Exception\InvalidRegionException
  • Aws\Exception\MultipartUploadException
  • Aws\Exception\UnresolvedApiException
  • Aws\Exception\UnresolvedEndpointException
  • Aws\Exception\UnresolvedSignatureException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FMS\Exception\FMSException
  • Aws\ForecastQueryService\Exception\ForecastQueryServiceException
  • Aws\ForecastService\Exception\ForecastServiceException
  • Aws\FraudDetector\Exception\FraudDetectorException
  • Aws\FSx\Exception\FSxException
  • Aws\GameLift\Exception\GameLiftException
  • Aws\Glacier\Exception\GlacierException
  • Aws\GlobalAccelerator\Exception\GlobalAcceleratorException
  • Aws\Glue\Exception\GlueException
  • Aws\GlueDataBrew\Exception\GlueDataBrewException
  • Aws\Greengrass\Exception\GreengrassException
  • Aws\GreengrassV2\Exception\GreengrassV2Exception
  • Aws\GroundStation\Exception\GroundStationException
  • Aws\GuardDuty\Exception\GuardDutyException
  • Aws\Health\Exception\HealthException
  • Aws\HealthLake\Exception\HealthLakeException
  • Aws\Honeycode\Exception\HoneycodeException
  • Aws\Iam\Exception\IamException
  • Aws\IdentityStore\Exception\IdentityStoreException
  • Aws\imagebuilder\Exception\imagebuilderException
  • Aws\ImportExport\Exception\ImportExportException
  • Aws\Inspector\Exception\InspectorException
  • Aws\IoT1ClickDevicesService\Exception\IoT1ClickDevicesServiceException
  • Aws\IoT1ClickProjects\Exception\IoT1ClickProjectsException
  • Aws\Iot\Exception\IotException
  • Aws\IoTAnalytics\Exception\IoTAnalyticsException
  • Aws\IotDataPlane\Exception\IotDataPlaneException
  • Aws\IoTDeviceAdvisor\Exception\IoTDeviceAdvisorException
  • Aws\IoTEvents\Exception\IoTEventsException
  • Aws\IoTEventsData\Exception\IoTEventsDataException
  • Aws\IoTFleetHub\Exception\IoTFleetHubException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
  • Aws\IoTSiteWise\Exception\IoTSiteWiseException
  • Aws\IoTThingsGraph\Exception\IoTThingsGraphException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\Kafka\Exception\KafkaException
  • Aws\kendra\Exception\kendraException
  • Aws\Kinesis\Exception\KinesisException
  • Aws\KinesisAnalytics\Exception\KinesisAnalyticsException
  • Aws\KinesisAnalyticsV2\Exception\KinesisAnalyticsV2Exception
  • Aws\KinesisVideo\Exception\KinesisVideoException
  • Aws\KinesisVideoArchivedMedia\Exception\KinesisVideoArchivedMediaException
  • Aws\KinesisVideoMedia\Exception\KinesisVideoMediaException
  • Aws\KinesisVideoSignalingChannels\Exception\KinesisVideoSignalingChannelsException
  • Aws\Kms\Exception\KmsException
  • Aws\LakeFormation\Exception\LakeFormationException
  • Aws\Lambda\Exception\LambdaException
  • Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LicenseManager\Exception\LicenseManagerException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\LocationService\Exception\LocationServiceException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • Aws\MarketplaceCatalog\Exception\MarketplaceCatalogException
  • Aws\MarketplaceCommerceAnalytics\Exception\MarketplaceCommerceAnalyticsException
  • Aws\MarketplaceEntitlementService\Exception\MarketplaceEntitlementServiceException
  • Aws\MarketplaceMetering\Exception\MarketplaceMeteringException
  • Aws\MediaConnect\Exception\MediaConnectException
  • Aws\MediaConvert\Exception\MediaConvertException
  • Aws\MediaLive\Exception\MediaLiveException
  • Aws\MediaPackage\Exception\MediaPackageException
  • Aws\MediaPackageVod\Exception\MediaPackageVodException
  • Aws\MediaStore\Exception\MediaStoreException
  • Aws\MediaStoreData\Exception\MediaStoreDataException
  • Aws\MediaTailor\Exception\MediaTailorException
  • Aws\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • Aws\Mobile\Exception\MobileException
  • Aws\MQ\Exception\MQException
  • Aws\MTurk\Exception\MTurkException
  • Aws\MWAA\Exception\MWAAException
  • Aws\Neptune\Exception\NeptuneException
  • Aws\NetworkFirewall\Exception\NetworkFirewallException
  • Aws\NetworkManager\Exception\NetworkManagerException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • Aws\Personalize\Exception\PersonalizeException
  • Aws\PersonalizeEvents\Exception\PersonalizeEventsException
  • Aws\PersonalizeRuntime\Exception\PersonalizeRuntimeException
  • Aws\PI\Exception\PIException
  • Aws\Pinpoint\Exception\PinpointException
  • Aws\PinpointEmail\Exception\PinpointEmailException
  • Aws\PinpointSMSVoice\Exception\PinpointSMSVoiceException
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrometheusService\Exception\PrometheusServiceException
  • Aws\QLDB\Exception\QLDBException
  • Aws\QLDBSession\Exception\QLDBSessionException
  • Aws\QuickSight\Exception\QuickSightException
  • Aws\RAM\Exception\RAMException
  • Aws\Rds\Exception\RdsException
  • Aws\RDSDataService\Exception\RDSDataServiceException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Retry\Exception\ConfigurationException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\Route53Resolver\Exception\Route53ResolverException
  • Aws\S3\Exception\DeleteMultipleObjectsException
  • Aws\S3\Exception\PermanentRedirectException
  • Aws\S3\Exception\S3Exception
  • Aws\S3\Exception\S3MultipartUploadException
  • Aws\S3\RegionalEndpoint\Exception\ConfigurationException
  • Aws\S3\UseArnRegion\Exception\ConfigurationException
  • Aws\S3Control\Exception\S3ControlException
  • Aws\S3Outposts\Exception\S3OutpostsException
  • Aws\SageMaker\Exception\SageMakerException
  • Aws\SagemakerEdgeManager\Exception\SagemakerEdgeManagerException
  • Aws\SageMakerFeatureStoreRuntime\Exception\SageMakerFeatureStoreRuntimeException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\Schemas\Exception\SchemasException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\ServerlessApplicationRepository\Exception\ServerlessApplicationRepositoryException
  • Aws\ServiceCatalog\Exception\ServiceCatalogException
  • Aws\ServiceDiscovery\Exception\ServiceDiscoveryException
  • Aws\ServiceQuotas\Exception\ServiceQuotasException
  • Aws\Ses\Exception\SesException
  • Aws\SesV2\Exception\SesV2Exception
  • Aws\Sfn\Exception\SfnException
  • Aws\Shield\Exception\ShieldException
  • Aws\signer\Exception\signerException
  • Aws\Sms\Exception\SmsException
  • Aws\SnowBall\Exception\SnowBallException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSO\Exception\SSOException
  • Aws\SSOAdmin\Exception\SSOAdminException
  • Aws\SSOOIDC\Exception\SSOOIDCException
  • Aws\StorageGateway\Exception\StorageGatewayException
  • Aws\Sts\Exception\StsException
  • Aws\Sts\RegionalEndpoints\Exception\ConfigurationException
  • Aws\Support\Exception\SupportException
  • Aws\Swf\Exception\SwfException
  • Aws\Synthetics\Exception\SyntheticsException
  • Aws\Textract\Exception\TextractException
  • Aws\TimestreamQuery\Exception\TimestreamQueryException
  • Aws\TimestreamWrite\Exception\TimestreamWriteException
  • Aws\TranscribeService\Exception\TranscribeServiceException
  • Aws\Transfer\Exception\TransferException
  • Aws\Translate\Exception\TranslateException
  • Aws\Waf\Exception\WafException
  • Aws\WafRegional\Exception\WafRegionalException
  • Aws\WAFV2\Exception\WAFV2Exception
  • Aws\WellArchitected\Exception\WellArchitectedException
  • Aws\WorkDocs\Exception\WorkDocsException
  • Aws\WorkLink\Exception\WorkLinkException
  • Aws\WorkMail\Exception\WorkMailException
  • Aws\WorkMailMessageFlow\Exception\WorkMailMessageFlowException
  • Aws\WorkSpaces\Exception\WorkSpacesException
  • Aws\XRay\Exception\XRayException

Functions

  • Aws\boolean_value
  • Aws\clear_compiled_json
  • Aws\constantly
  • Aws\default_http_handler
  • Aws\default_user_agent
  • Aws\describe_type
  • Aws\dir_iterator
  • Aws\filter
  • Aws\flatmap
  • Aws\guzzle_major_version
  • Aws\is_valid_epoch
  • Aws\is_valid_hostlabel
  • Aws\is_valid_hostname
  • Aws\load_compiled_json
  • Aws\manifest
  • Aws\map
  • Aws\or_chain
  • Aws\parse_ini_file
  • Aws\partition
  • Aws\recursive_dir_iterator
  • Aws\serialize

Amazon Macie 2 2020-01-01

Client: Aws\Macie2\Macie2Client
Service ID: macie2
Version: 2020-01-01

This page describes the parameters and results for the operations of the Amazon Macie 2 (2020-01-01), and shows how to use the Aws\Macie2\Macie2Client object to call the described operations. This documentation is specific to the 2020-01-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

  • AcceptInvitation ( array $params = [] )

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

  • BatchGetCustomDataIdentifiers ( array $params = [] )

    Retrieves information about one or more custom data identifiers.

  • CreateClassificationJob ( array $params = [] )

    Creates and defines the settings for a classification job.

  • CreateCustomDataIdentifier ( array $params = [] )

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

  • CreateFindingsFilter ( array $params = [] )

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

  • CreateInvitations ( array $params = [] )

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

  • CreateMember ( array $params = [] )

    Associates an account with an Amazon Macie master account.

  • CreateSampleFindings ( array $params = [] )

    Creates sample findings.

  • DeclineInvitations ( array $params = [] )

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

  • DeleteCustomDataIdentifier ( array $params = [] )

    Soft deletes a custom data identifier.

  • DeleteFindingsFilter ( array $params = [] )

    Deletes a findings filter.

  • DeleteInvitations ( array $params = [] )

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

  • DeleteMember ( array $params = [] )

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

  • DescribeBuckets ( array $params = [] )

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

  • DescribeClassificationJob ( array $params = [] )

    Retrieves the status and settings for a classification job.

  • DescribeOrganizationConfiguration ( array $params = [] )

    Retrieves the Amazon Macie configuration settings for an AWS organization.

  • DisableMacie ( array $params = [] )

    Disables an Amazon Macie account and deletes Macie resources for the account.

  • DisableOrganizationAdminAccount ( array $params = [] )

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

  • DisassociateFromMasterAccount ( array $params = [] )

    Disassociates a member account from its Amazon Macie master account.

  • DisassociateMember ( array $params = [] )

    Disassociates an Amazon Macie master account from a member account.

  • EnableMacie ( array $params = [] )

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

  • EnableOrganizationAdminAccount ( array $params = [] )

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

  • GetBucketStatistics ( array $params = [] )

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

  • GetClassificationExportConfiguration ( array $params = [] )

    Retrieves the configuration settings for storing data classification results.

  • GetCustomDataIdentifier ( array $params = [] )

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

  • GetFindingStatistics ( array $params = [] )

    Retrieves (queries) aggregated statistical data about findings.

  • GetFindings ( array $params = [] )

    Retrieves the details of one or more findings.

  • GetFindingsFilter ( array $params = [] )

    Retrieves the criteria and other settings for a findings filter.

  • GetInvitationsCount ( array $params = [] )

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

  • GetMacieSession ( array $params = [] )

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

  • GetMasterAccount ( array $params = [] )

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

  • GetMember ( array $params = [] )

    Retrieves information about a member account that's associated with an Amazon Macie master account.

  • GetUsageStatistics ( array $params = [] )

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

  • GetUsageTotals ( array $params = [] )

    Retrieves (queries) aggregated usage data for an account.

  • ListClassificationJobs ( array $params = [] )

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

  • ListCustomDataIdentifiers ( array $params = [] )

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

  • ListFindings ( array $params = [] )

    Retrieves a subset of information about one or more findings.

  • ListFindingsFilters ( array $params = [] )

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

  • ListInvitations ( array $params = [] )

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

  • ListMembers ( array $params = [] )

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

  • ListOrganizationAdminAccounts ( array $params = [] )

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

  • ListTagsForResource ( array $params = [] )

    Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

  • PutClassificationExportConfiguration ( array $params = [] )

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

  • TagResource ( array $params = [] )

    Adds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

  • TestCustomDataIdentifier ( array $params = [] )

    Tests a custom data identifier.

  • UntagResource ( array $params = [] )

    Removes one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account.

  • UpdateClassificationJob ( array $params = [] )

    Changes the status of a classification job.

  • UpdateFindingsFilter ( array $params = [] )

    Updates the criteria and other settings for a findings filter.

  • UpdateMacieSession ( array $params = [] )

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

  • UpdateMemberSession ( array $params = [] )

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

  • UpdateOrganizationConfiguration ( array $params = [] )

    Updates the Amazon Macie configuration settings for an AWS organization.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

  • DescribeBuckets
  • GetUsageStatistics
  • ListClassificationJobs
  • ListCustomDataIdentifiers
  • ListFindings
  • ListFindingsFilters
  • ListInvitations
  • ListMembers
  • ListOrganizationAdminAccounts

Operations

AcceptInvitation

$result = $client->acceptInvitation([/* ... */]);
$promise = $client->acceptInvitationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->acceptInvitation([
    'invitationId' => '<string>', // REQUIRED
    'masterAccount' => '<string>', // REQUIRED
]);

Parameter Details

Members
invitationId
  • Required: Yes
  • Type: string
masterAccount
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

BatchGetCustomDataIdentifiers

$result = $client->batchGetCustomDataIdentifiers([/* ... */]);
$promise = $client->batchGetCustomDataIdentifiersAsync([/* ... */]);

Retrieves information about one or more custom data identifiers.

Parameter Syntax

$result = $client->batchGetCustomDataIdentifiers([
    'ids' => ['<string>', ...],
]);

Parameter Details

Members
ids
  • Type: Array of strings

Result Syntax

[
    'customDataIdentifiers' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'deleted' => true || false,
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'notFoundIdentifierIds' => ['<string>', ...],
]

Result Details

Members
customDataIdentifiers
  • Type: Array of BatchGetCustomDataIdentifierSummary structures
notFoundIdentifierIds
  • Type: Array of strings

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

CreateClassificationJob

$result = $client->createClassificationJob([/* ... */]);
$promise = $client->createClassificationJobAsync([/* ... */]);

Creates and defines the settings for a classification job.

Parameter Syntax

$result = $client->createClassificationJob([
    'clientToken' => '<string>', // REQUIRED
    'customDataIdentifierIds' => ['<string>', ...],
    'description' => '<string>',
    'initialRun' => true || false,
    'jobType' => 'ONE_TIME|SCHEDULED', // REQUIRED
    'name' => '<string>', // REQUIRED
    's3JobDefinition' => [ // REQUIRED
        'bucketDefinitions' => [
            [
                'accountId' => '<string>',
                'buckets' => ['<string>', ...],
            ],
            // ...
        ],
        'scoping' => [
            'excludes' => [
                'and' => [
                    [
                        'simpleScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
                            'key' => 'BUCKET_CREATION_DATE|OBJECT_EXTENSION|OBJECT_LAST_MODIFIED_DATE|OBJECT_SIZE|TAG',
                            'values' => ['<string>', ...],
                        ],
                        'tagScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
                            'key' => '<string>',
                            'tagValues' => [
                                [
                                    'key' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'target' => 'S3_OBJECT',
                        ],
                    ],
                    // ...
                ],
            ],
            'includes' => [
                'and' => [
                    [
                        'simpleScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
                            'key' => 'BUCKET_CREATION_DATE|OBJECT_EXTENSION|OBJECT_LAST_MODIFIED_DATE|OBJECT_SIZE|TAG',
                            'values' => ['<string>', ...],
                        ],
                        'tagScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
                            'key' => '<string>',
                            'tagValues' => [
                                [
                                    'key' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'target' => 'S3_OBJECT',
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'samplingPercentage' => <integer>,
    'scheduleFrequency' => [
        'dailySchedule' => [
        ],
        'monthlySchedule' => [
            'dayOfMonth' => <integer>,
        ],
        'weeklySchedule' => [
            'dayOfWeek' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY',
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
clientToken
  • Required: Yes
  • Type: string
customDataIdentifierIds
  • Type: Array of strings
description
  • Type: string
initialRun
  • Type: boolean
jobType
  • Required: Yes
  • Type: string

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

name
  • Required: Yes
  • Type: string
s3JobDefinition
  • Required: Yes
  • Type: S3JobDefinition structure

Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.

samplingPercentage
  • Type: int
scheduleFrequency
  • Type: JobScheduleFrequency structure

Specifies the recurrence pattern for running a classification job.

tags
  • Type: Associative array of custom strings keys (__string) to strings

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

Result Syntax

[
    'jobArn' => '<string>',
    'jobId' => '<string>',
]

Result Details

Members
jobArn
  • Type: string
jobId
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

CreateCustomDataIdentifier

$result = $client->createCustomDataIdentifier([/* ... */]);
$promise = $client->createCustomDataIdentifierAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createCustomDataIdentifier([
    'clientToken' => '<string>',
    'description' => '<string>',
    'ignoreWords' => ['<string>', ...],
    'keywords' => ['<string>', ...],
    'maximumMatchDistance' => <integer>,
    'name' => '<string>',
    'regex' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
clientToken
  • Type: string
description
  • Type: string
ignoreWords
  • Type: Array of strings
keywords
  • Type: Array of strings
maximumMatchDistance
  • Type: int
name
  • Type: string
regex
  • Type: string
tags
  • Type: Associative array of custom strings keys (__string) to strings

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

Result Syntax

[
    'customDataIdentifierId' => '<string>',
]

Result Details

Members
customDataIdentifierId
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

CreateFindingsFilter

$result = $client->createFindingsFilter([/* ... */]);
$promise = $client->createFindingsFilterAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createFindingsFilter([
    'action' => 'ARCHIVE|NOOP', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'findingCriteria' => [ // REQUIRED
        'criterion' => [
            '<__string>' => [
                'eq' => ['<string>', ...],
                'eqExactMatch' => ['<string>', ...],
                'gt' => <integer>,
                'gte' => <integer>,
                'lt' => <integer>,
                'lte' => <integer>,
                'neq' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'name' => '<string>', // REQUIRED
    'position' => <integer>,
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
action
  • Required: Yes
  • Type: string

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

clientToken
  • Type: string
description
  • Type: string
findingCriteria
  • Required: Yes
  • Type: FindingCriteria structure

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

name
  • Required: Yes
  • Type: string
position
  • Type: int
tags
  • Type: Associative array of custom strings keys (__string) to strings

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
]

Result Details

Members
arn
  • Type: string
id
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

CreateInvitations

$result = $client->createInvitations([/* ... */]);
$promise = $client->createInvitationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createInvitations([
    'accountIds' => ['<string>', ...], // REQUIRED
    'disableEmailNotification' => true || false,
    'message' => '<string>',
]);

Parameter Details

Members
accountIds
  • Required: Yes
  • Type: Array of strings
disableEmailNotification
  • Type: boolean
message
  • Type: string

Result Syntax

[
    'unprocessedAccounts' => [
        [
            'accountId' => '<string>',
            'errorCode' => 'ClientError|InternalError',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
unprocessedAccounts
  • Type: Array of UnprocessedAccount structures

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

CreateMember

$result = $client->createMember([/* ... */]);
$promise = $client->createMemberAsync([/* ... */]);

Associates an account with an Amazon Macie master account.

Parameter Syntax

$result = $client->createMember([
    'account' => [ // REQUIRED
        'accountId' => '<string>', // REQUIRED
        'email' => '<string>', // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
account
  • Required: Yes
  • Type: AccountDetail structure

Specifies details for an account to associate with an Amazon Macie master account.

tags
  • Type: Associative array of custom strings keys (__string) to strings

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

Result Syntax

[
    'arn' => '<string>',
]

Result Details

Members
arn
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

CreateSampleFindings

$result = $client->createSampleFindings([/* ... */]);
$promise = $client->createSampleFindingsAsync([/* ... */]);

Creates sample findings.

Parameter Syntax

$result = $client->createSampleFindings([
    'findingTypes' => ['<string>', ...],
]);

Parameter Details

Members
findingTypes
  • Type: Array of strings

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

DeclineInvitations

$result = $client->declineInvitations([/* ... */]);
$promise = $client->declineInvitationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->declineInvitations([
    'accountIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
accountIds
  • Required: Yes
  • Type: Array of strings

Result Syntax

[
    'unprocessedAccounts' => [
        [
            'accountId' => '<string>',
            'errorCode' => 'ClientError|InternalError',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
unprocessedAccounts
  • Type: Array of UnprocessedAccount structures

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

DeleteCustomDataIdentifier

$result = $client->deleteCustomDataIdentifier([/* ... */]);
$promise = $client->deleteCustomDataIdentifierAsync([/* ... */]);

Soft deletes a custom data identifier.

Parameter Syntax

$result = $client->deleteCustomDataIdentifier([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

DeleteFindingsFilter

$result = $client->deleteFindingsFilter([/* ... */]);
$promise = $client->deleteFindingsFilterAsync([/* ... */]);

Deletes a findings filter.

Parameter Syntax

$result = $client->deleteFindingsFilter([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

DeleteInvitations

$result = $client->deleteInvitations([/* ... */]);
$promise = $client->deleteInvitationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteInvitations([
    'accountIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
accountIds
  • Required: Yes
  • Type: Array of strings

Result Syntax

[
    'unprocessedAccounts' => [
        [
            'accountId' => '<string>',
            'errorCode' => 'ClientError|InternalError',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
unprocessedAccounts
  • Type: Array of UnprocessedAccount structures

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

DeleteMember

$result = $client->deleteMember([/* ... */]);
$promise = $client->deleteMemberAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteMember([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

DescribeBuckets

$result = $client->describeBuckets([/* ... */]);
$promise = $client->describeBucketsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeBuckets([
    'criteria' => [
        '<__string>' => [
            'eq' => ['<string>', ...],
            'gt' => <integer>,
            'gte' => <integer>,
            'lt' => <integer>,
            'lte' => <integer>,
            'neq' => ['<string>', ...],
            'prefix' => '<string>',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortCriteria' => [
        'attributeName' => '<string>',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Members
criteria
  • Type: Associative array of custom strings keys (__string) to BucketCriteriaAdditionalProperties structures

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

maxResults
  • Type: int
nextToken
  • Type: string
sortCriteria
  • Type: BucketSortCriteria structure

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

Result Syntax

[
    'buckets' => [
        [
            'accountId' => '<string>',
            'bucketArn' => '<string>',
            'bucketCreatedAt' => <DateTime>,
            'bucketName' => '<string>',
            'classifiableObjectCount' => <integer>,
            'classifiableSizeInBytes' => <integer>,
            'jobDetails' => [
                'isDefinedInJob' => 'TRUE|FALSE|UNKNOWN',
                'isMonitoredByJob' => 'TRUE|FALSE|UNKNOWN',
                'lastJobId' => '<string>',
                'lastJobRunTime' => <DateTime>,
            ],
            'lastUpdated' => <DateTime>,
            'objectCount' => <integer>,
            'objectCountByEncryptionType' => [
                'customerManaged' => <integer>,
                'kmsManaged' => <integer>,
                's3Managed' => <integer>,
                'unencrypted' => <integer>,
            ],
            'publicAccess' => [
                'effectivePermission' => 'PUBLIC|NOT_PUBLIC|UNKNOWN',
                'permissionConfiguration' => [
                    'accountLevelPermissions' => [
                        'blockPublicAccess' => [
                            'blockPublicAcls' => true || false,
                            'blockPublicPolicy' => true || false,
                            'ignorePublicAcls' => true || false,
                            'restrictPublicBuckets' => true || false,
                        ],
                    ],
                    'bucketLevelPermissions' => [
                        'accessControlList' => [
                            'allowsPublicReadAccess' => true || false,
                            'allowsPublicWriteAccess' => true || false,
                        ],
                        'blockPublicAccess' => [
                            'blockPublicAcls' => true || false,
                            'blockPublicPolicy' => true || false,
                            'ignorePublicAcls' => true || false,
                            'restrictPublicBuckets' => true || false,
                        ],
                        'bucketPolicy' => [
                            'allowsPublicReadAccess' => true || false,
                            'allowsPublicWriteAccess' => true || false,
                        ],
                    ],
                ],
            ],
            'region' => '<string>',
            'replicationDetails' => [
                'replicated' => true || false,
                'replicatedExternally' => true || false,
                'replicationAccounts' => ['<string>', ...],
            ],
            'sharedAccess' => 'EXTERNAL|INTERNAL|NOT_SHARED|UNKNOWN',
            'sizeInBytes' => <integer>,
            'sizeInBytesCompressed' => <integer>,
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'unclassifiableObjectCount' => [
                'fileType' => <integer>,
                'storageClass' => <integer>,
                'total' => <integer>,
            ],
            'unclassifiableObjectSizeInBytes' => [
                'fileType' => <integer>,
                'storageClass' => <integer>,
                'total' => <integer>,
            ],
            'versioning' => true || false,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
buckets
  • Type: Array of BucketMetadata structures
nextToken
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

DescribeClassificationJob

$result = $client->describeClassificationJob([/* ... */]);
$promise = $client->describeClassificationJobAsync([/* ... */]);

Retrieves the status and settings for a classification job.

Parameter Syntax

$result = $client->describeClassificationJob([
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
jobId
  • Required: Yes
  • Type: string

Result Syntax

[
    'clientToken' => '<string>',
    'createdAt' => <DateTime>,
    'customDataIdentifierIds' => ['<string>', ...],
    'description' => '<string>',
    'initialRun' => true || false,
    'jobArn' => '<string>',
    'jobId' => '<string>',
    'jobStatus' => 'RUNNING|PAUSED|CANCELLED|COMPLETE|IDLE|USER_PAUSED',
    'jobType' => 'ONE_TIME|SCHEDULED',
    'lastRunErrorStatus' => [
        'code' => 'NONE|ERROR',
    ],
    'lastRunTime' => <DateTime>,
    'name' => '<string>',
    's3JobDefinition' => [
        'bucketDefinitions' => [
            [
                'accountId' => '<string>',
                'buckets' => ['<string>', ...],
            ],
            // ...
        ],
        'scoping' => [
            'excludes' => [
                'and' => [
                    [
                        'simpleScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
                            'key' => 'BUCKET_CREATION_DATE|OBJECT_EXTENSION|OBJECT_LAST_MODIFIED_DATE|OBJECT_SIZE|TAG',
                            'values' => ['<string>', ...],
                        ],
                        'tagScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
                            'key' => '<string>',
                            'tagValues' => [
                                [
                                    'key' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'target' => 'S3_OBJECT',
                        ],
                    ],
                    // ...
                ],
            ],
            'includes' => [
                'and' => [
                    [
                        'simpleScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
                            'key' => 'BUCKET_CREATION_DATE|OBJECT_EXTENSION|OBJECT_LAST_MODIFIED_DATE|OBJECT_SIZE|TAG',
                            'values' => ['<string>', ...],
                        ],
                        'tagScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
                            'key' => '<string>',
                            'tagValues' => [
                                [
                                    'key' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'target' => 'S3_OBJECT',
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'samplingPercentage' => <integer>,
    'scheduleFrequency' => [
        'dailySchedule' => [
        ],
        'monthlySchedule' => [
            'dayOfMonth' => <integer>,
        ],
        'weeklySchedule' => [
            'dayOfWeek' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY',
        ],
    ],
    'statistics' => [
        'approximateNumberOfObjectsToProcess' => <float>,
        'numberOfRuns' => <float>,
    ],
    'tags' => ['<string>', ...],
    'userPausedDetails' => [
        'jobExpiresAt' => <DateTime>,
        'jobImminentExpirationHealthEventArn' => '<string>',
        'jobPausedAt' => <DateTime>,
    ],
]

Result Details

Members
clientToken
  • Type: string
createdAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
customDataIdentifierIds
  • Type: Array of strings
description
  • Type: string
initialRun
  • Type: boolean
jobArn
  • Type: string
jobId
  • Type: string
jobStatus
  • Type: string

The status of a classification job. Possible values are:

jobType
  • Type: string

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

lastRunErrorStatus
  • Type: LastRunErrorStatus structure

Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For example, the job is configured to analyze data for a member account that was suspended, or the job is configured to analyze an S3 bucket that Amazon Macie isn't allowed to access.

lastRunTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
name
  • Type: string
s3JobDefinition
  • Type: S3JobDefinition structure

Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.

samplingPercentage
  • Type: int
scheduleFrequency
  • Type: JobScheduleFrequency structure

Specifies the recurrence pattern for running a classification job.

statistics
  • Type: Statistics structure

Provides processing statistics for a classification job.

tags
  • Type: Associative array of custom strings keys (__string) to strings

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

userPausedDetails
  • Type: UserPausedDetails structure

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.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

DescribeOrganizationConfiguration

$result = $client->describeOrganizationConfiguration([/* ... */]);
$promise = $client->describeOrganizationConfigurationAsync([/* ... */]);

Retrieves the Amazon Macie configuration settings for an AWS organization.

Parameter Syntax

$result = $client->describeOrganizationConfiguration([
]);

Parameter Details

Members

Result Syntax

[
    'autoEnable' => true || false,
    'maxAccountLimitReached' => true || false,
]

Result Details

Members
autoEnable
  • Type: boolean
maxAccountLimitReached
  • Type: boolean

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

DisableMacie

$result = $client->disableMacie([/* ... */]);
$promise = $client->disableMacieAsync([/* ... */]);

Disables an Amazon Macie account and deletes Macie resources for the account.

Parameter Syntax

$result = $client->disableMacie([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

DisableOrganizationAdminAccount

$result = $client->disableOrganizationAdminAccount([/* ... */]);
$promise = $client->disableOrganizationAdminAccountAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disableOrganizationAdminAccount([
    'adminAccountId' => '<string>', // REQUIRED
]);

Parameter Details

Members
adminAccountId
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

DisassociateFromMasterAccount

$result = $client->disassociateFromMasterAccount([/* ... */]);
$promise = $client->disassociateFromMasterAccountAsync([/* ... */]);

Disassociates a member account from its Amazon Macie master account.

Parameter Syntax

$result = $client->disassociateFromMasterAccount([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

DisassociateMember

$result = $client->disassociateMember([/* ... */]);
$promise = $client->disassociateMemberAsync([/* ... */]);

Disassociates an Amazon Macie master account from a member account.

Parameter Syntax

$result = $client->disassociateMember([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

EnableMacie

$result = $client->enableMacie([/* ... */]);
$promise = $client->enableMacieAsync([/* ... */]);

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

Parameter Syntax

$result = $client->enableMacie([
    'clientToken' => '<string>',
    'findingPublishingFrequency' => 'FIFTEEN_MINUTES|ONE_HOUR|SIX_HOURS',
    'status' => 'PAUSED|ENABLED',
]);

Parameter Details

Members
clientToken
  • Type: string
findingPublishingFrequency
  • Type: string

The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Valid values are:

status
  • Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

EnableOrganizationAdminAccount

$result = $client->enableOrganizationAdminAccount([/* ... */]);
$promise = $client->enableOrganizationAdminAccountAsync([/* ... */]);

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

Parameter Syntax

$result = $client->enableOrganizationAdminAccount([
    'adminAccountId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
]);

Parameter Details

Members
adminAccountId
  • Required: Yes
  • Type: string
clientToken
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

GetBucketStatistics

$result = $client->getBucketStatistics([/* ... */]);
$promise = $client->getBucketStatisticsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getBucketStatistics([
    'accountId' => '<string>',
]);

Parameter Details

Members
accountId
  • Type: string

Result Syntax

[
    'bucketCount' => <integer>,
    'bucketCountByEffectivePermission' => [
        'publiclyAccessible' => <integer>,
        'publiclyReadable' => <integer>,
        'publiclyWritable' => <integer>,
        'unknown' => <integer>,
    ],
    'bucketCountByEncryptionType' => [
        'kmsManaged' => <integer>,
        's3Managed' => <integer>,
        'unencrypted' => <integer>,
    ],
    'bucketCountBySharedAccessType' => [
        'external' => <integer>,
        'internal' => <integer>,
        'notShared' => <integer>,
        'unknown' => <integer>,
    ],
    'classifiableObjectCount' => <integer>,
    'classifiableSizeInBytes' => <integer>,
    'lastUpdated' => <DateTime>,
    'objectCount' => <integer>,
    'sizeInBytes' => <integer>,
    'sizeInBytesCompressed' => <integer>,
    'unclassifiableObjectCount' => [
        'fileType' => <integer>,
        'storageClass' => <integer>,
        'total' => <integer>,
    ],
    'unclassifiableObjectSizeInBytes' => [
        'fileType' => <integer>,
        'storageClass' => <integer>,
        'total' => <integer>,
    ],
]

Result Details

Members
bucketCount
  • Type: long (int|float)
bucketCountByEffectivePermission
  • Type: BucketCountByEffectivePermission structure

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

bucketCountByEncryptionType
  • Type: BucketCountByEncryptionType structure

Provides information about the number of S3 buckets that use certain types of server-side encryption or don't encrypt objects by default.

bucketCountBySharedAccessType
  • Type: BucketCountBySharedAccessType structure

Provides information about the number of S3 buckets that are shared with other AWS accounts.

classifiableObjectCount
  • Type: long (int|float)
classifiableSizeInBytes
  • Type: long (int|float)
lastUpdated
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
objectCount
  • Type: long (int|float)
sizeInBytes
  • Type: long (int|float)
sizeInBytesCompressed
  • Type: long (int|float)
unclassifiableObjectCount
  • Type: ObjectLevelStatistics structure

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 object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.

unclassifiableObjectSizeInBytes
  • Type: ObjectLevelStatistics structure

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 object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

GetClassificationExportConfiguration

$result = $client->getClassificationExportConfiguration([/* ... */]);
$promise = $client->getClassificationExportConfigurationAsync([/* ... */]);

Retrieves the configuration settings for storing data classification results.

Parameter Syntax

$result = $client->getClassificationExportConfiguration([
]);

Parameter Details

Members

Result Syntax

[
    'configuration' => [
        's3Destination' => [
            'bucketName' => '<string>',
            'keyPrefix' => '<string>',
            'kmsKeyArn' => '<string>',
        ],
    ],
]

Result Details

Members
configuration
  • Type: ClassificationExportConfiguration structure

Specifies where to store data classification results, and the encryption settings to use when storing results in that location. Currently, you can store classification results only in an S3 bucket.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

GetCustomDataIdentifier

$result = $client->getCustomDataIdentifier([/* ... */]);
$promise = $client->getCustomDataIdentifierAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getCustomDataIdentifier([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
  • Required: Yes
  • Type: string

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'deleted' => true || false,
    'description' => '<string>',
    'id' => '<string>',
    'ignoreWords' => ['<string>', ...],
    'keywords' => ['<string>', ...],
    'maximumMatchDistance' => <integer>,
    'name' => '<string>',
    'regex' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members
arn
  • Type: string
createdAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
deleted
  • Type: boolean
description
  • Type: string
id
  • Type: string
ignoreWords
  • Type: Array of strings
keywords
  • Type: Array of strings
maximumMatchDistance
  • Type: int
name
  • Type: string
regex
  • Type: string
tags
  • Type: Associative array of custom strings keys (__string) to strings

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

GetFindingStatistics

$result = $client->getFindingStatistics([/* ... */]);
$promise = $client->getFindingStatisticsAsync([/* ... */]);

Retrieves (queries) aggregated statistical data about findings.

Parameter Syntax

$result = $client->getFindingStatistics([
    'findingCriteria' => [
        'criterion' => [
            '<__string>' => [
                'eq' => ['<string>', ...],
                'eqExactMatch' => ['<string>', ...],
                'gt' => <integer>,
                'gte' => <integer>,
                'lt' => <integer>,
                'lte' => <integer>,
                'neq' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'groupBy' => 'resourcesAffected.s3Bucket.name|type|classificationDetails.jobId|severity.description', // REQUIRED
    'size' => <integer>,
    'sortCriteria' => [
        'attributeName' => 'groupKey|count',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Members
findingCriteria
  • Type: FindingCriteria structure

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

groupBy
  • Required: Yes
  • Type: string
size
  • Type: int
sortCriteria
  • Type: FindingStatisticsSortCriteria structure

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

Result Syntax

[
    'countsByGroup' => [
        [
            'count' => <integer>,
            'groupKey' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
countsByGroup
  • Type: Array of GroupCount structures

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

GetFindings

$result = $client->getFindings([/* ... */]);
$promise = $client->getFindingsAsync([/* ... */]);

Retrieves the details of one or more findings.

Parameter Syntax

$result = $client->getFindings([
    'findingIds' => ['<string>', ...], // REQUIRED
    'sortCriteria' => [
        'attributeName' => '<string>',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Members
findingIds
  • Required: Yes
  • Type: Array of strings
sortCriteria
  • Type: SortCriteria structure

Specifies criteria for sorting the results of a request for findings.

Result Syntax

[
    'findings' => [
        [
            'accountId' => '<string>',
            'archived' => true || false,
            'category' => 'CLASSIFICATION|POLICY',
            'classificationDetails' => [
                'detailedResultsLocation' => '<string>',
                'jobArn' => '<string>',
                'jobId' => '<string>',
                'result' => [
                    'additionalOccurrences' => true || false,
                    'customDataIdentifiers' => [
                        'detections' => [
                            [
                                'arn' => '<string>',
                                'count' => <integer>,
                                'name' => '<string>',
                                'occurrences' => [
                                    'cells' => [
                                        [
                                            'cellReference' => '<string>',
                                            'column' => <integer>,
                                            'columnName' => '<string>',
                                            'row' => <integer>,
                                        ],
                                        // ...
                                    ],
                                    'lineRanges' => [
                                        [
                                            'end' => <integer>,
                                            'start' => <integer>,
                                            'startColumn' => <integer>,
                                        ],
                                        // ...
                                    ],
                                    'offsetRanges' => [
                                        [
                                            'end' => <integer>,
                                            'start' => <integer>,
                                            'startColumn' => <integer>,
                                        ],
                                        // ...
                                    ],
                                    'pages' => [
                                        [
                                            'lineRange' => [
                                                'end' => <integer>,
                                                'start' => <integer>,
                                                'startColumn' => <integer>,
                                            ],
                                            'offsetRange' => [
                                                'end' => <integer>,
                                                'start' => <integer>,
                                                'startColumn' => <integer>,
                                            ],
                                            'pageNumber' => <integer>,
                                        ],
                                        // ...
                                    ],
                                    'records' => [
                                        [
                                            'jsonPath' => '<string>',
                                            'recordIndex' => <integer>,
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'totalCount' => <integer>,
                    ],
                    'mimeType' => '<string>',
                    'sensitiveData' => [
                        [
                            'category' => 'FINANCIAL_INFORMATION|PERSONAL_INFORMATION|CREDENTIALS|CUSTOM_IDENTIFIER',
                            'detections' => [
                                [
                                    'count' => <integer>,
                                    'occurrences' => [
                                        'cells' => [
                                            [
                                                'cellReference' => '<string>',
                                                'column' => <integer>,
                                                'columnName' => '<string>',
                                                'row' => <integer>,
                                            ],
                                            // ...
                                        ],
                                        'lineRanges' => [
                                            [
                                                'end' => <integer>,
                                                'start' => <integer>,
                                                'startColumn' => <integer>,
                                            ],
                                            // ...
                                        ],
                                        'offsetRanges' => [
                                            [
                                                'end' => <integer>,
                                                'start' => <integer>,
                                                'startColumn' => <integer>,
                                            ],
                                            // ...
                                        ],
                                        'pages' => [
                                            [
                                                'lineRange' => [
                                                    'end' => <integer>,
                                                    'start' => <integer>,
                                                    'startColumn' => <integer>,
                                                ],
                                                'offsetRange' => [
                                                    'end' => <integer>,
                                                    'start' => <integer>,
                                                    'startColumn' => <integer>,
                                                ],
                                                'pageNumber' => <integer>,
                                            ],
                                            // ...
                                        ],
                                        'records' => [
                                            [
                                                'jsonPath' => '<string>',
                                                'recordIndex' => <integer>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'type' => '<string>',
                                ],
                                // ...
                            ],
                            'totalCount' => <integer>,
                        ],
                        // ...
                    ],
                    'sizeClassified' => <integer>,
                    'status' => [
                        'code' => '<string>',
                        'reason' => '<string>',
                    ],
                ],
            ],
            'count' => <integer>,
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'partition' => '<string>',
            'policyDetails' => [
                'action' => [
                    'actionType' => 'AWS_API_CALL',
                    'apiCallDetails' => [
                        'api' => '<string>',
                        'apiServiceName' => '<string>',
                        'firstSeen' => <DateTime>,
                        'lastSeen' => <DateTime>,
                    ],
                ],
                'actor' => [
                    'domainDetails' => [
                        'domainName' => '<string>',
                    ],
                    'ipAddressDetails' => [
                        'ipAddressV4' => '<string>',
                        'ipCity' => [
                            'name' => '<string>',
                        ],
                        'ipCountry' => [
                            'code' => '<string>',
                            'name' => '<string>',
                        ],
                        'ipGeoLocation' => [
                            'lat' => <float>,
                            'lon' => <float>,
                        ],
                        'ipOwner' => [
                            'asn' => '<string>',
                            'asnOrg' => '<string>',
                            'isp' => '<string>',
                            'org' => '<string>',
                        ],
                    ],
                    'userIdentity' => [
                        'assumedRole' => [
                            'accessKeyId' => '<string>',
                            'accountId' => '<string>',
                            'arn' => '<string>',
                            'principalId' => '<string>',
                            'sessionContext' => [
                                'attributes' => [
                                    'creationDate' => <DateTime>,
                                    'mfaAuthenticated' => true || false,
                                ],
                                'sessionIssuer' => [
                                    'accountId' => '<string>',
                                    'arn' => '<string>',
                                    'principalId' => '<string>',
                                    'type' => '<string>',
                                    'userName' => '<string>',
                                ],
                            ],
                        ],
                        'awsAccount' => [
                            'accountId' => '<string>',
                            'principalId' => '<string>',
                        ],
                        'awsService' => [
                            'invokedBy' => '<string>',
                        ],
                        'federatedUser' => [
                            'accessKeyId' => '<string>',
                            'accountId' => '<string>',
                            'arn' => '<string>',
                            'principalId' => '<string>',
                            'sessionContext' => [
                                'attributes' => [
                                    'creationDate' => <DateTime>,
                                    'mfaAuthenticated' => true || false,
                                ],
                                'sessionIssuer' => [
                                    'accountId' => '<string>',
                                    'arn' => '<string>',
                                    'principalId' => '<string>',
                                    'type' => '<string>',
                                    'userName' => '<string>',
                                ],
                            ],
                        ],
                        'iamUser' => [
                            'accountId' => '<string>',
                            'arn' => '<string>',
                            'principalId' => '<string>',
                            'userName' => '<string>',
                        ],
                        'root' => [
                            'accountId' => '<string>',
                            'arn' => '<string>',
                            'principalId' => '<string>',
                        ],
                        'type' => 'AssumedRole|IAMUser|FederatedUser|Root|AWSAccount|AWSService',
                    ],
                ],
            ],
            'region' => '<string>',
            'resourcesAffected' => [
                's3Bucket' => [
                    'arn' => '<string>',
                    'createdAt' => <DateTime>,
                    'defaultServerSideEncryption' => [
                        'encryptionType' => 'NONE|AES256|aws:kms|UNKNOWN',
                        'kmsMasterKeyId' => '<string>',
                    ],
                    'name' => '<string>',
                    'owner' => [
                        'displayName' => '<string>',
                        'id' => '<string>',
                    ],
                    'publicAccess' => [
                        'effectivePermission' => 'PUBLIC|NOT_PUBLIC|UNKNOWN',
                        'permissionConfiguration' => [
                            'accountLevelPermissions' => [
                                'blockPublicAccess' => [
                                    'blockPublicAcls' => true || false,
                                    'blockPublicPolicy' => true || false,
                                    'ignorePublicAcls' => true || false,
                                    'restrictPublicBuckets' => true || false,
                                ],
                            ],
                            'bucketLevelPermissions' => [
                                'accessControlList' => [
                                    'allowsPublicReadAccess' => true || false,
                                    'allowsPublicWriteAccess' => true || false,
                                ],
                                'blockPublicAccess' => [
                                    'blockPublicAcls' => true || false,
                                    'blockPublicPolicy' => true || false,
                                    'ignorePublicAcls' => true || false,
                                    'restrictPublicBuckets' => true || false,
                                ],
                                'bucketPolicy' => [
                                    'allowsPublicReadAccess' => true || false,
                                    'allowsPublicWriteAccess' => true || false,
                                ],
                            ],
                        ],
                    ],
                    'tags' => [
                        [
                            'key' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                's3Object' => [
                    'bucketArn' => '<string>',
                    'eTag' => '<string>',
                    'extension' => '<string>',
                    'key' => '<string>',
                    'lastModified' => <DateTime>,
                    'path' => '<string>',
                    'publicAccess' => true || false,
                    'serverSideEncryption' => [
                        'encryptionType' => 'NONE|AES256|aws:kms|UNKNOWN',
                        'kmsMasterKeyId' => '<string>',
                    ],
                    'size' => <integer>,
                    'storageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|ONEZONE_IA|GLACIER',
                    'tags' => [
                        [
                            'key' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'versionId' => '<string>',
                ],
            ],
            'sample' => true || false,
            'schemaVersion' => '<string>',
            'severity' => [
                'description' => 'Low|Medium|High',
                'score' => <integer>,
            ],
            'title' => '<string>',
            'type' => 'SensitiveData:S3Object/Multiple|SensitiveData:S3Object/Financial|SensitiveData:S3Object/Personal|SensitiveData:S3Object/Credentials|SensitiveData:S3Object/CustomIdentifier|Policy:IAMUser/S3BucketPublic|Policy:IAMUser/S3BucketSharedExternally|Policy:IAMUser/S3BucketReplicatedExternally|Policy:IAMUser/S3BucketEncryptionDisabled|Policy:IAMUser/S3BlockPublicAccessDisabled',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
findings
  • Type: Array of Finding structures

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

GetFindingsFilter

$result = $client->getFindingsFilter([/* ... */]);
$promise = $client->getFindingsFilterAsync([/* ... */]);

Retrieves the criteria and other settings for a findings filter.

Parameter Syntax

$result = $client->getFindingsFilter([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
  • Required: Yes
  • Type: string

Result Syntax

[
    'action' => 'ARCHIVE|NOOP',
    'arn' => '<string>',
    'description' => '<string>',
    'findingCriteria' => [
        'criterion' => [
            '<__string>' => [
                'eq' => ['<string>', ...],
                'eqExactMatch' => ['<string>', ...],
                'gt' => <integer>,
                'gte' => <integer>,
                'lt' => <integer>,
                'lte' => <integer>,
                'neq' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'id' => '<string>',
    'name' => '<string>',
    'position' => <integer>,
    'tags' => ['<string>', ...],
]

Result Details

Members
action
  • Type: string

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

arn
  • Type: string
description
  • Type: string
findingCriteria
  • Type: FindingCriteria structure

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

id
  • Type: string
name
  • Type: string
position
  • Type: int
tags
  • Type: Associative array of custom strings keys (__string) to strings

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

GetInvitationsCount

$result = $client->getInvitationsCount([/* ... */]);
$promise = $client->getInvitationsCountAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getInvitationsCount([
]);

Parameter Details

Members

Result Syntax

[
    'invitationsCount' => <integer>,
]

Result Details

Members
invitationsCount
  • Type: long (int|float)

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

GetMacieSession

$result = $client->getMacieSession([/* ... */]);
$promise = $client->getMacieSessionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getMacieSession([
]);

Parameter Details

Members

Result Syntax

[
    'createdAt' => <DateTime>,
    'findingPublishingFrequency' => 'FIFTEEN_MINUTES|ONE_HOUR|SIX_HOURS',
    'serviceRole' => '<string>',
    'status' => 'PAUSED|ENABLED',
    'updatedAt' => <DateTime>,
]

Result Details

Members
createdAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
findingPublishingFrequency
  • Type: string

The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Valid values are:

serviceRole
  • Type: string
status
  • Type: string

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

updatedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

GetMasterAccount

$result = $client->getMasterAccount([/* ... */]);
$promise = $client->getMasterAccountAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getMasterAccount([
]);

Parameter Details

Members

Result Syntax

[
    'master' => [
        'accountId' => '<string>',
        'invitationId' => '<string>',
        'invitedAt' => <DateTime>,
        'relationshipStatus' => 'Enabled|Paused|Invited|Created|Removed|Resigned|EmailVerificationInProgress|EmailVerificationFailed|RegionDisabled|AccountSuspended',
    ],
]

Result Details

Members
master
  • Type: Invitation structure

Provides information about an Amazon Macie membership invitation that was received by an account.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

GetMember

$result = $client->getMember([/* ... */]);
$promise = $client->getMemberAsync([/* ... */]);

Retrieves information about a member account that's associated with an Amazon Macie master account.

Parameter Syntax

$result = $client->getMember([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
  • Required: Yes
  • Type: string

Result Syntax

[
    'accountId' => '<string>',
    'arn' => '<string>',
    'email' => '<string>',
    'invitedAt' => <DateTime>,
    'masterAccountId' => '<string>',
    'relationshipStatus' => 'Enabled|Paused|Invited|Created|Removed|Resigned|EmailVerificationInProgress|EmailVerificationFailed|RegionDisabled|AccountSuspended',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Members
accountId
  • Type: string
arn
  • Type: string
email
  • Type: string
invitedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
masterAccountId
  • Type: string
relationshipStatus
  • Type: string

The current status of the relationship between an account and an associated Amazon Macie master account (inviter account). Possible values are:

tags
  • Type: Associative array of custom strings keys (__string) to strings

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

updatedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

GetUsageStatistics

$result = $client->getUsageStatistics([/* ... */]);
$promise = $client->getUsageStatisticsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getUsageStatistics([
    'filterBy' => [
        [
            'comparator' => 'GT|GTE|LT|LTE|EQ|NE|CONTAINS',
            'key' => 'accountId|serviceLimit|freeTrialStartDate|total',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'key' => 'accountId|total|serviceLimitValue|freeTrialStartDate',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Members
filterBy
  • Type: Array of UsageStatisticsFilter structures
maxResults
  • Type: int
nextToken
  • Type: string
sortBy
  • Type: UsageStatisticsSortBy structure

Specifies criteria for sorting the results of a query for account quotas and usage data.

Result Syntax

[
    'nextToken' => '<string>',
    'records' => [
        [
            'accountId' => '<string>',
            'freeTrialStartDate' => <DateTime>,
            'usage' => [
                [
                    'currency' => 'USD',
                    'estimatedCost' => '<string>',
                    'serviceLimit' => [
                        'isServiceLimited' => true || false,
                        'unit' => 'TERABYTES',
                        'value' => <integer>,
                    ],
                    'type' => 'DATA_INVENTORY_EVALUATION|SENSITIVE_DATA_DISCOVERY',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string
records
  • Type: Array of UsageRecord structures

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

GetUsageTotals

$result = $client->getUsageTotals([/* ... */]);
$promise = $client->getUsageTotalsAsync([/* ... */]);

Retrieves (queries) aggregated usage data for an account.

Parameter Syntax

$result = $client->getUsageTotals([
]);

Parameter Details

Members

Result Syntax

[
    'usageTotals' => [
        [
            'currency' => 'USD',
            'estimatedCost' => '<string>',
            'type' => 'DATA_INVENTORY_EVALUATION|SENSITIVE_DATA_DISCOVERY',
        ],
        // ...
    ],
]

Result Details

Members
usageTotals
  • Type: Array of UsageTotal structures

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

ListClassificationJobs

$result = $client->listClassificationJobs([/* ... */]);
$promise = $client->listClassificationJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listClassificationJobs([
    'filterCriteria' => [
        'excludes' => [
            [
                'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
                'key' => 'jobType|jobStatus|createdAt|name',
                'values' => ['<string>', ...],
            ],
            // ...
        ],
        'includes' => [
            [
                'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
                'key' => 'jobType|jobStatus|createdAt|name',
                'values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortCriteria' => [
        'attributeName' => 'createdAt|jobStatus|name|jobType',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Members
filterCriteria
  • Type: ListJobsFilterCriteria structure

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

maxResults
  • Type: int
nextToken
  • Type: string
sortCriteria
  • Type: ListJobsSortCriteria structure

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

Result Syntax

[
    'items' => [
        [
            'bucketDefinitions' => [
                [
                    'accountId' => '<string>',
                    'buckets' => ['<string>', ...],
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'jobId' => '<string>',
            'jobStatus' => 'RUNNING|PAUSED|CANCELLED|COMPLETE|IDLE|USER_PAUSED',
            'jobType' => 'ONE_TIME|SCHEDULED',
            'lastRunErrorStatus' => [
                'code' => 'NONE|ERROR',
            ],
            'name' => '<string>',
            'userPausedDetails' => [
                'jobExpiresAt' => <DateTime>,
                'jobImminentExpirationHealthEventArn' => '<string>',
                'jobPausedAt' => <DateTime>,
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
items
  • Type: Array of JobSummary structures
nextToken
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

ListCustomDataIdentifiers

$result = $client->listCustomDataIdentifiers([/* ... */]);
$promise = $client->listCustomDataIdentifiersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listCustomDataIdentifiers([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int
nextToken
  • Type: string

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
items
  • Type: Array of CustomDataIdentifierSummary structures
nextToken
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

ListFindings

$result = $client->listFindings([/* ... */]);
$promise = $client->listFindingsAsync([/* ... */]);

Retrieves a subset of information about one or more findings.

Parameter Syntax

$result = $client->listFindings([
    'findingCriteria' => [
        'criterion' => [
            '<__string>' => [
                'eq' => ['<string>', ...],
                'eqExactMatch' => ['<string>', ...],
                'gt' => <integer>,
                'gte' => <integer>,
                'lt' => <integer>,
                'lte' => <integer>,
                'neq' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortCriteria' => [
        'attributeName' => '<string>',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Members
findingCriteria
  • Type: FindingCriteria structure

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

maxResults
  • Type: int
nextToken
  • Type: string
sortCriteria
  • Type: SortCriteria structure

Specifies criteria for sorting the results of a request for findings.

Result Syntax

[
    'findingIds' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Members
findingIds
  • Type: Array of strings
nextToken
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

ListFindingsFilters

$result = $client->listFindingsFilters([/* ... */]);
$promise = $client->listFindingsFiltersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listFindingsFilters([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int
nextToken
  • Type: string

Result Syntax

[
    'findingsFilterListItems' => [
        [
            'action' => 'ARCHIVE|NOOP',
            'arn' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
findingsFilterListItems
  • Type: Array of FindingsFilterListItem structures
nextToken
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

ListInvitations

$result = $client->listInvitations([/* ... */]);
$promise = $client->listInvitationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listInvitations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int
nextToken
  • Type: string

Result Syntax

[
    'invitations' => [
        [
            'accountId' => '<string>',
            'invitationId' => '<string>',
            'invitedAt' => <DateTime>,
            'relationshipStatus' => 'Enabled|Paused|Invited|Created|Removed|Resigned|EmailVerificationInProgress|EmailVerificationFailed|RegionDisabled|AccountSuspended',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
invitations
  • Type: Array of Invitation structures
nextToken
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

ListMembers

$result = $client->listMembers([/* ... */]);
$promise = $client->listMembersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listMembers([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'onlyAssociated' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int
nextToken
  • Type: string
onlyAssociated
  • Type: string

Result Syntax

[
    'members' => [
        [
            'accountId' => '<string>',
            'arn' => '<string>',
            'email' => '<string>',
            'invitedAt' => <DateTime>,
            'masterAccountId' => '<string>',
            'relationshipStatus' => 'Enabled|Paused|Invited|Created|Removed|Resigned|EmailVerificationInProgress|EmailVerificationFailed|RegionDisabled|AccountSuspended',
            'tags' => ['<string>', ...],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
members
  • Type: Array of Member structures
nextToken
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

ListOrganizationAdminAccounts

$result = $client->listOrganizationAdminAccounts([/* ... */]);
$promise = $client->listOrganizationAdminAccountsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listOrganizationAdminAccounts([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int
nextToken
  • Type: string

Result Syntax

[
    'adminAccounts' => [
        [
            'accountId' => '<string>',
            'status' => 'ENABLED|DISABLING_IN_PROGRESS',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
adminAccounts
  • Type: Array of AdminAccount structures
nextToken
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
  • Type: Associative array of custom strings keys (__string) to strings

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

Errors

There are no errors described for this operation.

PutClassificationExportConfiguration

$result = $client->putClassificationExportConfiguration([/* ... */]);
$promise = $client->putClassificationExportConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putClassificationExportConfiguration([
    'configuration' => [ // REQUIRED
        's3Destination' => [
            'bucketName' => '<string>', // REQUIRED
            'keyPrefix' => '<string>',
            'kmsKeyArn' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
configuration
  • Required: Yes
  • Type: ClassificationExportConfiguration structure

Specifies where to store data classification results, and the encryption settings to use when storing results in that location. Currently, you can store classification results only in an S3 bucket.

Result Syntax

[
    'configuration' => [
        's3Destination' => [
            'bucketName' => '<string>',
            'keyPrefix' => '<string>',
            'kmsKeyArn' => '<string>',
        ],
    ],
]

Result Details

Members
configuration
  • Type: ClassificationExportConfiguration structure

Specifies where to store data classification results, and the encryption settings to use when storing results in that location. Currently, you can store classification results only in an S3 bucket.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string
tags
  • Required: Yes
  • Type: Associative array of custom strings keys (__string) to strings

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

TestCustomDataIdentifier

$result = $client->testCustomDataIdentifier([/* ... */]);
$promise = $client->testCustomDataIdentifierAsync([/* ... */]);

Tests a custom data identifier.

Parameter Syntax

$result = $client->testCustomDataIdentifier([
    'ignoreWords' => ['<string>', ...],
    'keywords' => ['<string>', ...],
    'maximumMatchDistance' => <integer>,
    'regex' => '<string>', // REQUIRED
    'sampleText' => '<string>', // REQUIRED
]);

Parameter Details

Members
ignoreWords
  • Type: Array of strings
keywords
  • Type: Array of strings
maximumMatchDistance
  • Type: int
regex
  • Required: Yes
  • Type: string
sampleText
  • Required: Yes
  • Type: string

Result Syntax

[
    'matchCount' => <integer>,
]

Result Details

Members
matchCount
  • Type: int

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string
tagKeys
  • Required: Yes
  • Type: Array of strings

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

UpdateClassificationJob

$result = $client->updateClassificationJob([/* ... */]);
$promise = $client->updateClassificationJobAsync([/* ... */]);

Changes the status of a classification job.

Parameter Syntax

$result = $client->updateClassificationJob([
    'jobId' => '<string>', // REQUIRED
    'jobStatus' => 'RUNNING|PAUSED|CANCELLED|COMPLETE|IDLE|USER_PAUSED', // REQUIRED
]);

Parameter Details

Members
jobId
  • Required: Yes
  • Type: string
jobStatus
  • Required: Yes
  • Type: string

The status of a classification job. Possible values are:

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

UpdateFindingsFilter

$result = $client->updateFindingsFilter([/* ... */]);
$promise = $client->updateFindingsFilterAsync([/* ... */]);

Updates the criteria and other settings for a findings filter.

Parameter Syntax

$result = $client->updateFindingsFilter([
    'action' => 'ARCHIVE|NOOP',
    'description' => '<string>',
    'findingCriteria' => [
        'criterion' => [
            '<__string>' => [
                'eq' => ['<string>', ...],
                'eqExactMatch' => ['<string>', ...],
                'gt' => <integer>,
                'gte' => <integer>,
                'lt' => <integer>,
                'lte' => <integer>,
                'neq' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'id' => '<string>', // REQUIRED
    'name' => '<string>',
    'position' => <integer>,
]);

Parameter Details

Members
action
  • Type: string

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

description
  • Type: string
findingCriteria
  • Type: FindingCriteria structure

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

id
  • Required: Yes
  • Type: string
name
  • Type: string
position
  • Type: int

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
]

Result Details

Members
arn
  • Type: string
id
  • Type: string

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

UpdateMacieSession

$result = $client->updateMacieSession([/* ... */]);
$promise = $client->updateMacieSessionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateMacieSession([
    'findingPublishingFrequency' => 'FIFTEEN_MINUTES|ONE_HOUR|SIX_HOURS',
    'status' => 'PAUSED|ENABLED',
]);

Parameter Details

Members
findingPublishingFrequency
  • Type: string

The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Valid values are:

status
  • Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

UpdateMemberSession

$result = $client->updateMemberSession([/* ... */]);
$promise = $client->updateMemberSessionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateMemberSession([
    'id' => '<string>', // REQUIRED
    'status' => 'PAUSED|ENABLED', // REQUIRED
]);

Parameter Details

Members
id
  • Required: Yes
  • Type: string
status
  • Required: Yes
  • Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

UpdateOrganizationConfiguration

$result = $client->updateOrganizationConfiguration([/* ... */]);
$promise = $client->updateOrganizationConfigurationAsync([/* ... */]);

Updates the Amazon Macie configuration settings for an AWS organization.

Parameter Syntax

$result = $client->updateOrganizationConfiguration([
    'autoEnable' => true || false, // REQUIRED
]);

Parameter Details

Members
autoEnable
  • Required: Yes
  • Type: boolean

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Provides information about an error that occurred due to a syntax error in a request.

  • InternalServerException:

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

  • ServiceQuotaExceededException:

    Provides information about an error that occurred due to one or more service quotas for an account.

  • AccessDeniedException:

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

  • ResourceNotFoundException:

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

  • ThrottlingException:

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ConflictException:

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

Shapes

AccessControlList

Description

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

Members
allowsPublicReadAccess
  • Type: boolean
allowsPublicWriteAccess
  • Type: boolean

AccessDeniedException

Description

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

Members
message
  • Type: string

AccountDetail

Description

Specifies details for an account to associate with an Amazon Macie master account.

Members
accountId
  • Required: Yes
  • Type: string
email
  • Required: Yes
  • Type: string

AccountLevelPermissions

Description

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

Members
blockPublicAccess
  • Type: BlockPublicAccess structure

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

AdminAccount

Description

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

Members
accountId
  • Type: string
status
  • Type: string

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

ApiCallDetails

Description

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

Members
api
  • Type: string
apiServiceName
  • Type: string
firstSeen
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
lastSeen
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

AssumedRole

Description

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 AWS Security Token Service (AWS STS) API.

Members
accessKeyId
  • Type: string
accountId
  • Type: string
arn
  • Type: string
principalId
  • Type: string
sessionContext
  • Type: SessionContext structure

Provides information about a session that was created for an entity that performed an action by using temporary security credentials.

AwsAccount

Description

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

Members
accountId
  • Type: string
principalId
  • Type: string

AwsService

Description

Provides information about an AWS service that performed an action on an affected resource.

Members
invokedBy
  • Type: string

BatchGetCustomDataIdentifierSummary

Description

Provides information about a custom data identifier.

Members
arn
  • Type: string
createdAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
deleted
  • Type: boolean
description
  • Type: string
id
  • Type: string
name
  • Type: string

BlockPublicAccess

Description

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

Members
blockPublicAcls
  • Type: boolean
blockPublicPolicy
  • Type: boolean
ignorePublicAcls
  • Type: boolean
restrictPublicBuckets
  • Type: boolean

BucketCountByEffectivePermission

Description

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

Members
publiclyAccessible
  • Type: long (int|float)
publiclyReadable
  • Type: long (int|float)
publiclyWritable
  • Type: long (int|float)
unknown
  • Type: long (int|float)

BucketCountByEncryptionType

Description

Provides information about the number of S3 buckets that use certain types of server-side encryption or don't encrypt objects by default.

Members
kmsManaged
  • Type: long (int|float)
s3Managed
  • Type: long (int|float)
unencrypted
  • Type: long (int|float)

BucketCountBySharedAccessType

Description

Provides information about the number of S3 buckets that are shared with other AWS accounts.

Members
external
  • Type: long (int|float)
internal
  • Type: long (int|float)
notShared
  • Type: long (int|float)
unknown
  • Type: long (int|float)

BucketCriteriaAdditionalProperties

Description

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

Members
eq
  • Type: Array of strings
gt
  • Type: long (int|float)
gte
  • Type: long (int|float)
lt
  • Type: long (int|float)
lte
  • Type: long (int|float)
neq
  • Type: Array of strings
prefix
  • Type: string

BucketLevelPermissions

Description

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

Members
accessControlList
  • Type: AccessControlList structure

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

blockPublicAccess
  • Type: BlockPublicAccess structure

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

bucketPolicy
  • Type: BucketPolicy structure

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

BucketMetadata

Description

Provides information about an S3 bucket that Amazon Macie monitors and analyzes.

Members
accountId
  • Type: string
bucketArn
  • Type: string
bucketCreatedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
bucketName
  • Type: string
classifiableObjectCount
  • Type: long (int|float)
classifiableSizeInBytes
  • Type: long (int|float)
jobDetails
  • Type: JobDetails structure

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.

lastUpdated
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
objectCount
  • Type: long (int|float)
objectCountByEncryptionType
  • Type: ObjectCountByEncryptionType structure

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.

publicAccess
  • Type: BucketPublicAccess structure

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

region
  • Type: string
replicationDetails
  • Type: ReplicationDetails structure

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

sharedAccess
  • Type: string
sizeInBytes
  • Type: long (int|float)
sizeInBytesCompressed
  • Type: long (int|float)
tags
  • Type: Array of KeyValuePair structures
unclassifiableObjectCount
  • Type: ObjectLevelStatistics structure

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 object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.

unclassifiableObjectSizeInBytes
  • Type: ObjectLevelStatistics structure

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 object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.

versioning
  • Type: boolean

BucketPermissionConfiguration

Description

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

Members
accountLevelPermissions
  • Type: AccountLevelPermissions structure

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

bucketLevelPermissions
  • Type: BucketLevelPermissions structure

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

BucketPolicy

Description

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

Members
allowsPublicReadAccess
  • Type: boolean
allowsPublicWriteAccess
  • Type: boolean

BucketPublicAccess

Description

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

Members
effectivePermission
  • Type: string
permissionConfiguration
  • Type: BucketPermissionConfiguration structure

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

BucketSortCriteria

Description

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

Members
attributeName
  • Type: string
orderBy
  • Type: string

Cell

Description

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

Members
cellReference
  • Type: string
column
  • Type: long (int|float)
columnName
  • Type: string
row
  • Type: long (int|float)

ClassificationDetails

Description

Provides information about a sensitive data finding, including the classification job that produced the finding.

Members
detailedResultsLocation
  • Type: string
jobArn
  • Type: string
jobId
  • Type: string
result
  • Type: ClassificationResult structure

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

ClassificationExportConfiguration

Description

Specifies where to store data classification results, and the encryption settings to use when storing results in that location. Currently, you can store classification results only in an S3 bucket.

Members
s3Destination
  • Type: S3Destination structure

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

ClassificationResult

Description

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

Members
additionalOccurrences
  • Type: boolean
customDataIdentifiers
  • Type: CustomDataIdentifiers structure

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.

mimeType
  • Type: string
sensitiveData
  • Type: Array of SensitiveDataItem structures

Provides information about the category and number of occurrences of sensitive data that produced a finding.

sizeClassified
  • Type: long (int|float)
status
  • Type: ClassificationResultStatus structure

Provides information about the status of a sensitive data finding.

ClassificationResultStatus

Description

Provides information about the status of a sensitive data finding.

Members
code
  • Type: string
reason
  • Type: string

ConflictException

Description

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

Members
message
  • Type: string

CriterionAdditionalProperties

Description

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.

Members
eq
  • Type: Array of strings
eqExactMatch
  • Type: Array of strings
gt
  • Type: long (int|float)
gte
  • Type: long (int|float)
lt
  • Type: long (int|float)
lte
  • Type: long (int|float)
neq
  • Type: Array of strings

CustomDataIdentifierSummary

Description

Provides information about a custom data identifier.

Members
arn
  • Type: string
createdAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
description
  • Type: string
id
  • Type: string
name
  • Type: string

CustomDataIdentifiers

Description

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.

Members
detections
  • Type: Array of CustomDetection structures

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

totalCount
  • Type: long (int|float)

CustomDetection

Description

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

Members
arn
  • Type: string
count
  • Type: long (int|float)
name
  • Type: string
occurrences
  • Type: Occurrences structure

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

DailySchedule

Description

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

Members

DefaultDetection

Description

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

Members
count
  • Type: long (int|float)
occurrences
  • Type: Occurrences structure

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

type
  • Type: string

DomainDetails

Description

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

Members
domainName
  • Type: string

Empty

Description

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

Members

FederatedUser

Description

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 AWS Security Token Service (AWS STS) API.

Members
accessKeyId
  • Type: string
accountId
  • Type: string
arn
  • Type: string
principalId
  • Type: string
sessionContext
  • Type: SessionContext structure

Provides information about a session that was created for an entity that performed an action by using temporary security credentials.

Finding

Description

Provides the details of a finding.

Members
accountId
  • Type: string
archived
  • Type: boolean
category
  • Type: string

The category of the finding. Valid values are:

classificationDetails
  • Type: ClassificationDetails structure

Provides information about a sensitive data finding, including the classification job that produced the finding.

count
  • Type: long (int|float)
createdAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
description
  • Type: string
id
  • Type: string
partition
  • Type: string
policyDetails
  • Type: PolicyDetails structure

Provides the details of a policy finding.

region
  • Type: string
resourcesAffected
  • Type: ResourcesAffected structure

Provides information about the resources that a finding applies to.

sample
  • Type: boolean
schemaVersion
  • Type: string
severity
  • Type: Severity structure

Provides the numerical and qualitative representations of a finding's severity.

title
  • Type: string
type
  • Type: string

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

updatedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

FindingAction

Description

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

Members
actionType
  • Type: string

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

apiCallDetails
  • Type: ApiCallDetails structure

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

FindingActor

Description

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

Members
domainDetails
  • Type: DomainDetails structure

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

ipAddressDetails
  • Type: IpAddressDetails structure

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

userIdentity
  • Type: UserIdentity structure

Provides information about the type and other characteristics of an entity that performed an action on an affected resource.

FindingCriteria

Description

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

Members
criterion
  • Type: Associative array of custom strings keys (__string) to CriterionAdditionalProperties structures

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.

FindingStatisticsSortCriteria

Description

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

Members
attributeName
  • Type: string

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

orderBy
  • Type: string

FindingsFilterListItem

Description

Provides information about a findings filter.

Members
action
  • Type: string

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

arn
  • Type: string
id
  • Type: string
name
  • Type: string
tags
  • Type: Associative array of custom strings keys (__string) to strings

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

GroupCount

Description

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

Members
count
  • Type: long (int|float)
groupKey
  • Type: string

IamUser

Description

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

Members
accountId
  • Type: string
arn
  • Type: string
principalId
  • Type: string
userName
  • Type: string

InternalServerException

Description

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

Members
message
  • Type: string

Invitation

Description

Provides information about an Amazon Macie membership invitation that was received by an account.

Members
accountId
  • Type: string
invitationId
  • Type: string
invitedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
relationshipStatus
  • Type: string

The current status of the relationship between an account and an associated Amazon Macie master account (inviter account). Possible values are:

IpAddressDetails

Description

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

Members
ipAddressV4
  • Type: string
ipCity
  • Type: IpCity structure

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

ipCountry
  • Type: IpCountry structure

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

ipGeoLocation
  • Type: IpGeoLocation structure

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

ipOwner
  • Type: IpOwner structure

Provides information about the registered owner of an IP address.

IpCity

Description

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

Members
name
  • Type: string

IpCountry

Description

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

Members
code
  • Type: string
name
  • Type: string

IpGeoLocation

Description

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

Members
lat
  • Type: double
lon
  • Type: double

IpOwner

Description

Provides information about the registered owner of an IP address.

Members
asn
  • Type: string
asnOrg
  • Type: string
isp
  • Type: string
org
  • Type: string

JobDetails

Description

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.

Members
isDefinedInJob
  • Type: string
isMonitoredByJob
  • Type: string
lastJobId
  • Type: string
lastJobRunTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

JobScheduleFrequency

Description

Specifies the recurrence pattern for running a classification job.

Members
dailySchedule
  • Type: DailySchedule structure

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

monthlySchedule
  • Type: MonthlySchedule structure

Specifies a monthly recurrence pattern for running a classification job.

weeklySchedule
  • Type: WeeklySchedule structure

Specifies a weekly recurrence pattern for running a classification job.

JobScopeTerm

Description

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

Members
simpleScopeTerm
  • Type: SimpleScopeTerm structure

Specifies a property-based condition that determines whether an object is included or excluded from a classification job.

tagScopeTerm
  • Type: TagScopeTerm structure

Specifies a tag-based condition that determines whether an object is included or excluded from a classification job.

JobScopingBlock

Description

Specifies one or more property- and tag-based conditions that define criteria for including or excluding objects from a classification job. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

Members
and
  • Type: Array of JobScopeTerm structures

JobSummary

Description

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

Members
bucketDefinitions
  • Type: Array of S3BucketDefinitionForJob structures
createdAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
jobId
  • Type: string
jobStatus
  • Type: string

The status of a classification job. Possible values are:

jobType
  • Type: string

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

lastRunErrorStatus
  • Type: LastRunErrorStatus structure

Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For example, the job is configured to analyze data for a member account that was suspended, or the job is configured to analyze an S3 bucket that Amazon Macie isn't allowed to access.

name
  • Type: string
userPausedDetails
  • Type: UserPausedDetails structure

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.

KeyValuePair

Description

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.

Members
key
  • Type: string
value
  • Type: string

LastRunErrorStatus

Description

Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For example, the job is configured to analyze data for a member account that was suspended, or the job is configured to analyze an S3 bucket that Amazon Macie isn't allowed to access.

Members
code
  • Type: string

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:

ListJobsFilterCriteria

Description

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

Members
excludes
  • Type: Array of ListJobsFilterTerm structures
includes
  • Type: Array of ListJobsFilterTerm structures

ListJobsFilterTerm

Description

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.

Members
comparator
  • Type: string

The operator to use in a condition. Valid values are:

key
  • Type: string

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

values
  • Type: Array of strings

ListJobsSortCriteria

Description

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

Members
attributeName
  • Type: string

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

orderBy
  • Type: string

Member

Description

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

Members
accountId
  • Type: string
arn
  • Type: string
email
  • Type: string
invitedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
masterAccountId
  • Type: string
relationshipStatus
  • Type: string

The current status of the relationship between an account and an associated Amazon Macie master account (inviter account). Possible values are:

tags
  • Type: Associative array of custom strings keys (__string) to strings

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

updatedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

MonthlySchedule

Description

Specifies a monthly recurrence pattern for running a classification job.

Members
dayOfMonth
  • Type: int

ObjectCountByEncryptionType

Description

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.

Members
customerManaged
  • Type: long (int|float)
kmsManaged
  • Type: long (int|float)
s3Managed
  • Type: long (int|float)
unencrypted
  • Type: long (int|float)

ObjectLevelStatistics

Description

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 object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.

Members
fileType
  • Type: long (int|float)
storageClass
  • Type: long (int|float)
total
  • Type: long (int|float)

Occurrences

Description

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

Members
cells
  • Type: Array of Cell structures

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

lineRanges
  • Type: Array of Range structures

Provides details about the location of occurrences of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.

offsetRanges
  • Type: Array of Range structures

Provides details about the location of occurrences of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.

pages
  • Type: Array of Page structures

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

records
  • Type: Array of Record structures

Specifies the location of occurrences of sensitive data in an Apache Parquet file.

Page

Description

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

Members
lineRange
  • Type: Range structure

Provides details about the location of an occurrence of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.

offsetRange
  • Type: Range structure

Provides details about the location of an occurrence of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.

pageNumber
  • Type: long (int|float)

PolicyDetails

Description

Provides the details of a policy finding.

Members
action
  • Type: FindingAction structure

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

actor
  • Type: FindingActor structure

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

Range

Description

Provides details about the location of an occurrence of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.

Members
end
  • Type: long (int|float)
start
  • Type: long (int|float)
startColumn
  • Type: long (int|float)

Record

Description

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

Members
jsonPath
  • Type: string
recordIndex
  • Type: long (int|float)

ReplicationDetails

Description

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

Members
replicated
  • Type: boolean
replicatedExternally
  • Type: boolean
replicationAccounts
  • Type: Array of strings

ResourceNotFoundException

Description

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

Members
message
  • Type: string

ResourcesAffected

Description

Provides information about the resources that a finding applies to.

Members
s3Bucket
  • Type: S3Bucket structure

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

s3Object
  • Type: S3Object structure

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

S3Bucket

Description

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

Members
arn
  • Type: string
createdAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
defaultServerSideEncryption
  • Type: ServerSideEncryption structure

Provides information about the server-side encryption settings for an S3 bucket or S3 object.

name
  • Type: string
owner
  • Type: S3BucketOwner structure

Provides information about the user who owns an S3 bucket.

publicAccess
  • Type: BucketPublicAccess structure

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

tags
  • Type: Array of KeyValuePair structures

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.

S3BucketDefinitionForJob

Description

Specifies which AWS account owns the S3 buckets that a classification job analyzes, and the buckets to analyze for the account.

Members
accountId
  • Type: string
buckets
  • Type: Array of strings

S3BucketOwner

Description

Provides information about the user who owns an S3 bucket.

Members
displayName
  • Type: string
id
  • Type: string

S3Destination

Description

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

Members
bucketName
  • Required: Yes
  • Type: string
keyPrefix
  • Type: string
kmsKeyArn
  • Required: Yes
  • Type: string

S3JobDefinition

Description

Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.

Members
bucketDefinitions
  • Type: Array of S3BucketDefinitionForJob structures
scoping
  • Type: Scoping structure

Specifies one or more property- and tag-based conditions that refine the scope of a classification job. These conditions define criteria that determine which objects a job analyzes. Exclude conditions take precedence over include conditions.

S3Object

Description

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

Members
bucketArn
  • Type: string
eTag
  • Type: string
extension
  • Type: string
key
  • Type: string
lastModified
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
path
  • Type: string
publicAccess
  • Type: boolean
serverSideEncryption
  • Type: ServerSideEncryption structure

Provides information about the server-side encryption settings for an S3 bucket or S3 object.

size
  • Type: long (int|float)
storageClass
  • Type: string

The storage class of the S3 object. Possible values are:

tags
  • Type: Array of KeyValuePair structures

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.

versionId
  • Type: string

Scoping

Description

Specifies one or more property- and tag-based conditions that refine the scope of a classification job. These conditions define criteria that determine which objects a job analyzes. Exclude conditions take precedence over include conditions.

Members
excludes
  • Type: JobScopingBlock structure

Specifies one or more property- and tag-based conditions that define criteria for including or excluding objects from a classification job. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

includes
  • Type: JobScopingBlock structure

Specifies one or more property- and tag-based conditions that define criteria for including or excluding objects from a classification job. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

SensitiveDataItem

Description

Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.

Members
category
  • Type: string

The category of sensitive data that was detected and produced the finding. Possible values are:

detections
  • Type: Array of DefaultDetection structures

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.

totalCount
  • Type: long (int|float)

ServerSideEncryption

Description

Provides information about the server-side encryption settings for an S3 bucket or S3 object.

Members
encryptionType
  • Type: string

The type of server-side encryption that's used to encrypt an S3 object or objects in an S3 bucket. Valid values are:

kmsMasterKeyId
  • Type: string

ServiceLimit

Description

Specifies a current quota for an account.

Members
isServiceLimited
  • Type: boolean
unit
  • Type: string
value
  • Type: long (int|float)

ServiceQuotaExceededException

Description

Provides information about an error that occurred due to one or more service quotas for an account.

Members
message
  • Type: string

SessionContext

Description

Provides information about a session that was created for an entity that performed an action by using temporary security credentials.

Members
attributes
  • Type: SessionContextAttributes structure

Provides information about the context in which temporary security credentials were issued to an entity.

sessionIssuer
  • Type: SessionIssuer structure

Provides information about the source and type of temporary security credentials that were issued to an entity.

SessionContextAttributes

Description

Provides information about the context in which temporary security credentials were issued to an entity.

Members
creationDate
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
mfaAuthenticated
  • Type: boolean

SessionIssuer

Description

Provides information about the source and type of temporary security credentials that were issued to an entity.

Members
accountId
  • Type: string
arn
  • Type: string
principalId
  • Type: string
type
  • Type: string
userName
  • Type: string

Severity

Description

Provides the numerical and qualitative representations of a finding's severity.

Members
description
  • Type: string

The qualitative representation of the finding's severity. Possible values are:

score
  • Type: long (int|float)

SimpleScopeTerm

Description

Specifies a property-based condition that determines whether an object is included or excluded from a classification job.

Members
comparator
  • Type: string

The operator to use in a condition. Valid values are:

key
  • Type: string

The property to use in a condition that determines which objects are analyzed by a classification job. Valid values are:

values
  • Type: Array of strings

SortCriteria

Description

Specifies criteria for sorting the results of a request for findings.

Members
attributeName
  • Type: string
orderBy
  • Type: string

Statistics

Description

Provides processing statistics for a classification job.

Members
approximateNumberOfObjectsToProcess
  • Type: double
numberOfRuns
  • Type: double

TagScopeTerm

Description

Specifies a tag-based condition that determines whether an object is included or excluded from a classification job.

Members
comparator
  • Type: string

The operator to use in a condition. Valid values are:

key
  • Type: string
tagValues
  • Type: Array of TagValuePair structures
target
  • Type: string

The type of object to apply a tag-based condition to. Valid values are:

TagValuePair

Description

Specifies a tag key or tag key and value pair to use in a tag-based condition for a classification job.

Members
key
  • Type: string
value
  • Type: string

ThrottlingException

Description

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

Members
message
  • Type: string

UnprocessedAccount

Description

Provides information about an account-related request that hasn't been processed.

Members
accountId
  • Type: string
errorCode
  • Type: string

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

errorMessage
  • Type: string

UsageByAccount

Description

Provides data for a specific usage metric and the corresponding quota for an account. The value for the metric is an aggregated value that reports usage during the past 30 days.

Members
currency
  • Type: string

The type of currency that data for a usage metric is reported in. Possible values are:

estimatedCost
  • Type: string
serviceLimit
  • Type: ServiceLimit structure

Specifies a current quota for an account.

type
  • Type: string

The name of a usage metric for an account. Possible values are:

UsageRecord

Description

Provides quota and aggregated usage data for an account.

Members
accountId
  • Type: string
freeTrialStartDate
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
usage
  • Type: Array of UsageByAccount structures

UsageStatisticsFilter

Description

Specifies a condition for filtering the results of a query for account quotas and usage data.

Members
comparator
  • Type: string

The operator to use in a condition that filters the results of a query for account quotas and usage data. Valid values are:

key
  • Type: string

The field to use in a condition that filters the results of a query for account quotas and usage data. Valid values are:

values
  • Type: Array of strings

UsageStatisticsSortBy

Description

Specifies criteria for sorting the results of a query for account quotas and usage data.

Members
key
  • Type: string

The field to use to sort the results of a query for account quotas and usage data. Valid values are:

orderBy
  • Type: string

UsageTotal

Description

Provides aggregated data for a usage metric. The value for the metric reports usage data for an account during the past 30 days.

Members
currency
  • Type: string

The type of currency that data for a usage metric is reported in. Possible values are:

estimatedCost
  • Type: string
type
  • Type: string

The name of a usage metric for an account. Possible values are:

UserIdentity

Description

Provides information about the type and other characteristics of an entity that performed an action on an affected resource.

Members
assumedRole
  • Type: AssumedRole structure

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 AWS Security Token Service (AWS STS) API.

awsAccount
  • Type: AwsAccount structure

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

awsService
  • Type: AwsService structure

Provides information about an AWS service that performed an action on an affected resource.

federatedUser
  • Type: FederatedUser structure

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 AWS Security Token Service (AWS STS) API.

iamUser
  • Type: IamUser structure

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

root
  • Type: UserIdentityRoot structure

Provides information about an AWS account and entity that performed an action on an affected resource. The action was performed using the credentials for your AWS account.

type
  • Type: string

The type of entity that performed the action on the affected resource. Possible values are:

UserIdentityRoot

Description

Provides information about an AWS account and entity that performed an action on an affected resource. The action was performed using the credentials for your AWS account.

Members
accountId
  • Type: string
arn
  • Type: string
principalId
  • Type: string

UserPausedDetails

Description

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.

Members
jobExpiresAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
jobImminentExpirationHealthEventArn
  • Type: string
jobPausedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

ValidationException

Description

Provides information about an error that occurred due to a syntax error in a request.

Members
message
  • Type: string

WeeklySchedule

Description

Specifies a weekly recurrence pattern for running a classification job.

Members
dayOfWeek
  • Type: string
AWS SDK for PHP 3.x API documentation generated by ApiGen