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

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Account
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • AmplifyUIBuilder
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • AppConfigData
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationCostProfiler
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • AppRunner
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • ARCZonalShift
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • BackupGateway
      • Exception
    • BackupStorage
      • Exception
    • Batch
      • Exception
    • BillingConductor
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ChimeSDKIdentity
      • Exception
    • ChimeSDKMediaPipelines
      • Exception
    • ChimeSDKMeetings
      • Exception
    • ChimeSDKMessaging
      • Exception
    • ChimeSDKVoice
      • Exception
    • CleanRooms
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudControlApi
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchEvidently
      • Exception
    • CloudWatchLogs
      • Exception
    • CloudWatchRUM
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • CodeCatalyst
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodeGuruProfiler
      • Exception
    • CodeGuruReviewer
      • Exception
    • CodePipeline
      • Exception
    • CodeStar
      • Exception
    • CodeStarconnections
      • Exception
    • CodeStarNotifications
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoIdentityProvider
      • Exception
    • CognitoSync
      • Exception
    • Comprehend
      • Exception
    • ComprehendMedical
      • Exception
    • ComputeOptimizer
      • Exception
    • ConfigService
      • Exception
    • Connect
      • Exception
    • ConnectCampaignService
      • Exception
    • ConnectCases
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • ConnectWisdomService
      • Exception
    • ControlTower
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • DefaultsMode
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • Exception
    • DocDBElastic
      • Exception
    • drs
      • Exception
    • DynamoDb
      • Exception
    • DynamoDbStreams
      • Exception
    • EBS
      • Exception
    • Ec2
      • Exception
    • EC2InstanceConnect
      • Exception
    • Ecr
      • Exception
    • ECRPublic
      • Exception
    • Ecs
      • Exception
    • Efs
      • Exception
    • EKS
      • Exception
    • ElastiCache
      • Exception
    • ElasticBeanstalk
      • Exception
    • ElasticInference
      • Exception
    • ElasticLoadBalancing
      • Exception
    • ElasticLoadBalancingV2
      • Exception
    • ElasticsearchService
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Exception
    • EMRContainers
      • Exception
    • EMRServerless
      • Exception
    • Endpoint
      • UseDualstackEndpoint
        • Exception
      • UseFipsEndpoint
        • Exception
    • EndpointDiscovery
      • Exception
    • EndpointV2
      • Rule
      • Ruleset
    • EventBridge
      • Exception
    • Exception
    • finspace
      • Exception
    • FinSpaceData
      • Exception
    • Firehose
      • Exception
    • FIS
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • Exception
    • GameSparks
      • Exception
    • Glacier
      • Exception
    • GlobalAccelerator
      • Exception
    • Glue
      • Exception
    • GlueDataBrew
      • Exception
    • Greengrass
      • Exception
    • GreengrassV2
      • Exception
    • GroundStation
      • Exception
    • GuardDuty
      • Exception
    • Handler
      • GuzzleV5
      • GuzzleV6
    • Health
      • Exception
    • HealthLake
      • Exception
    • Honeycode
      • Exception
    • Iam
      • Exception
    • IdentityStore
      • Exception
    • imagebuilder
      • Exception
    • ImportExport
      • Exception
    • Inspector
      • Exception
    • Inspector2
      • Exception
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTDeviceAdvisor
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTFleetHub
      • Exception
    • IoTFleetWise
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTRoboRunner
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTTwinMaker
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • ivschat
      • Exception
    • Kafka
      • Exception
    • KafkaConnect
      • Exception
    • kendra
      • Exception
    • KendraRanking
      • Exception
    • Keyspaces
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • KinesisVideoWebRTCStorage
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexModelsV2
      • Exception
    • LexRuntimeService
      • Exception
    • LexRuntimeV2
      • Exception
    • LicenseManager
      • Exception
    • LicenseManagerLinuxSubscriptions
      • Exception
    • LicenseManagerUserSubscriptions
      • Exception
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • LookoutEquipment
      • Exception
    • LookoutforVision
      • Exception
    • LookoutMetrics
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • MainframeModernization
      • Exception
    • ManagedBlockchain
      • Exception
    • ManagedGrafana
      • Exception
    • MarketplaceCatalog
      • Exception
    • MarketplaceCommerceAnalytics
      • Exception
    • MarketplaceEntitlementService
      • Exception
    • MarketplaceMetering
      • Exception
    • MediaConnect
      • Exception
    • MediaConvert
      • Exception
    • MediaLive
      • Exception
    • MediaPackage
      • Exception
    • MediaPackageVod
      • Exception
    • MediaStore
      • Exception
    • MediaStoreData
      • Exception
    • MediaTailor
      • Exception
    • MemoryDB
      • Exception
    • mgn
      • Exception
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • MigrationHubOrchestrator
      • Exception
    • MigrationHubRefactorSpaces
      • Exception
    • MigrationHubStrategyRecommendations
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • NimbleStudio
      • Exception
    • OAM
      • Exception
    • Omics
      • Exception
    • OpenSearchServerless
      • Exception
    • OpenSearchService
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Panorama
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • PinpointSMSVoiceV2
      • Exception
    • Pipes
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrivateNetworks
      • Exception
    • PrometheusService
      • Exception
    • Proton
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • RecycleBin
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • RedshiftServerless
      • Exception
    • Rekognition
      • Exception
    • ResilienceHub
      • Exception
    • ResourceExplorer2
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • RolesAnywhere
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • Route53RecoveryCluster
      • Exception
    • Route53RecoveryControlConfig
      • Exception
    • Route53RecoveryReadiness
      • Exception
    • Route53Resolver
      • Exception
    • S3
      • Crypto
      • Exception
      • RegionalEndpoint
        • Exception
      • UseArnRegion
        • Exception
    • S3Control
      • Exception
    • S3Outposts
      • Exception
    • SageMaker
      • Exception
    • SagemakerEdgeManager
      • Exception
    • SageMakerFeatureStoreRuntime
      • Exception
    • SageMakerGeospatial
      • Exception
    • SageMakerMetrics
      • Exception
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • Scheduler
      • Exception
    • Schemas
      • Exception
    • Script
      • Composer
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • SecurityLake
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • SimSpaceWeaver
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • SnowDeviceManagement
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSMContacts
      • Exception
    • SSMIncidents
      • Exception
    • SsmSap
      • Exception
    • SSO
      • Exception
    • SSOAdmin
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • SupportApp
      • Exception
    • Swf
      • Exception
    • Synthetics
      • Exception
    • Textract
      • Exception
    • TimestreamQuery
      • Exception
    • TimestreamWrite
      • Exception
    • Token
    • TranscribeService
      • Exception
    • Transfer
      • Exception
    • Translate
      • Exception
    • VoiceID
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • WorkSpacesWeb
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Account\AccountClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • Aws\AmplifyUIBuilder\AmplifyUIBuilderClient
  • Aws\Api\AbstractModel
  • Aws\Api\ApiProvider
  • Aws\Api\DateTimeResult
  • Aws\Api\DocModel
  • Aws\Api\ErrorParser\AbstractErrorParser
  • Aws\Api\ErrorParser\JsonRpcErrorParser
  • Aws\Api\ErrorParser\RestJsonErrorParser
  • Aws\Api\ErrorParser\XmlErrorParser
  • Aws\Api\ListShape
  • Aws\Api\MapShape
  • Aws\Api\Operation
  • Aws\Api\Parser\Crc32ValidatingParser
  • Aws\Api\Parser\DecodingEventStreamIterator
  • Aws\Api\Parser\EventParsingIterator
  • Aws\Api\Parser\JsonParser
  • Aws\Api\Parser\JsonRpcParser
  • Aws\Api\Parser\QueryParser
  • Aws\Api\Parser\RestJsonParser
  • Aws\Api\Parser\RestXmlParser
  • Aws\Api\Parser\XmlParser
  • Aws\Api\Serializer\XmlBody
  • Aws\Api\Service
  • Aws\Api\Shape
  • Aws\Api\ShapeMap
  • Aws\Api\StructureShape
  • Aws\Api\TimestampShape
  • Aws\Api\Validator
  • Aws\ApiGateway\ApiGatewayClient
  • Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient
  • Aws\ApiGatewayV2\ApiGatewayV2Client
  • Aws\AppConfig\AppConfigClient
  • Aws\AppConfigData\AppConfigDataClient
  • Aws\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationCostProfiler\ApplicationCostProfilerClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\AppRunner\AppRunnerClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\ARCZonalShift\ARCZonalShiftClient
  • Aws\Athena\AthenaClient
  • Aws\AuditManager\AuditManagerClient
  • Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\BackupGateway\BackupGatewayClient
  • Aws\BackupStorage\BackupStorageClient
  • Aws\Batch\BatchClient
  • Aws\BillingConductor\BillingConductorClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ChimeSDKIdentity\ChimeSDKIdentityClient
  • Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient
  • Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient
  • Aws\ChimeSDKMessaging\ChimeSDKMessagingClient
  • Aws\ChimeSDKVoice\ChimeSDKVoiceClient
  • Aws\CleanRooms\CleanRoomsClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudControlApi\CloudControlApiClient
  • Aws\CloudDirectory\CloudDirectoryClient
  • Aws\CloudFormation\CloudFormationClient
  • Aws\CloudFront\CloudFrontClient
  • Aws\CloudFront\CookieSigner
  • Aws\CloudFront\UrlSigner
  • Aws\CloudHsm\CloudHsmClient
  • Aws\CloudHSMV2\CloudHSMV2Client
  • Aws\CloudSearch\CloudSearchClient
  • Aws\CloudSearchDomain\CloudSearchDomainClient
  • Aws\CloudTrail\CloudTrailClient
  • Aws\CloudTrail\LogFileIterator
  • Aws\CloudTrail\LogFileReader
  • Aws\CloudTrail\LogRecordIterator
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchEvidently\CloudWatchEvidentlyClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CloudWatchRUM\CloudWatchRUMClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCatalyst\CodeCatalystClient
  • Aws\CodeCommit\CodeCommitClient
  • Aws\CodeDeploy\CodeDeployClient
  • Aws\CodeGuruProfiler\CodeGuruProfilerClient
  • Aws\CodeGuruReviewer\CodeGuruReviewerClient
  • Aws\CodePipeline\CodePipelineClient
  • Aws\CodeStar\CodeStarClient
  • Aws\CodeStarconnections\CodeStarconnectionsClient
  • Aws\CodeStarNotifications\CodeStarNotificationsClient
  • Aws\CognitoIdentity\CognitoIdentityClient
  • Aws\CognitoIdentity\CognitoIdentityProvider
  • Aws\CognitoIdentityProvider\CognitoIdentityProviderClient
  • Aws\CognitoSync\CognitoSyncClient
  • Aws\Command
  • Aws\CommandPool
  • Aws\Comprehend\ComprehendClient
  • Aws\ComprehendMedical\ComprehendMedicalClient
  • Aws\ComputeOptimizer\ComputeOptimizerClient
  • Aws\ConfigService\ConfigServiceClient
  • Aws\Connect\ConnectClient
  • Aws\ConnectCampaignService\ConnectCampaignServiceClient
  • Aws\ConnectCases\ConnectCasesClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\ConnectWisdomService\ConnectWisdomServiceClient
  • Aws\ControlTower\ControlTowerClient
  • Aws\CostandUsageReportService\CostandUsageReportServiceClient
  • Aws\CostExplorer\CostExplorerClient
  • Aws\Credentials\AssumeRoleCredentialProvider
  • Aws\Credentials\AssumeRoleWithWebIdentityCredentialProvider
  • Aws\Credentials\CredentialProvider
  • Aws\Credentials\Credentials
  • Aws\Credentials\EcsCredentialProvider
  • Aws\Credentials\InstanceProfileProvider
  • Aws\Crypto\AesDecryptingStream
  • Aws\Crypto\AesEncryptingStream
  • Aws\Crypto\AesGcmDecryptingStream
  • Aws\Crypto\AesGcmEncryptingStream
  • Aws\Crypto\Cipher\Cbc
  • Aws\Crypto\KmsMaterialsProvider
  • Aws\Crypto\KmsMaterialsProviderV2
  • Aws\Crypto\MaterialsProvider
  • Aws\Crypto\MaterialsProviderV2
  • Aws\Crypto\Polyfill\AesGcm
  • Aws\Crypto\Polyfill\ByteArray
  • Aws\Crypto\Polyfill\Gmac
  • Aws\Crypto\Polyfill\Key
  • Aws\CustomerProfiles\CustomerProfilesClient
  • Aws\DatabaseMigrationService\DatabaseMigrationServiceClient
  • Aws\DataExchange\DataExchangeClient
  • Aws\DataPipeline\DataPipelineClient
  • Aws\DataSync\DataSyncClient
  • Aws\DAX\DAXClient
  • Aws\DefaultsMode\Configuration
  • Aws\DefaultsMode\ConfigurationProvider
  • Aws\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DocDBElastic\DocDBElasticClient
  • Aws\DoctrineCacheAdapter
  • Aws\drs\drsClient
  • Aws\DynamoDb\BinaryValue
  • Aws\DynamoDb\DynamoDbClient
  • Aws\DynamoDb\LockingSessionConnection
  • Aws\DynamoDb\Marshaler
  • Aws\DynamoDb\NumberValue
  • Aws\DynamoDb\SessionHandler
  • Aws\DynamoDb\SetValue
  • Aws\DynamoDb\StandardSessionConnection
  • Aws\DynamoDb\WriteRequestBatch
  • Aws\DynamoDbStreams\DynamoDbStreamsClient
  • Aws\EBS\EBSClient
  • Aws\Ec2\Ec2Client
  • Aws\EC2InstanceConnect\EC2InstanceConnectClient
  • Aws\Ecr\EcrClient
  • Aws\ECRPublic\ECRPublicClient
  • Aws\Ecs\EcsClient
  • Aws\Efs\EfsClient
  • Aws\EKS\EKSClient
  • Aws\ElastiCache\ElastiCacheClient
  • Aws\ElasticBeanstalk\ElasticBeanstalkClient
  • Aws\ElasticInference\ElasticInferenceClient
  • Aws\ElasticLoadBalancing\ElasticLoadBalancingClient
  • Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client
  • Aws\ElasticsearchService\ElasticsearchServiceClient
  • Aws\ElasticTranscoder\ElasticTranscoderClient
  • Aws\Emr\EmrClient
  • Aws\EMRContainers\EMRContainersClient
  • Aws\EMRServerless\EMRServerlessClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\Endpoint\UseDualstackEndpoint\Configuration
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationProvider
  • Aws\Endpoint\UseFipsEndpoint\Configuration
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EndpointV2\EndpointDefinitionProvider
  • Aws\EndpointV2\EndpointProviderV2
  • Aws\EndpointV2\Rule\AbstractRule
  • Aws\EndpointV2\Rule\EndpointRule
  • Aws\EndpointV2\Rule\ErrorRule
  • Aws\EndpointV2\Rule\RuleCreator
  • Aws\EndpointV2\Rule\TreeRule
  • Aws\EndpointV2\Ruleset\Ruleset
  • Aws\EndpointV2\Ruleset\RulesetEndpoint
  • Aws\EndpointV2\Ruleset\RulesetParameter
  • Aws\EventBridge\EventBridgeClient
  • Aws\finspace\finspaceClient
  • Aws\FinSpaceData\FinSpaceDataClient
  • Aws\Firehose\FirehoseClient
  • Aws\FIS\FISClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • Aws\GameSparks\GameSparksClient
  • Aws\Glacier\GlacierClient
  • Aws\Glacier\MultipartUploader
  • Aws\Glacier\TreeHash
  • Aws\GlobalAccelerator\GlobalAcceleratorClient
  • Aws\Glue\GlueClient
  • Aws\GlueDataBrew\GlueDataBrewClient
  • Aws\Greengrass\GreengrassClient
  • Aws\GreengrassV2\GreengrassV2Client
  • Aws\GroundStation\GroundStationClient
  • Aws\GuardDuty\GuardDutyClient
  • Aws\Handler\GuzzleV5\GuzzleHandler
  • Aws\Handler\GuzzleV5\GuzzleStream
  • Aws\Handler\GuzzleV5\PsrStream
  • Aws\Handler\GuzzleV6\GuzzleHandler
  • Aws\HandlerList
  • Aws\HashingStream
  • Aws\Health\HealthClient
  • Aws\HealthLake\HealthLakeClient
  • Aws\History
  • Aws\Honeycode\HoneycodeClient
  • Aws\Iam\IamClient
  • Aws\IdempotencyTokenMiddleware
  • Aws\IdentityStore\IdentityStoreClient
  • Aws\imagebuilder\imagebuilderClient
  • Aws\ImportExport\ImportExportClient
  • Aws\Inspector2\Inspector2Client
  • Aws\Inspector\InspectorClient
  • Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
  • Aws\IoT1ClickProjects\IoT1ClickProjectsClient
  • Aws\Iot\IotClient
  • Aws\IoTAnalytics\IoTAnalyticsClient
  • Aws\IotDataPlane\IotDataPlaneClient
  • Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient
  • Aws\IoTEvents\IoTEventsClient
  • Aws\IoTEventsData\IoTEventsDataClient
  • Aws\IoTFleetHub\IoTFleetHubClient
  • Aws\IoTFleetWise\IoTFleetWiseClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTRoboRunner\IoTRoboRunnerClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTTwinMaker\IoTTwinMakerClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\ivschat\ivschatClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\KafkaConnect\KafkaConnectClient
  • Aws\kendra\kendraClient
  • Aws\KendraRanking\KendraRankingClient
  • Aws\Keyspaces\KeyspacesClient
  • Aws\Kinesis\KinesisClient
  • Aws\KinesisAnalytics\KinesisAnalyticsClient
  • Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
  • Aws\KinesisVideo\KinesisVideoClient
  • Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
  • Aws\KinesisVideoMedia\KinesisVideoMediaClient
  • Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
  • Aws\KinesisVideoWebRTCStorage\KinesisVideoWebRTCStorageClient
  • Aws\Kms\KmsClient
  • Aws\LakeFormation\LakeFormationClient
  • Aws\Lambda\LambdaClient
  • Aws\LexModelBuildingService\LexModelBuildingServiceClient
  • Aws\LexModelsV2\LexModelsV2Client
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LexRuntimeV2\LexRuntimeV2Client
  • Aws\LicenseManager\LicenseManagerClient
  • Aws\LicenseManagerLinuxSubscriptions\LicenseManagerLinuxSubscriptionsClient
  • Aws\LicenseManagerUserSubscriptions\LicenseManagerUserSubscriptionsClient
  • Aws\Lightsail\LightsailClient
  • Aws\LocationService\LocationServiceClient
  • Aws\LookoutEquipment\LookoutEquipmentClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LookoutMetrics\LookoutMetricsClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\MainframeModernization\MainframeModernizationClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • Aws\ManagedGrafana\ManagedGrafanaClient
  • Aws\MarketplaceCatalog\MarketplaceCatalogClient
  • Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
  • Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
  • Aws\MarketplaceMetering\MarketplaceMeteringClient
  • Aws\MediaConnect\MediaConnectClient
  • Aws\MediaConvert\MediaConvertClient
  • Aws\MediaLive\MediaLiveClient
  • Aws\MediaPackage\MediaPackageClient
  • Aws\MediaPackageVod\MediaPackageVodClient
  • Aws\MediaStore\MediaStoreClient
  • Aws\MediaStoreData\MediaStoreDataClient
  • Aws\MediaTailor\MediaTailorClient
  • Aws\MemoryDB\MemoryDBClient
  • Aws\mgn\mgnClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • Aws\MigrationHubOrchestrator\MigrationHubOrchestratorClient
  • Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient
  • Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
  • Aws\Mobile\MobileClient
  • Aws\MockHandler
  • Aws\MQ\MQClient
  • Aws\MTurk\MTurkClient
  • Aws\Multipart\UploadState
  • Aws\MultiRegionClient
  • Aws\MWAA\MWAAClient
  • Aws\Neptune\NeptuneClient
  • Aws\NetworkFirewall\NetworkFirewallClient
  • Aws\NetworkManager\NetworkManagerClient
  • Aws\NimbleStudio\NimbleStudioClient
  • Aws\OAM\OAMClient
  • Aws\Omics\OmicsClient
  • Aws\OpenSearchServerless\OpenSearchServerlessClient
  • Aws\OpenSearchService\OpenSearchServiceClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Panorama\PanoramaClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client
  • Aws\Pipes\PipesClient
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrivateNetworks\PrivateNetworksClient
  • Aws\PrometheusService\PrometheusServiceClient
  • Aws\Proton\ProtonClient
  • Aws\Psr16CacheAdapter
  • Aws\PsrCacheAdapter
  • Aws\QLDB\QLDBClient
  • Aws\QLDBSession\QLDBSessionClient
  • Aws\QuickSight\QuickSightClient
  • Aws\RAM\RAMClient
  • Aws\Rds\AuthTokenGenerator
  • Aws\Rds\RdsClient
  • Aws\RDSDataService\RDSDataServiceClient
  • Aws\RecycleBin\RecycleBinClient
  • Aws\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\RedshiftServerless\RedshiftServerlessClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResilienceHub\ResilienceHubClient
  • Aws\ResourceExplorer2\ResourceExplorer2Client
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\Retry\Configuration
  • Aws\Retry\ConfigurationProvider
  • Aws\RoboMaker\RoboMakerClient
  • Aws\RolesAnywhere\RolesAnywhereClient
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\Route53RecoveryCluster\Route53RecoveryClusterClient
  • Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
  • Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
  • Aws\Route53Resolver\Route53ResolverClient
  • Aws\S3\BatchDelete
  • Aws\S3\Crypto\HeadersMetadataStrategy
  • Aws\S3\Crypto\InstructionFileMetadataStrategy
  • Aws\S3\Crypto\S3EncryptionClient
  • Aws\S3\Crypto\S3EncryptionClientV2
  • Aws\S3\Crypto\S3EncryptionMultipartUploader
  • Aws\S3\Crypto\S3EncryptionMultipartUploaderV2
  • Aws\S3\GetBucketLocationParser
  • Aws\S3\MultipartUploader
  • Aws\S3\ObjectCopier
  • Aws\S3\ObjectUploader
  • Aws\S3\PostObject
  • Aws\S3\PostObjectV4
  • Aws\S3\RegionalEndpoint\Configuration
  • Aws\S3\RegionalEndpoint\ConfigurationProvider
  • Aws\S3\S3Client
  • Aws\S3\S3MultiRegionClient
  • Aws\S3\S3UriParser
  • Aws\S3\StreamWrapper
  • Aws\S3\Transfer
  • Aws\S3\UseArnRegion\Configuration
  • Aws\S3\UseArnRegion\ConfigurationProvider
  • Aws\S3\ValidateResponseChecksumParser
  • Aws\S3Control\S3ControlClient
  • Aws\S3Outposts\S3OutpostsClient
  • Aws\SageMaker\SageMakerClient
  • Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
  • Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
  • Aws\SageMakerGeospatial\SageMakerGeospatialClient
  • Aws\SageMakerMetrics\SageMakerMetricsClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Scheduler\SchedulerClient
  • Aws\Schemas\SchemasClient
  • Aws\Script\Composer\Composer
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\SecurityLake\SecurityLakeClient
  • Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
  • Aws\ServiceCatalog\ServiceCatalogClient
  • Aws\ServiceDiscovery\ServiceDiscoveryClient
  • Aws\ServiceQuotas\ServiceQuotasClient
  • Aws\Ses\SesClient
  • Aws\SesV2\SesV2Client
  • Aws\Sfn\SfnClient
  • Aws\Shield\ShieldClient
  • Aws\Signature\AnonymousSignature
  • Aws\Signature\S3SignatureV4
  • Aws\Signature\SignatureProvider
  • Aws\Signature\SignatureV4
  • Aws\signer\signerClient
  • Aws\SimSpaceWeaver\SimSpaceWeaverClient
  • Aws\Sms\SmsClient
  • Aws\SnowBall\SnowBallClient
  • Aws\SnowDeviceManagement\SnowDeviceManagementClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSMContacts\SSMContactsClient
  • Aws\SSMIncidents\SSMIncidentsClient
  • Aws\SsmSap\SsmSapClient
  • Aws\SSO\SSOClient
  • Aws\SSOAdmin\SSOAdminClient
  • Aws\SSOOIDC\SSOOIDCClient
  • Aws\StorageGateway\StorageGatewayClient
  • Aws\Sts\RegionalEndpoints\Configuration
  • Aws\Sts\RegionalEndpoints\ConfigurationProvider
  • Aws\Sts\StsClient
  • Aws\Support\SupportClient
  • Aws\SupportApp\SupportAppClient
  • Aws\Swf\SwfClient
  • Aws\Synthetics\SyntheticsClient
  • Aws\Textract\TextractClient
  • Aws\TimestreamQuery\TimestreamQueryClient
  • Aws\TimestreamWrite\TimestreamWriteClient
  • Aws\Token\BearerTokenAuthorization
  • Aws\Token\SsoToken
  • Aws\Token\SsoTokenProvider
  • Aws\Token\Token
  • Aws\Token\TokenProvider
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Transfer\TransferClient
  • Aws\Translate\TranslateClient
  • Aws\VoiceID\VoiceIDClient
  • Aws\Waf\WafClient
  • Aws\WafRegional\WafRegionalClient
  • Aws\WAFV2\WAFV2Client
  • Aws\Waiter
  • Aws\WellArchitected\WellArchitectedClient
  • Aws\WorkDocs\WorkDocsClient
  • Aws\WorkLink\WorkLinkClient
  • Aws\WorkMail\WorkMailClient
  • Aws\WorkMailMessageFlow\WorkMailMessageFlowClient
  • Aws\WorkSpaces\WorkSpacesClient
  • Aws\WorkSpacesWeb\WorkSpacesWebClient
  • Aws\WrappedHttpHandler
  • Aws\XRay\XRayClient

