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

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Account
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • AmplifyUIBuilder
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • AppConfigData
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationCostProfiler
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • AppRunner
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • ARCZonalShift
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • BackupGateway
      • Exception
    • BackupStorage
      • Exception
    • Batch
      • Exception
    • BillingConductor
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ChimeSDKIdentity
      • Exception
    • ChimeSDKMediaPipelines
      • Exception
    • ChimeSDKMeetings
      • Exception
    • ChimeSDKMessaging
      • Exception
    • ChimeSDKVoice
      • Exception
    • CleanRooms
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudControlApi
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudTrailData
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchEvidently
      • Exception
    • CloudWatchLogs
      • Exception
    • CloudWatchRUM
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • CodeCatalyst
      • 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
    • ConnectCampaignService
      • Exception
    • ConnectCases
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • ConnectWisdomService
      • Exception
    • ControlTower
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • DefaultsMode
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • Exception
    • DocDBElastic
      • Exception
    • drs
      • 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
    • EMRServerless
      • Exception
    • Endpoint
      • UseDualstackEndpoint
        • Exception
      • UseFipsEndpoint
        • Exception
    • EndpointDiscovery
      • Exception
    • EndpointV2
      • Rule
      • Ruleset
    • EventBridge
      • Exception
    • Exception
    • finspace
      • Exception
    • FinSpaceData
      • Exception
    • Firehose
      • Exception
    • FIS
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • Exception
    • GameSparks
      • 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
    • Inspector2
      • Exception
    • InternetMonitor
      • Exception
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTDeviceAdvisor
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTFleetHub
      • Exception
    • IoTFleetWise
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTRoboRunner
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTTwinMaker
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • ivschat
      • Exception
    • IVSRealTime
      • Exception
    • Kafka
      • Exception
    • KafkaConnect
      • Exception
    • kendra
      • Exception
    • KendraRanking
      • Exception
    • Keyspaces
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • KinesisVideoWebRTCStorage
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexModelsV2
      • Exception
    • LexRuntimeService
      • Exception
    • LexRuntimeV2
      • Exception
    • LicenseManager
      • Exception
    • LicenseManagerLinuxSubscriptions
      • Exception
    • LicenseManagerUserSubscriptions
      • Exception
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • LookoutEquipment
      • Exception
    • LookoutforVision
      • Exception
    • LookoutMetrics
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • MainframeModernization
      • Exception
    • ManagedBlockchain
      • Exception
    • ManagedGrafana
      • 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
    • MemoryDB
      • Exception
    • mgn
      • Exception
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • MigrationHubOrchestrator
      • Exception
    • MigrationHubRefactorSpaces
      • Exception
    • MigrationHubStrategyRecommendations
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • NimbleStudio
      • Exception
    • OAM
      • Exception
    • Omics
      • Exception
    • OpenSearchServerless
      • Exception
    • OpenSearchService
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Panorama
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • PinpointSMSVoiceV2
      • Exception
    • Pipes
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrivateNetworks
      • Exception
    • PrometheusService
      • Exception
    • Proton
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • RecycleBin
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • RedshiftServerless
      • Exception
    • Rekognition
      • Exception
    • ResilienceHub
      • Exception
    • ResourceExplorer2
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • RolesAnywhere
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • Route53RecoveryCluster
      • Exception
    • Route53RecoveryControlConfig
      • Exception
    • Route53RecoveryReadiness
      • Exception
    • Route53Resolver
      • Exception
    • S3
      • Crypto
      • Exception
      • RegionalEndpoint
        • Exception
      • UseArnRegion
        • Exception
    • S3Control
      • Exception
    • S3Outposts
      • Exception
    • SageMaker
      • Exception
    • SagemakerEdgeManager
      • Exception
    • SageMakerFeatureStoreRuntime
      • Exception
    • SageMakerGeospatial
      • Exception
    • SageMakerMetrics
      • Exception
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • Scheduler
      • Exception
    • Schemas
      • Exception
    • Script
      • Composer
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • SecurityLake
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • SimSpaceWeaver
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • SnowDeviceManagement
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSMContacts
      • Exception
    • SSMIncidents
      • Exception
    • SsmSap
      • Exception
    • SSO
      • Exception
    • SSOAdmin
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • SupportApp
      • Exception
    • Swf
      • Exception
    • Synthetics
      • Exception
    • Textract
      • Exception
    • TimestreamQuery
      • Exception
    • TimestreamWrite
      • Exception
    • Tnb
      • Exception
    • Token
    • TranscribeService
      • Exception
    • Transfer
      • Exception
    • Translate
      • Exception
    • VoiceID
      • Exception
    • VPCLattice
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • WorkSpacesWeb
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Account\AccountClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • Aws\AmplifyUIBuilder\AmplifyUIBuilderClient
  • 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\AppConfigData\AppConfigDataClient
  • Aws\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationCostProfiler\ApplicationCostProfilerClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\AppRunner\AppRunnerClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\ARCZonalShift\ARCZonalShiftClient
  • Aws\Athena\AthenaClient
  • Aws\AuditManager\AuditManagerClient
  • Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\BackupGateway\BackupGatewayClient
  • Aws\BackupStorage\BackupStorageClient
  • Aws\Batch\BatchClient
  • Aws\BillingConductor\BillingConductorClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ChimeSDKIdentity\ChimeSDKIdentityClient
  • Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient
  • Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient
  • Aws\ChimeSDKMessaging\ChimeSDKMessagingClient
  • Aws\ChimeSDKVoice\ChimeSDKVoiceClient
  • Aws\CleanRooms\CleanRoomsClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudControlApi\CloudControlApiClient
  • 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\CloudTrailData\CloudTrailDataClient
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchEvidently\CloudWatchEvidentlyClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CloudWatchRUM\CloudWatchRUMClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCatalyst\CodeCatalystClient
  • 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\ConnectCampaignService\ConnectCampaignServiceClient
  • Aws\ConnectCases\ConnectCasesClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\ConnectWisdomService\ConnectWisdomServiceClient
  • Aws\ControlTower\ControlTowerClient
  • 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\DefaultsMode\Configuration
  • Aws\DefaultsMode\ConfigurationProvider
  • Aws\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DocDBElastic\DocDBElasticClient
  • Aws\DoctrineCacheAdapter
  • Aws\drs\drsClient
  • 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\EMRServerless\EMRServerlessClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\Endpoint\UseDualstackEndpoint\Configuration
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationProvider
  • Aws\Endpoint\UseFipsEndpoint\Configuration
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EndpointV2\EndpointDefinitionProvider
  • Aws\EndpointV2\EndpointProviderV2
  • Aws\EndpointV2\Rule\AbstractRule
  • Aws\EndpointV2\Rule\EndpointRule
  • Aws\EndpointV2\Rule\ErrorRule
  • Aws\EndpointV2\Rule\RuleCreator
  • Aws\EndpointV2\Rule\TreeRule
  • Aws\EndpointV2\Ruleset\Ruleset
  • Aws\EndpointV2\Ruleset\RulesetEndpoint
  • Aws\EndpointV2\Ruleset\RulesetParameter
  • Aws\EventBridge\EventBridgeClient
  • Aws\finspace\finspaceClient
  • Aws\FinSpaceData\FinSpaceDataClient
  • Aws\Firehose\FirehoseClient
  • Aws\FIS\FISClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • Aws\GameSparks\GameSparksClient
  • 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\Inspector2\Inspector2Client
  • Aws\Inspector\InspectorClient
  • Aws\InternetMonitor\InternetMonitorClient
  • 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\IoTFleetWise\IoTFleetWiseClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTRoboRunner\IoTRoboRunnerClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTTwinMaker\IoTTwinMakerClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\ivschat\ivschatClient
  • Aws\IVSRealTime\IVSRealTimeClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\KafkaConnect\KafkaConnectClient
  • Aws\kendra\kendraClient
  • Aws\KendraRanking\KendraRankingClient
  • Aws\Keyspaces\KeyspacesClient
  • Aws\Kinesis\KinesisClient
  • Aws\KinesisAnalytics\KinesisAnalyticsClient
  • Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
  • Aws\KinesisVideo\KinesisVideoClient
  • Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
  • Aws\KinesisVideoMedia\KinesisVideoMediaClient
  • Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
  • Aws\KinesisVideoWebRTCStorage\KinesisVideoWebRTCStorageClient
  • Aws\Kms\KmsClient
  • Aws\LakeFormation\LakeFormationClient
  • Aws\Lambda\LambdaClient
  • Aws\LexModelBuildingService\LexModelBuildingServiceClient
  • Aws\LexModelsV2\LexModelsV2Client
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LexRuntimeV2\LexRuntimeV2Client
  • Aws\LicenseManager\LicenseManagerClient
  • Aws\LicenseManagerLinuxSubscriptions\LicenseManagerLinuxSubscriptionsClient
  • Aws\LicenseManagerUserSubscriptions\LicenseManagerUserSubscriptionsClient
  • Aws\Lightsail\LightsailClient
  • Aws\LocationService\LocationServiceClient
  • Aws\LookoutEquipment\LookoutEquipmentClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LookoutMetrics\LookoutMetricsClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\MainframeModernization\MainframeModernizationClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • Aws\ManagedGrafana\ManagedGrafanaClient
  • 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\MemoryDB\MemoryDBClient
  • Aws\mgn\mgnClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • Aws\MigrationHubOrchestrator\MigrationHubOrchestratorClient
  • Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient
  • Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
  • 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\NimbleStudio\NimbleStudioClient
  • Aws\OAM\OAMClient
  • Aws\Omics\OmicsClient
  • Aws\OpenSearchServerless\OpenSearchServerlessClient
  • Aws\OpenSearchService\OpenSearchServiceClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Panorama\PanoramaClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client
  • Aws\Pipes\PipesClient
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrivateNetworks\PrivateNetworksClient
  • Aws\PrometheusService\PrometheusServiceClient
  • Aws\Proton\ProtonClient
  • 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\RecycleBin\RecycleBinClient
  • Aws\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\RedshiftServerless\RedshiftServerlessClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResilienceHub\ResilienceHubClient
  • Aws\ResourceExplorer2\ResourceExplorer2Client
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\Retry\Configuration
  • Aws\Retry\ConfigurationProvider
  • Aws\RoboMaker\RoboMakerClient
  • Aws\RolesAnywhere\RolesAnywhereClient
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\Route53RecoveryCluster\Route53RecoveryClusterClient
  • Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
  • Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
  • 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\S3\ValidateResponseChecksumParser
  • Aws\S3Control\S3ControlClient
  • Aws\S3Outposts\S3OutpostsClient
  • Aws\SageMaker\SageMakerClient
  • Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
  • Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
  • Aws\SageMakerGeospatial\SageMakerGeospatialClient
  • Aws\SageMakerMetrics\SageMakerMetricsClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Scheduler\SchedulerClient
  • Aws\Schemas\SchemasClient
  • Aws\Script\Composer\Composer
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\SecurityLake\SecurityLakeClient
  • 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\SimSpaceWeaver\SimSpaceWeaverClient
  • Aws\Sms\SmsClient
  • Aws\SnowBall\SnowBallClient
  • Aws\SnowDeviceManagement\SnowDeviceManagementClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSMContacts\SSMContactsClient
  • Aws\SSMIncidents\SSMIncidentsClient
  • Aws\SsmSap\SsmSapClient
  • 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\SupportApp\SupportAppClient
  • Aws\Swf\SwfClient
  • Aws\Synthetics\SyntheticsClient
  • Aws\Textract\TextractClient
  • Aws\TimestreamQuery\TimestreamQueryClient
  • Aws\TimestreamWrite\TimestreamWriteClient
  • Aws\Tnb\TnbClient
  • Aws\Token\BearerTokenAuthorization
  • Aws\Token\SsoToken
  • Aws\Token\SsoTokenProvider
  • Aws\Token\Token
  • Aws\Token\TokenProvider
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Transfer\TransferClient
  • Aws\Translate\TranslateClient
  • Aws\VoiceID\VoiceIDClient
  • Aws\VPCLattice\VPCLatticeClient
  • 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\WorkSpacesWeb\WorkSpacesWebClient
  • 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\DefaultsMode\ConfigurationInterface
  • Aws\DynamoDb\SessionConnectionInterface
  • Aws\Endpoint\PartitionInterface
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationInterface
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationInterface
  • 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
  • Aws\Token\RefreshableTokenProviderInterface
  • Aws\Token\TokenAuthorization
  • Aws\Token\TokenInterface

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\CalculatesChecksumTrait
  • Aws\S3\Crypto\CryptoParamsTrait
  • Aws\S3\Crypto\CryptoParamsTraitV2
  • Aws\S3\Crypto\UserAgentTrait
  • Aws\S3\MultipartUploadingTrait
  • Aws\S3\S3ClientTrait
  • Aws\Signature\SignatureTrait
  • Aws\Token\ParsesIniTrait

