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

Namespaces

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

Classes

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

Interfaces

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

Traits

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

Exceptions

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

Functions

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

AWS Well-Architected Tool 2020-03-31

Client: Aws\WellArchitected\WellArchitectedClient
Service ID: wellarchitected
Version: 2020-03-31

This page describes the parameters and results for the operations of the AWS Well-Architected Tool (2020-03-31), and shows how to use the Aws\WellArchitected\WellArchitectedClient object to call the described operations. This documentation is specific to the 2020-03-31 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 */).

  • AssociateLenses ( array $params = [] )

    Associate a lens to a workload.

  • CreateMilestone ( array $params = [] )

    Create a milestone for an existing workload.

  • CreateWorkload ( array $params = [] )

    Create a new workload.

  • CreateWorkloadShare ( array $params = [] )

    Create a workload share.

  • DeleteWorkload ( array $params = [] )

    Delete an existing workload.

  • DeleteWorkloadShare ( array $params = [] )

    Delete a workload share.

  • DisassociateLenses ( array $params = [] )

    Disassociate a lens from a workload.

  • GetAnswer ( array $params = [] )

    Get lens review.

  • GetLensReview ( array $params = [] )

    Get lens review.

  • GetLensReviewReport ( array $params = [] )

    Get lens review report.

  • GetLensVersionDifference ( array $params = [] )

    Get lens version differences.

  • GetMilestone ( array $params = [] )

    Get a milestone for an existing workload.

  • GetWorkload ( array $params = [] )

    Get an existing workload.

  • ListAnswers ( array $params = [] )

    List of answers.

  • ListLensReviewImprovements ( array $params = [] )

    List lens review improvements.

  • ListLensReviews ( array $params = [] )

    List lens reviews.

  • ListLenses ( array $params = [] )

    List the available lenses.

  • ListMilestones ( array $params = [] )

    List all milestones for an existing workload.

  • ListNotifications ( array $params = [] )

    List lens notifications.

  • ListShareInvitations ( array $params = [] )

    List the workload invitations.

  • ListWorkloadShares ( array $params = [] )

    List the workload shares associated with the workload.

  • ListWorkloads ( array $params = [] )

    List workloads.

  • UpdateAnswer ( array $params = [] )

    Update the answer.

  • UpdateLensReview ( array $params = [] )

    Update lens review.

  • UpdateShareInvitation ( array $params = [] )

    Update a workload invitation.

  • UpdateWorkload ( array $params = [] )

    Update an existing workload.

  • UpdateWorkloadShare ( array $params = [] )

    Update a workload share.

  • UpgradeLensReview ( array $params = [] )

    Upgrade lens review.

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:

  • ListAnswers
  • ListLensReviewImprovements
  • ListLensReviews
  • ListLenses
  • ListMilestones
  • ListNotifications
  • ListShareInvitations
  • ListWorkloadShares
  • ListWorkloads

Operations

AssociateLenses

$result = $client->associateLenses([/* ... */]);
$promise = $client->associateLensesAsync([/* ... */]);

Associate a lens to a workload.

Parameter Syntax