Interfaces

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

Traits

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

Exceptions

  • Aws\AccessAnalyzer\Exception\AccessAnalyzerException
  • Aws\Account\Exception\AccountException
  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\AmplifyUIBuilder\Exception\AmplifyUIBuilderException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\AppConfigData\Exception\AppConfigDataException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationCostProfiler\Exception\ApplicationCostProfilerException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • Aws\AppRunner\Exception\AppRunnerException
  • Aws\Appstream\Exception\AppstreamException
  • Aws\AppSync\Exception\AppSyncException
  • Aws\ARCZonalShift\Exception\ARCZonalShiftException
  • Aws\Arn\Exception\InvalidArnException
  • Aws\Athena\Exception\AthenaException
  • Aws\AuditManager\Exception\AuditManagerException
  • Aws\AugmentedAIRuntime\Exception\AugmentedAIRuntimeException
  • Aws\AutoScaling\Exception\AutoScalingException
  • Aws\AutoScalingPlans\Exception\AutoScalingPlansException
  • Aws\Backup\Exception\BackupException
  • Aws\BackupGateway\Exception\BackupGatewayException
  • Aws\BackupStorage\Exception\BackupStorageException
  • Aws\Batch\Exception\BatchException
  • Aws\BillingConductor\Exception\BillingConductorException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ChimeSDKIdentity\Exception\ChimeSDKIdentityException
  • Aws\ChimeSDKMediaPipelines\Exception\ChimeSDKMediaPipelinesException
  • Aws\ChimeSDKMeetings\Exception\ChimeSDKMeetingsException
  • Aws\ChimeSDKMessaging\Exception\ChimeSDKMessagingException
  • Aws\ChimeSDKVoice\Exception\ChimeSDKVoiceException
  • Aws\CleanRooms\Exception\CleanRoomsException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudControlApi\Exception\CloudControlApiException
  • Aws\CloudDirectory\Exception\CloudDirectoryException
  • Aws\CloudFormation\Exception\CloudFormationException
  • Aws\CloudFront\Exception\CloudFrontException
  • Aws\CloudHsm\Exception\CloudHsmException
  • Aws\CloudHSMV2\Exception\CloudHSMV2Exception
  • Aws\CloudSearch\Exception\CloudSearchException
  • Aws\CloudSearchDomain\Exception\CloudSearchDomainException
  • Aws\CloudTrail\Exception\CloudTrailException
  • Aws\CloudWatch\Exception\CloudWatchException
  • Aws\CloudWatchEvents\Exception\CloudWatchEventsException
  • Aws\CloudWatchEvidently\Exception\CloudWatchEvidentlyException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CloudWatchRUM\Exception\CloudWatchRUMException
  • Aws\CodeArtifact\Exception\CodeArtifactException
  • Aws\CodeBuild\Exception\CodeBuildException
  • Aws\CodeCatalyst\Exception\CodeCatalystException
  • Aws\CodeCommit\Exception\CodeCommitException
  • Aws\CodeDeploy\Exception\CodeDeployException
  • Aws\CodeGuruProfiler\Exception\CodeGuruProfilerException
  • Aws\CodeGuruReviewer\Exception\CodeGuruReviewerException
  • Aws\CodePipeline\Exception\CodePipelineException
  • Aws\CodeStar\Exception\CodeStarException
  • Aws\CodeStarconnections\Exception\CodeStarconnectionsException
  • Aws\CodeStarNotifications\Exception\CodeStarNotificationsException
  • Aws\CognitoIdentity\Exception\CognitoIdentityException
  • Aws\CognitoIdentityProvider\Exception\CognitoIdentityProviderException
  • Aws\CognitoSync\Exception\CognitoSyncException
  • Aws\Comprehend\Exception\ComprehendException
  • Aws\ComprehendMedical\Exception\ComprehendMedicalException
  • Aws\ComputeOptimizer\Exception\ComputeOptimizerException
  • Aws\ConfigService\Exception\ConfigServiceException
  • Aws\Connect\Exception\ConnectException
  • Aws\ConnectCampaignService\Exception\ConnectCampaignServiceException
  • Aws\ConnectCases\Exception\ConnectCasesException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\ConnectWisdomService\Exception\ConnectWisdomServiceException
  • Aws\ControlTower\Exception\ControlTowerException
  • Aws\CostandUsageReportService\Exception\CostandUsageReportServiceException
  • Aws\CostExplorer\Exception\CostExplorerException
  • Aws\CustomerProfiles\Exception\CustomerProfilesException
  • Aws\DatabaseMigrationService\Exception\DatabaseMigrationServiceException
  • Aws\DataExchange\Exception\DataExchangeException
  • Aws\DataPipeline\Exception\DataPipelineException
  • Aws\DataSync\Exception\DataSyncException
  • Aws\DAX\Exception\DAXException
  • Aws\DefaultsMode\Exception\ConfigurationException
  • Aws\Detective\Exception\DetectiveException
  • Aws\DeviceFarm\Exception\DeviceFarmException
  • Aws\DevOpsGuru\Exception\DevOpsGuruException
  • Aws\DirectConnect\Exception\DirectConnectException
  • Aws\DirectoryService\Exception\DirectoryServiceException
  • Aws\DLM\Exception\DLMException
  • Aws\DocDB\Exception\DocDBException
  • Aws\DocDBElastic\Exception\DocDBElasticException
  • Aws\drs\Exception\drsException
  • Aws\DynamoDb\Exception\DynamoDbException
  • Aws\DynamoDbStreams\Exception\DynamoDbStreamsException
  • Aws\EBS\Exception\EBSException
  • Aws\Ec2\Exception\Ec2Exception
  • Aws\EC2InstanceConnect\Exception\EC2InstanceConnectException
  • Aws\Ecr\Exception\EcrException
  • Aws\ECRPublic\Exception\ECRPublicException
  • Aws\Ecs\Exception\EcsException
  • Aws\Efs\Exception\EfsException
  • Aws\EKS\Exception\EKSException
  • Aws\ElastiCache\Exception\ElastiCacheException
  • Aws\ElasticBeanstalk\Exception\ElasticBeanstalkException
  • Aws\ElasticInference\Exception\ElasticInferenceException
  • Aws\ElasticLoadBalancing\Exception\ElasticLoadBalancingException
  • Aws\ElasticLoadBalancingV2\Exception\ElasticLoadBalancingV2Exception
  • Aws\ElasticsearchService\Exception\ElasticsearchServiceException
  • Aws\ElasticTranscoder\Exception\ElasticTranscoderException
  • Aws\Emr\Exception\EmrException
  • Aws\EMRContainers\Exception\EMRContainersException
  • Aws\EMRServerless\Exception\EMRServerlessException
  • Aws\Endpoint\UseDualstackEndpoint\Exception\ConfigurationException
  • Aws\Endpoint\UseFipsEndpoint\Exception\ConfigurationException
  • Aws\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CommonRuntimeException
  • Aws\Exception\CouldNotCreateChecksumException
  • Aws\Exception\CredentialsException
  • Aws\Exception\CryptoException
  • Aws\Exception\CryptoPolyfillException
  • Aws\Exception\EventStreamDataException
  • Aws\Exception\IncalculablePayloadException
  • Aws\Exception\InvalidJsonException
  • Aws\Exception\InvalidRegionException
  • Aws\Exception\MultipartUploadException
  • Aws\Exception\TokenException
  • Aws\Exception\UnresolvedApiException
  • Aws\Exception\UnresolvedEndpointException
  • Aws\Exception\UnresolvedSignatureException
  • Aws\finspace\Exception\finspaceException
  • Aws\FinSpaceData\Exception\FinSpaceDataException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FIS\Exception\FISException
  • Aws\FMS\Exception\FMSException
  • Aws\ForecastQueryService\Exception\ForecastQueryServiceException
  • Aws\ForecastService\Exception\ForecastServiceException
  • Aws\FraudDetector\Exception\FraudDetectorException
  • Aws\FSx\Exception\FSxException
  • Aws\GameLift\Exception\GameLiftException
  • Aws\GameSparks\Exception\GameSparksException
  • Aws\Glacier\Exception\GlacierException
  • Aws\GlobalAccelerator\Exception\GlobalAcceleratorException
  • Aws\Glue\Exception\GlueException
  • Aws\GlueDataBrew\Exception\GlueDataBrewException
  • Aws\Greengrass\Exception\GreengrassException
  • Aws\GreengrassV2\Exception\GreengrassV2Exception
  • Aws\GroundStation\Exception\GroundStationException
  • Aws\GuardDuty\Exception\GuardDutyException
  • Aws\Health\Exception\HealthException
  • Aws\HealthLake\Exception\HealthLakeException
  • Aws\Honeycode\Exception\HoneycodeException
  • Aws\Iam\Exception\IamException
  • Aws\IdentityStore\Exception\IdentityStoreException
  • Aws\imagebuilder\Exception\imagebuilderException
  • Aws\ImportExport\Exception\ImportExportException
  • Aws\Inspector2\Exception\Inspector2Exception
  • Aws\Inspector\Exception\InspectorException
  • Aws\IoT1ClickDevicesService\Exception\IoT1ClickDevicesServiceException
  • Aws\IoT1ClickProjects\Exception\IoT1ClickProjectsException
  • Aws\Iot\Exception\IotException
  • Aws\IoTAnalytics\Exception\IoTAnalyticsException
  • Aws\IotDataPlane\Exception\IotDataPlaneException
  • Aws\IoTDeviceAdvisor\Exception\IoTDeviceAdvisorException
  • Aws\IoTEvents\Exception\IoTEventsException
  • Aws\IoTEventsData\Exception\IoTEventsDataException
  • Aws\IoTFleetHub\Exception\IoTFleetHubException
  • Aws\IoTFleetWise\Exception\IoTFleetWiseException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTRoboRunner\Exception\IoTRoboRunnerException
  • Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
  • Aws\IoTSiteWise\Exception\IoTSiteWiseException
  • Aws\IoTThingsGraph\Exception\IoTThingsGraphException
  • Aws\IoTTwinMaker\Exception\IoTTwinMakerException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\ivschat\Exception\ivschatException
  • Aws\Kafka\Exception\KafkaException
  • Aws\KafkaConnect\Exception\KafkaConnectException
  • Aws\kendra\Exception\kendraException
  • Aws\KendraRanking\Exception\KendraRankingException
  • Aws\Keyspaces\Exception\KeyspacesException
  • Aws\Kinesis\Exception\KinesisException
  • Aws\KinesisAnalytics\Exception\KinesisAnalyticsException
  • Aws\KinesisAnalyticsV2\Exception\KinesisAnalyticsV2Exception
  • Aws\KinesisVideo\Exception\KinesisVideoException
  • Aws\KinesisVideoArchivedMedia\Exception\KinesisVideoArchivedMediaException
  • Aws\KinesisVideoMedia\Exception\KinesisVideoMediaException
  • Aws\KinesisVideoSignalingChannels\Exception\KinesisVideoSignalingChannelsException
  • Aws\KinesisVideoWebRTCStorage\Exception\KinesisVideoWebRTCStorageException
  • Aws\Kms\Exception\KmsException
  • Aws\LakeFormation\Exception\LakeFormationException
  • Aws\Lambda\Exception\LambdaException
  • Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException
  • Aws\LexModelsV2\Exception\LexModelsV2Exception
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LexRuntimeV2\Exception\LexRuntimeV2Exception
  • Aws\LicenseManager\Exception\LicenseManagerException
  • Aws\LicenseManagerLinuxSubscriptions\Exception\LicenseManagerLinuxSubscriptionsException
  • Aws\LicenseManagerUserSubscriptions\Exception\LicenseManagerUserSubscriptionsException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\LocationService\Exception\LocationServiceException
  • Aws\LookoutEquipment\Exception\LookoutEquipmentException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\LookoutMetrics\Exception\LookoutMetricsException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\MainframeModernization\Exception\MainframeModernizationException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • Aws\ManagedGrafana\Exception\ManagedGrafanaException
  • Aws\MarketplaceCatalog\Exception\MarketplaceCatalogException
  • Aws\MarketplaceCommerceAnalytics\Exception\MarketplaceCommerceAnalyticsException
  • Aws\MarketplaceEntitlementService\Exception\MarketplaceEntitlementServiceException
  • Aws\MarketplaceMetering\Exception\MarketplaceMeteringException
  • Aws\MediaConnect\Exception\MediaConnectException
  • Aws\MediaConvert\Exception\MediaConvertException
  • Aws\MediaLive\Exception\MediaLiveException
  • Aws\MediaPackage\Exception\MediaPackageException
  • Aws\MediaPackageVod\Exception\MediaPackageVodException
  • Aws\MediaStore\Exception\MediaStoreException
  • Aws\MediaStoreData\Exception\MediaStoreDataException
  • Aws\MediaTailor\Exception\MediaTailorException
  • Aws\MemoryDB\Exception\MemoryDBException
  • Aws\mgn\Exception\mgnException
  • Aws\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • Aws\MigrationHubOrchestrator\Exception\MigrationHubOrchestratorException
  • Aws\MigrationHubRefactorSpaces\Exception\MigrationHubRefactorSpacesException
  • Aws\MigrationHubStrategyRecommendations\Exception\MigrationHubStrategyRecommendationsException
  • Aws\Mobile\Exception\MobileException
  • Aws\MQ\Exception\MQException
  • Aws\MTurk\Exception\MTurkException
  • Aws\MWAA\Exception\MWAAException
  • Aws\Neptune\Exception\NeptuneException
  • Aws\NetworkFirewall\Exception\NetworkFirewallException
  • Aws\NetworkManager\Exception\NetworkManagerException
  • Aws\NimbleStudio\Exception\NimbleStudioException
  • Aws\OAM\Exception\OAMException
  • Aws\Omics\Exception\OmicsException
  • Aws\OpenSearchServerless\Exception\OpenSearchServerlessException
  • Aws\OpenSearchService\Exception\OpenSearchServiceException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • Aws\Panorama\Exception\PanoramaException
  • Aws\Personalize\Exception\PersonalizeException
  • Aws\PersonalizeEvents\Exception\PersonalizeEventsException
  • Aws\PersonalizeRuntime\Exception\PersonalizeRuntimeException
  • Aws\PI\Exception\PIException
  • Aws\Pinpoint\Exception\PinpointException
  • Aws\PinpointEmail\Exception\PinpointEmailException
  • Aws\PinpointSMSVoice\Exception\PinpointSMSVoiceException
  • Aws\PinpointSMSVoiceV2\Exception\PinpointSMSVoiceV2Exception
  • Aws\Pipes\Exception\PipesException
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrivateNetworks\Exception\PrivateNetworksException
  • Aws\PrometheusService\Exception\PrometheusServiceException
  • Aws\Proton\Exception\ProtonException
  • Aws\QLDB\Exception\QLDBException
  • Aws\QLDBSession\Exception\QLDBSessionException
  • Aws\QuickSight\Exception\QuickSightException
  • Aws\RAM\Exception\RAMException
  • Aws\Rds\Exception\RdsException
  • Aws\RDSDataService\Exception\RDSDataServiceException
  • Aws\RecycleBin\Exception\RecycleBinException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\RedshiftServerless\Exception\RedshiftServerlessException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResilienceHub\Exception\ResilienceHubException
  • Aws\ResourceExplorer2\Exception\ResourceExplorer2Exception
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Retry\Exception\ConfigurationException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\RolesAnywhere\Exception\RolesAnywhereException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\Route53RecoveryCluster\Exception\Route53RecoveryClusterException
  • Aws\Route53RecoveryControlConfig\Exception\Route53RecoveryControlConfigException
  • Aws\Route53RecoveryReadiness\Exception\Route53RecoveryReadinessException
  • Aws\Route53Resolver\Exception\Route53ResolverException
  • Aws\S3\Exception\DeleteMultipleObjectsException
  • Aws\S3\Exception\PermanentRedirectException
  • Aws\S3\Exception\S3Exception
  • Aws\S3\Exception\S3MultipartUploadException
  • Aws\S3\RegionalEndpoint\Exception\ConfigurationException
  • Aws\S3\UseArnRegion\Exception\ConfigurationException
  • Aws\S3Control\Exception\S3ControlException
  • Aws\S3Outposts\Exception\S3OutpostsException
  • Aws\SageMaker\Exception\SageMakerException
  • Aws\SagemakerEdgeManager\Exception\SagemakerEdgeManagerException
  • Aws\SageMakerFeatureStoreRuntime\Exception\SageMakerFeatureStoreRuntimeException
  • Aws\SageMakerGeospatial\Exception\SageMakerGeospatialException
  • Aws\SageMakerMetrics\Exception\SageMakerMetricsException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\Scheduler\Exception\SchedulerException
  • Aws\Schemas\Exception\SchemasException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\SecurityLake\Exception\SecurityLakeException
  • Aws\ServerlessApplicationRepository\Exception\ServerlessApplicationRepositoryException
  • Aws\ServiceCatalog\Exception\ServiceCatalogException
  • Aws\ServiceDiscovery\Exception\ServiceDiscoveryException
  • Aws\ServiceQuotas\Exception\ServiceQuotasException
  • Aws\Ses\Exception\SesException
  • Aws\SesV2\Exception\SesV2Exception
  • Aws\Sfn\Exception\SfnException
  • Aws\Shield\Exception\ShieldException
  • Aws\signer\Exception\signerException
  • Aws\SimSpaceWeaver\Exception\SimSpaceWeaverException
  • Aws\Sms\Exception\SmsException
  • Aws\SnowBall\Exception\SnowBallException
  • Aws\SnowDeviceManagement\Exception\SnowDeviceManagementException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSMContacts\Exception\SSMContactsException
  • Aws\SSMIncidents\Exception\SSMIncidentsException
  • Aws\SsmSap\Exception\SsmSapException
  • Aws\SSO\Exception\SSOException
  • Aws\SSOAdmin\Exception\SSOAdminException
  • Aws\SSOOIDC\Exception\SSOOIDCException
  • Aws\StorageGateway\Exception\StorageGatewayException
  • Aws\Sts\Exception\StsException
  • Aws\Sts\RegionalEndpoints\Exception\ConfigurationException
  • Aws\Support\Exception\SupportException
  • Aws\SupportApp\Exception\SupportAppException
  • Aws\Swf\Exception\SwfException
  • Aws\Synthetics\Exception\SyntheticsException
  • Aws\Textract\Exception\TextractException
  • Aws\TimestreamQuery\Exception\TimestreamQueryException
  • Aws\TimestreamWrite\Exception\TimestreamWriteException
  • Aws\TranscribeService\Exception\TranscribeServiceException
  • Aws\Transfer\Exception\TransferException
  • Aws\Translate\Exception\TranslateException
  • Aws\VoiceID\Exception\VoiceIDException
  • Aws\Waf\Exception\WafException
  • Aws\WafRegional\Exception\WafRegionalException
  • Aws\WAFV2\Exception\WAFV2Exception
  • Aws\WellArchitected\Exception\WellArchitectedException
  • Aws\WorkDocs\Exception\WorkDocsException
  • Aws\WorkLink\Exception\WorkLinkException
  • Aws\WorkMail\Exception\WorkMailException
  • Aws\WorkMailMessageFlow\Exception\WorkMailMessageFlowException
  • Aws\WorkSpaces\Exception\WorkSpacesException
  • Aws\WorkSpacesWeb\Exception\WorkSpacesWebException
  • Aws\XRay\Exception\XRayException