Exceptions

  • Aws\AccessAnalyzer\Exception\AccessAnalyzerException
  • Aws\Account\Exception\AccountException
  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\AmplifyUIBuilder\Exception\AmplifyUIBuilderException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\AppConfigData\Exception\AppConfigDataException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationCostProfiler\Exception\ApplicationCostProfilerException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • Aws\AppRunner\Exception\AppRunnerException
  • Aws\Appstream\Exception\AppstreamException
  • Aws\AppSync\Exception\AppSyncException
  • Aws\ARCZonalShift\Exception\ARCZonalShiftException
  • 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\BackupGateway\Exception\BackupGatewayException
  • Aws\BackupStorage\Exception\BackupStorageException
  • Aws\Batch\Exception\BatchException
  • Aws\BillingConductor\Exception\BillingConductorException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ChimeSDKIdentity\Exception\ChimeSDKIdentityException
  • Aws\ChimeSDKMediaPipelines\Exception\ChimeSDKMediaPipelinesException
  • Aws\ChimeSDKMeetings\Exception\ChimeSDKMeetingsException
  • Aws\ChimeSDKMessaging\Exception\ChimeSDKMessagingException
  • Aws\ChimeSDKVoice\Exception\ChimeSDKVoiceException
  • Aws\CleanRooms\Exception\CleanRoomsException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudControlApi\Exception\CloudControlApiException
  • 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\CloudTrailData\Exception\CloudTrailDataException
  • Aws\CloudWatch\Exception\CloudWatchException
  • Aws\CloudWatchEvents\Exception\CloudWatchEventsException
  • Aws\CloudWatchEvidently\Exception\CloudWatchEvidentlyException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CloudWatchRUM\Exception\CloudWatchRUMException
  • Aws\CodeArtifact\Exception\CodeArtifactException
  • Aws\CodeBuild\Exception\CodeBuildException
  • Aws\CodeCatalyst\Exception\CodeCatalystException
  • 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\ConnectCampaignService\Exception\ConnectCampaignServiceException
  • Aws\ConnectCases\Exception\ConnectCasesException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\ConnectWisdomService\Exception\ConnectWisdomServiceException
  • Aws\ControlTower\Exception\ControlTowerException
  • 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\DefaultsMode\Exception\ConfigurationException
  • 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\DocDBElastic\Exception\DocDBElasticException
  • Aws\drs\Exception\drsException
  • 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\EMRServerless\Exception\EMRServerlessException
  • Aws\Endpoint\UseDualstackEndpoint\Exception\ConfigurationException
  • Aws\Endpoint\UseFipsEndpoint\Exception\ConfigurationException
  • Aws\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CommonRuntimeException
  • 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\TokenException
  • Aws\Exception\UnresolvedApiException
  • Aws\Exception\UnresolvedEndpointException
  • Aws\Exception\UnresolvedSignatureException
  • Aws\finspace\Exception\finspaceException
  • Aws\FinSpaceData\Exception\FinSpaceDataException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FIS\Exception\FISException
  • 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\GameSparks\Exception\GameSparksException
  • 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\Inspector2\Exception\Inspector2Exception
  • Aws\Inspector\Exception\InspectorException
  • Aws\InternetMonitor\Exception\InternetMonitorException
  • 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\IoTFleetWise\Exception\IoTFleetWiseException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTRoboRunner\Exception\IoTRoboRunnerException
  • Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
  • Aws\IoTSiteWise\Exception\IoTSiteWiseException
  • Aws\IoTThingsGraph\Exception\IoTThingsGraphException
  • Aws\IoTTwinMaker\Exception\IoTTwinMakerException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\ivschat\Exception\ivschatException
  • Aws\IVSRealTime\Exception\IVSRealTimeException
  • Aws\Kafka\Exception\KafkaException
  • Aws\KafkaConnect\Exception\KafkaConnectException
  • Aws\kendra\Exception\kendraException
  • Aws\KendraRanking\Exception\KendraRankingException
  • Aws\Keyspaces\Exception\KeyspacesException
  • 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\KinesisVideoWebRTCStorage\Exception\KinesisVideoWebRTCStorageException
  • Aws\Kms\Exception\KmsException
  • Aws\LakeFormation\Exception\LakeFormationException
  • Aws\Lambda\Exception\LambdaException
  • Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException
  • Aws\LexModelsV2\Exception\LexModelsV2Exception
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LexRuntimeV2\Exception\LexRuntimeV2Exception
  • Aws\LicenseManager\Exception\LicenseManagerException
  • Aws\LicenseManagerLinuxSubscriptions\Exception\LicenseManagerLinuxSubscriptionsException
  • Aws\LicenseManagerUserSubscriptions\Exception\LicenseManagerUserSubscriptionsException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\LocationService\Exception\LocationServiceException
  • Aws\LookoutEquipment\Exception\LookoutEquipmentException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\LookoutMetrics\Exception\LookoutMetricsException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\MainframeModernization\Exception\MainframeModernizationException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • Aws\ManagedGrafana\Exception\ManagedGrafanaException
  • 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\MemoryDB\Exception\MemoryDBException
  • Aws\mgn\Exception\mgnException
  • Aws\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • Aws\MigrationHubOrchestrator\Exception\MigrationHubOrchestratorException
  • Aws\MigrationHubRefactorSpaces\Exception\MigrationHubRefactorSpacesException
  • Aws\MigrationHubStrategyRecommendations\Exception\MigrationHubStrategyRecommendationsException
  • 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\NimbleStudio\Exception\NimbleStudioException
  • Aws\OAM\Exception\OAMException
  • Aws\Omics\Exception\OmicsException
  • Aws\OpenSearchServerless\Exception\OpenSearchServerlessException
  • Aws\OpenSearchService\Exception\OpenSearchServiceException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • Aws\Panorama\Exception\PanoramaException
  • 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\PinpointSMSVoiceV2\Exception\PinpointSMSVoiceV2Exception
  • Aws\Pipes\Exception\PipesException
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrivateNetworks\Exception\PrivateNetworksException
  • Aws\PrometheusService\Exception\PrometheusServiceException
  • Aws\Proton\Exception\ProtonException
  • 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\RecycleBin\Exception\RecycleBinException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\RedshiftServerless\Exception\RedshiftServerlessException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResilienceHub\Exception\ResilienceHubException
  • Aws\ResourceExplorer2\Exception\ResourceExplorer2Exception
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Retry\Exception\ConfigurationException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\RolesAnywhere\Exception\RolesAnywhereException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\Route53RecoveryCluster\Exception\Route53RecoveryClusterException
  • Aws\Route53RecoveryControlConfig\Exception\Route53RecoveryControlConfigException
  • Aws\Route53RecoveryReadiness\Exception\Route53RecoveryReadinessException
  • 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\SageMakerGeospatial\Exception\SageMakerGeospatialException
  • Aws\SageMakerMetrics\Exception\SageMakerMetricsException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\Scheduler\Exception\SchedulerException
  • Aws\Schemas\Exception\SchemasException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\SecurityLake\Exception\SecurityLakeException
  • 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\SimSpaceWeaver\Exception\SimSpaceWeaverException
  • Aws\Sms\Exception\SmsException
  • Aws\SnowBall\Exception\SnowBallException
  • Aws\SnowDeviceManagement\Exception\SnowDeviceManagementException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSMContacts\Exception\SSMContactsException
  • Aws\SSMIncidents\Exception\SSMIncidentsException
  • Aws\SsmSap\Exception\SsmSapException
  • 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\SupportApp\Exception\SupportAppException
  • Aws\Swf\Exception\SwfException
  • Aws\Synthetics\Exception\SyntheticsException
  • Aws\Textract\Exception\TextractException
  • Aws\TimestreamQuery\Exception\TimestreamQueryException
  • Aws\TimestreamWrite\Exception\TimestreamWriteException
  • Aws\Tnb\Exception\TnbException
  • Aws\TranscribeService\Exception\TranscribeServiceException
  • Aws\Transfer\Exception\TransferException
  • Aws\Translate\Exception\TranslateException
  • Aws\VoiceID\Exception\VoiceIDException
  • Aws\VPCLattice\Exception\VPCLatticeException
  • 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\WorkSpacesWeb\Exception\WorkSpacesWebException
  • 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_fips_pseudo_region
  • 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
  • Aws\strip_fips_pseudo_regions

Access Analyzer 2019-11-01

Client: Aws\AccessAnalyzer\AccessAnalyzerClient
Service ID: accessanalyzer
Version: 2019-11-01

This page describes the parameters and results for the operations of the Access Analyzer (2019-11-01), and shows how to use the Aws\AccessAnalyzer\AccessAnalyzerClient object to call the described operations. This documentation is specific to the 2019-11-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 */).

  • ApplyArchiveRule ( array $params = [] )

    Retroactively applies the archive rule to existing findings that meet the archive rule criteria.

  • CancelPolicyGeneration ( array $params = [] )

    Cancels the requested policy generation.

  • CreateAccessPreview ( array $params = [] )

    Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.

  • CreateAnalyzer ( array $params = [] )

    Creates an analyzer for your account.

  • CreateArchiveRule ( array $params = [] )

    Creates an archive rule for the specified analyzer.

  • DeleteAnalyzer ( array $params = [] )

    Deletes the specified analyzer.

  • DeleteArchiveRule ( array $params = [] )

    Deletes the specified archive rule.

  • GetAccessPreview ( array $params = [] )

    Retrieves information about an access preview for the specified analyzer.

  • GetAnalyzedResource ( array $params = [] )

    Retrieves information about a resource that was analyzed.

  • GetAnalyzer ( array $params = [] )

    Retrieves information about the specified analyzer.

  • GetArchiveRule ( array $params = [] )

    Retrieves information about an archive rule.

  • GetFinding ( array $params = [] )

    Retrieves information about the specified finding.

  • GetGeneratedPolicy ( array $params = [] )

    Retrieves the policy that was generated using StartPolicyGeneration.

  • ListAccessPreviewFindings ( array $params = [] )

    Retrieves a list of access preview findings generated by the specified access preview.

  • ListAccessPreviews ( array $params = [] )

    Retrieves a list of access previews for the specified analyzer.

  • ListAnalyzedResources ( array $params = [] )

    Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer.

  • ListAnalyzers ( array $params = [] )

    Retrieves a list of analyzers.

  • ListArchiveRules ( array $params = [] )

    Retrieves a list of archive rules created for the specified analyzer.

  • ListFindings ( array $params = [] )

    Retrieves a list of findings generated by the specified analyzer.

  • ListPolicyGenerations ( array $params = [] )

    Lists all of the policy generations requested in the last seven days.

  • ListTagsForResource ( array $params = [] )

    Retrieves a list of tags applied to the specified resource.

  • StartPolicyGeneration ( array $params = [] )

    Starts the policy generation request.

  • StartResourceScan ( array $params = [] )

    Immediately starts a scan of the policies applied to the specified resource.

  • TagResource ( array $params = [] )

    Adds a tag to the specified resource.

  • UntagResource ( array $params = [] )

    Removes a tag from the specified resource.

  • UpdateArchiveRule ( array $params = [] )

    Updates the criteria and values for the specified archive rule.

  • UpdateFindings ( array $params = [] )

    Updates the status for the specified findings.

  • ValidatePolicy ( array $params = [] )

    Requests the validation of a policy and returns a list of findings.

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:

  • ListAccessPreviewFindings
  • ListAccessPreviews
  • ListAnalyzedResources
  • ListAnalyzers
  • ListArchiveRules
  • ListFindings
  • ListPolicyGenerations
  • ValidatePolicy