$result = $client->associateLenses([
    'LensAliases' => ['<string>', ...], // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

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

List of lens aliases to associate or disassociate with a workload.

Identify a lens using its LensSummary$LensAlias.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • ConflictException:

    The resource already exists.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

CreateMilestone

$result = $client->createMilestone([/* ... */]);
$promise = $client->createMilestoneAsync([/* ... */]);

Create a milestone for an existing workload.

Parameter Syntax

$result = $client->createMilestone([
    'ClientRequestToken' => '<string>', // REQUIRED
    'MilestoneName' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
  • Required: Yes
  • Type: string

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.

MilestoneName
  • Required: Yes
  • Type: string

The name of the milestone in a workload.

Milestone names must be unique within a workload.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'MilestoneNumber' => <integer>,
    'WorkloadId' => '<string>',
]

Result Details

Members
MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • ConflictException:

    The resource already exists.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • ResourceNotFoundException:

    The requested resource was not found.

  • ServiceQuotaExceededException:

    The user has reached their resource quota.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

CreateWorkload

$result = $client->createWorkload([/* ... */]);
$promise = $client->createWorkloadAsync([/* ... */]);

Create a new workload.

The owner of a workload can share the workload with other AWS accounts and IAM users in the same AWS Region. Only the owner of a workload can delete it.

For more information, see Defining a Workload in the AWS Well-Architected Tool User Guide.

Parameter Syntax

$result = $client->createWorkload([
    'AccountIds' => ['<string>', ...],
    'ArchitecturalDesign' => '<string>',
    'AwsRegions' => ['<string>', ...],
    'ClientRequestToken' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'Environment' => 'PRODUCTION|PREPRODUCTION', // REQUIRED
    'Industry' => '<string>',
    'IndustryType' => '<string>',
    'Lenses' => ['<string>', ...], // REQUIRED
    'NonAwsRegions' => ['<string>', ...],
    'Notes' => '<string>',
    'PillarPriorities' => ['<string>', ...],
    'ReviewOwner' => '<string>', // REQUIRED
    'WorkloadName' => '<string>', // REQUIRED
]);

Parameter Details

Members
AccountIds
  • Type: Array of strings

The list of AWS account IDs associated with the workload.

ArchitecturalDesign
  • Type: string

The URL of the architectural design for the workload.

AwsRegions
  • Type: Array of strings

The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.

ClientRequestToken
  • Required: Yes
  • Type: string

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.

Description
  • Required: Yes
  • Type: string

The description for the workload.

Environment
  • Required: Yes
  • Type: string

The environment for the workload.

Industry
  • Type: string

The industry for the workload.

IndustryType
  • Type: string

The industry type for the workload.

If specified, must be one of the following:

  • Agriculture

  • Automobile

  • Defense

  • Design and Engineering

  • Digital Advertising

  • Education

  • Environmental Protection

  • Financial Services

  • Gaming

  • General Public Services

  • Healthcare

  • Hospitality

  • InfoTech

  • Justice and Public Safety

  • Life Sciences

  • Manufacturing

  • Media & Entertainment

  • Mining & Resources

  • Oil & Gas

  • Power & Utilities

  • Professional Services

  • Real Estate & Construction

  • Retail & Wholesale

  • Social Protection

  • Telecommunications

  • Travel, Transportation & Logistics

  • Other

Lenses
  • Required: Yes
  • Type: Array of strings

The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

NonAwsRegions
  • Type: Array of strings

The list of non-AWS Regions associated with the workload.

Notes
  • Type: string

The notes associated with the workload.

PillarPriorities
  • Type: Array of strings

The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.

ReviewOwner
  • Required: Yes
  • Type: string

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

WorkloadName
  • Required: Yes
  • Type: string

The name of the workload.

The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

Result Syntax

[
    'WorkloadArn' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Members
WorkloadArn
  • Type: string

The ARN for the workload.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • ConflictException:

    The resource already exists.

  • ServiceQuotaExceededException:

    The user has reached their resource quota.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

CreateWorkloadShare

$result = $client->createWorkloadShare([/* ... */]);
$promise = $client->createWorkloadShareAsync([/* ... */]);

Create a workload share.

The owner of a workload can share it with other AWS accounts and IAM users in the same AWS Region. Shared access to a workload is not removed until the workload invitation is deleted.

For more information, see Sharing a Workload in the AWS Well-Architected Tool User Guide.

Parameter Syntax

$result = $client->createWorkloadShare([
    'ClientRequestToken' => '<string>', // REQUIRED
    'PermissionType' => 'READONLY|CONTRIBUTOR', // REQUIRED
    'SharedWith' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
  • Required: Yes
  • Type: string

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.

PermissionType
  • Required: Yes
  • Type: string

Permission granted on a workload share.

SharedWith
  • Required: Yes
  • Type: string

The AWS account ID or IAM role with which the workload is shared.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'ShareId' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Members
ShareId
  • Type: string

The ID associated with the workload share.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • ConflictException:

    The resource already exists.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • ResourceNotFoundException:

    The requested resource was not found.

  • ServiceQuotaExceededException:

    The user has reached their resource quota.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

DeleteWorkload

$result = $client->deleteWorkload([/* ... */]);
$promise = $client->deleteWorkloadAsync([/* ... */]);

Delete an existing workload.

Parameter Syntax

$result = $client->deleteWorkload([
    'ClientRequestToken' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
  • Required: Yes
  • Type: string

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • ConflictException:

    The resource already exists.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

DeleteWorkloadShare

$result = $client->deleteWorkloadShare([/* ... */]);
$promise = $client->deleteWorkloadShareAsync([/* ... */]);

Delete a workload share.

Parameter Syntax

$result = $client->deleteWorkloadShare([
    'ClientRequestToken' => '<string>', // REQUIRED
    'ShareId' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
  • Required: Yes
  • Type: string

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.

ShareId
  • Required: Yes
  • Type: string

The ID associated with the workload share.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The user input is not valid.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • ResourceNotFoundException:

    The requested resource was not found.

  • ConflictException:

    The resource already exists.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

DisassociateLenses

$result = $client->disassociateLenses([/* ... */]);
$promise = $client->disassociateLensesAsync([/* ... */]);

Disassociate a lens from a workload.

The AWS Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.

Parameter Syntax

$result = $client->disassociateLenses([
    'LensAliases' => ['<string>', ...], // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

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

List of lens aliases to associate or disassociate with a workload.

Identify a lens using its LensSummary$LensAlias.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • ConflictException:

    The resource already exists.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

GetAnswer

$result = $client->getAnswer([/* ... */]);
$promise = $client->getAnswerAsync([/* ... */]);

Get lens review.

Parameter Syntax

$result = $client->getAnswer([
    'LensAlias' => '<string>', // REQUIRED
    'MilestoneNumber' => <integer>,
    'QuestionId' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
LensAlias
  • Required: Yes
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

QuestionId
  • Required: Yes
  • Type: string

The ID of the question.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'Answer' => [
        'Choices' => [
            [
                'ChoiceId' => '<string>',
                'Description' => '<string>',
                'Title' => '<string>',
            ],
            // ...
        ],
        'HelpfulResourceUrl' => '<string>',
        'ImprovementPlanUrl' => '<string>',
        'IsApplicable' => true || false,
        'Notes' => '<string>',
        'PillarId' => '<string>',
        'QuestionDescription' => '<string>',
        'QuestionId' => '<string>',
        'QuestionTitle' => '<string>',
        'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
        'SelectedChoices' => ['<string>', ...],
    ],
    'LensAlias' => '<string>',
    'MilestoneNumber' => <integer>,
    'WorkloadId' => '<string>',
]

Result Details

Members
Answer
  • Type: Answer structure

An answer of the question.

LensAlias
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

GetLensReview

$result = $client->getLensReview([/* ... */]);
$promise = $client->getLensReviewAsync([/* ... */]);

Get lens review.

Parameter Syntax

$result = $client->getLensReview([
    'LensAlias' => '<string>', // REQUIRED
    'MilestoneNumber' => <integer>,
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
LensAlias
  • Required: Yes
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'LensReview' => [
        'LensAlias' => '<string>',
        'LensName' => '<string>',
        'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED',
        'LensVersion' => '<string>',
        'NextToken' => '<string>',
        'Notes' => '<string>',
        'PillarReviewSummaries' => [
            [
                'Notes' => '<string>',
                'PillarId' => '<string>',
                'PillarName' => '<string>',
                'RiskCounts' => [<integer>, ...],
            ],
            // ...
        ],
        'RiskCounts' => [<integer>, ...],
        'UpdatedAt' => <DateTime>,
    ],
    'MilestoneNumber' => <integer>,
    'WorkloadId' => '<string>',
]

Result Details

Members
LensReview
  • Type: LensReview structure

A lens review of a question.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

GetLensReviewReport

$result = $client->getLensReviewReport([/* ... */]);
$promise = $client->getLensReviewReportAsync([/* ... */]);

Get lens review report.

Parameter Syntax

$result = $client->getLensReviewReport([
    'LensAlias' => '<string>', // REQUIRED
    'MilestoneNumber' => <integer>,
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
LensAlias
  • Required: Yes
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'LensReviewReport' => [
        'Base64String' => '<string>',
        'LensAlias' => '<string>',
    ],
    'MilestoneNumber' => <integer>,
    'WorkloadId' => '<string>',
]

Result Details

Members
LensReviewReport
  • Type: LensReviewReport structure

A report of a lens review.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

GetLensVersionDifference

$result = $client->getLensVersionDifference([/* ... */]);
$promise = $client->getLensVersionDifferenceAsync([/* ... */]);

Get lens version differences.

Parameter Syntax

$result = $client->getLensVersionDifference([
    'BaseLensVersion' => '<string>', // REQUIRED
    'LensAlias' => '<string>', // REQUIRED
]);

Parameter Details

Members
BaseLensVersion
  • Required: Yes
  • Type: string

The base version of the lens.

LensAlias
  • Required: Yes
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

Result Syntax

[
    'BaseLensVersion' => '<string>',
    'LatestLensVersion' => '<string>',
    'LensAlias' => '<string>',
    'VersionDifferences' => [
        'PillarDifferences' => [
            [
                'DifferenceStatus' => 'UPDATED|NEW|DELETED',
                'PillarId' => '<string>',
                'QuestionDifferences' => [
                    [
                        'DifferenceStatus' => 'UPDATED|NEW|DELETED',
                        'QuestionId' => '<string>',
                        'QuestionTitle' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
BaseLensVersion
  • Type: string

The base version of the lens.

LatestLensVersion
  • Type: string

The latest version of the lens.

LensAlias
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

VersionDifferences
  • Type: VersionDifferences structure

The differences between the base and latest versions of the lens.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

GetMilestone

$result = $client->getMilestone([/* ... */]);
$promise = $client->getMilestoneAsync([/* ... */]);

Get a milestone for an existing workload.

Parameter Syntax

$result = $client->getMilestone([
    'MilestoneNumber' => <integer>, // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
MilestoneNumber
  • Required: Yes
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'Milestone' => [
        'MilestoneName' => '<string>',
        'MilestoneNumber' => <integer>,
        'RecordedAt' => <DateTime>,
        'Workload' => [
            'AccountIds' => ['<string>', ...],
            'ArchitecturalDesign' => '<string>',
            'AwsRegions' => ['<string>', ...],
            'Description' => '<string>',
            'Environment' => 'PRODUCTION|PREPRODUCTION',
            'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
            'Industry' => '<string>',
            'IndustryType' => '<string>',
            'IsReviewOwnerUpdateAcknowledged' => true || false,
            'Lenses' => ['<string>', ...],
            'NonAwsRegions' => ['<string>', ...],
            'Notes' => '<string>',
            'Owner' => '<string>',
            'PillarPriorities' => ['<string>', ...],
            'ReviewOwner' => '<string>',
            'ReviewRestrictionDate' => <DateTime>,
            'RiskCounts' => [<integer>, ...],
            'ShareInvitationId' => '<string>',
            'UpdatedAt' => <DateTime>,
            'WorkloadArn' => '<string>',
            'WorkloadId' => '<string>',
            'WorkloadName' => '<string>',
        ],
    ],
    'WorkloadId' => '<string>',
]

Result Details

Members
Milestone
  • Type: Milestone structure

A milestone return object.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

GetWorkload

$result = $client->getWorkload([/* ... */]);
$promise = $client->getWorkloadAsync([/* ... */]);

Get an existing workload.

Parameter Syntax

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

Parameter Details

Members
WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'Workload' => [
        'AccountIds' => ['<string>', ...],
        'ArchitecturalDesign' => '<string>',
        'AwsRegions' => ['<string>', ...],
        'Description' => '<string>',
        'Environment' => 'PRODUCTION|PREPRODUCTION',
        'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
        'Industry' => '<string>',
        'IndustryType' => '<string>',
        'IsReviewOwnerUpdateAcknowledged' => true || false,
        'Lenses' => ['<string>', ...],
        'NonAwsRegions' => ['<string>', ...],
        'Notes' => '<string>',
        'Owner' => '<string>',
        'PillarPriorities' => ['<string>', ...],
        'ReviewOwner' => '<string>',
        'ReviewRestrictionDate' => <DateTime>,
        'RiskCounts' => [<integer>, ...],
        'ShareInvitationId' => '<string>',
        'UpdatedAt' => <DateTime>,
        'WorkloadArn' => '<string>',
        'WorkloadId' => '<string>',
        'WorkloadName' => '<string>',
    ],
]

Result Details

Members
Workload
  • Type: Workload structure

A workload return object.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

ListAnswers

$result = $client->listAnswers([/* ... */]);
$promise = $client->listAnswersAsync([/* ... */]);

List of answers.

Parameter Syntax

$result = $client->listAnswers([
    'LensAlias' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'MilestoneNumber' => <integer>,
    'NextToken' => '<string>',
    'PillarId' => '<string>',
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
LensAlias
  • Required: Yes
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

MaxResults
  • Type: int

The maximum number of results to return for this request.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

PillarId
  • Type: string

The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'AnswerSummaries' => [
        [
            'Choices' => [
                [
                    'ChoiceId' => '<string>',
                    'Description' => '<string>',
                    'Title' => '<string>',
                ],
                // ...
            ],
            'IsApplicable' => true || false,
            'PillarId' => '<string>',
            'QuestionId' => '<string>',
            'QuestionTitle' => '<string>',
            'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
            'SelectedChoices' => ['<string>', ...],
        ],
        // ...
    ],
    'LensAlias' => '<string>',
    'MilestoneNumber' => <integer>,
    'NextToken' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Members
AnswerSummaries
  • Type: Array of AnswerSummary structures

List of answer summaries of lens review in a workload.

LensAlias
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • ResourceNotFoundException:

    The requested resource was not found.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

ListLensReviewImprovements

$result = $client->listLensReviewImprovements([/* ... */]);
$promise = $client->listLensReviewImprovementsAsync([/* ... */]);

List lens review improvements.

Parameter Syntax

$result = $client->listLensReviewImprovements([
    'LensAlias' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'MilestoneNumber' => <integer>,
    'NextToken' => '<string>',
    'PillarId' => '<string>',
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
LensAlias
  • Required: Yes
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

MaxResults
  • Type: int

The maximum number of results to return for this request.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

PillarId
  • Type: string

The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'ImprovementSummaries' => [
        [
            'ImprovementPlanUrl' => '<string>',
            'PillarId' => '<string>',
            'QuestionId' => '<string>',
            'QuestionTitle' => '<string>',
            'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
        ],
        // ...
    ],
    'LensAlias' => '<string>',
    'MilestoneNumber' => <integer>,
    'NextToken' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Members
ImprovementSummaries
  • Type: Array of ImprovementSummary structures

List of improvement summaries of lens review in a workload.

LensAlias
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • ResourceNotFoundException:

    The requested resource was not found.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

ListLensReviews

$result = $client->listLensReviews([/* ... */]);
$promise = $client->listLensReviewsAsync([/* ... */]);

List lens reviews.

Parameter Syntax

$result = $client->listLensReviews([
    'MaxResults' => <integer>,
    'MilestoneNumber' => <integer>,
    'NextToken' => '<string>',
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of results to return for this request.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'LensReviewSummaries' => [
        [
            'LensAlias' => '<string>',
            'LensName' => '<string>',
            'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED',
            'LensVersion' => '<string>',
            'RiskCounts' => [<integer>, ...],
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'MilestoneNumber' => <integer>,
    'NextToken' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Members
LensReviewSummaries
  • Type: Array of LensReviewSummary structures

List of lens summaries of lens reviews of a workload.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • ResourceNotFoundException:

    The requested resource was not found.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

ListLenses

$result = $client->listLenses([/* ... */]);
$promise = $client->listLensesAsync([/* ... */]);

List the available lenses.

Parameter Syntax

$result = $client->listLenses([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of results to return for this request.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

Result Syntax

[
    'LensSummaries' => [
        [
            'Description' => '<string>',
            'LensAlias' => '<string>',
            'LensName' => '<string>',
            'LensVersion' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
LensSummaries
  • Type: Array of LensSummary structures

List of lens summaries of available lenses.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

Errors

  • ValidationException:

    The user input is not valid.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

ListMilestones

$result = $client->listMilestones([/* ... */]);
$promise = $client->listMilestonesAsync([/* ... */]);

List all milestones for an existing workload.

Parameter Syntax

$result = $client->listMilestones([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of results to return for this request.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'MilestoneSummaries' => [
        [
            'MilestoneName' => '<string>',
            'MilestoneNumber' => <integer>,
            'RecordedAt' => <DateTime>,
            'WorkloadSummary' => [
                'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
                'Lenses' => ['<string>', ...],
                'Owner' => '<string>',
                'RiskCounts' => [<integer>, ...],
                'UpdatedAt' => <DateTime>,
                'WorkloadArn' => '<string>',
                'WorkloadId' => '<string>',
                'WorkloadName' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Members
MilestoneSummaries
  • Type: Array of MilestoneSummary structures

A list of milestone summaries.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • ResourceNotFoundException:

    The requested resource was not found.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

ListNotifications

$result = $client->listNotifications([/* ... */]);
$promise = $client->listNotificationsAsync([/* ... */]);

List lens notifications.

Parameter Syntax

$result = $client->listNotifications([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkloadId' => '<string>',
]);

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of results to return for this request.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'NextToken' => '<string>',
    'NotificationSummaries' => [
        [
            'LensUpgradeSummary' => [
                'CurrentLensVersion' => '<string>',
                'LatestLensVersion' => '<string>',
                'LensAlias' => '<string>',
                'WorkloadId' => '<string>',
                'WorkloadName' => '<string>',
            ],
            'Type' => 'LENS_VERSION_UPGRADED|LENS_VERSION_DEPRECATED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The token to use to retrieve the next set of results.

NotificationSummaries
  • Type: Array of NotificationSummary structures

List of lens notification summaries in a workload.

Errors

  • ValidationException:

    The user input is not valid.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

ListShareInvitations

$result = $client->listShareInvitations([/* ... */]);
$promise = $client->listShareInvitationsAsync([/* ... */]);

List the workload invitations.

Parameter Syntax

$result = $client->listShareInvitations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkloadNamePrefix' => '<string>',
]);

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of results to return for this request.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

WorkloadNamePrefix
  • Type: string

An optional string added to the beginning of each workload name returned in the results.

Result Syntax

[
    'NextToken' => '<string>',
    'ShareInvitationSummaries' => [
        [
            'PermissionType' => 'READONLY|CONTRIBUTOR',
            'ShareInvitationId' => '<string>',
            'SharedBy' => '<string>',
            'SharedWith' => '<string>',
            'WorkloadId' => '<string>',
            'WorkloadName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The token to use to retrieve the next set of results.

ShareInvitationSummaries
  • Type: Array of ShareInvitationSummary structures

List of share invitation summaries in a workload.

Errors

  • ValidationException:

    The user input is not valid.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

ListWorkloadShares

$result = $client->listWorkloadShares([/* ... */]);
$promise = $client->listWorkloadSharesAsync([/* ... */]);

List the workload shares associated with the workload.

Parameter Syntax

$result = $client->listWorkloadShares([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SharedWithPrefix' => '<string>',
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of results to return for this request.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

SharedWithPrefix
  • Type: string

The AWS account ID or IAM role with which the workload is shared.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'NextToken' => '<string>',
    'WorkloadId' => '<string>',
    'WorkloadShareSummaries' => [
        [
            'PermissionType' => 'READONLY|CONTRIBUTOR',
            'ShareId' => '<string>',
            'SharedWith' => '<string>',
            'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The token to use to retrieve the next set of results.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

WorkloadShareSummaries
  • Type: Array of WorkloadShareSummary structures

A list of workload share summaries.

Errors

  • ValidationException:

    The user input is not valid.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • ResourceNotFoundException:

    The requested resource was not found.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

ListWorkloads

$result = $client->listWorkloads([/* ... */]);
$promise = $client->listWorkloadsAsync([/* ... */]);

List workloads. Paginated.

Parameter Syntax

$result = $client->listWorkloads([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkloadNamePrefix' => '<string>',
]);

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of results to return for this request.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

WorkloadNamePrefix
  • Type: string

An optional string added to the beginning of each workload name returned in the results.

Result Syntax

[
    'NextToken' => '<string>',
    'WorkloadSummaries' => [
        [
            'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
            'Lenses' => ['<string>', ...],
            'Owner' => '<string>',
            'RiskCounts' => [<integer>, ...],
            'UpdatedAt' => <DateTime>,
            'WorkloadArn' => '<string>',
            'WorkloadId' => '<string>',
            'WorkloadName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The token to use to retrieve the next set of results.

WorkloadSummaries
  • Type: Array of WorkloadSummary structures

A list of workload summaries.

Errors

  • ValidationException:

    The user input is not valid.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

UpdateAnswer

$result = $client->updateAnswer([/* ... */]);
$promise = $client->updateAnswerAsync([/* ... */]);

Update the answer.

Parameter Syntax

$result = $client->updateAnswer([
    'IsApplicable' => true || false,
    'LensAlias' => '<string>', // REQUIRED
    'Notes' => '<string>',
    'QuestionId' => '<string>', // REQUIRED
    'SelectedChoices' => ['<string>', ...],
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
IsApplicable
  • Type: boolean

Defines whether this question is applicable to a lens review.

LensAlias
  • Required: Yes
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

Notes
  • Type: string

The notes associated with the workload.

QuestionId
  • Required: Yes
  • Type: string

The ID of the question.

SelectedChoices
  • Type: Array of strings

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'Answer' => [
        'Choices' => [
            [
                'ChoiceId' => '<string>',
                'Description' => '<string>',
                'Title' => '<string>',
            ],
            // ...
        ],
        'HelpfulResourceUrl' => '<string>',
        'ImprovementPlanUrl' => '<string>',
        'IsApplicable' => true || false,
        'Notes' => '<string>',
        'PillarId' => '<string>',
        'QuestionDescription' => '<string>',
        'QuestionId' => '<string>',
        'QuestionTitle' => '<string>',
        'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
        'SelectedChoices' => ['<string>', ...],
    ],
    'LensAlias' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Members
Answer
  • Type: Answer structure

An answer of the question.

LensAlias
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • ConflictException:

    The resource already exists.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

UpdateLensReview

$result = $client->updateLensReview([/* ... */]);
$promise = $client->updateLensReviewAsync([/* ... */]);

Update lens review.

Parameter Syntax

$result = $client->updateLensReview([
    'LensAlias' => '<string>', // REQUIRED
    'LensNotes' => '<string>',
    'PillarNotes' => ['<string>', ...],
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
LensAlias
  • Required: Yes
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

LensNotes
  • Type: string

The notes associated with the workload.

PillarNotes
  • Type: Associative array of custom strings keys (PillarId) to strings

List of pillar notes of a lens review in a workload.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'LensReview' => [
        'LensAlias' => '<string>',
        'LensName' => '<string>',
        'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED',
        'LensVersion' => '<string>',
        'NextToken' => '<string>',
        'Notes' => '<string>',
        'PillarReviewSummaries' => [
            [
                'Notes' => '<string>',
                'PillarId' => '<string>',
                'PillarName' => '<string>',
                'RiskCounts' => [<integer>, ...],
            ],
            // ...
        ],
        'RiskCounts' => [<integer>, ...],
        'UpdatedAt' => <DateTime>,
    ],
    'WorkloadId' => '<string>',
]

Result Details

Members
LensReview
  • Type: LensReview structure

A lens review of a question.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • ConflictException:

    The resource already exists.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

UpdateShareInvitation

$result = $client->updateShareInvitation([/* ... */]);
$promise = $client->updateShareInvitationAsync([/* ... */]);

Update a workload invitation.

Parameter Syntax

$result = $client->updateShareInvitation([
    'ShareInvitationAction' => 'ACCEPT|REJECT', // REQUIRED
    'ShareInvitationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ShareInvitationAction
  • Required: Yes
  • Type: string

Share invitation action taken by contributor.

ShareInvitationId
  • Required: Yes
  • Type: string

The ID assigned to the share invitation.

Result Syntax

[
    'ShareInvitation' => [
        'ShareInvitationId' => '<string>',
        'WorkloadId' => '<string>',
    ],
]

Result Details

Members
ShareInvitation
  • Type: ShareInvitation structure

The updated workload share invitation.

Errors

  • ValidationException:

    The user input is not valid.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • ResourceNotFoundException:

    The requested resource was not found.

  • ConflictException:

    The resource already exists.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

UpdateWorkload

$result = $client->updateWorkload([/* ... */]);
$promise = $client->updateWorkloadAsync([/* ... */]);

Update an existing workload.

Parameter Syntax

$result = $client->updateWorkload([
    'AccountIds' => ['<string>', ...],
    'ArchitecturalDesign' => '<string>',
    'AwsRegions' => ['<string>', ...],
    'Description' => '<string>',
    'Environment' => 'PRODUCTION|PREPRODUCTION',
    'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
    'Industry' => '<string>',
    'IndustryType' => '<string>',
    'IsReviewOwnerUpdateAcknowledged' => true || false,
    'NonAwsRegions' => ['<string>', ...],
    'Notes' => '<string>',
    'PillarPriorities' => ['<string>', ...],
    'ReviewOwner' => '<string>',
    'WorkloadId' => '<string>', // REQUIRED
    'WorkloadName' => '<string>',
]);

Parameter Details

Members
AccountIds
  • Type: Array of strings

The list of AWS account IDs associated with the workload.

ArchitecturalDesign
  • Type: string

The URL of the architectural design for the workload.

AwsRegions
  • Type: Array of strings

The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.

Description
  • Type: string

The description for the workload.

Environment
  • Type: string

The environment for the workload.

ImprovementStatus
  • Type: string

The improvement status for a workload.

Industry
  • Type: string

The industry for the workload.

IndustryType
  • Type: string

The industry type for the workload.

If specified, must be one of the following:

  • Agriculture

  • Automobile

  • Defense

  • Design and Engineering

  • Digital Advertising

  • Education

  • Environmental Protection

  • Financial Services

  • Gaming

  • General Public Services

  • Healthcare

  • Hospitality

  • InfoTech

  • Justice and Public Safety

  • Life Sciences

  • Manufacturing

  • Media & Entertainment

  • Mining & Resources

  • Oil & Gas

  • Power & Utilities

  • Professional Services

  • Real Estate & Construction

  • Retail & Wholesale

  • Social Protection

  • Telecommunications

  • Travel, Transportation & Logistics

  • Other

IsReviewOwnerUpdateAcknowledged
  • Type: boolean

Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

NonAwsRegions
  • Type: Array of strings

The list of non-AWS Regions associated with the workload.

Notes
  • Type: string

The notes associated with the workload.

PillarPriorities
  • Type: Array of strings

The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.

ReviewOwner
  • Type: string

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

WorkloadName
  • Type: string

The name of the workload.

The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

Result Syntax

[
    'Workload' => [
        'AccountIds' => ['<string>', ...],
        'ArchitecturalDesign' => '<string>',
        'AwsRegions' => ['<string>', ...],
        'Description' => '<string>',
        'Environment' => 'PRODUCTION|PREPRODUCTION',
        'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
        'Industry' => '<string>',
        'IndustryType' => '<string>',
        'IsReviewOwnerUpdateAcknowledged' => true || false,
        'Lenses' => ['<string>', ...],
        'NonAwsRegions' => ['<string>', ...],
        'Notes' => '<string>',
        'Owner' => '<string>',
        'PillarPriorities' => ['<string>', ...],
        'ReviewOwner' => '<string>',
        'ReviewRestrictionDate' => <DateTime>,
        'RiskCounts' => [<integer>, ...],
        'ShareInvitationId' => '<string>',
        'UpdatedAt' => <DateTime>,
        'WorkloadArn' => '<string>',
        'WorkloadId' => '<string>',
        'WorkloadName' => '<string>',
    ],
]

Result Details

Members
Workload
  • Type: Workload structure

A workload return object.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • ConflictException:

    The resource already exists.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

UpdateWorkloadShare

$result = $client->updateWorkloadShare([/* ... */]);
$promise = $client->updateWorkloadShareAsync([/* ... */]);

Update a workload share.

Parameter Syntax

$result = $client->updateWorkloadShare([
    'PermissionType' => 'READONLY|CONTRIBUTOR', // REQUIRED
    'ShareId' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
PermissionType
  • Required: Yes
  • Type: string

Permission granted on a workload share.

ShareId
  • Required: Yes
  • Type: string

The ID associated with the workload share.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[
    'WorkloadId' => '<string>',
    'WorkloadShare' => [
        'PermissionType' => 'READONLY|CONTRIBUTOR',
        'ShareId' => '<string>',
        'SharedBy' => '<string>',
        'SharedWith' => '<string>',
        'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED',
        'WorkloadId' => '<string>',
        'WorkloadName' => '<string>',
    ],
]

Result Details

Members
WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

WorkloadShare
  • Type: WorkloadShare structure

A workload share return object.

Errors

  • ValidationException:

    The user input is not valid.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • ResourceNotFoundException:

    The requested resource was not found.

  • ConflictException:

    The resource already exists.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

UpgradeLensReview

$result = $client->upgradeLensReview([/* ... */]);
$promise = $client->upgradeLensReviewAsync([/* ... */]);

Upgrade lens review.

Parameter Syntax

$result = $client->upgradeLensReview([
    'ClientRequestToken' => '<string>',
    'LensAlias' => '<string>', // REQUIRED
    'MilestoneName' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
  • Type: string

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.

LensAlias
  • Required: Yes
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

MilestoneName
  • Required: Yes
  • Type: string

The name of the milestone in a workload.

Milestone names must be unique within a workload.

WorkloadId
  • Required: Yes
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The user input is not valid.

  • ResourceNotFoundException:

    The requested resource was not found.

  • ConflictException:

    The resource already exists.

  • InternalServerException:

    There is a problem with the AWS Well-Architected Tool API service.

  • AccessDeniedException:

    User does not have sufficient access to perform this action.

  • ThrottlingException:

    Request was denied due to request throttling.

Shapes

AccessDeniedException

Description

User does not have sufficient access to perform this action.

Members
Message
  • Required: Yes
  • Type: string

Description of the error.

Answer

Description

An answer of the question.

Members
Choices
  • Type: Array of Choice structures

List of choices available for a question.

HelpfulResourceUrl
  • Type: string

The helpful resource URL for a question.

ImprovementPlanUrl
  • Type: string

The improvement plan URL for a question.

IsApplicable
  • Type: boolean

Defines whether this question is applicable to a lens review.

Notes
  • Type: string

The notes associated with the workload.

PillarId
  • Type: string

The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.

QuestionDescription
  • Type: string

The description of the question.

QuestionId
  • Type: string

The ID of the question.

QuestionTitle
  • Type: string

The title of the question.

Risk
  • Type: string

The risk for a given workload, lens review, pillar, or question.

SelectedChoices
  • Type: Array of strings

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

AnswerSummary

Description

An answer summary of a lens review in a workload.

Members
Choices
  • Type: Array of Choice structures

List of choices available for a question.

IsApplicable
  • Type: boolean

Defines whether this question is applicable to a lens review.

PillarId
  • Type: string

The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.

QuestionId
  • Type: string

The ID of the question.

QuestionTitle
  • Type: string

The title of the question.

Risk
  • Type: string

The risk for a given workload, lens review, pillar, or question.

SelectedChoices
  • Type: Array of strings

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

Choice

Description

A choice available to answer question.

Members
ChoiceId
  • Type: string

The ID of a choice.

Description
  • Type: string

The description of a choice.

Title
  • Type: string

The title of a choice.

ConflictException

Description

The resource already exists.

Members
Message
  • Required: Yes
  • Type: string

Description of the error.

ResourceId
  • Required: Yes
  • Type: string

Identifier of the resource affected.

ResourceType
  • Required: Yes
  • Type: string

Type of the resource affected.

ImprovementSummary

Description

An improvement summary of a lens review in a workload.

Members
ImprovementPlanUrl
  • Type: string

The improvement plan URL for a question.

PillarId
  • Type: string

The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.

QuestionId
  • Type: string

The ID of the question.

QuestionTitle
  • Type: string

The title of the question.

Risk
  • Type: string

The risk for a given workload, lens review, pillar, or question.

InternalServerException

Description

There is a problem with the AWS Well-Architected Tool API service.

Members
Message
  • Required: Yes
  • Type: string

Description of the error.

LensReview

Description

A lens review of a question.

Members
LensAlias
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

LensName
  • Type: string

The full name of the lens.

LensStatus
  • Type: string

The status of the lens.

LensVersion
  • Type: string

The version of the lens.

NextToken
  • Type: string

The token to use to retrieve the next set of results.

Notes
  • Type: string

The notes associated with the workload.

PillarReviewSummaries
  • Type: Array of PillarReviewSummary structures

List of pillar review summaries of lens review in a workload.

RiskCounts
  • Type: Associative array of custom strings keys (Risk) to ints

A map from risk names to the count of how questions have that rating.

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

The date and time recorded.

LensReviewReport

Description

A report of a lens review.

Members
Base64String
  • Type: string

The Base64-encoded string representation of a lens review report.

This data can be used to create a PDF file.

LensAlias
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

LensReviewSummary

Description

A lens review summary of a workload.

Members
LensAlias
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

LensName
  • Type: string

The full name of the lens.

LensStatus
  • Type: string

The status of the lens.

LensVersion
  • Type: string

The version of the lens.

RiskCounts
  • Type: Associative array of custom strings keys (Risk) to ints

A map from risk names to the count of how questions have that rating.

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

The date and time recorded.

LensSummary

Description

A lens summary of a lens.

Members
Description
  • Type: string

The description of the lens.

LensAlias
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

LensName
  • Type: string

The full name of the lens.

LensVersion
  • Type: string

The version of the lens.

LensUpgradeSummary

Description

Lens upgrade summary return object.

Members
CurrentLensVersion
  • Type: string

The current version of the lens.

LatestLensVersion
  • Type: string

The latest version of the lens.

LensAlias
  • Type: string

The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary$LensAlias.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

WorkloadName
  • Type: string

The name of the workload.

The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

Milestone

Description

A milestone return object.

Members
MilestoneName
  • Type: string

The name of the milestone in a workload.

Milestone names must be unique within a workload.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

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

The date and time recorded.

Workload
  • Type: Workload structure

A workload return object.

MilestoneSummary

Description

A milestone summary return object.

Members
MilestoneName
  • Type: string

The name of the milestone in a workload.

Milestone names must be unique within a workload.

MilestoneNumber
  • Type: int

The milestone number.

A workload can have a maximum of 100 milestones.

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

The date and time recorded.

WorkloadSummary
  • Type: WorkloadSummary structure

A workload summary return object.

NotificationSummary

Description

A notification summary return object.

Members
LensUpgradeSummary
  • Type: LensUpgradeSummary structure

Summary of lens upgrade.

Type
  • Type: string

The type of notification.

PillarDifference

Description

A pillar difference return object.

Members
DifferenceStatus
  • Type: string

Indicates the type of change to the pillar.

PillarId
  • Type: string

The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.

QuestionDifferences
  • Type: Array of QuestionDifference structures

List of question differences.

PillarReviewSummary

Description

A pillar review summary of a lens review.

Members
Notes
  • Type: string

The notes associated with the workload.

PillarId
  • Type: string

The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.

PillarName
  • Type: string

The name of the pillar.

RiskCounts
  • Type: Associative array of custom strings keys (Risk) to ints

A map from risk names to the count of how questions have that rating.

QuestionDifference

Description

A question difference return object.

Members
DifferenceStatus
  • Type: string

Indicates the type of change to the question.

QuestionId
  • Type: string

The ID of the question.

QuestionTitle
  • Type: string

The title of the question.

ResourceNotFoundException

Description

The requested resource was not found.

Members
Message
  • Required: Yes
  • Type: string

Description of the error.

ResourceId
  • Required: Yes
  • Type: string

Identifier of the resource affected.

ResourceType
  • Required: Yes
  • Type: string

Type of the resource affected.

ServiceQuotaExceededException

Description

The user has reached their resource quota.

Members
Message
  • Required: Yes
  • Type: string

Description of the error.

QuotaCode
  • Required: Yes
  • Type: string

Service Quotas requirement to identify originating quota.

ResourceId
  • Type: string

Identifier of the resource affected.

ResourceType
  • Type: string

Type of the resource affected.

ServiceCode
  • Required: Yes
  • Type: string

Service Quotas requirement to identify originating service.

ShareInvitation

Description

The share invitation.

Members
ShareInvitationId
  • Type: string

The ID assigned to the share invitation.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

ShareInvitationSummary

Description

A share invitation summary return object.

Members
PermissionType
  • Type: string

Permission granted on a workload share.

ShareInvitationId
  • Type: string

The ID assigned to the share invitation.

SharedBy
  • Type: string

An AWS account ID.

SharedWith
  • Type: string

The AWS account ID or IAM role with which the workload is shared.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

WorkloadName
  • Type: string

The name of the workload.

The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

ThrottlingException

Description

Request was denied due to request throttling.

Members
Message
  • Required: Yes
  • Type: string

Description of the error.

QuotaCode
  • Type: string

Service Quotas requirement to identify originating quota.

ServiceCode
  • Type: string

Service Quotas requirement to identify originating service.

ValidationException

Description

The user input is not valid.

Members
Fields
  • Type: Array of ValidationExceptionField structures

The fields that caused the error, if applicable.

Message
  • Required: Yes
  • Type: string

Description of the error.

Reason
  • Type: string

The reason why the request failed validation.

ValidationExceptionField

Description

Stores information about a field passed inside a request that resulted in an exception.

Members
Message
  • Required: Yes
  • Type: string

Description of the error.

Name
  • Required: Yes
  • Type: string

The field name for which validation failed.

VersionDifferences

Description

The differences between the base and latest versions of the lens.

Members
PillarDifferences
  • Type: Array of PillarDifference structures

The differences between the base and latest versions of the lens.

Workload

Description

A workload return object.

Members
AccountIds
  • Type: Array of strings

The list of AWS account IDs associated with the workload.

ArchitecturalDesign
  • Type: string

The URL of the architectural design for the workload.

AwsRegions
  • Type: Array of strings

The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.

Description
  • Type: string

The description for the workload.

Environment
  • Type: string

The environment for the workload.

ImprovementStatus
  • Type: string

The improvement status for a workload.

Industry
  • Type: string

The industry for the workload.

IndustryType
  • Type: string

The industry type for the workload.

If specified, must be one of the following:

  • Agriculture

  • Automobile

  • Defense

  • Design and Engineering

  • Digital Advertising

  • Education

  • Environmental Protection

  • Financial Services

  • Gaming

  • General Public Services

  • Healthcare

  • Hospitality

  • InfoTech

  • Justice and Public Safety

  • Life Sciences

  • Manufacturing

  • Media & Entertainment

  • Mining & Resources

  • Oil & Gas

  • Power & Utilities

  • Professional Services

  • Real Estate & Construction

  • Retail & Wholesale

  • Social Protection

  • Telecommunications

  • Travel, Transportation & Logistics

  • Other

IsReviewOwnerUpdateAcknowledged
  • Type: boolean

Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

Lenses
  • Type: Array of strings

The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

NonAwsRegions
  • Type: Array of strings

The list of non-AWS Regions associated with the workload.

Notes
  • Type: string

The notes associated with the workload.

Owner
  • Type: string

An AWS account ID.

PillarPriorities
  • Type: Array of strings

The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.

ReviewOwner
  • Type: string

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

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

The date and time recorded.

RiskCounts
  • Type: Associative array of custom strings keys (Risk) to ints

A map from risk names to the count of how questions have that rating.

ShareInvitationId
  • Type: string

The ID assigned to the share invitation.

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

The date and time recorded.

WorkloadArn
  • Type: string

The ARN for the workload.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

WorkloadName
  • Type: string

The name of the workload.

The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

WorkloadShare

Description

A workload share return object.

Members
PermissionType
  • Type: string

Permission granted on a workload share.

ShareId
  • Type: string

The ID associated with the workload share.

SharedBy
  • Type: string

An AWS account ID.

SharedWith
  • Type: string

The AWS account ID or IAM role with which the workload is shared.

Status
  • Type: string

The status of a workload share.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

WorkloadName
  • Type: string

The name of the workload.

The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

WorkloadShareSummary

Description

A workload share summary return object.

Members
PermissionType
  • Type: string

Permission granted on a workload share.

ShareId
  • Type: string

The ID associated with the workload share.

SharedWith
  • Type: string

The AWS account ID or IAM role with which the workload is shared.

Status
  • Type: string

The status of a workload share.

WorkloadSummary

Description

A workload summary return object.

Members
ImprovementStatus
  • Type: string

The improvement status for a workload.

Lenses
  • Type: Array of strings

The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

Owner
  • Type: string

An AWS account ID.

RiskCounts
  • Type: Associative array of custom strings keys (Risk) to ints

A map from risk names to the count of how questions have that rating.

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

The date and time recorded.

WorkloadArn
  • Type: string

The ARN for the workload.

WorkloadId
  • Type: string

The ID assigned to the workload. This ID is unique within an AWS Region.

WorkloadName
  • Type: string

The name of the workload.

The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

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