Functions

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

AWS Resilience Hub 2020-04-30

Client: Aws\ResilienceHub\ResilienceHubClient
Service ID: resiliencehub
Version: 2020-04-30

This page describes the parameters and results for the operations of the AWS Resilience Hub (2020-04-30), and shows how to use the Aws\ResilienceHub\ResilienceHubClient object to call the described operations. This documentation is specific to the 2020-04-30 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 */).

  • AddDraftAppVersionResourceMappings ( array $params = [] )

    Adds the resource mapping for the draft application version.

  • CreateApp ( array $params = [] )

    Creates a Resilience Hub application.

  • CreateRecommendationTemplate ( array $params = [] )

    Creates a new recommendation template.

  • CreateResiliencyPolicy ( array $params = [] )

    Creates a resiliency policy for an application.

  • DeleteApp ( array $params = [] )

    Deletes an AWS Resilience Hub application.

  • DeleteAppAssessment ( array $params = [] )

    Deletes an AWS Resilience Hub application assessment.

  • DeleteRecommendationTemplate ( array $params = [] )

    Deletes a recommendation template.

  • DeleteResiliencyPolicy ( array $params = [] )

    Deletes a resiliency policy.

  • DescribeApp ( array $params = [] )

    Describes an AWS Resilience Hub application.

  • DescribeAppAssessment ( array $params = [] )

    Describes an assessment for an AWS Resilience Hub application.

  • DescribeAppVersionResourcesResolutionStatus ( array $params = [] )

    Returns the resolution status for the specified resolution identifier for an application version.

  • DescribeAppVersionTemplate ( array $params = [] )

    Describes details about an AWS Resilience Hub

  • DescribeDraftAppVersionResourcesImportStatus ( array $params = [] )

    Describes the status of importing resources to an application version.

  • DescribeResiliencyPolicy ( array $params = [] )

    Describes a specified resiliency policy for an AWS Resilience Hub application.

  • ImportResourcesToDraftAppVersion ( array $params = [] )

    Imports resources from sources such as a CloudFormation stack, resource-groups, or application registry app to a draft application version.

  • ListAlarmRecommendations ( array $params = [] )

    Lists the alarm recommendations for a AWS Resilience Hub application.

  • ListAppAssessments ( array $params = [] )

    Lists the assessments for an AWS Resilience Hub application.

  • ListAppComponentCompliances ( array $params = [] )

    Lists the compliances for an AWS Resilience Hub component.

  • ListAppComponentRecommendations ( array $params = [] )

    Lists the recommendations for an AWS Resilience Hub component.

  • ListAppVersionResourceMappings ( array $params = [] )

    Lists how the resources in an application version are mapped/sourced from.

  • ListAppVersionResources ( array $params = [] )

    Lists all the resources in an application version.

  • ListAppVersions ( array $params = [] )

    Lists the different versions for the Resilience Hub applications.

  • ListApps ( array $params = [] )

    Lists your Resilience Hub applications.

  • ListRecommendationTemplates ( array $params = [] )

    Lists the recommendation templates for the Resilience Hub applications.

  • ListResiliencyPolicies ( array $params = [] )

    Lists the resiliency policies for the Resilience Hub applications.

  • ListSopRecommendations ( array $params = [] )

    Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.

  • ListSuggestedResiliencyPolicies ( array $params = [] )

    Lists the suggested resiliency policies for the Resilience Hub applications.

  • ListTagsForResource ( array $params = [] )

    Lists the tags for your resources in your Resilience Hub applications.

  • ListTestRecommendations ( array $params = [] )

    Lists the test recommendations for the Resilience Hub application.

  • ListUnsupportedAppVersionResources ( array $params = [] )

    Lists the resources that are not currently supported in AWS Resilience Hub.

  • PublishAppVersion ( array $params = [] )

    Publishes a new version of a specific Resilience Hub application.

  • PutDraftAppVersionTemplate ( array $params = [] )

    Adds or updates the app template for a draft version of a Resilience Hub app.

  • RemoveDraftAppVersionResourceMappings ( array $params = [] )

    Removes resource mappings from a draft application version.

  • ResolveAppVersionResources ( array $params = [] )

    Resolves the resources for an application version.

  • StartAppAssessment ( array $params = [] )

    Creates a new application assessment for an application.

  • TagResource ( array $params = [] )

    Applies one or more tags to a resource.

  • UntagResource ( array $params = [] )

    Removes one or more tags from a resource.

  • UpdateApp ( array $params = [] )

    Updates an application.

  • UpdateResiliencyPolicy ( array $params = [] )

    Updates a resiliency policy.

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:

  • ListAlarmRecommendations
  • ListAppAssessments
  • ListAppComponentCompliances
  • ListAppComponentRecommendations
  • ListAppVersionResourceMappings
  • ListAppVersionResources
  • ListAppVersions
  • ListApps
  • ListRecommendationTemplates
  • ListResiliencyPolicies
  • ListSopRecommendations
  • ListSuggestedResiliencyPolicies
  • ListTestRecommendations
  • ListUnsupportedAppVersionResources