Operations

ApplyArchiveRule

$result = $client->applyArchiveRule([/* ... */]);
$promise = $client->applyArchiveRuleAsync([/* ... */]);

Retroactively applies the archive rule to existing findings that meet the archive rule criteria.

Parameter Syntax

$result = $client->applyArchiveRule([
    'analyzerArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'ruleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
analyzerArn
  • Required: Yes
  • Type: string

The Amazon resource name (ARN) of the analyzer.

clientToken
  • Type: string

A client token.

ruleName
  • Required: Yes
  • Type: string

The name of the rule to apply.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

CancelPolicyGeneration

$result = $client->cancelPolicyGeneration([/* ... */]);
$promise = $client->cancelPolicyGenerationAsync([/* ... */]);

Cancels the requested policy generation.

Parameter Syntax

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

Parameter Details

Members
jobId
  • Required: Yes
  • Type: string

The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

CreateAccessPreview

$result = $client->createAccessPreview([/* ... */]);
$promise = $client->createAccessPreviewAsync([/* ... */]);

Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.

Parameter Syntax

$result = $client->createAccessPreview([
    'analyzerArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'configurations' => [ // REQUIRED
        '<ConfigurationsMapKey>' => [
            'ebsSnapshot' => [
                'groups' => ['<string>', ...],
                'kmsKeyId' => '<string>',
                'userIds' => ['<string>', ...],
            ],
            'ecrRepository' => [
                'repositoryPolicy' => '<string>',
            ],
            'efsFileSystem' => [
                'fileSystemPolicy' => '<string>',
            ],
            'iamRole' => [
                'trustPolicy' => '<string>',
            ],
            'kmsKey' => [
                'grants' => [
                    [
                        'constraints' => [
                            'encryptionContextEquals' => ['<string>', ...],
                            'encryptionContextSubset' => ['<string>', ...],
                        ],
                        'granteePrincipal' => '<string>', // REQUIRED
                        'issuingAccount' => '<string>', // REQUIRED
                        'operations' => ['<string>', ...], // REQUIRED
                        'retiringPrincipal' => '<string>',
                    ],
                    // ...
                ],
                'keyPolicies' => ['<string>', ...],
            ],
            'rdsDbClusterSnapshot' => [
                'attributes' => [
                    '<RdsDbClusterSnapshotAttributeName>' => [
                        'accountIds' => ['<string>', ...],
                    ],
                    // ...
                ],
                'kmsKeyId' => '<string>',
            ],
            'rdsDbSnapshot' => [
                'attributes' => [
                    '<RdsDbSnapshotAttributeName>' => [
                        'accountIds' => ['<string>', ...],
                    ],
                    // ...
                ],
                'kmsKeyId' => '<string>',
            ],
            's3Bucket' => [
                'accessPoints' => [
                    '<AccessPointArn>' => [
                        'accessPointPolicy' => '<string>',
                        'networkOrigin' => [
                            'internetConfiguration' => [
                            ],
                            'vpcConfiguration' => [
                                'vpcId' => '<string>', // REQUIRED
                            ],
                        ],
                        'publicAccessBlock' => [
                            'ignorePublicAcls' => true || false, // REQUIRED
                            'restrictPublicBuckets' => true || false, // REQUIRED
                        ],
                    ],
                    // ...
                ],
                'bucketAclGrants' => [
                    [
                        'grantee' => [ // REQUIRED
                            'id' => '<string>',
                            'uri' => '<string>',
                        ],
                        'permission' => 'READ|WRITE|READ_ACP|WRITE_ACP|FULL_CONTROL', // REQUIRED
                    ],
                    // ...
                ],
                'bucketPolicy' => '<string>',
                'bucketPublicAccessBlock' => [
                    'ignorePublicAcls' => true || false, // REQUIRED
                    'restrictPublicBuckets' => true || false, // REQUIRED
                ],
            ],
            'secretsManagerSecret' => [
                'kmsKeyId' => '<string>',
                'secretPolicy' => '<string>',
            ],
            'snsTopic' => [
                'topicPolicy' => '<string>',
            ],
            'sqsQueue' => [
                'queuePolicy' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
analyzerArn
  • Required: Yes
  • Type: string

The ARN of the account analyzer used to generate the access preview. You can only create an access preview for analyzers with an Account type and Active status.

clientToken
  • Type: string

A client token.

configurations
  • Required: Yes
  • Type: Associative array of custom strings keys (ConfigurationsMapKey) to Configuration structures

Access control configuration for your resource that is used to generate the access preview. The access preview includes findings for external access allowed to the resource with the proposed access control configuration. The configuration must contain exactly one element.

Result Syntax

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

Result Details

Members
id
  • Required: Yes
  • Type: string

The unique ID for the access preview.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    A conflict exception error.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ServiceQuotaExceededException:

    Service quote met error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

CreateAnalyzer

$result = $client->createAnalyzer([/* ... */]);
$promise = $client->createAnalyzerAsync([/* ... */]);

Creates an analyzer for your account.

Parameter Syntax

$result = $client->createAnalyzer([
    'analyzerName' => '<string>', // REQUIRED
    'archiveRules' => [
        [
            'filter' => [ // REQUIRED
                '<String>' => [
                    'contains' => ['<string>', ...],
                    'eq' => ['<string>', ...],
                    'exists' => true || false,
                    'neq' => ['<string>', ...],
                ],
                // ...
            ],
            'ruleName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'clientToken' => '<string>',
    'tags' => ['<string>', ...],
    'type' => 'ACCOUNT|ORGANIZATION', // REQUIRED
]);

Parameter Details

Members
analyzerName
  • Required: Yes
  • Type: string

The name of the analyzer to create.

archiveRules
  • Type: Array of InlineArchiveRule structures

Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.

clientToken
  • Type: string

A client token.

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

The tags to apply to the analyzer.

type
  • Required: Yes
  • Type: string

The type of analyzer to create. Only ACCOUNT and ORGANIZATION analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.

Result Syntax

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

Result Details

Members
arn
  • Type: string

The ARN of the analyzer that was created by the request.

Errors

  • ConflictException:

    A conflict exception error.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ServiceQuotaExceededException:

    Service quote met error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

CreateArchiveRule

$result = $client->createArchiveRule([/* ... */]);
$promise = $client->createArchiveRuleAsync([/* ... */]);

Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.

To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.

Parameter Syntax

$result = $client->createArchiveRule([
    'analyzerName' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'filter' => [ // REQUIRED
        '<String>' => [
            'contains' => ['<string>', ...],
            'eq' => ['<string>', ...],
            'exists' => true || false,
            'neq' => ['<string>', ...],
        ],
        // ...
    ],
    'ruleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
analyzerName
  • Required: Yes
  • Type: string

The name of the created analyzer.

clientToken
  • Type: string

A client token.

filter
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to Criterion structures

The criteria for the rule.

ruleName
  • Required: Yes
  • Type: string

The name of the rule to create.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    A conflict exception error.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ServiceQuotaExceededException:

    Service quote met error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

DeleteAnalyzer

$result = $client->deleteAnalyzer([/* ... */]);
$promise = $client->deleteAnalyzerAsync([/* ... */]);

Deletes the specified analyzer. When you delete an analyzer, IAM Access Analyzer is disabled for the account or organization in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action.

Parameter Syntax

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

Parameter Details

Members
analyzerName
  • Required: Yes
  • Type: string

The name of the analyzer to delete.

clientToken
  • Type: string

A client token.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

DeleteArchiveRule

$result = $client->deleteArchiveRule([/* ... */]);
$promise = $client->deleteArchiveRuleAsync([/* ... */]);

Deletes the specified archive rule.

Parameter Syntax

$result = $client->deleteArchiveRule([
    'analyzerName' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'ruleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
analyzerName
  • Required: Yes
  • Type: string

The name of the analyzer that associated with the archive rule to delete.

clientToken
  • Type: string

A client token.

ruleName
  • Required: Yes
  • Type: string

The name of the rule to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

GetAccessPreview

$result = $client->getAccessPreview([/* ... */]);
$promise = $client->getAccessPreviewAsync([/* ... */]);

Retrieves information about an access preview for the specified analyzer.

Parameter Syntax

$result = $client->getAccessPreview([
    'accessPreviewId' => '<string>', // REQUIRED
    'analyzerArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
accessPreviewId
  • Required: Yes
  • Type: string

The unique ID for the access preview.

analyzerArn
  • Required: Yes
  • Type: string

The ARN of the analyzer used to generate the access preview.

Result Syntax

[
    'accessPreview' => [
        'analyzerArn' => '<string>',
        'configurations' => [
            '<ConfigurationsMapKey>' => [
                'ebsSnapshot' => [
                    'groups' => ['<string>', ...],
                    'kmsKeyId' => '<string>',
                    'userIds' => ['<string>', ...],
                ],
                'ecrRepository' => [
                    'repositoryPolicy' => '<string>',
                ],
                'efsFileSystem' => [
                    'fileSystemPolicy' => '<string>',
                ],
                'iamRole' => [
                    'trustPolicy' => '<string>',
                ],
                'kmsKey' => [
                    'grants' => [
                        [
                            'constraints' => [
                                'encryptionContextEquals' => ['<string>', ...],
                                'encryptionContextSubset' => ['<string>', ...],
                            ],
                            'granteePrincipal' => '<string>',
                            'issuingAccount' => '<string>',
                            'operations' => ['<string>', ...],
                            'retiringPrincipal' => '<string>',
                        ],
                        // ...
                    ],
                    'keyPolicies' => ['<string>', ...],
                ],
                'rdsDbClusterSnapshot' => [
                    'attributes' => [
                        '<RdsDbClusterSnapshotAttributeName>' => [
                            'accountIds' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'kmsKeyId' => '<string>',
                ],
                'rdsDbSnapshot' => [
                    'attributes' => [
                        '<RdsDbSnapshotAttributeName>' => [
                            'accountIds' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'kmsKeyId' => '<string>',
                ],
                's3Bucket' => [
                    'accessPoints' => [
                        '<AccessPointArn>' => [
                            'accessPointPolicy' => '<string>',
                            'networkOrigin' => [
                                'internetConfiguration' => [
                                ],
                                'vpcConfiguration' => [
                                    'vpcId' => '<string>',
                                ],
                            ],
                            'publicAccessBlock' => [
                                'ignorePublicAcls' => true || false,
                                'restrictPublicBuckets' => true || false,
                            ],
                        ],
                        // ...
                    ],
                    'bucketAclGrants' => [
                        [
                            'grantee' => [
                                'id' => '<string>',
                                'uri' => '<string>',
                            ],
                            'permission' => 'READ|WRITE|READ_ACP|WRITE_ACP|FULL_CONTROL',
                        ],
                        // ...
                    ],
                    'bucketPolicy' => '<string>',
                    'bucketPublicAccessBlock' => [
                        'ignorePublicAcls' => true || false,
                        'restrictPublicBuckets' => true || false,
                    ],
                ],
                'secretsManagerSecret' => [
                    'kmsKeyId' => '<string>',
                    'secretPolicy' => '<string>',
                ],
                'snsTopic' => [
                    'topicPolicy' => '<string>',
                ],
                'sqsQueue' => [
                    'queuePolicy' => '<string>',
                ],
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'id' => '<string>',
        'status' => 'COMPLETED|CREATING|FAILED',
        'statusReason' => [
            'code' => 'INTERNAL_ERROR|INVALID_CONFIGURATION',
        ],
    ],
]

Result Details

Members
accessPreview
  • Required: Yes
  • Type: AccessPreview structure

An object that contains information about the access preview.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

GetAnalyzedResource

$result = $client->getAnalyzedResource([/* ... */]);
$promise = $client->getAnalyzedResourceAsync([/* ... */]);

Retrieves information about a resource that was analyzed.

Parameter Syntax

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

Parameter Details

Members
analyzerArn
  • Required: Yes
  • Type: string

The ARN of the analyzer to retrieve information from.

resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource to retrieve information about.

Result Syntax

[
    'resource' => [
        'actions' => ['<string>', ...],
        'analyzedAt' => <DateTime>,
        'createdAt' => <DateTime>,
        'error' => '<string>',
        'isPublic' => true || false,
        'resourceArn' => '<string>',
        'resourceOwnerAccount' => '<string>',
        'resourceType' => 'AWS::S3::Bucket|AWS::IAM::Role|AWS::SQS::Queue|AWS::Lambda::Function|AWS::Lambda::LayerVersion|AWS::KMS::Key|AWS::SecretsManager::Secret|AWS::EFS::FileSystem|AWS::EC2::Snapshot|AWS::ECR::Repository|AWS::RDS::DBSnapshot|AWS::RDS::DBClusterSnapshot|AWS::SNS::Topic',
        'sharedVia' => ['<string>', ...],
        'status' => 'ACTIVE|ARCHIVED|RESOLVED',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
resource
  • Type: AnalyzedResource structure

An AnalyzedResource object that contains information that IAM Access Analyzer found when it analyzed the resource.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

GetAnalyzer

$result = $client->getAnalyzer([/* ... */]);
$promise = $client->getAnalyzerAsync([/* ... */]);

Retrieves information about the specified analyzer.

Parameter Syntax

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

Parameter Details

Members
analyzerName
  • Required: Yes
  • Type: string

The name of the analyzer retrieved.

Result Syntax

[
    'analyzer' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'lastResourceAnalyzed' => '<string>',
        'lastResourceAnalyzedAt' => <DateTime>,
        'name' => '<string>',
        'status' => 'ACTIVE|CREATING|DISABLED|FAILED',
        'statusReason' => [
            'code' => 'AWS_SERVICE_ACCESS_DISABLED|DELEGATED_ADMINISTRATOR_DEREGISTERED|ORGANIZATION_DELETED|SERVICE_LINKED_ROLE_CREATION_FAILED',
        ],
        'tags' => ['<string>', ...],
        'type' => 'ACCOUNT|ORGANIZATION',
    ],
]

Result Details

Members
analyzer
  • Required: Yes
  • Type: AnalyzerSummary structure

An AnalyzerSummary object that contains information about the analyzer.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

GetArchiveRule

$result = $client->getArchiveRule([/* ... */]);
$promise = $client->getArchiveRuleAsync([/* ... */]);

Retrieves information about an archive rule.

To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.

Parameter Syntax

$result = $client->getArchiveRule([
    'analyzerName' => '<string>', // REQUIRED
    'ruleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
analyzerName
  • Required: Yes
  • Type: string

The name of the analyzer to retrieve rules from.

ruleName
  • Required: Yes
  • Type: string

The name of the rule to retrieve.

Result Syntax

[
    'archiveRule' => [
        'createdAt' => <DateTime>,
        'filter' => [
            '<String>' => [
                'contains' => ['<string>', ...],
                'eq' => ['<string>', ...],
                'exists' => true || false,
                'neq' => ['<string>', ...],
            ],
            // ...
        ],
        'ruleName' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
archiveRule
  • Required: Yes
  • Type: ArchiveRuleSummary structure

Contains information about an archive rule.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

GetFinding

$result = $client->getFinding([/* ... */]);
$promise = $client->getFindingAsync([/* ... */]);

Retrieves information about the specified finding.

Parameter Syntax

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

Parameter Details

Members
analyzerArn
  • Required: Yes
  • Type: string

The ARN of the analyzer that generated the finding.

id
  • Required: Yes
  • Type: string

The ID of the finding to retrieve.

Result Syntax

[
    'finding' => [
        'action' => ['<string>', ...],
        'analyzedAt' => <DateTime>,
        'condition' => ['<string>', ...],
        'createdAt' => <DateTime>,
        'error' => '<string>',
        'id' => '<string>',
        'isPublic' => true || false,
        'principal' => ['<string>', ...],
        'resource' => '<string>',
        'resourceOwnerAccount' => '<string>',
        'resourceType' => 'AWS::S3::Bucket|AWS::IAM::Role|AWS::SQS::Queue|AWS::Lambda::Function|AWS::Lambda::LayerVersion|AWS::KMS::Key|AWS::SecretsManager::Secret|AWS::EFS::FileSystem|AWS::EC2::Snapshot|AWS::ECR::Repository|AWS::RDS::DBSnapshot|AWS::RDS::DBClusterSnapshot|AWS::SNS::Topic',
        'sources' => [
            [
                'detail' => [
                    'accessPointAccount' => '<string>',
                    'accessPointArn' => '<string>',
                ],
                'type' => 'POLICY|BUCKET_ACL|S3_ACCESS_POINT|S3_ACCESS_POINT_ACCOUNT',
            ],
            // ...
        ],
        'status' => 'ACTIVE|ARCHIVED|RESOLVED',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
finding
  • Type: Finding structure

A finding object that contains finding details.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

GetGeneratedPolicy

$result = $client->getGeneratedPolicy([/* ... */]);
$promise = $client->getGeneratedPolicyAsync([/* ... */]);

Retrieves the policy that was generated using StartPolicyGeneration.

Parameter Syntax

$result = $client->getGeneratedPolicy([
    'includeResourcePlaceholders' => true || false,
    'includeServiceLevelTemplate' => true || false,
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
includeResourcePlaceholders
  • Type: boolean

The level of detail that you want to generate. You can specify whether to generate policies with placeholders for resource ARNs for actions that support resource level granularity in policies.

For example, in the resource section of a policy, you can receive a placeholder such as "Resource":"arn:aws:s3:::${BucketName}" instead of "*".

includeServiceLevelTemplate
  • Type: boolean

The level of detail that you want to generate. You can specify whether to generate service-level policies.

IAM Access Analyzer uses iam:servicelastaccessed to identify services that have been used recently to create this service-level template.

jobId
  • Required: Yes
  • Type: string

The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

Result Syntax

[
    'generatedPolicyResult' => [
        'generatedPolicies' => [
            [
                'policy' => '<string>',
            ],
            // ...
        ],
        'properties' => [
            'cloudTrailProperties' => [
                'endTime' => <DateTime>,
                'startTime' => <DateTime>,
                'trailProperties' => [
                    [
                        'allRegions' => true || false,
                        'cloudTrailArn' => '<string>',
                        'regions' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'isComplete' => true || false,
            'principalArn' => '<string>',
        ],
    ],
    'jobDetails' => [
        'completedOn' => <DateTime>,
        'jobError' => [
            'code' => 'AUTHORIZATION_ERROR|RESOURCE_NOT_FOUND_ERROR|SERVICE_QUOTA_EXCEEDED_ERROR|SERVICE_ERROR',
            'message' => '<string>',
        ],
        'jobId' => '<string>',
        'startedOn' => <DateTime>,
        'status' => 'IN_PROGRESS|SUCCEEDED|FAILED|CANCELED',
    ],
]

Result Details

Members
generatedPolicyResult
  • Required: Yes
  • Type: GeneratedPolicyResult structure

A GeneratedPolicyResult object that contains the generated policies and associated details.

jobDetails
  • Required: Yes
  • Type: JobDetails structure

A GeneratedPolicyDetails object that contains details about the generated policy.

Errors

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListAccessPreviewFindings

$result = $client->listAccessPreviewFindings([/* ... */]);
$promise = $client->listAccessPreviewFindingsAsync([/* ... */]);

Retrieves a list of access preview findings generated by the specified access preview.

Parameter Syntax

$result = $client->listAccessPreviewFindings([
    'accessPreviewId' => '<string>', // REQUIRED
    'analyzerArn' => '<string>', // REQUIRED
    'filter' => [
        '<String>' => [
            'contains' => ['<string>', ...],
            'eq' => ['<string>', ...],
            'exists' => true || false,
            'neq' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
accessPreviewId
  • Required: Yes
  • Type: string

The unique ID for the access preview.

analyzerArn
  • Required: Yes
  • Type: string

The ARN of the analyzer used to generate the access.

filter
  • Type: Associative array of custom strings keys (String) to Criterion structures

Criteria to filter the returned findings.

maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

A token used for pagination of results returned.

Result Syntax

[
    'findings' => [
        [
            'action' => ['<string>', ...],
            'changeType' => 'CHANGED|NEW|UNCHANGED',
            'condition' => ['<string>', ...],
            'createdAt' => <DateTime>,
            'error' => '<string>',
            'existingFindingId' => '<string>',
            'existingFindingStatus' => 'ACTIVE|ARCHIVED|RESOLVED',
            'id' => '<string>',
            'isPublic' => true || false,
            'principal' => ['<string>', ...],
            'resource' => '<string>',
            'resourceOwnerAccount' => '<string>',
            'resourceType' => 'AWS::S3::Bucket|AWS::IAM::Role|AWS::SQS::Queue|AWS::Lambda::Function|AWS::Lambda::LayerVersion|AWS::KMS::Key|AWS::SecretsManager::Secret|AWS::EFS::FileSystem|AWS::EC2::Snapshot|AWS::ECR::Repository|AWS::RDS::DBSnapshot|AWS::RDS::DBClusterSnapshot|AWS::SNS::Topic',
            'sources' => [
                [
                    'detail' => [
                        'accessPointAccount' => '<string>',
                        'accessPointArn' => '<string>',
                    ],
                    'type' => 'POLICY|BUCKET_ACL|S3_ACCESS_POINT|S3_ACCESS_POINT_ACCOUNT',
                ],
                // ...
            ],
            'status' => 'ACTIVE|ARCHIVED|RESOLVED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
findings
  • Required: Yes
  • Type: Array of AccessPreviewFinding structures

A list of access preview findings that match the specified filter criteria.

nextToken
  • Type: string

A token used for pagination of results returned.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    A conflict exception error.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListAccessPreviews

$result = $client->listAccessPreviews([/* ... */]);
$promise = $client->listAccessPreviewsAsync([/* ... */]);

Retrieves a list of access previews for the specified analyzer.

Parameter Syntax

$result = $client->listAccessPreviews([
    'analyzerArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
analyzerArn
  • Required: Yes
  • Type: string

The ARN of the analyzer used to generate the access preview.

maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

A token used for pagination of results returned.

Result Syntax

[
    'accessPreviews' => [
        [
            'analyzerArn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'status' => 'COMPLETED|CREATING|FAILED',
            'statusReason' => [
                'code' => 'INTERNAL_ERROR|INVALID_CONFIGURATION',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
accessPreviews
  • Required: Yes
  • Type: Array of AccessPreviewSummary structures

A list of access previews retrieved for the analyzer.

nextToken
  • Type: string

A token used for pagination of results returned.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListAnalyzedResources

$result = $client->listAnalyzedResources([/* ... */]);
$promise = $client->listAnalyzedResourcesAsync([/* ... */]);

Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..

Parameter Syntax

$result = $client->listAnalyzedResources([
    'analyzerArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceType' => 'AWS::S3::Bucket|AWS::IAM::Role|AWS::SQS::Queue|AWS::Lambda::Function|AWS::Lambda::LayerVersion|AWS::KMS::Key|AWS::SecretsManager::Secret|AWS::EFS::FileSystem|AWS::EC2::Snapshot|AWS::ECR::Repository|AWS::RDS::DBSnapshot|AWS::RDS::DBClusterSnapshot|AWS::SNS::Topic',
]);

Parameter Details

Members
analyzerArn
  • Required: Yes
  • Type: string

The ARN of the analyzer to retrieve a list of analyzed resources from.

maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

A token used for pagination of results returned.

resourceType
  • Type: string

The type of resource.

Result Syntax

[
    'analyzedResources' => [
        [
            'resourceArn' => '<string>',
            'resourceOwnerAccount' => '<string>',
            'resourceType' => 'AWS::S3::Bucket|AWS::IAM::Role|AWS::SQS::Queue|AWS::Lambda::Function|AWS::Lambda::LayerVersion|AWS::KMS::Key|AWS::SecretsManager::Secret|AWS::EFS::FileSystem|AWS::EC2::Snapshot|AWS::ECR::Repository|AWS::RDS::DBSnapshot|AWS::RDS::DBClusterSnapshot|AWS::SNS::Topic',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
analyzedResources
  • Required: Yes
  • Type: Array of AnalyzedResourceSummary structures

A list of resources that were analyzed.

nextToken
  • Type: string

A token used for pagination of results returned.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListAnalyzers

$result = $client->listAnalyzers([/* ... */]);
$promise = $client->listAnalyzersAsync([/* ... */]);

Retrieves a list of analyzers.

Parameter Syntax

$result = $client->listAnalyzers([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'type' => 'ACCOUNT|ORGANIZATION',
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

A token used for pagination of results returned.

type
  • Type: string

The type of analyzer.

Result Syntax

[
    'analyzers' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastResourceAnalyzed' => '<string>',
            'lastResourceAnalyzedAt' => <DateTime>,
            'name' => '<string>',
            'status' => 'ACTIVE|CREATING|DISABLED|FAILED',
            'statusReason' => [
                'code' => 'AWS_SERVICE_ACCESS_DISABLED|DELEGATED_ADMINISTRATOR_DEREGISTERED|ORGANIZATION_DELETED|SERVICE_LINKED_ROLE_CREATION_FAILED',
            ],
            'tags' => ['<string>', ...],
            'type' => 'ACCOUNT|ORGANIZATION',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
analyzers
  • Required: Yes
  • Type: Array of AnalyzerSummary structures

The analyzers retrieved.

nextToken
  • Type: string

A token used for pagination of results returned.

Errors

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListArchiveRules

$result = $client->listArchiveRules([/* ... */]);
$promise = $client->listArchiveRulesAsync([/* ... */]);

Retrieves a list of archive rules created for the specified analyzer.

Parameter Syntax

$result = $client->listArchiveRules([
    'analyzerName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
analyzerName
  • Required: Yes
  • Type: string

The name of the analyzer to retrieve rules from.

maxResults
  • Type: int

The maximum number of results to return in the request.

nextToken
  • Type: string

A token used for pagination of results returned.

Result Syntax

[
    'archiveRules' => [
        [
            'createdAt' => <DateTime>,
            'filter' => [
                '<String>' => [
                    'contains' => ['<string>', ...],
                    'eq' => ['<string>', ...],
                    'exists' => true || false,
                    'neq' => ['<string>', ...],
                ],
                // ...
            ],
            'ruleName' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
archiveRules
  • Required: Yes
  • Type: Array of ArchiveRuleSummary structures

A list of archive rules created for the specified analyzer.

nextToken
  • Type: string

A token used for pagination of results returned.

Errors

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListFindings

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

Retrieves a list of findings generated by the specified analyzer.

To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.

Parameter Syntax

$result = $client->listFindings([
    'analyzerArn' => '<string>', // REQUIRED
    'filter' => [
        '<String>' => [
            'contains' => ['<string>', ...],
            'eq' => ['<string>', ...],
            'exists' => true || false,
            'neq' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sort' => [
        'attributeName' => '<string>',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Members
analyzerArn
  • Required: Yes
  • Type: string

The ARN of the analyzer to retrieve findings from.

filter
  • Type: Associative array of custom strings keys (String) to Criterion structures

A filter to match for the findings to return.

maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

A token used for pagination of results returned.

sort
  • Type: SortCriteria structure

The sort order for the findings returned.

Result Syntax

[
    'findings' => [
        [
            'action' => ['<string>', ...],
            'analyzedAt' => <DateTime>,
            'condition' => ['<string>', ...],
            'createdAt' => <DateTime>,
            'error' => '<string>',
            'id' => '<string>',
            'isPublic' => true || false,
            'principal' => ['<string>', ...],
            'resource' => '<string>',
            'resourceOwnerAccount' => '<string>',
            'resourceType' => 'AWS::S3::Bucket|AWS::IAM::Role|AWS::SQS::Queue|AWS::Lambda::Function|AWS::Lambda::LayerVersion|AWS::KMS::Key|AWS::SecretsManager::Secret|AWS::EFS::FileSystem|AWS::EC2::Snapshot|AWS::ECR::Repository|AWS::RDS::DBSnapshot|AWS::RDS::DBClusterSnapshot|AWS::SNS::Topic',
            'sources' => [
                [
                    'detail' => [
                        'accessPointAccount' => '<string>',
                        'accessPointArn' => '<string>',
                    ],
                    'type' => 'POLICY|BUCKET_ACL|S3_ACCESS_POINT|S3_ACCESS_POINT_ACCOUNT',
                ],
                // ...
            ],
            'status' => 'ACTIVE|ARCHIVED|RESOLVED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
findings
  • Required: Yes
  • Type: Array of FindingSummary structures

A list of findings retrieved from the analyzer that match the filter criteria specified, if any.

nextToken
  • Type: string

A token used for pagination of results returned.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListPolicyGenerations

$result = $client->listPolicyGenerations([/* ... */]);
$promise = $client->listPolicyGenerationsAsync([/* ... */]);

Lists all of the policy generations requested in the last seven days.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

A token used for pagination of results returned.

principalArn
  • Type: string

The ARN of the IAM entity (user or role) for which you are generating a policy. Use this with ListGeneratedPolicies to filter the results to only include results for a specific principal.

Result Syntax

[
    'nextToken' => '<string>',
    'policyGenerations' => [
        [
            'completedOn' => <DateTime>,
            'jobId' => '<string>',
            'principalArn' => '<string>',
            'startedOn' => <DateTime>,
            'status' => 'IN_PROGRESS|SUCCEEDED|FAILED|CANCELED',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

A token used for pagination of results returned.

policyGenerations
  • Required: Yes
  • Type: Array of PolicyGeneration structures

A PolicyGeneration object that contains details about the generated policy.

Errors

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ListTagsForResource

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

Retrieves a list of tags applied to the specified resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource to retrieve tags from.

Result Syntax

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

Result Details

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

The tags that are applied to the specified resource.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

StartPolicyGeneration

$result = $client->startPolicyGeneration([/* ... */]);
$promise = $client->startPolicyGenerationAsync([/* ... */]);

Starts the policy generation request.

Parameter Syntax

$result = $client->startPolicyGeneration([
    'clientToken' => '<string>',
    'cloudTrailDetails' => [
        'accessRole' => '<string>', // REQUIRED
        'endTime' => <integer || string || DateTime>,
        'startTime' => <integer || string || DateTime>, // REQUIRED
        'trails' => [ // REQUIRED
            [
                'allRegions' => true || false,
                'cloudTrailArn' => '<string>', // REQUIRED
                'regions' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'policyGenerationDetails' => [ // REQUIRED
        'principalArn' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
clientToken
  • Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

cloudTrailDetails
  • Type: CloudTrailDetails structure

A CloudTrailDetails object that contains details about a Trail that you want to analyze to generate policies.

policyGenerationDetails
  • Required: Yes
  • Type: PolicyGenerationDetails structure

Contains the ARN of the IAM entity (user or role) for which you are generating a policy.

Result Syntax

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

Result Details

Members
jobId
  • Required: Yes
  • Type: string

The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

Errors

  • ConflictException:

    A conflict exception error.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ServiceQuotaExceededException:

    Service quote met error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

StartResourceScan

$result = $client->startResourceScan([/* ... */]);
$promise = $client->startResourceScanAsync([/* ... */]);

Immediately starts a scan of the policies applied to the specified resource.

Parameter Syntax

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

Parameter Details

Members
analyzerArn
  • Required: Yes
  • Type: string

The ARN of the analyzer to use to scan the policies applied to the specified resource.

resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource to scan.

resourceOwnerAccount
  • Type: string

The Amazon Web Services account ID that owns the resource. For most Amazon Web Services resources, the owning account is the account in which the resource was created.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

TagResource

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

Adds a tag to the specified resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource to add the tag to.

tags
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to strings

The tags to add to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

UntagResource

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

Removes a tag from the specified resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource to remove the tag from.

tagKeys
  • Required: Yes
  • Type: Array of strings

The key for the tag to add.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

UpdateArchiveRule

$result = $client->updateArchiveRule([/* ... */]);
$promise = $client->updateArchiveRuleAsync([/* ... */]);

Updates the criteria and values for the specified archive rule.

Parameter Syntax

$result = $client->updateArchiveRule([
    'analyzerName' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'filter' => [ // REQUIRED
        '<String>' => [
            'contains' => ['<string>', ...],
            'eq' => ['<string>', ...],
            'exists' => true || false,
            'neq' => ['<string>', ...],
        ],
        // ...
    ],
    'ruleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
analyzerName
  • Required: Yes
  • Type: string

The name of the analyzer to update the archive rules for.

clientToken
  • Type: string

A client token.

filter
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to Criterion structures

A filter to match for the rules to update. Only rules that match the filter are updated.

ruleName
  • Required: Yes
  • Type: string

The name of the rule to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

UpdateFindings

$result = $client->updateFindings([/* ... */]);
$promise = $client->updateFindingsAsync([/* ... */]);

Updates the status for the specified findings.

Parameter Syntax

$result = $client->updateFindings([
    'analyzerArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'ids' => ['<string>', ...],
    'resourceArn' => '<string>',
    'status' => 'ACTIVE|ARCHIVED', // REQUIRED
]);

Parameter Details

Members
analyzerArn
  • Required: Yes
  • Type: string

The ARN of the analyzer that generated the findings to update.

clientToken
  • Type: string

A client token.

ids
  • Type: Array of strings

The IDs of the findings to update.

resourceArn
  • Type: string

The ARN of the resource identified in the finding.

status
  • Required: Yes
  • Type: string

The state represents the action to take to update the finding Status. Use ARCHIVE to change an Active finding to an Archived finding. Use ACTIVE to change an Archived finding to an Active finding.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

ValidatePolicy

$result = $client->validatePolicy([/* ... */]);
$promise = $client->validatePolicyAsync([/* ... */]);

Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices.

Parameter Syntax

$result = $client->validatePolicy([
    'locale' => 'DE|EN|ES|FR|IT|JA|KO|PT_BR|ZH_CN|ZH_TW',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'policyDocument' => '<string>', // REQUIRED
    'policyType' => 'IDENTITY_POLICY|RESOURCE_POLICY|SERVICE_CONTROL_POLICY', // REQUIRED
    'validatePolicyResourceType' => 'AWS::S3::Bucket|AWS::S3::AccessPoint|AWS::S3::MultiRegionAccessPoint|AWS::S3ObjectLambda::AccessPoint|AWS::IAM::AssumeRolePolicyDocument',
]);

Parameter Details

Members
locale
  • Type: string

The locale to use for localizing the findings.

maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

A token used for pagination of results returned.

policyDocument
  • Required: Yes
  • Type: string

The JSON policy document to use as the content for the policy.

policyType
  • Required: Yes
  • Type: string

The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups. They also include service-control policies (SCPs) that are attached to an Amazon Web Services organization, organizational unit (OU), or an account.

Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.

validatePolicyResourceType
  • Type: string

The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.

For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.

Result Syntax

[
    'findings' => [
        [
            'findingDetails' => '<string>',
            'findingType' => 'ERROR|SECURITY_WARNING|SUGGESTION|WARNING',
            'issueCode' => '<string>',
            'learnMoreLink' => '<string>',
            'locations' => [
                [
                    'path' => [
                        [
                            'index' => <integer>,
                            'key' => '<string>',
                            'substring' => [
                                'length' => <integer>,
                                'start' => <integer>,
                            ],
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'span' => [
                        'end' => [
                            'column' => <integer>,
                            'line' => <integer>,
                            'offset' => <integer>,
                        ],
                        'start' => [
                            'column' => <integer>,
                            'line' => <integer>,
                            'offset' => <integer>,
                        ],
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
findings
  • Required: Yes
  • Type: Array of ValidatePolicyFinding structures

The list of findings in a policy returned by IAM Access Analyzer based on its suite of policy checks.

nextToken
  • Type: string

A token used for pagination of results returned.

Errors

  • ValidationException:

    Validation exception error.

  • InternalServerException:

    Internal server error.

  • ThrottlingException:

    Throttling limit exceeded error.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
message
  • Required: Yes
  • Type: string

AccessPreview

Description

Contains information about an access preview.

Members
analyzerArn
  • Required: Yes
  • Type: string

The ARN of the analyzer used to generate the access preview.

configurations
  • Required: Yes
  • Type: Associative array of custom strings keys (ConfigurationsMapKey) to Configuration structures

A map of resource ARNs for the proposed resource configuration.

createdAt
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the access preview was created.

id
  • Required: Yes
  • Type: string

The unique ID for the access preview.

status
  • Required: Yes
  • Type: string

The status of the access preview.

  • Creating - The access preview creation is in progress.

  • Completed - The access preview is complete. You can preview findings for external access to the resource.

  • Failed - The access preview creation has failed.

statusReason
  • Type: AccessPreviewStatusReason structure

Provides more details about the current status of the access preview.

For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.

AccessPreviewFinding

Description

An access preview finding generated by the access preview.

Members
action
  • Type: Array of strings

The action in the analyzed policy statement that an external principal has permission to perform.

changeType
  • Required: Yes
  • Type: string

Provides context on how the access preview finding compares to existing access identified in IAM Access Analyzer.

  • New - The finding is for newly-introduced access.

  • Unchanged - The preview finding is an existing finding that would remain unchanged.

  • Changed - The preview finding is an existing finding with a change in status.

For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.

condition
  • Type: Associative array of custom strings keys (String) to strings

The condition in the analyzed policy statement that resulted in a finding.

createdAt
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the access preview finding was created.

error
  • Type: string

An error.

existingFindingId
  • Type: string

The existing ID of the finding in IAM Access Analyzer, provided only for existing findings.

existingFindingStatus
  • Type: string

The existing status of the finding, provided only for existing findings.

id
  • Required: Yes
  • Type: string

The ID of the access preview finding. This ID uniquely identifies the element in the list of access preview findings and is not related to the finding ID in Access Analyzer.

isPublic
  • Type: boolean

Indicates whether the policy that generated the finding allows public access to the resource.

principal
  • Type: Associative array of custom strings keys (String) to strings

The external principal that has access to a resource within the zone of trust.

resource
  • Type: string

The resource that an external principal has access to. This is the resource associated with the access preview.

resourceOwnerAccount
  • Required: Yes
  • Type: string

The Amazon Web Services account ID that owns the resource. For most Amazon Web Services resources, the owning account is the account in which the resource was created.

resourceType
  • Required: Yes
  • Type: string

The type of the resource that can be accessed in the finding.

sources
  • Type: Array of FindingSource structures

The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

status
  • Required: Yes
  • Type: string

The preview status of the finding. This is what the status of the finding would be after permissions deployment. For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.

AccessPreviewStatusReason

Description

Provides more details about the current status of the access preview. For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid proposed resource configuration.

Members
code
  • Required: Yes
  • Type: string

The reason code for the current status of the access preview.

AccessPreviewSummary

Description

Contains a summary of information about an access preview.

Members
analyzerArn
  • Required: Yes
  • Type: string

The ARN of the analyzer used to generate the access preview.

createdAt
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the access preview was created.

id
  • Required: Yes
  • Type: string

The unique ID for the access preview.

status
  • Required: Yes
  • Type: string

The status of the access preview.

  • Creating - The access preview creation is in progress.

  • Completed - The access preview is complete and previews the findings for external access to the resource.

  • Failed - The access preview creation has failed.

statusReason
  • Type: AccessPreviewStatusReason structure

Provides more details about the current status of the access preview. For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid proposed resource configuration.

AclGrantee

Description

You specify each grantee as a type-value pair using one of these types. You can specify only one type of grantee. For more information, see PutBucketAcl.

Members
id
  • Type: string

The value specified is the canonical user ID of an Amazon Web Services account.

uri
  • Type: string

Used for granting permissions to a predefined group.

AnalyzedResource

Description

Contains details about the analyzed resource.

Members
actions
  • Type: Array of strings

The actions that an external principal is granted permission to use by the policy that generated the finding.

analyzedAt
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the resource was analyzed.

createdAt
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the finding was created.

error
  • Type: string

An error message.

isPublic
  • Required: Yes
  • Type: boolean

Indicates whether the policy that generated the finding grants public access to the resource.

resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource that was analyzed.

resourceOwnerAccount
  • Required: Yes
  • Type: string

The Amazon Web Services account ID that owns the resource.

resourceType
  • Required: Yes
  • Type: string

The type of the resource that was analyzed.

sharedVia
  • Type: Array of strings

Indicates how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.

status
  • Type: string

The current status of the finding generated from the analyzed resource.

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

The time at which the finding was updated.

AnalyzedResourceSummary

Description

Contains the ARN of the analyzed resource.

Members
resourceArn
  • Required: Yes
  • Type: string

The ARN of the analyzed resource.

resourceOwnerAccount
  • Required: Yes
  • Type: string

The Amazon Web Services account ID that owns the resource.

resourceType
  • Required: Yes
  • Type: string

The type of resource that was analyzed.

AnalyzerSummary

Description

Contains information about the analyzer.

Members
arn
  • Required: Yes
  • Type: string

The ARN of the analyzer.

createdAt
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp for the time at which the analyzer was created.

lastResourceAnalyzed
  • Type: string

The resource that was most recently analyzed by the analyzer.

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

The time at which the most recently analyzed resource was analyzed.

name
  • Required: Yes
  • Type: string

The name of the analyzer.

status
  • Required: Yes
  • Type: string

The status of the analyzer. An Active analyzer successfully monitors supported resources and generates new findings. The analyzer is Disabled when a user action, such as removing trusted access for Identity and Access Management Access Analyzer from Organizations, causes the analyzer to stop generating new findings. The status is Creating when the analyzer creation is in progress and Failed when the analyzer creation has failed.

statusReason
  • Type: StatusReason structure

The statusReason provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a Failed status is returned. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the Amazon Web Services organization.

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

The tags added to the analyzer.

type
  • Required: Yes
  • Type: string

The type of analyzer, which corresponds to the zone of trust chosen for the analyzer.

ArchiveRuleSummary

Description

Contains information about an archive rule.

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

The time at which the archive rule was created.

filter
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to Criterion structures

A filter used to define the archive rule.

ruleName
  • Required: Yes
  • Type: string

The name of the archive rule.

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

The time at which the archive rule was last updated.

CloudTrailDetails

Description

Contains information about CloudTrail access.

Members
accessRole
  • Required: Yes
  • Type: string

The ARN of the service role that IAM Access Analyzer uses to access your CloudTrail trail and service last accessed information.

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

The end of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp after this time are not considered to generate a policy. If this is not included in the request, the default value is the current time.

startTime
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The start of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp before this time are not considered to generate a policy.

trails
  • Required: Yes
  • Type: Array of Trail structures

A Trail object that contains settings for a trail.

CloudTrailProperties

Description

Contains information about CloudTrail access.

Members
endTime
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The end of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp after this time are not considered to generate a policy. If this is not included in the request, the default value is the current time.

startTime
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The start of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp before this time are not considered to generate a policy.

trailProperties
  • Required: Yes
  • Type: Array of TrailProperties structures

A TrailProperties object that contains settings for trail properties.

Configuration

Description

Access control configuration structures for your resource. You specify the configuration as a type-value pair. You can specify only one type of access control configuration.

Members
ebsSnapshot
  • Type: EbsSnapshotConfiguration structure

The access control configuration is for an Amazon EBS volume snapshot.

ecrRepository
  • Type: EcrRepositoryConfiguration structure

The access control configuration is for an Amazon ECR repository.

efsFileSystem
  • Type: EfsFileSystemConfiguration structure

The access control configuration is for an Amazon EFS file system.

iamRole
  • Type: IamRoleConfiguration structure

The access control configuration is for an IAM role.

kmsKey
  • Type: KmsKeyConfiguration structure

The access control configuration is for a KMS key.

rdsDbClusterSnapshot
  • Type: RdsDbClusterSnapshotConfiguration structure

The access control configuration is for an Amazon RDS DB cluster snapshot.

rdsDbSnapshot
  • Type: RdsDbSnapshotConfiguration structure

The access control configuration is for an Amazon RDS DB snapshot.

s3Bucket
  • Type: S3BucketConfiguration structure

The access control configuration is for an Amazon S3 Bucket.

secretsManagerSecret
  • Type: SecretsManagerSecretConfiguration structure

The access control configuration is for a Secrets Manager secret.

snsTopic
  • Type: SnsTopicConfiguration structure

The access control configuration is for an Amazon SNS topic

sqsQueue
  • Type: SqsQueueConfiguration structure

The access control configuration is for an Amazon SQS queue.

ConflictException

Description

A conflict exception error.

Members
message
  • Required: Yes
  • Type: string
resourceId
  • Required: Yes
  • Type: string

The ID of the resource.

resourceType
  • Required: Yes
  • Type: string

The resource type.

Criterion

Description

The criteria to use in the filter that defines the archive rule. For more information on available filter keys, see IAM Access Analyzer filter keys.

Members
contains
  • Type: Array of strings

A "contains" operator to match for the filter used to create the rule.

eq
  • Type: Array of strings

An "equals" operator to match for the filter used to create the rule.

exists
  • Type: boolean

An "exists" operator to match for the filter used to create the rule.

neq
  • Type: Array of strings

A "not equals" operator to match for the filter used to create the rule.

EbsSnapshotConfiguration

Description

The proposed access control configuration for an Amazon EBS volume snapshot. You can propose a configuration for a new Amazon EBS volume snapshot or an Amazon EBS volume snapshot that you own by specifying the user IDs, groups, and optional KMS encryption key. For more information, see ModifySnapshotAttribute.

Members
groups
  • Type: Array of strings

The groups that have access to the Amazon EBS volume snapshot. If the value all is specified, then the Amazon EBS volume snapshot is public.

  • If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the groups, then the access preview uses the existing shared groups for the snapshot.

  • If the access preview is for a new resource and you do not specify the groups, then the access preview considers the snapshot without any groups.

  • To propose deletion of existing shared groups, you can specify an empty list for groups.

kmsKeyId
  • Type: string

The KMS key identifier for an encrypted Amazon EBS volume snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

  • If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot.

  • If the access preview is for a new resource and you do not specify the kmsKeyId, the access preview considers the snapshot as unencrypted.

userIds
  • Type: Array of strings

The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.

  • If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the userIds, then the access preview uses the existing shared userIds for the snapshot.

  • If the access preview is for a new resource and you do not specify the userIds, then the access preview considers the snapshot without any userIds.

  • To propose deletion of existing shared accountIds, you can specify an empty list for userIds.

EcrRepositoryConfiguration

Description

The proposed access control configuration for an Amazon ECR repository. You can propose a configuration for a new Amazon ECR repository or an existing Amazon ECR repository that you own by specifying the Amazon ECR policy. For more information, see Repository.

  • If the configuration is for an existing Amazon ECR repository and you do not specify the Amazon ECR policy, then the access preview uses the existing Amazon ECR policy for the repository.

  • If the access preview is for a new resource and you do not specify the policy, then the access preview assumes an Amazon ECR repository without a policy.

  • To propose deletion of an existing Amazon ECR repository policy, you can specify an empty string for the Amazon ECR policy.

Members
repositoryPolicy
  • Type: string

The JSON repository policy text to apply to the Amazon ECR repository. For more information, see Private repository policy examples in the Amazon ECR User Guide.

EfsFileSystemConfiguration

Description

The proposed access control configuration for an Amazon EFS file system. You can propose a configuration for a new Amazon EFS file system or an existing Amazon EFS file system that you own by specifying the Amazon EFS policy. For more information, see Using file systems in Amazon EFS.

  • If the configuration is for an existing Amazon EFS file system and you do not specify the Amazon EFS policy, then the access preview uses the existing Amazon EFS policy for the file system.

  • If the access preview is for a new resource and you do not specify the policy, then the access preview assumes an Amazon EFS file system without a policy.

  • To propose deletion of an existing Amazon EFS file system policy, you can specify an empty string for the Amazon EFS policy.

Members
fileSystemPolicy
  • Type: string

The JSON policy definition to apply to the Amazon EFS file system. For more information on the elements that make up a file system policy, see Amazon EFS Resource-based policies.

Finding

Description

Contains information about a finding.

Members
action
  • Type: Array of strings

The action in the analyzed policy statement that an external principal has permission to use.

analyzedAt
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the resource was analyzed.

condition
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to strings

The condition in the analyzed policy statement that resulted in a finding.

createdAt
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the finding was generated.

error
  • Type: string

An error.

id
  • Required: Yes
  • Type: string

The ID of the finding.

isPublic
  • Type: boolean

Indicates whether the policy that generated the finding allows public access to the resource.

principal
  • Type: Associative array of custom strings keys (String) to strings

The external principal that access to a resource within the zone of trust.

resource
  • Type: string

The resource that an external principal has access to.

resourceOwnerAccount
  • Required: Yes
  • Type: string

The Amazon Web Services account ID that owns the resource.

resourceType
  • Required: Yes
  • Type: string

The type of the resource identified in the finding.

sources
  • Type: Array of FindingSource structures

The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

status
  • Required: Yes
  • Type: string

The current status of the finding.

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

The time at which the finding was updated.

FindingSource

Description

The source of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

Members
detail
  • Type: FindingSourceDetail structure

Includes details about how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.

type
  • Required: Yes
  • Type: string

Indicates the type of access that generated the finding.

FindingSourceDetail

Description

Includes details about how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.

Members
accessPointAccount
  • Type: string

The account of the cross-account access point that generated the finding.

accessPointArn
  • Type: string

The ARN of the access point that generated the finding. The ARN format depends on whether the ARN represents an access point or a multi-region access point.

FindingSummary

Description

Contains information about a finding.

Members
action
  • Type: Array of strings

The action in the analyzed policy statement that an external principal has permission to use.

analyzedAt
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the resource-based policy that generated the finding was analyzed.

condition
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to strings

The condition in the analyzed policy statement that resulted in a finding.

createdAt
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the finding was created.

error
  • Type: string

The error that resulted in an Error finding.

id
  • Required: Yes
  • Type: string

The ID of the finding.

isPublic
  • Type: boolean

Indicates whether the finding reports a resource that has a policy that allows public access.

principal
  • Type: Associative array of custom strings keys (String) to strings

The external principal that has access to a resource within the zone of trust.

resource
  • Type: string

The resource that the external principal has access to.

resourceOwnerAccount
  • Required: Yes
  • Type: string

The Amazon Web Services account ID that owns the resource.

resourceType
  • Required: Yes
  • Type: string

The type of the resource that the external principal has access to.

sources
  • Type: Array of FindingSource structures

The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

status
  • Required: Yes
  • Type: string

The status of the finding.

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

The time at which the finding was most recently updated.

GeneratedPolicy

Description

Contains the text for the generated policy.

Members
policy
  • Required: Yes
  • Type: string

The text to use as the content for the new policy. The policy is created using the CreatePolicy action.

GeneratedPolicyProperties

Description

Contains the generated policy details.

Members
cloudTrailProperties
  • Type: CloudTrailProperties structure

Lists details about the Trail used to generated policy.

isComplete
  • Type: boolean

This value is set to true if the generated policy contains all possible actions for a service that IAM Access Analyzer identified from the CloudTrail trail that you specified, and false otherwise.

principalArn
  • Required: Yes
  • Type: string

The ARN of the IAM entity (user or role) for which you are generating a policy.

GeneratedPolicyResult

Description

Contains the text for the generated policy and its details.

Members
generatedPolicies
  • Type: Array of GeneratedPolicy structures

The text to use as the content for the new policy. The policy is created using the CreatePolicy action.

properties
  • Required: Yes
  • Type: GeneratedPolicyProperties structure

A GeneratedPolicyProperties object that contains properties of the generated policy.

IamRoleConfiguration

Description

The proposed access control configuration for an IAM role. You can propose a configuration for a new IAM role or an existing IAM role that you own by specifying the trust policy. If the configuration is for a new IAM role, you must specify the trust policy. If the configuration is for an existing IAM role that you own and you do not propose the trust policy, the access preview uses the existing trust policy for the role. The proposed trust policy cannot be an empty string. For more information about role trust policy limits, see IAM and STS quotas.

Members
trustPolicy
  • Type: string

The proposed trust policy for the IAM role.

InlineArchiveRule

Description

An criterion statement in an archive rule. Each archive rule may have multiple criteria.

Members
filter
  • Required: Yes
  • Type: Associative array of custom strings keys (String) to Criterion structures

The condition and values for a criterion.

ruleName
  • Required: Yes
  • Type: string

The name of the rule.

InternalServerException

Description

Internal server error.

Members
message
  • Required: Yes
  • Type: string
retryAfterSeconds
  • Type: int

The seconds to wait to retry.

InternetConfiguration

Description

This configuration sets the network origin for the Amazon S3 access point or multi-region access point to Internet.

Members

JobDetails

Description

Contains details about the policy generation request.

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

A timestamp of when the job was completed.

jobError
  • Type: JobError structure

The job error for the policy generation request.

jobId
  • Required: Yes
  • Type: string

The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

startedOn
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the job was started.

status
  • Required: Yes
  • Type: string

The status of the job request.

JobError

Description

Contains the details about the policy generation error.

Members
code
  • Required: Yes
  • Type: string

The job error code.

message
  • Required: Yes
  • Type: string

Specific information about the error. For example, which service quota was exceeded or which resource was not found.

KmsGrantConfiguration

Description

A proposed grant configuration for a KMS key. For more information, see CreateGrant.

Members
constraints
  • Type: KmsGrantConstraints structure

Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context.

granteePrincipal
  • Required: Yes
  • Type: string

The principal that is given permission to perform the operations that the grant permits.

issuingAccount
  • Required: Yes
  • Type: string

The Amazon Web Services account under which the grant was issued. The account is used to propose KMS grants issued by accounts other than the owner of the key.

operations
  • Required: Yes
  • Type: Array of strings

A list of operations that the grant permits.

retiringPrincipal
  • Type: string

The principal that is given permission to retire the grant by using RetireGrant operation.

KmsGrantConstraints

Description

Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context. You can specify only one type of encryption context. An empty map is treated as not specified. For more information, see GrantConstraints.

Members
encryptionContextEquals
  • Type: Associative array of custom strings keys (KmsConstraintsKey) to strings

A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.

encryptionContextSubset
  • Type: Associative array of custom strings keys (KmsConstraintsKey) to strings

A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.

KmsKeyConfiguration

Description

Proposed access control configuration for a KMS key. You can propose a configuration for a new KMS key or an existing KMS key that you own by specifying the key policy and KMS grant configuration. If the configuration is for an existing key and you do not specify the key policy, the access preview uses the existing policy for the key. If the access preview is for a new resource and you do not specify the key policy, then the access preview uses the default key policy. The proposed key policy cannot be an empty string. For more information, see Default key policy. For more information about key policy limits, see Resource quotas.

Members
grants
  • Type: Array of KmsGrantConfiguration structures

A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.

keyPolicies
  • Type: Associative array of custom strings keys (PolicyName) to strings

Resource policy configuration for the KMS key. The only valid value for the name of the key policy is default. For more information, see Default key policy.

Location

Description

A location in a policy that is represented as a path through the JSON representation and a corresponding span.

Members
path
  • Required: Yes
  • Type: Array of PathElement structures

A path in a policy, represented as a sequence of path elements.

span
  • Required: Yes
  • Type: Span structure

A span in a policy.

NetworkOriginConfiguration

Description

The proposed InternetConfiguration or VpcConfiguration to apply to the Amazon S3 access point. VpcConfiguration does not apply to multi-region access points. You can make the access point accessible from the internet, or you can specify that all requests made through that access point must originate from a specific virtual private cloud (VPC). You can specify only one type of network configuration. For more information, see Creating access points.

Members
internetConfiguration
  • Type: InternetConfiguration structure

The configuration for the Amazon S3 access point or multi-region access point with an Internet origin.

vpcConfiguration
  • Type: VpcConfiguration structure

The proposed virtual private cloud (VPC) configuration for the Amazon S3 access point. VPC configuration does not apply to multi-region access points. For more information, see VpcConfiguration.

PathElement

Description

A single element in a path through the JSON representation of a policy.

Members
index
  • Type: int

Refers to an index in a JSON array.

key
  • Type: string

Refers to a key in a JSON object.

substring
  • Type: Substring structure

Refers to a substring of a literal string in a JSON object.

value
  • Type: string

Refers to the value associated with a given key in a JSON object.

PolicyGeneration

Description

Contains details about the policy generation status and properties.

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

A timestamp of when the policy generation was completed.

jobId
  • Required: Yes
  • Type: string

The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

principalArn
  • Required: Yes
  • Type: string

The ARN of the IAM entity (user or role) for which you are generating a policy.

startedOn
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the policy generation started.

status
  • Required: Yes
  • Type: string

The status of the policy generation request.

PolicyGenerationDetails

Description

Contains the ARN details about the IAM entity for which the policy is generated.

Members
principalArn
  • Required: Yes
  • Type: string

The ARN of the IAM entity (user or role) for which you are generating a policy.

Position

Description

A position in a policy.

Members
column
  • Required: Yes
  • Type: int

The column of the position, starting from 0.

line
  • Required: Yes
  • Type: int

The line of the position, starting from 1.

offset
  • Required: Yes
  • Type: int

The offset within the policy that corresponds to the position, starting from 0.

RdsDbClusterSnapshotAttributeValue

Description

The values for a manual Amazon RDS DB cluster snapshot attribute.

Members
accountIds
  • Type: Array of strings

The Amazon Web Services account IDs that have access to the manual Amazon RDS DB cluster snapshot. If the value all is specified, then the Amazon RDS DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

  • If the configuration is for an existing Amazon RDS DB cluster snapshot and you do not specify the accountIds in RdsDbClusterSnapshotAttributeValue, then the access preview uses the existing shared accountIds for the snapshot.

  • If the access preview is for a new resource and you do not specify the specify the accountIds in RdsDbClusterSnapshotAttributeValue, then the access preview considers the snapshot without any attributes.

  • To propose deletion of existing shared accountIds, you can specify an empty list for accountIds in the RdsDbClusterSnapshotAttributeValue.

RdsDbClusterSnapshotConfiguration

Description

The proposed access control configuration for an Amazon RDS DB cluster snapshot. You can propose a configuration for a new Amazon RDS DB cluster snapshot or an Amazon RDS DB cluster snapshot that you own by specifying the RdsDbClusterSnapshotAttributeValue and optional KMS encryption key. For more information, see ModifyDBClusterSnapshotAttribute.

Members
attributes
  • Type: Associative array of custom strings keys (RdsDbClusterSnapshotAttributeName) to RdsDbClusterSnapshotAttributeValue structures

The names and values of manual DB cluster snapshot attributes. Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. The only valid value for AttributeName for the attribute map is restore

kmsKeyId
  • Type: string

The KMS key identifier for an encrypted Amazon RDS DB cluster snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

  • If the configuration is for an existing Amazon RDS DB cluster snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot.

  • If the access preview is for a new resource and you do not specify the specify the kmsKeyId, then the access preview considers the snapshot as unencrypted.

RdsDbSnapshotAttributeValue

Description

The name and values of a manual Amazon RDS DB snapshot attribute. Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot.

Members
accountIds
  • Type: Array of strings

The Amazon Web Services account IDs that have access to the manual Amazon RDS DB snapshot. If the value all is specified, then the Amazon RDS DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.

  • If the configuration is for an existing Amazon RDS DB snapshot and you do not specify the accountIds in RdsDbSnapshotAttributeValue, then the access preview uses the existing shared accountIds for the snapshot.

  • If the access preview is for a new resource and you do not specify the specify the accountIds in RdsDbSnapshotAttributeValue, then the access preview considers the snapshot without any attributes.

  • To propose deletion of an existing shared accountIds, you can specify an empty list for accountIds in the RdsDbSnapshotAttributeValue.

RdsDbSnapshotConfiguration

Description

The proposed access control configuration for an Amazon RDS DB snapshot. You can propose a configuration for a new Amazon RDS DB snapshot or an Amazon RDS DB snapshot that you own by specifying the RdsDbSnapshotAttributeValue and optional KMS encryption key. For more information, see ModifyDBSnapshotAttribute.

Members
attributes
  • Type: Associative array of custom strings keys (RdsDbSnapshotAttributeName) to RdsDbSnapshotAttributeValue structures

The names and values of manual DB snapshot attributes. Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. The only valid value for attributeName for the attribute map is restore.

kmsKeyId
  • Type: string

The KMS key identifier for an encrypted Amazon RDS DB snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

  • If the configuration is for an existing Amazon RDS DB snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot.

  • If the access preview is for a new resource and you do not specify the specify the kmsKeyId, then the access preview considers the snapshot as unencrypted.

ResourceNotFoundException

Description

The specified resource could not be found.

Members
message
  • Required: Yes
  • Type: string
resourceId
  • Required: Yes
  • Type: string

The ID of the resource.

resourceType
  • Required: Yes
  • Type: string

The type of the resource.

S3AccessPointConfiguration

Description

The configuration for an Amazon S3 access point or multi-region access point for the bucket. You can propose up to 10 access points or multi-region access points per bucket. If the proposed Amazon S3 access point configuration is for an existing bucket, the access preview uses the proposed access point configuration in place of the existing access points. To propose an access point without a policy, you can provide an empty string as the access point policy. For more information, see Creating access points. For more information about access point policy limits, see Access points restrictions and limitations.

Members
accessPointPolicy
  • Type: string

The access point or multi-region access point policy.

networkOrigin
  • Type: NetworkOriginConfiguration structure

The proposed Internet and VpcConfiguration to apply to this Amazon S3 access point. VpcConfiguration does not apply to multi-region access points. If the access preview is for a new resource and neither is specified, the access preview uses Internet for the network origin. If the access preview is for an existing resource and neither is specified, the access preview uses the exiting network origin.

publicAccessBlock
  • Type: S3PublicAccessBlockConfiguration structure

The proposed S3PublicAccessBlock configuration to apply to this Amazon S3 access point or multi-region access point.

S3BucketAclGrantConfiguration

Description

A proposed access control list grant configuration for an Amazon S3 bucket. For more information, see How to Specify an ACL.

Members
grantee
  • Required: Yes
  • Type: AclGrantee structure

The grantee to whom you’re assigning access rights.

permission
  • Required: Yes
  • Type: string

The permissions being granted.

S3BucketConfiguration

Description

Proposed access control configuration for an Amazon S3 bucket. You can propose a configuration for a new Amazon S3 bucket or an existing Amazon S3 bucket that you own by specifying the Amazon S3 bucket policy, bucket ACLs, bucket BPA settings, Amazon S3 access points, and multi-region access points attached to the bucket. If the configuration is for an existing Amazon S3 bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the existing policy attached to the bucket. If the access preview is for a new resource and you do not specify the Amazon S3 bucket policy, the access preview assumes a bucket without a policy. To propose deletion of an existing bucket policy, you can specify an empty string. For more information about bucket policy limits, see Bucket Policy Examples.

Members
accessPoints
  • Type: Associative array of custom strings keys (AccessPointArn) to S3AccessPointConfiguration structures

The configuration of Amazon S3 access points or multi-region access points for the bucket. You can propose up to 10 new access points per bucket.

bucketAclGrants
  • Type: Array of S3BucketAclGrantConfiguration structures

The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL grants per bucket. If the proposed grant configuration is for an existing bucket, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the bucket.

bucketPolicy
  • Type: string

The proposed bucket policy for the Amazon S3 bucket.

bucketPublicAccessBlock
  • Type: S3PublicAccessBlockConfiguration structure

The proposed block public access configuration for the Amazon S3 bucket.

S3PublicAccessBlockConfiguration

Description

The PublicAccessBlock configuration to apply to this Amazon S3 bucket. If the proposed configuration is for an existing Amazon S3 bucket and the configuration is not specified, the access preview uses the existing setting. If the proposed configuration is for a new bucket and the configuration is not specified, the access preview uses false. If the proposed configuration is for a new access point or multi-region access point and the access point BPA configuration is not specified, the access preview uses true. For more information, see PublicAccessBlockConfiguration.

Members
ignorePublicAcls
  • Required: Yes
  • Type: boolean

Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket.

restrictPublicBuckets
  • Required: Yes
  • Type: boolean

Specifies whether Amazon S3 should restrict public bucket policies for this bucket.

SecretsManagerSecretConfiguration

Description

The configuration for a Secrets Manager secret. For more information, see CreateSecret.

You can propose a configuration for a new secret or an existing secret that you own by specifying the secret policy and optional KMS encryption key. If the configuration is for an existing secret and you do not specify the secret policy, the access preview uses the existing policy for the secret. If the access preview is for a new resource and you do not specify the policy, the access preview assumes a secret without a policy. To propose deletion of an existing policy, you can specify an empty string. If the proposed configuration is for a new secret and you do not specify the KMS key ID, the access preview uses the Amazon Web Services managed key aws/secretsmanager. If you specify an empty string for the KMS key ID, the access preview uses the Amazon Web Services managed key of the Amazon Web Services account. For more information about secret policy limits, see Quotas for Secrets Manager..

Members
kmsKeyId
  • Type: string

The proposed ARN, key ID, or alias of the KMS key.

secretPolicy
  • Type: string

The proposed resource policy defining who can access or manage the secret.

ServiceQuotaExceededException

Description

Service quote met error.

Members
message
  • Required: Yes
  • Type: string
resourceId
  • Required: Yes
  • Type: string

The resource ID.

resourceType
  • Required: Yes
  • Type: string

The resource type.

SnsTopicConfiguration

Description

The proposed access control configuration for an Amazon SNS topic. You can propose a configuration for a new Amazon SNS topic or an existing Amazon SNS topic that you own by specifying the policy. If the configuration is for an existing Amazon SNS topic and you do not specify the Amazon SNS policy, then the access preview uses the existing Amazon SNS policy for the topic. If the access preview is for a new resource and you do not specify the policy, then the access preview assumes an Amazon SNS topic without a policy. To propose deletion of an existing Amazon SNS topic policy, you can specify an empty string for the Amazon SNS policy. For more information, see Topic.

Members
topicPolicy
  • Type: string

The JSON policy text that defines who can access an Amazon SNS topic. For more information, see Example cases for Amazon SNS access control in the Amazon SNS Developer Guide.

SortCriteria

Description

The criteria used to sort.

Members
attributeName
  • Type: string

The name of the attribute to sort on.

orderBy
  • Type: string

The sort order, ascending or descending.

Span

Description

A span in a policy. The span consists of a start position (inclusive) and end position (exclusive).

Members
end
  • Required: Yes
  • Type: Position structure

The end position of the span (exclusive).

start
  • Required: Yes
  • Type: Position structure

The start position of the span (inclusive).

SqsQueueConfiguration

Description

The proposed access control configuration for an Amazon SQS queue. You can propose a configuration for a new Amazon SQS queue or an existing Amazon SQS queue that you own by specifying the Amazon SQS policy. If the configuration is for an existing Amazon SQS queue and you do not specify the Amazon SQS policy, the access preview uses the existing Amazon SQS policy for the queue. If the access preview is for a new resource and you do not specify the policy, the access preview assumes an Amazon SQS queue without a policy. To propose deletion of an existing Amazon SQS queue policy, you can specify an empty string for the Amazon SQS policy. For more information about Amazon SQS policy limits, see Quotas related to policies.

Members
queuePolicy
  • Type: string

The proposed resource policy for the Amazon SQS queue.

StatusReason

Description

Provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a Failed status is returned. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the Amazon Web Services organization.

Members
code
  • Required: Yes
  • Type: string

The reason code for the current status of the analyzer.

Substring

Description

A reference to a substring of a literal string in a JSON document.

Members
length
  • Required: Yes
  • Type: int

The length of the substring.

start
  • Required: Yes
  • Type: int

The start index of the substring, starting from 0.

ThrottlingException

Description

Throttling limit exceeded error.

Members
message
  • Required: Yes
  • Type: string
retryAfterSeconds
  • Type: int

The seconds to wait to retry.

Trail

Description

Contains details about the CloudTrail trail being analyzed to generate a policy.

Members
allRegions
  • Type: boolean

Possible values are true or false. If set to true, IAM Access Analyzer retrieves CloudTrail data from all regions to analyze and generate a policy.

cloudTrailArn
  • Required: Yes
  • Type: string

Specifies the ARN of the trail. The format of a trail ARN is arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.

regions
  • Type: Array of strings

A list of regions to get CloudTrail data from and analyze to generate a policy.

TrailProperties

Description

Contains details about the CloudTrail trail being analyzed to generate a policy.

Members
allRegions
  • Type: boolean

Possible values are true or false. If set to true, IAM Access Analyzer retrieves CloudTrail data from all regions to analyze and generate a policy.

cloudTrailArn
  • Required: Yes
  • Type: string

Specifies the ARN of the trail. The format of a trail ARN is arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.

regions
  • Type: Array of strings

A list of regions to get CloudTrail data from and analyze to generate a policy.

ValidatePolicyFinding

Description

A finding in a policy. Each finding is an actionable recommendation that can be used to improve the policy.

Members
findingDetails
  • Required: Yes
  • Type: string

A localized message that explains the finding and provides guidance on how to address it.

findingType
  • Required: Yes
  • Type: string

The impact of the finding.

Security warnings report when the policy allows access that we consider overly permissive.

Errors report when a part of the policy is not functional.

Warnings report non-security issues when a policy does not conform to policy writing best practices.

Suggestions recommend stylistic improvements in the policy that do not impact access.

issueCode
  • Required: Yes
  • Type: string

The issue code provides an identifier of the issue associated with this finding.

learnMoreLink
  • Required: Yes
  • Type: string

A link to additional documentation about the type of finding.

locations
  • Required: Yes
  • Type: Array of Location structures

The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.

ValidationException

Description

Validation exception error.

Members
fieldList
  • Type: Array of ValidationExceptionField structures

A list of fields that didn't validate.

message
  • Required: Yes
  • Type: string
reason
  • Required: Yes
  • Type: string

The reason for the exception.

ValidationExceptionField

Description

Contains information about a validation exception.

Members
message
  • Required: Yes
  • Type: string

A message about the validation exception.

name
  • Required: Yes
  • Type: string

The name of the validation exception.

VpcConfiguration

Description

The proposed virtual private cloud (VPC) configuration for the Amazon S3 access point. VPC configuration does not apply to multi-region access points. For more information, see VpcConfiguration.

Members
vpcId
  • Required: Yes
  • Type: string

If this field is specified, this access point will only allow connections from the specified VPC ID.

AWS SDK for PHP 3.x API documentation generated by ApiGen