Operations

AddDraftAppVersionResourceMappings

$result = $client->addDraftAppVersionResourceMappings([/* ... */]);
$promise = $client->addDraftAppVersionResourceMappingsAsync([/* ... */]);

Adds the resource mapping for the draft application version.

Parameter Syntax

$result = $client->addDraftAppVersionResourceMappings([
    'appArn' => '<string>', // REQUIRED
    'resourceMappings' => [ // REQUIRED
        [
            'appRegistryAppName' => '<string>',
            'logicalStackName' => '<string>',
            'mappingType' => 'CfnStack|Resource|AppRegistryApp|ResourceGroup|Terraform', // REQUIRED
            'physicalResourceId' => [ // REQUIRED
                'awsAccountId' => '<string>',
                'awsRegion' => '<string>',
                'identifier' => '<string>', // REQUIRED
                'type' => 'Arn|Native', // REQUIRED
            ],
            'resourceGroupName' => '<string>',
            'resourceName' => '<string>',
            'terraformSourceName' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

resourceMappings
  • Required: Yes
  • Type: Array of ResourceMapping structures

Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'resourceMappings' => [
        [
            'appRegistryAppName' => '<string>',
            'logicalStackName' => '<string>',
            'mappingType' => 'CfnStack|Resource|AppRegistryApp|ResourceGroup|Terraform',
            'physicalResourceId' => [
                'awsAccountId' => '<string>',
                'awsRegion' => '<string>',
                'identifier' => '<string>',
                'type' => 'Arn|Native',
            ],
            'resourceGroupName' => '<string>',
            'resourceName' => '<string>',
            'terraformSourceName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

resourceMappings
  • Required: Yes
  • Type: Array of ResourceMapping structures

Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

CreateApp

$result = $client->createApp([/* ... */]);
$promise = $client->createAppAsync([/* ... */]);

Creates a Resilience Hub application. A Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more–up to five–CloudFormation stacks, and an appropriate resiliency policy.

After you create a Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).

Parameter Syntax

$result = $client->createApp([
    'assessmentSchedule' => 'Disabled|Daily',
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'policyArn' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
assessmentSchedule
  • Type: string

Assessment execution schedule with 'Daily' or 'Disabled' values.

clientToken
  • Type: string

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

description
  • Type: string

The optional description for an app.

name
  • Required: Yes
  • Type: string

The name for the application.

policyArn
  • Type: string

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

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

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

Result Syntax

[
    'app' => [
        'appArn' => '<string>',
        'assessmentSchedule' => 'Disabled|Daily',
        'complianceStatus' => 'PolicyBreached|PolicyMet|NotAssessed|ChangesDetected',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'lastAppComplianceEvaluationTime' => <DateTime>,
        'lastResiliencyScoreEvaluationTime' => <DateTime>,
        'name' => '<string>',
        'policyArn' => '<string>',
        'resiliencyScore' => <float>,
        'status' => 'Active|Deleting',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
app
  • Required: Yes
  • Type: App structure

The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ServiceQuotaExceededException:

    You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

CreateRecommendationTemplate

$result = $client->createRecommendationTemplate([/* ... */]);
$promise = $client->createRecommendationTemplateAsync([/* ... */]);

Creates a new recommendation template.

Parameter Syntax

$result = $client->createRecommendationTemplate([
    'assessmentArn' => '<string>', // REQUIRED
    'bucketName' => '<string>',
    'clientToken' => '<string>',
    'format' => 'CfnYaml|CfnJson',
    'name' => '<string>', // REQUIRED
    'recommendationIds' => ['<string>', ...],
    'recommendationTypes' => ['<string>', ...],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

bucketName
  • Type: string

The name of the Amazon S3 bucket that will contain the recommendation template.

clientToken
  • Type: string

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

format
  • Type: string

The format for the recommendation template.

CfnJson

The template is CloudFormation JSON.

CfnYaml

The template is CloudFormation YAML.

name
  • Required: Yes
  • Type: string

The name for the recommendation template.

recommendationIds
  • Type: Array of strings

Identifiers for the recommendations used to create a recommendation template.

recommendationTypes
  • Type: Array of strings

An array of strings that specify the recommendation template type or types.

Alarm

The template is an AlarmRecommendation template.

Sop

The template is a SopRecommendation template.

Test

The template is a TestRecommendation template.

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

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

Result Syntax

[
    'recommendationTemplate' => [
        'appArn' => '<string>',
        'assessmentArn' => '<string>',
        'endTime' => <DateTime>,
        'format' => 'CfnYaml|CfnJson',
        'message' => '<string>',
        'name' => '<string>',
        'needsReplacements' => true || false,
        'recommendationIds' => ['<string>', ...],
        'recommendationTemplateArn' => '<string>',
        'recommendationTypes' => ['<string>', ...],
        'startTime' => <DateTime>,
        'status' => 'Pending|InProgress|Failed|Success',
        'tags' => ['<string>', ...],
        'templatesLocation' => [
            'bucket' => '<string>',
            'prefix' => '<string>',
        ],
    ],
]

Result Details

Members
recommendationTemplate
  • Type: RecommendationTemplate structure

The newly created recommendation template, returned as an object. This object includes the template's name, format, status, tags, Amazon S3 bucket location, and more.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

CreateResiliencyPolicy

$result = $client->createResiliencyPolicy([/* ... */]);
$promise = $client->createResiliencyPolicyAsync([/* ... */]);

Creates a resiliency policy for an application.

Parameter Syntax

$result = $client->createResiliencyPolicy([
    'clientToken' => '<string>',
    'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
    'policy' => [ // REQUIRED
        '<DisruptionType>' => [
            'rpoInSecs' => <integer>, // REQUIRED
            'rtoInSecs' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'policyDescription' => '<string>',
    'policyName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical', // REQUIRED
]);

Parameter Details

Members
clientToken
  • Type: string

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

dataLocationConstraint
  • Type: string

Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

policy
  • Required: Yes
  • Type: Associative array of custom strings keys (DisruptionType) to FailurePolicy structures

The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

policyDescription
  • Type: string

The description for the policy.

policyName
  • Required: Yes
  • Type: string

The name of the policy

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

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

tier
  • Required: Yes
  • Type: string

The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

Result Syntax

[
    'policy' => [
        'creationTime' => <DateTime>,
        'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
        'estimatedCostTier' => 'L1|L2|L3|L4',
        'policy' => [
            '<DisruptionType>' => [
                'rpoInSecs' => <integer>,
                'rtoInSecs' => <integer>,
            ],
            // ...
        ],
        'policyArn' => '<string>',
        'policyDescription' => '<string>',
        'policyName' => '<string>',
        'tags' => ['<string>', ...],
        'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical',
    ],
]

Result Details

Members
policy
  • Required: Yes
  • Type: ResiliencyPolicy structure

The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ServiceQuotaExceededException:

    You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

DeleteApp

$result = $client->deleteApp([/* ... */]);
$promise = $client->deleteAppAsync([/* ... */]);

Deletes an AWS Resilience Hub application. This is a destructive action that can't be undone.

Parameter Syntax

$result = $client->deleteApp([
    'appArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'forceDelete' => true || false,
]);

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

clientToken
  • Type: string

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

forceDelete
  • Type: boolean

A boolean option to force the deletion of a Resilience Hub application.

Result Syntax

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

Result Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

DeleteAppAssessment

$result = $client->deleteAppAssessment([/* ... */]);
$promise = $client->deleteAppAssessmentAsync([/* ... */]);

Deletes an AWS Resilience Hub application assessment. This is a destructive action that can't be undone.

Parameter Syntax

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

Parameter Details

Members
assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

clientToken
  • Type: string

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

Result Syntax

[
    'assessmentArn' => '<string>',
    'assessmentStatus' => 'Pending|InProgress|Failed|Success',
]

Result Details

Members
assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

assessmentStatus
  • Required: Yes
  • Type: string

The current status of the assessment for the resiliency policy.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

DeleteRecommendationTemplate

$result = $client->deleteRecommendationTemplate([/* ... */]);
$promise = $client->deleteRecommendationTemplateAsync([/* ... */]);

Deletes a recommendation template. This is a destructive action that can't be undone.

Parameter Syntax

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

Parameter Details

Members
clientToken
  • Type: string

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

recommendationTemplateArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) for a recommendation template.

Result Syntax

[
    'recommendationTemplateArn' => '<string>',
    'status' => 'Pending|InProgress|Failed|Success',
]

Result Details

Members
recommendationTemplateArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) for a recommendation template.

status
  • Required: Yes
  • Type: string

The status of the action.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

DeleteResiliencyPolicy

$result = $client->deleteResiliencyPolicy([/* ... */]);
$promise = $client->deleteResiliencyPolicyAsync([/* ... */]);

Deletes a resiliency policy. This is a destructive action that can't be undone.

Parameter Syntax

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

Parameter Details

Members
clientToken
  • Type: string

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

policyArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Result Syntax

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

Result Details

Members
policyArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

DescribeApp

$result = $client->describeApp([/* ... */]);
$promise = $client->describeAppAsync([/* ... */]);

Describes an AWS Resilience Hub application.

Parameter Syntax

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

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Result Syntax

[
    'app' => [
        'appArn' => '<string>',
        'assessmentSchedule' => 'Disabled|Daily',
        'complianceStatus' => 'PolicyBreached|PolicyMet|NotAssessed|ChangesDetected',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'lastAppComplianceEvaluationTime' => <DateTime>,
        'lastResiliencyScoreEvaluationTime' => <DateTime>,
        'name' => '<string>',
        'policyArn' => '<string>',
        'resiliencyScore' => <float>,
        'status' => 'Active|Deleting',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
app
  • Required: Yes
  • Type: App structure

The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

DescribeAppAssessment

$result = $client->describeAppAssessment([/* ... */]);
$promise = $client->describeAppAssessmentAsync([/* ... */]);

Describes an assessment for an AWS Resilience Hub application.

Parameter Syntax

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

Parameter Details

Members
assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Result Syntax

[
    'assessment' => [
        'appArn' => '<string>',
        'appVersion' => '<string>',
        'assessmentArn' => '<string>',
        'assessmentName' => '<string>',
        'assessmentStatus' => 'Pending|InProgress|Failed|Success',
        'compliance' => [
            '<DisruptionType>' => [
                'achievableRpoInSecs' => <integer>,
                'achievableRtoInSecs' => <integer>,
                'complianceStatus' => 'PolicyBreached|PolicyMet',
                'currentRpoInSecs' => <integer>,
                'currentRtoInSecs' => <integer>,
                'message' => '<string>',
                'rpoDescription' => '<string>',
                'rpoReferenceId' => '<string>',
                'rtoDescription' => '<string>',
                'rtoReferenceId' => '<string>',
            ],
            // ...
        ],
        'complianceStatus' => 'PolicyBreached|PolicyMet',
        'cost' => [
            'amount' => <float>,
            'currency' => '<string>',
            'frequency' => 'Hourly|Daily|Monthly|Yearly',
        ],
        'endTime' => <DateTime>,
        'invoker' => 'User|System',
        'message' => '<string>',
        'policy' => [
            'creationTime' => <DateTime>,
            'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
            'estimatedCostTier' => 'L1|L2|L3|L4',
            'policy' => [
                '<DisruptionType>' => [
                    'rpoInSecs' => <integer>,
                    'rtoInSecs' => <integer>,
                ],
                // ...
            ],
            'policyArn' => '<string>',
            'policyDescription' => '<string>',
            'policyName' => '<string>',
            'tags' => ['<string>', ...],
            'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical',
        ],
        'resiliencyScore' => [
            'disruptionScore' => [<float>, ...],
            'score' => <float>,
        ],
        'resourceErrorsDetails' => [
            'hasMoreErrors' => true || false,
            'resourceErrors' => [
                [
                    'logicalResourceId' => '<string>',
                    'physicalResourceId' => '<string>',
                    'reason' => '<string>',
                ],
                // ...
            ],
        ],
        'startTime' => <DateTime>,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
assessment
  • Required: Yes
  • Type: AppAssessment structure

The assessment for an AWS Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

DescribeAppVersionResourcesResolutionStatus

$result = $client->describeAppVersionResourcesResolutionStatus([/* ... */]);
$promise = $client->describeAppVersionResourcesResolutionStatusAsync([/* ... */]);

Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.

Parameter Syntax

$result = $client->describeAppVersionResourcesResolutionStatus([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
    'resolutionId' => '<string>',
]);

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

resolutionId
  • Type: string

The identifier for a specific resolution.

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'errorMessage' => '<string>',
    'resolutionId' => '<string>',
    'status' => 'Pending|InProgress|Failed|Success',
]

Result Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

errorMessage
  • Type: string

The returned error message for the request.

resolutionId
  • Required: Yes
  • Type: string

The identifier for a specific resolution.

status
  • Required: Yes
  • Type: string

The status of the action.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

DescribeAppVersionTemplate

$result = $client->describeAppVersionTemplate([/* ... */]);
$promise = $client->describeAppVersionTemplateAsync([/* ... */]);

Describes details about an AWS Resilience Hub

Parameter Syntax

$result = $client->describeAppVersionTemplate([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

Result Syntax

[
    'appArn' => '<string>',
    'appTemplateBody' => '<string>',
    'appVersion' => '<string>',
]

Result Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appTemplateBody
  • Required: Yes
  • Type: string

The body of the template.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

DescribeDraftAppVersionResourcesImportStatus

$result = $client->describeDraftAppVersionResourcesImportStatus([/* ... */]);
$promise = $client->describeDraftAppVersionResourcesImportStatusAsync([/* ... */]);

Describes the status of importing resources to an application version.

Parameter Syntax

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

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'errorMessage' => '<string>',
    'status' => 'Pending|InProgress|Failed|Success',
    'statusChangeTime' => <DateTime>,
]

Result Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

errorMessage
  • Type: string

The returned error message for the request.

status
  • Required: Yes
  • Type: string

The status of the action.

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

The timestamp for when the status last changed.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

DescribeResiliencyPolicy

$result = $client->describeResiliencyPolicy([/* ... */]);
$promise = $client->describeResiliencyPolicyAsync([/* ... */]);

Describes a specified resiliency policy for an AWS Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.

Parameter Syntax

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

Parameter Details

Members
policyArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Result Syntax

[
    'policy' => [
        'creationTime' => <DateTime>,
        'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
        'estimatedCostTier' => 'L1|L2|L3|L4',
        'policy' => [
            '<DisruptionType>' => [
                'rpoInSecs' => <integer>,
                'rtoInSecs' => <integer>,
            ],
            // ...
        ],
        'policyArn' => '<string>',
        'policyDescription' => '<string>',
        'policyName' => '<string>',
        'tags' => ['<string>', ...],
        'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical',
    ],
]

Result Details

Members
policy
  • Required: Yes
  • Type: ResiliencyPolicy structure

Information about the specific resiliency policy, returned as an object. This object includes creation time, data location constraints, its name, description, tags, the recovery time objective (RTO) and recovery point objective (RPO) in seconds, and more.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ImportResourcesToDraftAppVersion

$result = $client->importResourcesToDraftAppVersion([/* ... */]);
$promise = $client->importResourcesToDraftAppVersionAsync([/* ... */]);

Imports resources from sources such as a CloudFormation stack, resource-groups, or application registry app to a draft application version.

Parameter Syntax

$result = $client->importResourcesToDraftAppVersion([
    'appArn' => '<string>', // REQUIRED
    'sourceArns' => ['<string>', ...],
    'terraformSources' => [
        [
            's3StateFileUrl' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

sourceArns
  • Type: Array of strings

The Amazon Resource Names (ARNs) for the resources that you want to import.

terraformSources
  • Type: Array of TerraformSource structures

A list of terraform file s3 URLs you need to import.

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'sourceArns' => ['<string>', ...],
    'status' => 'Pending|InProgress|Failed|Success',
    'terraformSources' => [
        [
            's3StateFileUrl' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

sourceArns
  • Type: Array of strings

The Amazon Resource Names (ARNs) for the resources that you imported.

status
  • Required: Yes
  • Type: string

The status of the action.

terraformSources
  • Type: Array of TerraformSource structures

A list of terraform file s3 URLs you need to import.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListAlarmRecommendations

$result = $client->listAlarmRecommendations([/* ... */]);
$promise = $client->listAlarmRecommendationsAsync([/* ... */]);

Lists the alarm recommendations for a AWS Resilience Hub application.

Parameter Syntax

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

Parameter Details

Members
assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

Result Syntax

[
    'alarmRecommendations' => [
        [
            'appComponentName' => '<string>',
            'description' => '<string>',
            'items' => [
                [
                    'alreadyImplemented' => true || false,
                    'resourceId' => '<string>',
                    'targetAccountId' => '<string>',
                    'targetRegion' => '<string>',
                ],
                // ...
            ],
            'name' => '<string>',
            'prerequisite' => '<string>',
            'recommendationId' => '<string>',
            'referenceId' => '<string>',
            'type' => 'Metric|Composite|Canary|Logs|Event',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
alarmRecommendations
  • Required: Yes
  • Type: Array of AlarmRecommendation structures

The alarm recommendations for an AWS Resilience Hub application, returned as an object. This object includes application component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.

nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListAppAssessments

$result = $client->listAppAssessments([/* ... */]);
$promise = $client->listAppAssessmentsAsync([/* ... */]);

Lists the assessments for an AWS Resilience Hub application. You can use request parameters to refine the results for the response object.

Parameter Syntax

$result = $client->listAppAssessments([
    'appArn' => '<string>',
    'assessmentName' => '<string>',
    'assessmentStatus' => ['<string>', ...],
    'complianceStatus' => 'PolicyBreached|PolicyMet',
    'invoker' => 'User|System',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'reverseOrder' => true || false,
]);

Parameter Details

Members
appArn
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

assessmentName
  • Type: string

The name for the assessment.

assessmentStatus
  • Type: Array of strings

The current status of the assessment for the resiliency policy.

complianceStatus
  • Type: string

The current status of compliance for the resiliency policy.

invoker
  • Type: string

Specifies the entity that invoked a specific assessment, either a User or the System.

maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

reverseOrder
  • Type: boolean

The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

Result Syntax

[
    'assessmentSummaries' => [
        [
            'appArn' => '<string>',
            'appVersion' => '<string>',
            'assessmentArn' => '<string>',
            'assessmentName' => '<string>',
            'assessmentStatus' => 'Pending|InProgress|Failed|Success',
            'complianceStatus' => 'PolicyBreached|PolicyMet',
            'cost' => [
                'amount' => <float>,
                'currency' => '<string>',
                'frequency' => 'Hourly|Daily|Monthly|Yearly',
            ],
            'endTime' => <DateTime>,
            'invoker' => 'User|System',
            'message' => '<string>',
            'resiliencyScore' => <float>,
            'startTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
assessmentSummaries
  • Required: Yes
  • Type: Array of AppAssessmentSummary structures

The summaries for the specified assessments, returned as an object. This object includes application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.

nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListAppComponentCompliances

$result = $client->listAppComponentCompliances([/* ... */]);
$promise = $client->listAppComponentCompliancesAsync([/* ... */]);

Lists the compliances for an AWS Resilience Hub component.

Parameter Syntax

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

Parameter Details

Members
assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

Result Syntax

[
    'componentCompliances' => [
        [
            'appComponentName' => '<string>',
            'compliance' => [
                '<DisruptionType>' => [
                    'achievableRpoInSecs' => <integer>,
                    'achievableRtoInSecs' => <integer>,
                    'complianceStatus' => 'PolicyBreached|PolicyMet',
                    'currentRpoInSecs' => <integer>,
                    'currentRtoInSecs' => <integer>,
                    'message' => '<string>',
                    'rpoDescription' => '<string>',
                    'rpoReferenceId' => '<string>',
                    'rtoDescription' => '<string>',
                    'rtoReferenceId' => '<string>',
                ],
                // ...
            ],
            'cost' => [
                'amount' => <float>,
                'currency' => '<string>',
                'frequency' => 'Hourly|Daily|Monthly|Yearly',
            ],
            'message' => '<string>',
            'resiliencyScore' => [
                'disruptionScore' => [<float>, ...],
                'score' => <float>,
            ],
            'status' => 'PolicyBreached|PolicyMet',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
componentCompliances
  • Required: Yes
  • Type: Array of AppComponentCompliance structures

The compliances for an AWS Resilience Hub application component, returned as an object. This object contains component names, compliances, costs, resiliency scores, outage scores, and more.

nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListAppComponentRecommendations

$result = $client->listAppComponentRecommendations([/* ... */]);
$promise = $client->listAppComponentRecommendationsAsync([/* ... */]);

Lists the recommendations for an AWS Resilience Hub component.

Parameter Syntax

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

Parameter Details

Members
assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

Result Syntax

[
    'componentRecommendations' => [
        [
            'appComponentName' => '<string>',
            'configRecommendations' => [
                [
                    'appComponentName' => '<string>',
                    'compliance' => [
                        '<DisruptionType>' => [
                            'achievableRpoInSecs' => <integer>,
                            'achievableRtoInSecs' => <integer>,
                            'complianceStatus' => 'PolicyBreached|PolicyMet',
                            'currentRpoInSecs' => <integer>,
                            'currentRtoInSecs' => <integer>,
                            'message' => '<string>',
                            'rpoDescription' => '<string>',
                            'rpoReferenceId' => '<string>',
                            'rtoDescription' => '<string>',
                            'rtoReferenceId' => '<string>',
                        ],
                        // ...
                    ],
                    'cost' => [
                        'amount' => <float>,
                        'currency' => '<string>',
                        'frequency' => 'Hourly|Daily|Monthly|Yearly',
                    ],
                    'description' => '<string>',
                    'haArchitecture' => 'MultiSite|WarmStandby|PilotLight|BackupAndRestore|NoRecoveryPlan',
                    'name' => '<string>',
                    'optimizationType' => 'LeastCost|LeastChange|BestAZRecovery|LeastErrors|BestAttainable|BestRegionRecovery',
                    'recommendationCompliance' => [
                        '<DisruptionType>' => [
                            'expectedComplianceStatus' => 'PolicyBreached|PolicyMet',
                            'expectedRpoDescription' => '<string>',
                            'expectedRpoInSecs' => <integer>,
                            'expectedRtoDescription' => '<string>',
                            'expectedRtoInSecs' => <integer>,
                        ],
                        // ...
                    ],
                    'referenceId' => '<string>',
                    'suggestedChanges' => ['<string>', ...],
                ],
                // ...
            ],
            'recommendationStatus' => 'BreachedUnattainable|BreachedCanMeet|MetCanImprove',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
componentRecommendations
  • Required: Yes
  • Type: Array of ComponentRecommendation structures

The recommendations for an Resilience Hub application component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.

nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListAppVersionResourceMappings

$result = $client->listAppVersionResourceMappings([/* ... */]);
$promise = $client->listAppVersionResourceMappingsAsync([/* ... */]);

Lists how the resources in an application version are mapped/sourced from. Mappings can be physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry app.

Parameter Syntax

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

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

Result Syntax

[
    'nextToken' => '<string>',
    'resourceMappings' => [
        [
            'appRegistryAppName' => '<string>',
            'logicalStackName' => '<string>',
            'mappingType' => 'CfnStack|Resource|AppRegistryApp|ResourceGroup|Terraform',
            'physicalResourceId' => [
                'awsAccountId' => '<string>',
                'awsRegion' => '<string>',
                'identifier' => '<string>',
                'type' => 'Arn|Native',
            ],
            'resourceGroupName' => '<string>',
            'resourceName' => '<string>',
            'terraformSourceName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

resourceMappings
  • Required: Yes
  • Type: Array of ResourceMapping structures

Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListAppVersionResources

$result = $client->listAppVersionResources([/* ... */]);
$promise = $client->listAppVersionResourcesAsync([/* ... */]);

Lists all the resources in an application version.

Parameter Syntax

$result = $client->listAppVersionResources([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resolutionId' => '<string>',
]);

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

resolutionId
  • Type: string

The identifier for a specific resolution.

Result Syntax

[
    'nextToken' => '<string>',
    'physicalResources' => [
        [
            'appComponents' => [
                [
                    'name' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
            'logicalResourceId' => [
                'identifier' => '<string>',
                'logicalStackName' => '<string>',
                'resourceGroupName' => '<string>',
                'terraformSourceName' => '<string>',
            ],
            'physicalResourceId' => [
                'awsAccountId' => '<string>',
                'awsRegion' => '<string>',
                'identifier' => '<string>',
                'type' => 'Arn|Native',
            ],
            'resourceName' => '<string>',
            'resourceType' => '<string>',
        ],
        // ...
    ],
    'resolutionId' => '<string>',
]

Result Details

Members
nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

physicalResources
  • Required: Yes
  • Type: Array of PhysicalResource structures

The physical resources in the application version.

resolutionId
  • Required: Yes
  • Type: string

The identifier for a specific resolution.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListAppVersions

$result = $client->listAppVersions([/* ... */]);
$promise = $client->listAppVersionsAsync([/* ... */]);

Lists the different versions for the Resilience Hub applications.

Parameter Syntax

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

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

Result Syntax

[
    'appVersions' => [
        [
            'appVersion' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
appVersions
  • Required: Yes
  • Type: Array of AppVersionSummary structures

The version of the application.

nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListApps

$result = $client->listApps([/* ... */]);
$promise = $client->listAppsAsync([/* ... */]);

Lists your Resilience Hub applications.

Parameter Syntax

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

Parameter Details

Members
appArn
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

name
  • Type: string

The name for the one of the listed applications.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

Result Syntax

[
    'appSummaries' => [
        [
            'appArn' => '<string>',
            'assessmentSchedule' => 'Disabled|Daily',
            'complianceStatus' => 'PolicyBreached|PolicyMet|NotAssessed|ChangesDetected',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'name' => '<string>',
            'resiliencyScore' => <float>,
            'status' => 'Active|Deleting',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
appSummaries
  • Required: Yes
  • Type: Array of AppSummary structures

Summaries for the Resilience Hub application.

nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListRecommendationTemplates

$result = $client->listRecommendationTemplates([/* ... */]);
$promise = $client->listRecommendationTemplatesAsync([/* ... */]);

Lists the recommendation templates for the Resilience Hub applications.

Parameter Syntax

$result = $client->listRecommendationTemplates([
    'assessmentArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
    'recommendationTemplateArn' => '<string>',
    'reverseOrder' => true || false,
    'status' => ['<string>', ...],
]);

Parameter Details

Members
assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

name
  • Type: string

The name for one of the listed recommendation templates.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

recommendationTemplateArn
  • Type: string

The Amazon Resource Name (ARN) for a recommendation template.

reverseOrder
  • Type: boolean

The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

status
  • Type: Array of strings

The status of the action.

Result Syntax

[
    'nextToken' => '<string>',
    'recommendationTemplates' => [
        [
            'appArn' => '<string>',
            'assessmentArn' => '<string>',
            'endTime' => <DateTime>,
            'format' => 'CfnYaml|CfnJson',
            'message' => '<string>',
            'name' => '<string>',
            'needsReplacements' => true || false,
            'recommendationIds' => ['<string>', ...],
            'recommendationTemplateArn' => '<string>',
            'recommendationTypes' => ['<string>', ...],
            'startTime' => <DateTime>,
            'status' => 'Pending|InProgress|Failed|Success',
            'tags' => ['<string>', ...],
            'templatesLocation' => [
                'bucket' => '<string>',
                'prefix' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

recommendationTemplates
  • Type: Array of RecommendationTemplate structures

The recommendation templates for the Resilience Hub applications.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListResiliencyPolicies

$result = $client->listResiliencyPolicies([/* ... */]);
$promise = $client->listResiliencyPoliciesAsync([/* ... */]);

Lists the resiliency policies for the Resilience Hub applications.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

policyName
  • Type: string

The name of the policy

Result Syntax

[
    'nextToken' => '<string>',
    'resiliencyPolicies' => [
        [
            'creationTime' => <DateTime>,
            'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
            'estimatedCostTier' => 'L1|L2|L3|L4',
            'policy' => [
                '<DisruptionType>' => [
                    'rpoInSecs' => <integer>,
                    'rtoInSecs' => <integer>,
                ],
                // ...
            ],
            'policyArn' => '<string>',
            'policyDescription' => '<string>',
            'policyName' => '<string>',
            'tags' => ['<string>', ...],
            'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

resiliencyPolicies
  • Required: Yes
  • Type: Array of ResiliencyPolicy structures

The resiliency policies for the Resilience Hub applications.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListSopRecommendations

$result = $client->listSopRecommendations([/* ... */]);
$promise = $client->listSopRecommendationsAsync([/* ... */]);

Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.

Parameter Syntax

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

Parameter Details

Members
assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

Result Syntax

[
    'nextToken' => '<string>',
    'sopRecommendations' => [
        [
            'appComponentName' => '<string>',
            'description' => '<string>',
            'items' => [
                [
                    'alreadyImplemented' => true || false,
                    'resourceId' => '<string>',
                    'targetAccountId' => '<string>',
                    'targetRegion' => '<string>',
                ],
                // ...
            ],
            'name' => '<string>',
            'prerequisite' => '<string>',
            'recommendationId' => '<string>',
            'referenceId' => '<string>',
            'serviceType' => 'SSM',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

sopRecommendations
  • Required: Yes
  • Type: Array of SopRecommendation structures

The standard operating procedure (SOP) recommendations for the Resilience Hub applications.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListSuggestedResiliencyPolicies

$result = $client->listSuggestedResiliencyPolicies([/* ... */]);
$promise = $client->listSuggestedResiliencyPoliciesAsync([/* ... */]);

Lists the suggested resiliency policies for the Resilience Hub applications.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

Result Syntax

[
    'nextToken' => '<string>',
    'resiliencyPolicies' => [
        [
            'creationTime' => <DateTime>,
            'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
            'estimatedCostTier' => 'L1|L2|L3|L4',
            'policy' => [
                '<DisruptionType>' => [
                    'rpoInSecs' => <integer>,
                    'rtoInSecs' => <integer>,
                ],
                // ...
            ],
            'policyArn' => '<string>',
            'policyDescription' => '<string>',
            'policyName' => '<string>',
            'tags' => ['<string>', ...],
            'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

resiliencyPolicies
  • Required: Yes
  • Type: Array of ResiliencyPolicy structures

The suggested resiliency policies for the Resilience Hub applications.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListTagsForResource

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

Lists the tags for your resources in your Resilience Hub applications.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub application.

Result Syntax

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

Result Details

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

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListTestRecommendations

$result = $client->listTestRecommendations([/* ... */]);
$promise = $client->listTestRecommendationsAsync([/* ... */]);

Lists the test recommendations for the Resilience Hub application.

Parameter Syntax

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

Parameter Details

Members
assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

Result Syntax

[
    'nextToken' => '<string>',
    'testRecommendations' => [
        [
            'appComponentName' => '<string>',
            'dependsOnAlarms' => ['<string>', ...],
            'description' => '<string>',
            'intent' => '<string>',
            'items' => [
                [
                    'alreadyImplemented' => true || false,
                    'resourceId' => '<string>',
                    'targetAccountId' => '<string>',
                    'targetRegion' => '<string>',
                ],
                // ...
            ],
            'name' => '<string>',
            'prerequisite' => '<string>',
            'recommendationId' => '<string>',
            'referenceId' => '<string>',
            'risk' => 'Small|Medium|High',
            'type' => 'Software|Hardware|AZ|Region',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

testRecommendations
  • Required: Yes
  • Type: Array of TestRecommendation structures

The test recommendations for the Resilience Hub application.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ListUnsupportedAppVersionResources

$result = $client->listUnsupportedAppVersionResources([/* ... */]);
$promise = $client->listUnsupportedAppVersionResourcesAsync([/* ... */]);

Lists the resources that are not currently supported in AWS Resilience Hub. An unsupported resource is a resource that exists in the object that was used to create an app, but is not supported by Resilience Hub.

Parameter Syntax

$result = $client->listUnsupportedAppVersionResources([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resolutionId' => '<string>',
]);

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

maxResults
  • Type: int

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken
  • Type: string

Null, or the token from a previous call to get the next set of results.

resolutionId
  • Type: string

The identifier for a specific resolution.

Result Syntax

[
    'nextToken' => '<string>',
    'resolutionId' => '<string>',
    'unsupportedResources' => [
        [
            'logicalResourceId' => [
                'identifier' => '<string>',
                'logicalStackName' => '<string>',
                'resourceGroupName' => '<string>',
                'terraformSourceName' => '<string>',
            ],
            'physicalResourceId' => [
                'awsAccountId' => '<string>',
                'awsRegion' => '<string>',
                'identifier' => '<string>',
                'type' => 'Arn|Native',
            ],
            'resourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The token for the next set of results, or null if there are no more results.

resolutionId
  • Required: Yes
  • Type: string

The identifier for a specific resolution.

unsupportedResources
  • Required: Yes
  • Type: Array of UnsupportedResource structures

The unsupported resources for the application.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

PublishAppVersion

$result = $client->publishAppVersion([/* ... */]);
$promise = $client->publishAppVersionAsync([/* ... */]);

Publishes a new version of a specific Resilience Hub application.

Parameter Syntax

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

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
]

Result Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Type: string

The version of the application.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

PutDraftAppVersionTemplate

$result = $client->putDraftAppVersionTemplate([/* ... */]);
$promise = $client->putDraftAppVersionTemplateAsync([/* ... */]);

Adds or updates the app template for a draft version of a Resilience Hub app.

Parameter Syntax

$result = $client->putDraftAppVersionTemplate([
    'appArn' => '<string>', // REQUIRED
    'appTemplateBody' => '<string>', // REQUIRED
]);

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appTemplateBody
  • Required: Yes
  • Type: string

A JSON string that contains the body of the app template.

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
]

Result Details

Members
appArn
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Type: string

The version of the application.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

RemoveDraftAppVersionResourceMappings

$result = $client->removeDraftAppVersionResourceMappings([/* ... */]);
$promise = $client->removeDraftAppVersionResourceMappingsAsync([/* ... */]);

Removes resource mappings from a draft application version.

Parameter Syntax

$result = $client->removeDraftAppVersionResourceMappings([
    'appArn' => '<string>', // REQUIRED
    'appRegistryAppNames' => ['<string>', ...],
    'logicalStackNames' => ['<string>', ...],
    'resourceGroupNames' => ['<string>', ...],
    'resourceNames' => ['<string>', ...],
    'terraformSourceNames' => ['<string>', ...],
]);

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appRegistryAppNames
  • Type: Array of strings

The names of the registered applications to remove from the resource mappings.

logicalStackNames
  • Type: Array of strings

The names of the CloudFormation stacks to remove from the resource mappings.

resourceGroupNames
  • Type: Array of strings

The names of the resource groups to remove from the resource mappings.

resourceNames
  • Type: Array of strings

The names of the resources to remove from the resource mappings.

terraformSourceNames
  • Type: Array of strings

</p> 

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
]

Result Details

Members
appArn
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Type: string

The version of the application.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

ResolveAppVersionResources

$result = $client->resolveAppVersionResources([/* ... */]);
$promise = $client->resolveAppVersionResourcesAsync([/* ... */]);

Resolves the resources for an application version.

Parameter Syntax

$result = $client->resolveAppVersionResources([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'resolutionId' => '<string>',
    'status' => 'Pending|InProgress|Failed|Success',
]

Result Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

resolutionId
  • Required: Yes
  • Type: string

The identifier for a specific resolution.

status
  • Required: Yes
  • Type: string

The status of the action.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

StartAppAssessment

$result = $client->startAppAssessment([/* ... */]);
$promise = $client->startAppAssessmentAsync([/* ... */]);

Creates a new application assessment for an application.

Parameter Syntax

$result = $client->startAppAssessment([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
    'assessmentName' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Required: Yes
  • Type: string

The version of the application.

assessmentName
  • Required: Yes
  • Type: string

The name for the assessment.

clientToken
  • Type: string

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

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

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

Result Syntax

[
    'assessment' => [
        'appArn' => '<string>',
        'appVersion' => '<string>',
        'assessmentArn' => '<string>',
        'assessmentName' => '<string>',
        'assessmentStatus' => 'Pending|InProgress|Failed|Success',
        'compliance' => [
            '<DisruptionType>' => [
                'achievableRpoInSecs' => <integer>,
                'achievableRtoInSecs' => <integer>,
                'complianceStatus' => 'PolicyBreached|PolicyMet',
                'currentRpoInSecs' => <integer>,
                'currentRtoInSecs' => <integer>,
                'message' => '<string>',
                'rpoDescription' => '<string>',
                'rpoReferenceId' => '<string>',
                'rtoDescription' => '<string>',
                'rtoReferenceId' => '<string>',
            ],
            // ...
        ],
        'complianceStatus' => 'PolicyBreached|PolicyMet',
        'cost' => [
            'amount' => <float>,
            'currency' => '<string>',
            'frequency' => 'Hourly|Daily|Monthly|Yearly',
        ],
        'endTime' => <DateTime>,
        'invoker' => 'User|System',
        'message' => '<string>',
        'policy' => [
            'creationTime' => <DateTime>,
            'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
            'estimatedCostTier' => 'L1|L2|L3|L4',
            'policy' => [
                '<DisruptionType>' => [
                    'rpoInSecs' => <integer>,
                    'rtoInSecs' => <integer>,
                ],
                // ...
            ],
            'policyArn' => '<string>',
            'policyDescription' => '<string>',
            'policyName' => '<string>',
            'tags' => ['<string>', ...],
            'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical',
        ],
        'resiliencyScore' => [
            'disruptionScore' => [<float>, ...],
            'score' => <float>,
        ],
        'resourceErrorsDetails' => [
            'hasMoreErrors' => true || false,
            'resourceErrors' => [
                [
                    'logicalResourceId' => '<string>',
                    'physicalResourceId' => '<string>',
                    'reason' => '<string>',
                ],
                // ...
            ],
        ],
        'startTime' => <DateTime>,
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
assessment
  • Required: Yes
  • Type: AppAssessment structure

The assessment created.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ServiceQuotaExceededException:

    You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

TagResource

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

Applies one or more tags to a resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource.

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

The tags to assign to the resource. Each tag consists of a key/value pair.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

UntagResource

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

Removes one or more tags from a resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource.

tagKeys
  • Required: Yes
  • Type: Array of strings

The keys of the tags to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

UpdateApp

$result = $client->updateApp([/* ... */]);
$promise = $client->updateAppAsync([/* ... */]);

Updates an application.

Parameter Syntax

$result = $client->updateApp([
    'appArn' => '<string>', // REQUIRED
    'assessmentSchedule' => 'Disabled|Daily',
    'clearResiliencyPolicyArn' => true || false,
    'description' => '<string>',
    'policyArn' => '<string>',
]);

Parameter Details

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

assessmentSchedule
  • Type: string

Assessment execution schedule with 'Daily' or 'Disabled' values.

clearResiliencyPolicyArn
  • Type: boolean

Specifies if the resiliency policy ARN should be cleared.

description
  • Type: string

The optional description for an app.

policyArn
  • Type: string

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Result Syntax

[
    'app' => [
        'appArn' => '<string>',
        'assessmentSchedule' => 'Disabled|Daily',
        'complianceStatus' => 'PolicyBreached|PolicyMet|NotAssessed|ChangesDetected',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'lastAppComplianceEvaluationTime' => <DateTime>,
        'lastResiliencyScoreEvaluationTime' => <DateTime>,
        'name' => '<string>',
        'policyArn' => '<string>',
        'resiliencyScore' => <float>,
        'status' => 'Active|Deleting',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members
app
  • Required: Yes
  • Type: App structure

The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

UpdateResiliencyPolicy

$result = $client->updateResiliencyPolicy([/* ... */]);
$promise = $client->updateResiliencyPolicyAsync([/* ... */]);

Updates a resiliency policy.

Parameter Syntax

$result = $client->updateResiliencyPolicy([
    'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
    'policy' => [
        '<DisruptionType>' => [
            'rpoInSecs' => <integer>, // REQUIRED
            'rtoInSecs' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'policyArn' => '<string>', // REQUIRED
    'policyDescription' => '<string>',
    'policyName' => '<string>',
    'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical',
]);

Parameter Details

Members
dataLocationConstraint
  • Type: string

Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

policy
  • Type: Associative array of custom strings keys (DisruptionType) to FailurePolicy structures

The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

policyArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

policyDescription
  • Type: string

The description for the policy.

policyName
  • Type: string

The name of the policy

tier
  • Type: string

The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

Result Syntax

[
    'policy' => [
        'creationTime' => <DateTime>,
        'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
        'estimatedCostTier' => 'L1|L2|L3|L4',
        'policy' => [
            '<DisruptionType>' => [
                'rpoInSecs' => <integer>,
                'rtoInSecs' => <integer>,
            ],
            // ...
        ],
        'policyArn' => '<string>',
        'policyDescription' => '<string>',
        'policyName' => '<string>',
        'tags' => ['<string>', ...],
        'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical',
    ],
]

Result Details

Members
policy
  • Required: Yes
  • Type: ResiliencyPolicy structure

The type of resiliency policy that was updated, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

Errors

  • InternalServerException:

    This exception occurs when there is an internal failure in the AWS Resilience Hub service.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • ThrottlingException:

    The limit on the number of requests per second was exceeded.

  • ValidationException:

    Indicates that a request was not valid.

  • AccessDeniedException:

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

Shapes

AccessDeniedException

Description

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

Members
message
  • Type: string

AlarmRecommendation

Description

Defines a recommendation for a CloudWatch alarm.

Members
appComponentName
  • Type: string

The application component for the CloudWatch alarm recommendation.

description
  • Type: string

The description of the recommendation.

items
  • Type: Array of RecommendationItem structures

The list of CloudWatch alarm recommendations.

name
  • Required: Yes
  • Type: string

The name of the alarm recommendation.

prerequisite
  • Type: string

The prerequisite for the alarm recommendation.

recommendationId
  • Required: Yes
  • Type: string

The identifier of the alarm recommendation.

referenceId
  • Required: Yes
  • Type: string

The reference identifier of the alarm recommendation.

type
  • Required: Yes
  • Type: string

The type of alarm recommendation.

App

Description

Defines a Resilience Hub application.

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

assessmentSchedule
  • Type: string

Assessment execution schedule with 'Daily' or 'Disabled' values.

complianceStatus
  • Type: string

The current status of compliance for the resiliency policy.

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

The timestamp for when the app was created.

description
  • Type: string

The optional description for an app.

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

The timestamp for the most recent compliance evaluation.

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

The timestamp for the most recent resiliency score evaluation.

name
  • Required: Yes
  • Type: string

The name for the application.

policyArn
  • Type: string

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

resiliencyScore
  • Type: double

The current resiliency score for the application.

status
  • Type: string

The status of the application.

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

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

AppAssessment

Description

Defines an application assessment.

Members
appArn
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Type: string

The version of the application.

assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

assessmentName
  • Type: string

The name of the assessment.

assessmentStatus
  • Required: Yes
  • Type: string

The current status of the assessment for the resiliency policy.

compliance
  • Type: Associative array of custom strings keys (DisruptionType) to DisruptionCompliance structures

The application compliance against the resiliency policy.

complianceStatus
  • Type: string

The current status of the compliance for the resiliency policy.

cost
  • Type: Cost structure

The cost for the application.

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

The end time for the action.

invoker
  • Required: Yes
  • Type: string

The entity that invoked the assessment.

message
  • Type: string

Error or warning message from the assessment execution

policy
  • Type: ResiliencyPolicy structure

The resiliency policy.

resiliencyScore
  • Type: ResiliencyScore structure

The current resiliency score for the application.

resourceErrorsDetails
  • Type: ResourceErrorsDetails structure

A resource error object containing a list of errors retrieving an application's resources.

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

The starting time for the action.

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

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

AppAssessmentSummary

Description

Defines an application assessment summary.

Members
appArn
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appVersion
  • Type: string

The version of the application.

assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

assessmentName
  • Type: string

The name of the assessment.

assessmentStatus
  • Required: Yes
  • Type: string

The current status of the assessment for the resiliency policy.

complianceStatus
  • Type: string

The current status of compliance for the resiliency policy.

cost
  • Type: Cost structure

The cost for the application.

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

The end time for the action.

invoker
  • Type: string

The entity that invoked the assessment.

message
  • Type: string

The message from the assessment run.

resiliencyScore
  • Type: double

The current resiliency score for the application.

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

The starting time for the action.

AppComponent

Description

Defines an application component.

Members
name
  • Required: Yes
  • Type: string

The name of the application component.

type
  • Required: Yes
  • Type: string

The type of application component.

AppComponentCompliance

Description

Defines the compliance of an application component against the resiliency policy.

Members
appComponentName
  • Type: string

The name of the application component.

compliance
  • Type: Associative array of custom strings keys (DisruptionType) to DisruptionCompliance structures

The compliance of the application component against the resiliency policy.

cost
  • Type: Cost structure

The cost for the application.

message
  • Type: string

The compliance message.

resiliencyScore
  • Type: ResiliencyScore structure

The current resiliency score for the application.

status
  • Type: string

The status of the action.

AppSummary

Description

Defines an application summary.

Members
appArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

assessmentSchedule
  • Type: string

Assessment execution schedule with 'Daily' or 'Disabled' values.

complianceStatus
  • Type: string

The current status of compliance for the resiliency policy.

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

The timestamp for when the app was created.

description
  • Type: string

The optional description for an app.

name
  • Required: Yes
  • Type: string

The name of the application.

resiliencyScore
  • Type: double

The current resiliency score for the application.

status
  • Type: string

The status of the application.

AppVersionSummary

Description

The version of the application.

Members
appVersion
  • Required: Yes
  • Type: string

The version of the application.

ComponentRecommendation

Description

Defines recommendations for a Resilience Hub application component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.

Members
appComponentName
  • Required: Yes
  • Type: string

The name of the application component.

configRecommendations
  • Required: Yes
  • Type: Array of ConfigRecommendation structures

The list of recommendations.

recommendationStatus
  • Required: Yes
  • Type: string

The recommendation status.

ConfigRecommendation

Description

Defines a configuration recommendation.

Members
appComponentName
  • Type: string

The application component name.

compliance
  • Type: Associative array of custom strings keys (DisruptionType) to DisruptionCompliance structures

The current compliance against the resiliency policy before applying the configuration change.

cost
  • Type: Cost structure

The cost for the application.

description
  • Type: string

The optional description for an app.

haArchitecture
  • Type: string

The architecture type.

name
  • Required: Yes
  • Type: string

The name of the recommendation configuration.

optimizationType
  • Required: Yes
  • Type: string

The type of optimization.

recommendationCompliance
  • Type: Associative array of custom strings keys (DisruptionType) to RecommendationDisruptionCompliance structures

The expected compliance against the resiliency policy after applying the configuration change.

referenceId
  • Required: Yes
  • Type: string

The reference identifier for the recommendation configuration.

suggestedChanges
  • Type: Array of strings

List of the suggested configuration changes.

ConflictException

Description

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

Members
message
  • Type: string
resourceId
  • Type: string

The identifier of the resource that the exception applies to.

resourceType
  • Type: string

The type of the resource that the exception applies to.

Cost

Description

Defines a cost object.

Members
amount
  • Required: Yes
  • Type: double

The cost amount.

currency
  • Required: Yes
  • Type: string

The cost currency, for example USD.

frequency
  • Required: Yes
  • Type: string

The cost frequency.

DisruptionCompliance

Description

Defines the compliance against the resiliency policy for a disruption.

Members
achievableRpoInSecs
  • Type: int

The Recovery Point Objective (RPO) that is achievable, in seconds.

achievableRtoInSecs
  • Type: int

The Recovery Time Objective (RTO) that is achievable, in seconds

complianceStatus
  • Required: Yes
  • Type: string

The current status of compliance for the resiliency policy.

currentRpoInSecs
  • Type: int

The current RPO, in seconds.

currentRtoInSecs
  • Type: int

The current RTO, in seconds.

message
  • Type: string

The disruption compliance message.

rpoDescription
  • Type: string

The RPO description.

rpoReferenceId
  • Type: string

The RPO reference identifier.

rtoDescription
  • Type: string

The RTO description.

rtoReferenceId
  • Type: string

The RTO reference identifier.

FailurePolicy

Description

Defines a failure policy.

Members
rpoInSecs
  • Required: Yes
  • Type: int

The Recovery Point Objective (RPO), in seconds.

rtoInSecs
  • Required: Yes
  • Type: int

The Recovery Time Objective (RTO), in seconds.

InternalServerException

Description

This exception occurs when there is an internal failure in the AWS Resilience Hub service.

Members
message
  • Type: string

LogicalResourceId

Description

Defines a logical resource identifier.

Members
identifier
  • Required: Yes
  • Type: string

The identifier of the resource.

logicalStackName
  • Type: string

The name of the CloudFormation stack this resource belongs to.

resourceGroupName
  • Type: string

The name of the resource group that this resource belongs to.

terraformSourceName
  • Type: string

The name of the Terraform S3 state file this resource belongs to.

PhysicalResource

Description

Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

Members
appComponents
  • Type: Array of AppComponent structures

The application components that belong to this resource.

logicalResourceId
  • Required: Yes
  • Type: LogicalResourceId structure

The logical identifier of the resource.

physicalResourceId
  • Required: Yes
  • Type: PhysicalResourceId structure

The physical identifier of the resource.

resourceName
  • Type: string

The name of the resource.

resourceType
  • Required: Yes
  • Type: string

The type of resource.

PhysicalResourceId

Description

Defines a physical resource identifier.

Members
awsAccountId
  • Type: string

The Amazon Web Services account that owns the physical resource.

awsRegion
  • Type: string

The Amazon Web Services Region that the physical resource is located in.

identifier
  • Required: Yes
  • Type: string

The identifier of the physical resource.

type
  • Required: Yes
  • Type: string

Specifies the type of physical resource identifier.

Arn

The resource identifier is an Amazon Resource Name (ARN) .

Native

The resource identifier is a Resilience Hub-native identifier.

RecommendationDisruptionCompliance

Description

Defines a disruption compliance recommendation.

Members
expectedComplianceStatus
  • Required: Yes
  • Type: string

The expected compliance status after applying the recommended configuration change.

expectedRpoDescription
  • Type: string

The expected Recovery Point Objective (RPO) description after applying the recommended configuration change.

expectedRpoInSecs
  • Type: int

The expected RPO after applying the recommended configuration change.

expectedRtoDescription
  • Type: string

The expected Recovery Time Objective (RTO) description after applying the recommended configuration change.

expectedRtoInSecs
  • Type: int

The expected RTO after applying the recommended configuration change.

RecommendationItem

Description

Defines a recommendation.

Members
alreadyImplemented
  • Type: boolean

Specifies if the recommendation has already been implemented.

resourceId
  • Type: string

The resource identifier.

targetAccountId
  • Type: string

The target account identifier.

targetRegion
  • Type: string

The target region.

RecommendationTemplate

Description

Defines a recommendation template created with the CreateRecommendationTemplate action.

Members
appArn
  • Type: string

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

assessmentArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

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

The end time for the action.

format
  • Required: Yes
  • Type: string

The format of the recommendation template.

CfnJson

The template is CloudFormation JSON.

CfnYaml

The template is CloudFormation YAML.

message
  • Type: string

The message for the recommendation template.

name
  • Required: Yes
  • Type: string

The name for the recommendation template.

needsReplacements
  • Type: boolean

Indicates if replacements are needed.

recommendationIds
  • Type: Array of strings

Identifiers for the recommendations used in the recommendation template.

recommendationTemplateArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) for the recommendation template.

recommendationTypes
  • Required: Yes
  • Type: Array of strings

An array of strings that specify the recommendation template type or types.

Alarm

The template is an AlarmRecommendation template.

Sop

The template is a SopRecommendation template.

Test

The template is a TestRecommendation template.

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

The start time for the action.

status
  • Required: Yes
  • Type: string

The status of the action.

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

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

templatesLocation
  • Type: S3Location structure

The file location of the template.

ResiliencyPolicy

Description

Defines a resiliency policy.

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

The timestamp for when the resiliency policy was created.

dataLocationConstraint
  • Type: string

Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

estimatedCostTier
  • Type: string

Specifies the estimated cost tier of the resiliency policy.

policy
  • Type: Associative array of custom strings keys (DisruptionType) to FailurePolicy structures

The resiliency policy.

policyArn
  • Type: string

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

policyDescription
  • Type: string

The description for the policy.

policyName
  • Type: string

The name of the policy

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

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

tier
  • Type: string

The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

ResiliencyScore

Description

The overall resiliency score, returned as an object that includes the disruption score and outage score.

Members
disruptionScore
  • Required: Yes
  • Type: Associative array of custom strings keys (DisruptionType) to doubles

The disruption score for a valid key.

score
  • Required: Yes
  • Type: double

The outage score for a valid key.

ResourceError

Description

Defines application resource errors.

Members
logicalResourceId
  • Type: string

This is the identifier of the resource.

physicalResourceId
  • Type: string

This is the identifier of the physical resource.

reason
  • Type: string

This is the error message.

ResourceErrorsDetails

Description

A list of errors retrieving an application's resources.

Members
hasMoreErrors
  • Type: boolean

This indicates if there are more errors not listed in the resourceErrors list.

resourceErrors
  • Type: Array of ResourceError structures

A list of errors retrieving an application's resources.

ResourceMapping

Description

Defines a resource mapping.

Members
appRegistryAppName
  • Type: string

The name of the application this resource is mapped to.

logicalStackName
  • Type: string

The name of the CloudFormation stack this resource is mapped to.

mappingType
  • Required: Yes
  • Type: string

Specifies the type of resource mapping.

AppRegistryApp

The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.

CfnStack

The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.

Resource

The resource is mapped to another resource. The name of the resource is contained in the resourceName property.

ResourceGroup

The resource is mapped to a resource group. The name of the resource group is contained in the resourceGroupName property.

physicalResourceId
  • Required: Yes
  • Type: PhysicalResourceId structure

The identifier of this resource.

resourceGroupName
  • Type: string

The name of the resource group this resource is mapped to.

resourceName
  • Type: string

The name of the resource this resource is mapped to.

terraformSourceName
  • Type: string

The short name of the Terraform source.

ResourceNotFoundException

Description

The specified resource could not be found.

Members
message
  • Type: string
resourceId
  • Type: string

The identifier of the resource that the exception applies to.

resourceType
  • Type: string

The type of the resource that the exception applies to.

S3Location

Description

The location of the Amazon S3 bucket.

Members
bucket
  • Type: string

The name of the Amazon S3 bucket.

prefix
  • Type: string

The prefix for the Amazon S3 bucket.

ServiceQuotaExceededException

Description

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

Members
message
  • Type: string

SopRecommendation

Description

Defines a standard operating procedure (SOP) recommendation.

Members
appComponentName
  • Type: string

The application component name.

description
  • Type: string

The description of the SOP recommendation.

items
  • Type: Array of RecommendationItem structures

The recommendation items.

name
  • Type: string

The name of the SOP recommendation.

prerequisite
  • Type: string

The prerequisite for the SOP recommendation.

recommendationId
  • Required: Yes
  • Type: string

Identifier for the SOP recommendation.

referenceId
  • Required: Yes
  • Type: string

The reference identifier for the SOP recommendation.

serviceType
  • Required: Yes
  • Type: string

The service type.

TerraformSource

Description

The Terraform s3 state file you need to import.

Members
s3StateFileUrl
  • Required: Yes
  • Type: string

The Terraform s3 state file you need to import.

TestRecommendation

Description

Defines a test recommendation.

Members
appComponentName
  • Type: string

The name of the application component.

dependsOnAlarms
  • Type: Array of strings

A list of recommended alarms that are used in the test and must be exported before or with the test.

description
  • Type: string

The description for the test recommendation.

intent
  • Type: string

The intent of the test recommendation.

items
  • Type: Array of RecommendationItem structures

The test recommendation items.

name
  • Type: string

The name of the test recommendation.

prerequisite
  • Type: string

The prerequisite of the test recommendation.

recommendationId
  • Type: string

Identifier for the test recommendation.

referenceId
  • Required: Yes
  • Type: string

The reference identifier for the test recommendation.

risk
  • Type: string

The level of risk for this test recommendation.

type
  • Type: string

The type of test recommendation.

ThrottlingException

Description

The limit on the number of requests per second was exceeded.

Members
message
  • Type: string
retryAfterSeconds
  • Type: int

The number of seconds to wait before retrying the operation.

UnsupportedResource

Description

Defines a resource that is not supported by Resilience Hub.

Members
logicalResourceId
  • Required: Yes
  • Type: LogicalResourceId structure

The logical resource identifier for the unsupported resource.

physicalResourceId
  • Required: Yes
  • Type: PhysicalResourceId structure

The physical resource identifier for the unsupported resource.

resourceType
  • Required: Yes
  • Type: string

The type of resource.

ValidationException

Description

Indicates that a request was not valid.

Members
message
  • Type: string
AWS SDK for PHP 3.x API documentation generated by ApiGen