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

Namespaces

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

Classes

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

Interfaces

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

Traits

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

Exceptions

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

Functions

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

AWS SecurityHub 2018-10-26

Client: Aws\SecurityHub\SecurityHubClient
Service ID: securityhub
Version: 2018-10-26

This page describes the parameters and results for the operations of the AWS SecurityHub (2018-10-26), and shows how to use the Aws\SecurityHub\SecurityHubClient object to call the described operations. This documentation is specific to the 2018-10-26 API version of the service.

Operation Summary

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

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

  • AcceptInvitation ( array $params = [] )

    Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from.

  • BatchDisableStandards ( array $params = [] )

    Disables the standards specified by the provided StandardsSubscriptionArns.

  • BatchEnableStandards ( array $params = [] )

    Enables the standards specified by the provided StandardsArn.

  • BatchImportFindings ( array $params = [] )

    Imports security findings generated from an integrated third-party product into Security Hub.

  • BatchUpdateFindings ( array $params = [] )

    Used by Security Hub customers to update information about their investigation into a finding.

  • CreateActionTarget ( array $params = [] )

    Creates a custom action target in Security Hub.

  • CreateInsight ( array $params = [] )

    Creates a custom insight in Security Hub.

  • CreateMembers ( array $params = [] )

    Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account.

  • DeclineInvitations ( array $params = [] )

    Declines invitations to become a member account.

  • DeleteActionTarget ( array $params = [] )

    Deletes a custom action target from Security Hub.

  • DeleteInsight ( array $params = [] )

    Deletes the insight specified by the InsightArn.

  • DeleteInvitations ( array $params = [] )

    Deletes invitations received by the AWS account to become a member account.

  • DeleteMembers ( array $params = [] )

    Deletes the specified member accounts from Security Hub.

  • DescribeActionTargets ( array $params = [] )

    Returns a list of the custom action targets in Security Hub in your account.

  • DescribeHub ( array $params = [] )

    Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.

  • DescribeOrganizationConfiguration ( array $params = [] )

    Returns information about the Organizations configuration for Security Hub.

  • DescribeProducts ( array $params = [] )

    Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.

  • DescribeStandards ( array $params = [] )

    Returns a list of the available standards in Security Hub.

  • DescribeStandardsControls ( array $params = [] )

    Returns a list of security standards controls.

  • DisableImportFindingsForProduct ( array $params = [] )

    Disables the integration of the specified product with Security Hub.

  • DisableOrganizationAdminAccount ( array $params = [] )

    Disables a Security Hub administrator account.

  • DisableSecurityHub ( array $params = [] )

    Disables Security Hub in your account only in the current Region.

  • DisassociateFromMasterAccount ( array $params = [] )

    Disassociates the current Security Hub member account from the associated master account.

  • DisassociateMembers ( array $params = [] )

    Disassociates the specified member accounts from the associated master account.

  • EnableImportFindingsForProduct ( array $params = [] )

    Enables the integration of a partner product with Security Hub.

  • EnableOrganizationAdminAccount ( array $params = [] )

    Designates the Security Hub administrator account for an organization.

  • EnableSecurityHub ( array $params = [] )

    Enables Security Hub for your account in the current Region or the Region you specify in the request.

  • GetEnabledStandards ( array $params = [] )

    Returns a list of the standards that are currently enabled.

  • GetFindings ( array $params = [] )

    Returns a list of findings that match the specified criteria.

  • GetInsightResults ( array $params = [] )

    Lists the results of the Security Hub insight specified by the insight ARN.

  • GetInsights ( array $params = [] )

    Lists and describes insights for the specified insight ARNs.

  • GetInvitationsCount ( array $params = [] )

    Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.

  • GetMasterAccount ( array $params = [] )

    Provides the details for the Security Hub master account for the current member account.

  • GetMembers ( array $params = [] )

    Returns the details for the Security Hub member accounts for the specified account IDs.

  • InviteMembers ( array $params = [] )

    Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from.

  • ListEnabledProductsForImport ( array $params = [] )

    Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.

  • ListInvitations ( array $params = [] )

    Lists all Security Hub membership invitations that were sent to the current AWS account.

  • ListMembers ( array $params = [] )

    Lists details about all member accounts for the current Security Hub master account.

  • ListOrganizationAdminAccounts ( array $params = [] )

    Lists the Security Hub administrator accounts.

  • ListTagsForResource ( array $params = [] )

    Returns a list of tags associated with a resource.

  • TagResource ( array $params = [] )

    Adds one or more tags to a resource.

  • UntagResource ( array $params = [] )

    Removes one or more tags from a resource.

  • UpdateActionTarget ( array $params = [] )

    Updates the name and description of a custom action target in Security Hub.

  • UpdateFindings ( array $params = [] )

    UpdateFindings is deprecated.

  • UpdateInsight ( array $params = [] )

    Updates the Security Hub insight identified by the specified insight ARN.

  • UpdateOrganizationConfiguration ( array $params = [] )

    Used to update the configuration related to Organizations.

  • UpdateSecurityHubConfiguration ( array $params = [] )

    Updates configuration options for Security Hub.

  • UpdateStandardsControl ( array $params = [] )

    Used to control whether an individual security standard control is enabled or disabled.

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:

  • DescribeActionTargets
  • DescribeProducts
  • DescribeStandards
  • DescribeStandardsControls
  • GetEnabledStandards
  • GetFindings
  • GetInsights
  • ListEnabledProductsForImport
  • ListInvitations
  • ListMembers
  • ListOrganizationAdminAccounts

Operations

AcceptInvitation

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

Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from.

This operation is only used by member accounts that are not added through Organizations.

When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.

Parameter Syntax

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

Parameter Details

Members
InvitationId
  • Required: Yes
  • Type: string

The ID of the invitation sent from the Security Hub master account.

MasterId
  • Required: Yes
  • Type: string

The account ID of the Security Hub master account that sent the invitation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

BatchDisableStandards

$result = $client->batchDisableStandards([/* ... */]);
$promise = $client->batchDisableStandardsAsync([/* ... */]);

Disables the standards specified by the provided StandardsSubscriptionArns.

For more information, see Security Standards section of the AWS Security Hub User Guide.

Parameter Syntax

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

Parameter Details

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

The ARNs of the standards subscriptions to disable.

Result Syntax

[
    'StandardsSubscriptions' => [
        [
            'StandardsArn' => '<string>',
            'StandardsInput' => ['<string>', ...],
            'StandardsStatus' => 'PENDING|READY|FAILED|DELETING|INCOMPLETE',
            'StandardsSubscriptionArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
StandardsSubscriptions
  • Type: Array of StandardsSubscription structures

The details of the standards subscriptions that were disabled.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

BatchEnableStandards

$result = $client->batchEnableStandards([/* ... */]);
$promise = $client->batchEnableStandardsAsync([/* ... */]);

Enables the standards specified by the provided StandardsArn. To obtain the ARN for a standard, use the DescribeStandards operation.

For more information, see the Security Standards section of the AWS Security Hub User Guide.

Parameter Syntax

$result = $client->batchEnableStandards([
    'StandardsSubscriptionRequests' => [ // REQUIRED
        [
            'StandardsArn' => '<string>', // REQUIRED
            'StandardsInput' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Members
StandardsSubscriptionRequests
  • Required: Yes
  • Type: Array of StandardsSubscriptionRequest structures

The list of standards checks to enable.

Result Syntax

[
    'StandardsSubscriptions' => [
        [
            'StandardsArn' => '<string>',
            'StandardsInput' => ['<string>', ...],
            'StandardsStatus' => 'PENDING|READY|FAILED|DELETING|INCOMPLETE',
            'StandardsSubscriptionArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
StandardsSubscriptions
  • Type: Array of StandardsSubscription structures

The details of the standards subscriptions that were enabled.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

BatchImportFindings

$result = $client->batchImportFindings([/* ... */]);
$promise = $client->batchImportFindingsAsync([/* ... */]);

Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.

After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.

  • Note

  • UserDefinedFields

  • VerificationState

  • Workflow

BatchImportFindings can be used to update the following finding fields and objects only if they have not been updated using BatchUpdateFindings. After they are updated using BatchUpdateFindings, these fields cannot be updated using BatchImportFindings.

  • Confidence

  • Criticality

  • RelatedFindings

  • Severity

  • Types

Parameter Syntax

$result = $client->batchImportFindings([
    'Findings' => [ // REQUIRED
        [
            'Action' => [
                'ActionType' => '<string>',
                'AwsApiCallAction' => [
                    'AffectedResources' => ['<string>', ...],
                    'Api' => '<string>',
                    'CallerType' => '<string>',
                    'DomainDetails' => [
                        'Domain' => '<string>',
                    ],
                    'FirstSeen' => '<string>',
                    'LastSeen' => '<string>',
                    'RemoteIpDetails' => [
                        'City' => [
                            'CityName' => '<string>',
                        ],
                        'Country' => [
                            'CountryCode' => '<string>',
                            'CountryName' => '<string>',
                        ],
                        'GeoLocation' => [
                            'Lat' => <float>,
                            'Lon' => <float>,
                        ],
                        'IpAddressV4' => '<string>',
                        'Organization' => [
                            'Asn' => <integer>,
                            'AsnOrg' => '<string>',
                            'Isp' => '<string>',
                            'Org' => '<string>',
                        ],
                    ],
                    'ServiceName' => '<string>',
                ],
                'DnsRequestAction' => [
                    'Blocked' => true || false,
                    'Domain' => '<string>',
                    'Protocol' => '<string>',
                ],
                'NetworkConnectionAction' => [
                    'Blocked' => true || false,
                    'ConnectionDirection' => '<string>',
                    'LocalPortDetails' => [
                        'Port' => <integer>,
                        'PortName' => '<string>',
                    ],
                    'Protocol' => '<string>',
                    'RemoteIpDetails' => [
                        'City' => [
                            'CityName' => '<string>',
                        ],
                        'Country' => [
                            'CountryCode' => '<string>',
                            'CountryName' => '<string>',
                        ],
                        'GeoLocation' => [
                            'Lat' => <float>,
                            'Lon' => <float>,
                        ],
                        'IpAddressV4' => '<string>',
                        'Organization' => [
                            'Asn' => <integer>,
                            'AsnOrg' => '<string>',
                            'Isp' => '<string>',
                            'Org' => '<string>',
                        ],
                    ],
                    'RemotePortDetails' => [
                        'Port' => <integer>,
                        'PortName' => '<string>',
                    ],
                ],
                'PortProbeAction' => [
                    'Blocked' => true || false,
                    'PortProbeDetails' => [
                        [
                            'LocalIpDetails' => [
                                'IpAddressV4' => '<string>',
                            ],
                            'LocalPortDetails' => [
                                'Port' => <integer>,
                                'PortName' => '<string>',
                            ],
                            'RemoteIpDetails' => [
                                'City' => [
                                    'CityName' => '<string>',
                                ],
                                'Country' => [
                                    'CountryCode' => '<string>',
                                    'CountryName' => '<string>',
                                ],
                                'GeoLocation' => [
                                    'Lat' => <float>,
                                    'Lon' => <float>,
                                ],
                                'IpAddressV4' => '<string>',
                                'Organization' => [
                                    'Asn' => <integer>,
                                    'AsnOrg' => '<string>',
                                    'Isp' => '<string>',
                                    'Org' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'AwsAccountId' => '<string>', // REQUIRED
            'Compliance' => [
                'RelatedRequirements' => ['<string>', ...],
                'Status' => 'PASSED|WARNING|FAILED|NOT_AVAILABLE',
                'StatusReasons' => [
                    [
                        'Description' => '<string>',
                        'ReasonCode' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Confidence' => <integer>,
            'CreatedAt' => '<string>', // REQUIRED
            'Criticality' => <integer>,
            'Description' => '<string>', // REQUIRED
            'FirstObservedAt' => '<string>',
            'GeneratorId' => '<string>', // REQUIRED
            'Id' => '<string>', // REQUIRED
            'LastObservedAt' => '<string>',
            'Malware' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Path' => '<string>',
                    'State' => 'OBSERVED|REMOVAL_FAILED|REMOVED',
                    'Type' => 'ADWARE|BLENDED_THREAT|BOTNET_AGENT|COIN_MINER|EXPLOIT_KIT|KEYLOGGER|MACRO|POTENTIALLY_UNWANTED|SPYWARE|RANSOMWARE|REMOTE_ACCESS|ROOTKIT|TROJAN|VIRUS|WORM',
                ],
                // ...
            ],
            'Network' => [
                'DestinationDomain' => '<string>',
                'DestinationIpV4' => '<string>',
                'DestinationIpV6' => '<string>',
                'DestinationPort' => <integer>,
                'Direction' => 'IN|OUT',
                'OpenPortRange' => [
                    'Begin' => <integer>,
                    'End' => <integer>,
                ],
                'Protocol' => '<string>',
                'SourceDomain' => '<string>',
                'SourceIpV4' => '<string>',
                'SourceIpV6' => '<string>',
                'SourceMac' => '<string>',
                'SourcePort' => <integer>,
            ],
            'NetworkPath' => [
                [
                    'ComponentId' => '<string>',
                    'ComponentType' => '<string>',
                    'Egress' => [
                        'Destination' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'Protocol' => '<string>',
                        'Source' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'Ingress' => [
                        'Destination' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'Protocol' => '<string>',
                        'Source' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                    ],
                ],
                // ...
            ],
            'Note' => [
                'Text' => '<string>', // REQUIRED
                'UpdatedAt' => '<string>', // REQUIRED
                'UpdatedBy' => '<string>', // REQUIRED
            ],
            'PatchSummary' => [
                'FailedCount' => <integer>,
                'Id' => '<string>', // REQUIRED
                'InstalledCount' => <integer>,
                'InstalledOtherCount' => <integer>,
                'InstalledPendingReboot' => <integer>,
                'InstalledRejectedCount' => <integer>,
                'MissingCount' => <integer>,
                'Operation' => '<string>',
                'OperationEndTime' => '<string>',
                'OperationStartTime' => '<string>',
                'RebootOption' => '<string>',
            ],
            'Process' => [
                'LaunchedAt' => '<string>',
                'Name' => '<string>',
                'ParentPid' => <integer>,
                'Path' => '<string>',
                'Pid' => <integer>,
                'TerminatedAt' => '<string>',
            ],
            'ProductArn' => '<string>', // REQUIRED
            'ProductFields' => ['<string>', ...],
            'RecordState' => 'ACTIVE|ARCHIVED',
            'RelatedFindings' => [
                [
                    'Id' => '<string>', // REQUIRED
                    'ProductArn' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Remediation' => [
                'Recommendation' => [
                    'Text' => '<string>',
                    'Url' => '<string>',
                ],
            ],
            'Resources' => [ // REQUIRED
                [
                    'Details' => [
                        'AwsApiGatewayRestApi' => [
                            'ApiKeySource' => '<string>',
                            'BinaryMediaTypes' => ['<string>', ...],
                            'CreatedDate' => '<string>',
                            'Description' => '<string>',
                            'EndpointConfiguration' => [
                                'Types' => ['<string>', ...],
                            ],
                            'Id' => '<string>',
                            'MinimumCompressionSize' => <integer>,
                            'Name' => '<string>',
                            'Version' => '<string>',
                        ],
                        'AwsApiGatewayStage' => [
                            'AccessLogSettings' => [
                                'DestinationArn' => '<string>',
                                'Format' => '<string>',
                            ],
                            'CacheClusterEnabled' => true || false,
                            'CacheClusterSize' => '<string>',
                            'CacheClusterStatus' => '<string>',
                            'CanarySettings' => [
                                'DeploymentId' => '<string>',
                                'PercentTraffic' => <float>,
                                'StageVariableOverrides' => ['<string>', ...],
                                'UseStageCache' => true || false,
                            ],
                            'ClientCertificateId' => '<string>',
                            'CreatedDate' => '<string>',
                            'DeploymentId' => '<string>',
                            'Description' => '<string>',
                            'DocumentationVersion' => '<string>',
                            'LastUpdatedDate' => '<string>',
                            'MethodSettings' => [
                                [
                                    'CacheDataEncrypted' => true || false,
                                    'CacheTtlInSeconds' => <integer>,
                                    'CachingEnabled' => true || false,
                                    'DataTraceEnabled' => true || false,
                                    'HttpMethod' => '<string>',
                                    'LoggingLevel' => '<string>',
                                    'MetricsEnabled' => true || false,
                                    'RequireAuthorizationForCacheControl' => true || false,
                                    'ResourcePath' => '<string>',
                                    'ThrottlingBurstLimit' => <integer>,
                                    'ThrottlingRateLimit' => <float>,
                                    'UnauthorizedCacheControlHeaderStrategy' => '<string>',
                                ],
                                // ...
                            ],
                            'StageName' => '<string>',
                            'TracingEnabled' => true || false,
                            'Variables' => ['<string>', ...],
                            'WebAclArn' => '<string>',
                        ],
                        'AwsApiGatewayV2Api' => [
                            'ApiEndpoint' => '<string>',
                            'ApiId' => '<string>',
                            'ApiKeySelectionExpression' => '<string>',
                            'CorsConfiguration' => [
                                'AllowCredentials' => true || false,
                                'AllowHeaders' => ['<string>', ...],
                                'AllowMethods' => ['<string>', ...],
                                'AllowOrigins' => ['<string>', ...],
                                'ExposeHeaders' => ['<string>', ...],
                                'MaxAge' => <integer>,
                            ],
                            'CreatedDate' => '<string>',
                            'Description' => '<string>',
                            'Name' => '<string>',
                            'ProtocolType' => '<string>',
                            'RouteSelectionExpression' => '<string>',
                            'Version' => '<string>',
                        ],
                        'AwsApiGatewayV2Stage' => [
                            'AccessLogSettings' => [
                                'DestinationArn' => '<string>',
                                'Format' => '<string>',
                            ],
                            'ApiGatewayManaged' => true || false,
                            'AutoDeploy' => true || false,
                            'CreatedDate' => '<string>',
                            'DefaultRouteSettings' => [
                                'DataTraceEnabled' => true || false,
                                'DetailedMetricsEnabled' => true || false,
                                'LoggingLevel' => '<string>',
                                'ThrottlingBurstLimit' => <integer>,
                                'ThrottlingRateLimit' => <float>,
                            ],
                            'DeploymentId' => '<string>',
                            'Description' => '<string>',
                            'LastDeploymentStatusMessage' => '<string>',
                            'LastUpdatedDate' => '<string>',
                            'RouteSettings' => [
                                'DataTraceEnabled' => true || false,
                                'DetailedMetricsEnabled' => true || false,
                                'LoggingLevel' => '<string>',
                                'ThrottlingBurstLimit' => <integer>,
                                'ThrottlingRateLimit' => <float>,
                            ],
                            'StageName' => '<string>',
                            'StageVariables' => ['<string>', ...],
                        ],
                        'AwsAutoScalingAutoScalingGroup' => [
                            'CreatedTime' => '<string>',
                            'HealthCheckGracePeriod' => <integer>,
                            'HealthCheckType' => '<string>',
                            'LaunchConfigurationName' => '<string>',
                            'LoadBalancerNames' => ['<string>', ...],
                        ],
                        'AwsCertificateManagerCertificate' => [
                            'CertificateAuthorityArn' => '<string>',
                            'CreatedAt' => '<string>',
                            'DomainName' => '<string>',
                            'DomainValidationOptions' => [
                                [
                                    'DomainName' => '<string>',
                                    'ResourceRecord' => [
                                        'Name' => '<string>',
                                        'Type' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    'ValidationDomain' => '<string>',
                                    'ValidationEmails' => ['<string>', ...],
                                    'ValidationMethod' => '<string>',
                                    'ValidationStatus' => '<string>',
                                ],
                                // ...
                            ],
                            'ExtendedKeyUsages' => [
                                [
                                    'Name' => '<string>',
                                    'OId' => '<string>',
                                ],
                                // ...
                            ],
                            'FailureReason' => '<string>',
                            'ImportedAt' => '<string>',
                            'InUseBy' => ['<string>', ...],
                            'IssuedAt' => '<string>',
                            'Issuer' => '<string>',
                            'KeyAlgorithm' => '<string>',
                            'KeyUsages' => [
                                [
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                            'NotAfter' => '<string>',
                            'NotBefore' => '<string>',
                            'Options' => [
                                'CertificateTransparencyLoggingPreference' => '<string>',
                            ],
                            'RenewalEligibility' => '<string>',
                            'RenewalSummary' => [
                                'DomainValidationOptions' => [
                                    [
                                        'DomainName' => '<string>',
                                        'ResourceRecord' => [
                                            'Name' => '<string>',
                                            'Type' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        'ValidationDomain' => '<string>',
                                        'ValidationEmails' => ['<string>', ...],
                                        'ValidationMethod' => '<string>',
                                        'ValidationStatus' => '<string>',
                                    ],
                                    // ...
                                ],
                                'RenewalStatus' => '<string>',
                                'RenewalStatusReason' => '<string>',
                                'UpdatedAt' => '<string>',
                            ],
                            'Serial' => '<string>',
                            'SignatureAlgorithm' => '<string>',
                            'Status' => '<string>',
                            'Subject' => '<string>',
                            'SubjectAlternativeNames' => ['<string>', ...],
                            'Type' => '<string>',
                        ],
                        'AwsCloudFrontDistribution' => [
                            'CacheBehaviors' => [
                                'Items' => [
                                    [
                                        'ViewerProtocolPolicy' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'DefaultCacheBehavior' => [
                                'ViewerProtocolPolicy' => '<string>',
                            ],
                            'DefaultRootObject' => '<string>',
                            'DomainName' => '<string>',
                            'ETag' => '<string>',
                            'LastModifiedTime' => '<string>',
                            'Logging' => [
                                'Bucket' => '<string>',
                                'Enabled' => true || false,
                                'IncludeCookies' => true || false,
                                'Prefix' => '<string>',
                            ],
                            'OriginGroups' => [
                                'Items' => [
                                    [
                                        'FailoverCriteria' => [
                                            'StatusCodes' => [
                                                'Items' => [<integer>, ...],
                                                'Quantity' => <integer>,
                                            ],
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                            'Origins' => [
                                'Items' => [
                                    [
                                        'DomainName' => '<string>',
                                        'Id' => '<string>',
                                        'OriginPath' => '<string>',
                                        'S3OriginConfig' => [
                                            'OriginAccessIdentity' => '<string>',
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                            'Status' => '<string>',
                            'WebAclId' => '<string>',
                        ],
                        'AwsCloudTrailTrail' => [
                            'CloudWatchLogsLogGroupArn' => '<string>',
                            'CloudWatchLogsRoleArn' => '<string>',
                            'HasCustomEventSelectors' => true || false,
                            'HomeRegion' => '<string>',
                            'IncludeGlobalServiceEvents' => true || false,
                            'IsMultiRegionTrail' => true || false,
                            'IsOrganizationTrail' => true || false,
                            'KmsKeyId' => '<string>',
                            'LogFileValidationEnabled' => true || false,
                            'Name' => '<string>',
                            'S3BucketName' => '<string>',
                            'S3KeyPrefix' => '<string>',
                            'SnsTopicArn' => '<string>',
                            'SnsTopicName' => '<string>',
                            'TrailArn' => '<string>',
                        ],
                        'AwsCodeBuildProject' => [
                            'EncryptionKey' => '<string>',
                            'Environment' => [
                                'Certificate' => '<string>',
                                'ImagePullCredentialsType' => '<string>',
                                'RegistryCredential' => [
                                    'Credential' => '<string>',
                                    'CredentialProvider' => '<string>',
                                ],
                                'Type' => '<string>',
                            ],
                            'Name' => '<string>',
                            'ServiceRole' => '<string>',
                            'Source' => [
                                'GitCloneDepth' => <integer>,
                                'InsecureSsl' => true || false,
                                'Location' => '<string>',
                                'Type' => '<string>',
                            ],
                            'VpcConfig' => [
                                'SecurityGroupIds' => ['<string>', ...],
                                'Subnets' => ['<string>', ...],
                                'VpcId' => '<string>',
                            ],
                        ],
                        'AwsDynamoDbTable' => [
                            'AttributeDefinitions' => [
                                [
                                    'AttributeName' => '<string>',
                                    'AttributeType' => '<string>',
                                ],
                                // ...
                            ],
                            'BillingModeSummary' => [
                                'BillingMode' => '<string>',
                                'LastUpdateToPayPerRequestDateTime' => '<string>',
                            ],
                            'CreationDateTime' => '<string>',
                            'GlobalSecondaryIndexes' => [
                                [
                                    'Backfilling' => true || false,
                                    'IndexArn' => '<string>',
                                    'IndexName' => '<string>',
                                    'IndexSizeBytes' => <integer>,
                                    'IndexStatus' => '<string>',
                                    'ItemCount' => <integer>,
                                    'KeySchema' => [
                                        [
                                            'AttributeName' => '<string>',
                                            'KeyType' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Projection' => [
                                        'NonKeyAttributes' => ['<string>', ...],
                                        'ProjectionType' => '<string>',
                                    ],
                                    'ProvisionedThroughput' => [
                                        'LastDecreaseDateTime' => '<string>',
                                        'LastIncreaseDateTime' => '<string>',
                                        'NumberOfDecreasesToday' => <integer>,
                                        'ReadCapacityUnits' => <integer>,
                                        'WriteCapacityUnits' => <integer>,
                                    ],
                                ],
                                // ...
                            ],
                            'GlobalTableVersion' => '<string>',
                            'ItemCount' => <integer>,
                            'KeySchema' => [
                                [
                                    'AttributeName' => '<string>',
                                    'KeyType' => '<string>',
                                ],
                                // ...
                            ],
                            'LatestStreamArn' => '<string>',
                            'LatestStreamLabel' => '<string>',
                            'LocalSecondaryIndexes' => [
                                [
                                    'IndexArn' => '<string>',
                                    'IndexName' => '<string>',
                                    'KeySchema' => [
                                        [
                                            'AttributeName' => '<string>',
                                            'KeyType' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Projection' => [
                                        'NonKeyAttributes' => ['<string>', ...],
                                        'ProjectionType' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'ProvisionedThroughput' => [
                                'LastDecreaseDateTime' => '<string>',
                                'LastIncreaseDateTime' => '<string>',
                                'NumberOfDecreasesToday' => <integer>,
                                'ReadCapacityUnits' => <integer>,
                                'WriteCapacityUnits' => <integer>,
                            ],
                            'Replicas' => [
                                [
                                    'GlobalSecondaryIndexes' => [
                                        [
                                            'IndexName' => '<string>',
                                            'ProvisionedThroughputOverride' => [
                                                'ReadCapacityUnits' => <integer>,
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'KmsMasterKeyId' => '<string>',
                                    'ProvisionedThroughputOverride' => [
                                        'ReadCapacityUnits' => <integer>,
                                    ],
                                    'RegionName' => '<string>',
                                    'ReplicaStatus' => '<string>',
                                    'ReplicaStatusDescription' => '<string>',
                                ],
                                // ...
                            ],
                            'RestoreSummary' => [
                                'RestoreDateTime' => '<string>',
                                'RestoreInProgress' => true || false,
                                'SourceBackupArn' => '<string>',
                                'SourceTableArn' => '<string>',
                            ],
                            'SseDescription' => [
                                'InaccessibleEncryptionDateTime' => '<string>',
                                'KmsMasterKeyArn' => '<string>',
                                'SseType' => '<string>',
                                'Status' => '<string>',
                            ],
                            'StreamSpecification' => [
                                'StreamEnabled' => true || false,
                                'StreamViewType' => '<string>',
                            ],
                            'TableId' => '<string>',
                            'TableName' => '<string>',
                            'TableSizeBytes' => <integer>,
                            'TableStatus' => '<string>',
                        ],
                        'AwsEc2Eip' => [
                            'AllocationId' => '<string>',
                            'AssociationId' => '<string>',
                            'Domain' => '<string>',
                            'InstanceId' => '<string>',
                            'NetworkBorderGroup' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'NetworkInterfaceOwnerId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'PublicIp' => '<string>',
                            'PublicIpv4Pool' => '<string>',
                        ],
                        'AwsEc2Instance' => [
                            'IamInstanceProfileArn' => '<string>',
                            'ImageId' => '<string>',
                            'IpV4Addresses' => ['<string>', ...],
                            'IpV6Addresses' => ['<string>', ...],
                            'KeyName' => '<string>',
                            'LaunchedAt' => '<string>',
                            'SubnetId' => '<string>',
                            'Type' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsEc2NetworkInterface' => [
                            'Attachment' => [
                                'AttachTime' => '<string>',
                                'AttachmentId' => '<string>',
                                'DeleteOnTermination' => true || false,
                                'DeviceIndex' => <integer>,
                                'InstanceId' => '<string>',
                                'InstanceOwnerId' => '<string>',
                                'Status' => '<string>',
                            ],
                            'IpV6Addresses' => [
                                [
                                    'IpV6Address' => '<string>',
                                ],
                                // ...
                            ],
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddresses' => [
                                [
                                    'PrivateDnsName' => '<string>',
                                    'PrivateIpAddress' => '<string>',
                                ],
                                // ...
                            ],
                            'PublicDnsName' => '<string>',
                            'PublicIp' => '<string>',
                            'SecurityGroups' => [
                                [
                                    'GroupId' => '<string>',
                                    'GroupName' => '<string>',
                                ],
                                // ...
                            ],
                            'SourceDestCheck' => true || false,
                        ],
                        'AwsEc2SecurityGroup' => [
                            'GroupId' => '<string>',
                            'GroupName' => '<string>',
                            'IpPermissions' => [
                                [
                                    'FromPort' => <integer>,
                                    'IpProtocol' => '<string>',
                                    'IpRanges' => [
                                        [
                                            'CidrIp' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Ipv6Ranges' => [
                                        [
                                            'CidrIpv6' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'PrefixListIds' => [
                                        [
                                            'PrefixListId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ToPort' => <integer>,
                                    'UserIdGroupPairs' => [
                                        [
                                            'GroupId' => '<string>',
                                            'GroupName' => '<string>',
                                            'PeeringStatus' => '<string>',
                                            'UserId' => '<string>',
                                            'VpcId' => '<string>',
                                            'VpcPeeringConnectionId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'IpPermissionsEgress' => [
                                [
                                    'FromPort' => <integer>,
                                    'IpProtocol' => '<string>',
                                    'IpRanges' => [
                                        [
                                            'CidrIp' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Ipv6Ranges' => [
                                        [
                                            'CidrIpv6' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'PrefixListIds' => [
                                        [
                                            'PrefixListId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ToPort' => <integer>,
                                    'UserIdGroupPairs' => [
                                        [
                                            'GroupId' => '<string>',
                                            'GroupName' => '<string>',
                                            'PeeringStatus' => '<string>',
                                            'UserId' => '<string>',
                                            'VpcId' => '<string>',
                                            'VpcPeeringConnectionId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'OwnerId' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsEc2Volume' => [
                            'Attachments' => [
                                [
                                    'AttachTime' => '<string>',
                                    'DeleteOnTermination' => true || false,
                                    'InstanceId' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'CreateTime' => '<string>',
                            'Encrypted' => true || false,
                            'KmsKeyId' => '<string>',
                            'Size' => <integer>,
                            'SnapshotId' => '<string>',
                            'Status' => '<string>',
                        ],
                        'AwsEc2Vpc' => [
                            'CidrBlockAssociationSet' => [
                                [
                                    'AssociationId' => '<string>',
                                    'CidrBlock' => '<string>',
                                    'CidrBlockState' => '<string>',
                                ],
                                // ...
                            ],
                            'DhcpOptionsId' => '<string>',
                            'Ipv6CidrBlockAssociationSet' => [
                                [
                                    'AssociationId' => '<string>',
                                    'CidrBlockState' => '<string>',
                                    'Ipv6CidrBlock' => '<string>',
                                ],
                                // ...
                            ],
                            'State' => '<string>',
                        ],
                        'AwsElasticsearchDomain' => [
                            'AccessPolicies' => '<string>',
                            'DomainEndpointOptions' => [
                                'EnforceHTTPS' => true || false,
                                'TLSSecurityPolicy' => '<string>',
                            ],
                            'DomainId' => '<string>',
                            'DomainName' => '<string>',
                            'ElasticsearchVersion' => '<string>',
                            'EncryptionAtRestOptions' => [
                                'Enabled' => true || false,
                                'KmsKeyId' => '<string>',
                            ],
                            'Endpoint' => '<string>',
                            'Endpoints' => ['<string>', ...],
                            'NodeToNodeEncryptionOptions' => [
                                'Enabled' => true || false,
                            ],
                            'VPCOptions' => [
                                'AvailabilityZones' => ['<string>', ...],
                                'SecurityGroupIds' => ['<string>', ...],
                                'SubnetIds' => ['<string>', ...],
                                'VPCId' => '<string>',
                            ],
                        ],
                        'AwsElbLoadBalancer' => [
                            'AvailabilityZones' => ['<string>', ...],
                            'BackendServerDescriptions' => [
                                [
                                    'InstancePort' => <integer>,
                                    'PolicyNames' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'CanonicalHostedZoneName' => '<string>',
                            'CanonicalHostedZoneNameID' => '<string>',
                            'CreatedTime' => '<string>',
                            'DnsName' => '<string>',
                            'HealthCheck' => [
                                'HealthyThreshold' => <integer>,
                                'Interval' => <integer>,
                                'Target' => '<string>',
                                'Timeout' => <integer>,
                                'UnhealthyThreshold' => <integer>,
                            ],
                            'Instances' => [
                                [
                                    'InstanceId' => '<string>',
                                ],
                                // ...
                            ],
                            'ListenerDescriptions' => [
                                [
                                    'Listener' => [
                                        'InstancePort' => <integer>,
                                        'InstanceProtocol' => '<string>',
                                        'LoadBalancerPort' => <integer>,
                                        'Protocol' => '<string>',
                                        'SslCertificateId' => '<string>',
                                    ],
                                    'PolicyNames' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'LoadBalancerAttributes' => [
                                'AccessLog' => [
                                    'EmitInterval' => <integer>,
                                    'Enabled' => true || false,
                                    'S3BucketName' => '<string>',
                                    'S3BucketPrefix' => '<string>',
                                ],
                                'ConnectionDraining' => [
                                    'Enabled' => true || false,
                                    'Timeout' => <integer>,
                                ],
                                'ConnectionSettings' => [
                                    'IdleTimeout' => <integer>,
                                ],
                                'CrossZoneLoadBalancing' => [
                                    'Enabled' => true || false,
                                ],
                            ],
                            'LoadBalancerName' => '<string>',
                            'Policies' => [
                                'AppCookieStickinessPolicies' => [
                                    [
                                        'CookieName' => '<string>',
                                        'PolicyName' => '<string>',
                                    ],
                                    // ...
                                ],
                                'LbCookieStickinessPolicies' => [
                                    [
                                        'CookieExpirationPeriod' => <integer>,
                                        'PolicyName' => '<string>',
                                    ],
                                    // ...
                                ],
                                'OtherPolicies' => ['<string>', ...],
                            ],
                            'Scheme' => '<string>',
                            'SecurityGroups' => ['<string>', ...],
                            'SourceSecurityGroup' => [
                                'GroupName' => '<string>',
                                'OwnerAlias' => '<string>',
                            ],
                            'Subnets' => ['<string>', ...],
                            'VpcId' => '<string>',
                        ],
                        'AwsElbv2LoadBalancer' => [
                            'AvailabilityZones' => [
                                [
                                    'SubnetId' => '<string>',
                                    'ZoneName' => '<string>',
                                ],
                                // ...
                            ],
                            'CanonicalHostedZoneId' => '<string>',
                            'CreatedTime' => '<string>',
                            'DNSName' => '<string>',
                            'IpAddressType' => '<string>',
                            'Scheme' => '<string>',
                            'SecurityGroups' => ['<string>', ...],
                            'State' => [
                                'Code' => '<string>',
                                'Reason' => '<string>',
                            ],
                            'Type' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsIamAccessKey' => [
                            'AccessKeyId' => '<string>',
                            'AccountId' => '<string>',
                            'CreatedAt' => '<string>',
                            'PrincipalId' => '<string>',
                            'PrincipalName' => '<string>',
                            'PrincipalType' => '<string>',
                            'SessionContext' => [
                                'Attributes' => [
                                    'CreationDate' => '<string>',
                                    'MfaAuthenticated' => true || false,
                                ],
                                'SessionIssuer' => [
                                    'AccountId' => '<string>',
                                    'Arn' => '<string>',
                                    'PrincipalId' => '<string>',
                                    'Type' => '<string>',
                                    'UserName' => '<string>',
                                ],
                            ],
                            'Status' => 'Active|Inactive',
                            'UserName' => '<string>',
                        ],
                        'AwsIamGroup' => [
                            'AttachedManagedPolicies' => [
                                [
                                    'PolicyArn' => '<string>',
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                            'CreateDate' => '<string>',
                            'GroupId' => '<string>',
                            'GroupName' => '<string>',
                            'GroupPolicyList' => [
                                [
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                            'Path' => '<string>',
                        ],
                        'AwsIamPolicy' => [
                            'AttachmentCount' => <integer>,
                            'CreateDate' => '<string>',
                            'DefaultVersionId' => '<string>',
                            'Description' => '<string>',
                            'IsAttachable' => true || false,
                            'Path' => '<string>',
                            'PermissionsBoundaryUsageCount' => <integer>,
                            'PolicyId' => '<string>',
                            'PolicyName' => '<string>',
                            'PolicyVersionList' => [
                                [
                                    'CreateDate' => '<string>',
                                    'IsDefaultVersion' => true || false,
                                    'VersionId' => '<string>',
                                ],
                                // ...
                            ],
                            'UpdateDate' => '<string>',
                        ],
                        'AwsIamRole' => [
                            'AssumeRolePolicyDocument' => '<string>',
                            'AttachedManagedPolicies' => [
                                [
                                    'PolicyArn' => '<string>',
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                            'CreateDate' => '<string>',
                            'InstanceProfileList' => [
                                [
                                    'Arn' => '<string>',
                                    'CreateDate' => '<string>',
                                    'InstanceProfileId' => '<string>',
                                    'InstanceProfileName' => '<string>',
                                    'Path' => '<string>',
                                    'Roles' => [
                                        [
                                            'Arn' => '<string>',
                                            'AssumeRolePolicyDocument' => '<string>',
                                            'CreateDate' => '<string>',
                                            'Path' => '<string>',
                                            'RoleId' => '<string>',
                                            'RoleName' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'MaxSessionDuration' => <integer>,
                            'Path' => '<string>',
                            'PermissionsBoundary' => [
                                'PermissionsBoundaryArn' => '<string>',
                                'PermissionsBoundaryType' => '<string>',
                            ],
                            'RoleId' => '<string>',
                            'RoleName' => '<string>',
                            'RolePolicyList' => [
                                [
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsIamUser' => [
                            'AttachedManagedPolicies' => [
                                [
                                    'PolicyArn' => '<string>',
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                            'CreateDate' => '<string>',
                            'GroupList' => ['<string>', ...],
                            'Path' => '<string>',
                            'PermissionsBoundary' => [
                                'PermissionsBoundaryArn' => '<string>',
                                'PermissionsBoundaryType' => '<string>',
                            ],
                            'UserId' => '<string>',
                            'UserName' => '<string>',
                            'UserPolicyList' => [
                                [
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsKmsKey' => [
                            'AWSAccountId' => '<string>',
                            'CreationDate' => <float>,
                            'Description' => '<string>',
                            'KeyId' => '<string>',
                            'KeyManager' => '<string>',
                            'KeyState' => '<string>',
                            'Origin' => '<string>',
                        ],
                        'AwsLambdaFunction' => [
                            'Code' => [
                                'S3Bucket' => '<string>',
                                'S3Key' => '<string>',
                                'S3ObjectVersion' => '<string>',
                                'ZipFile' => '<string>',
                            ],
                            'CodeSha256' => '<string>',
                            'DeadLetterConfig' => [
                                'TargetArn' => '<string>',
                            ],
                            'Environment' => [
                                'Error' => [
                                    'ErrorCode' => '<string>',
                                    'Message' => '<string>',
                                ],
                                'Variables' => ['<string>', ...],
                            ],
                            'FunctionName' => '<string>',
                            'Handler' => '<string>',
                            'KmsKeyArn' => '<string>',
                            'LastModified' => '<string>',
                            'Layers' => [
                                [
                                    'Arn' => '<string>',
                                    'CodeSize' => <integer>,
                                ],
                                // ...
                            ],
                            'MasterArn' => '<string>',
                            'MemorySize' => <integer>,
                            'RevisionId' => '<string>',
                            'Role' => '<string>',
                            'Runtime' => '<string>',
                            'Timeout' => <integer>,
                            'TracingConfig' => [
                                'Mode' => '<string>',
                            ],
                            'Version' => '<string>',
                            'VpcConfig' => [
                                'SecurityGroupIds' => ['<string>', ...],
                                'SubnetIds' => ['<string>', ...],
                                'VpcId' => '<string>',
                            ],
                        ],
                        'AwsLambdaLayerVersion' => [
                            'CompatibleRuntimes' => ['<string>', ...],
                            'CreatedDate' => '<string>',
                            'Version' => <integer>,
                        ],
                        'AwsRdsDbCluster' => [
                            'ActivityStreamStatus' => '<string>',
                            'AllocatedStorage' => <integer>,
                            'AssociatedRoles' => [
                                [
                                    'RoleArn' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'AvailabilityZones' => ['<string>', ...],
                            'BackupRetentionPeriod' => <integer>,
                            'ClusterCreateTime' => '<string>',
                            'CopyTagsToSnapshot' => true || false,
                            'CrossAccountClone' => true || false,
                            'CustomEndpoints' => ['<string>', ...],
                            'DatabaseName' => '<string>',
                            'DbClusterIdentifier' => '<string>',
                            'DbClusterMembers' => [
                                [
                                    'DbClusterParameterGroupStatus' => '<string>',
                                    'DbInstanceIdentifier' => '<string>',
                                    'IsClusterWriter' => true || false,
                                    'PromotionTier' => <integer>,
                                ],
                                // ...
                            ],
                            'DbClusterOptionGroupMemberships' => [
                                [
                                    'DbClusterOptionGroupName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'DbClusterParameterGroup' => '<string>',
                            'DbClusterResourceId' => '<string>',
                            'DbSubnetGroup' => '<string>',
                            'DeletionProtection' => true || false,
                            'DomainMemberships' => [
                                [
                                    'Domain' => '<string>',
                                    'Fqdn' => '<string>',
                                    'IamRoleName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'EnabledCloudWatchLogsExports' => ['<string>', ...],
                            'Endpoint' => '<string>',
                            'Engine' => '<string>',
                            'EngineMode' => '<string>',
                            'EngineVersion' => '<string>',
                            'HostedZoneId' => '<string>',
                            'HttpEndpointEnabled' => true || false,
                            'IamDatabaseAuthenticationEnabled' => true || false,
                            'KmsKeyId' => '<string>',
                            'MasterUsername' => '<string>',
                            'MultiAz' => true || false,
                            'Port' => <integer>,
                            'PreferredBackupWindow' => '<string>',
                            'PreferredMaintenanceWindow' => '<string>',
                            'ReadReplicaIdentifiers' => ['<string>', ...],
                            'ReaderEndpoint' => '<string>',
                            'Status' => '<string>',
                            'StorageEncrypted' => true || false,
                            'VpcSecurityGroups' => [
                                [
                                    'Status' => '<string>',
                                    'VpcSecurityGroupId' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsRdsDbClusterSnapshot' => [
                            'AllocatedStorage' => <integer>,
                            'AvailabilityZones' => ['<string>', ...],
                            'ClusterCreateTime' => '<string>',
                            'DbClusterIdentifier' => '<string>',
                            'DbClusterSnapshotIdentifier' => '<string>',
                            'Engine' => '<string>',
                            'EngineVersion' => '<string>',
                            'IamDatabaseAuthenticationEnabled' => true || false,
                            'KmsKeyId' => '<string>',
                            'LicenseModel' => '<string>',
                            'MasterUsername' => '<string>',
                            'PercentProgress' => <integer>,
                            'Port' => <integer>,
                            'SnapshotCreateTime' => '<string>',
                            'SnapshotType' => '<string>',
                            'Status' => '<string>',
                            'StorageEncrypted' => true || false,
                            'VpcId' => '<string>',
                        ],
                        'AwsRdsDbInstance' => [
                            'AllocatedStorage' => <integer>,
                            'AssociatedRoles' => [
                                [
                                    'FeatureName' => '<string>',
                                    'RoleArn' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'AutoMinorVersionUpgrade' => true || false,
                            'AvailabilityZone' => '<string>',
                            'BackupRetentionPeriod' => <integer>,
                            'CACertificateIdentifier' => '<string>',
                            'CharacterSetName' => '<string>',
                            'CopyTagsToSnapshot' => true || false,
                            'DBClusterIdentifier' => '<string>',
                            'DBInstanceClass' => '<string>',
                            'DBInstanceIdentifier' => '<string>',
                            'DBName' => '<string>',
                            'DbInstancePort' => <integer>,
                            'DbInstanceStatus' => '<string>',
                            'DbParameterGroups' => [
                                [
                                    'DbParameterGroupName' => '<string>',
                                    'ParameterApplyStatus' => '<string>',
                                ],
                                // ...
                            ],
                            'DbSecurityGroups' => ['<string>', ...],
                            'DbSubnetGroup' => [
                                'DbSubnetGroupArn' => '<string>',
                                'DbSubnetGroupDescription' => '<string>',
                                'DbSubnetGroupName' => '<string>',
                                'SubnetGroupStatus' => '<string>',
                                'Subnets' => [
                                    [
                                        'SubnetAvailabilityZone' => [
                                            'Name' => '<string>',
                                        ],
                                        'SubnetIdentifier' => '<string>',
                                        'SubnetStatus' => '<string>',
                                    ],
                                    // ...
                                ],
                                'VpcId' => '<string>',
                            ],
                            'DbiResourceId' => '<string>',
                            'DeletionProtection' => true || false,
                            'DomainMemberships' => [
                                [
                                    'Domain' => '<string>',
                                    'Fqdn' => '<string>',
                                    'IamRoleName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'EnabledCloudWatchLogsExports' => ['<string>', ...],
                            'Endpoint' => [
                                'Address' => '<string>',
                                'HostedZoneId' => '<string>',
                                'Port' => <integer>,
                            ],
                            'Engine' => '<string>',
                            'EngineVersion' => '<string>',
                            'EnhancedMonitoringResourceArn' => '<string>',
                            'IAMDatabaseAuthenticationEnabled' => true || false,
                            'InstanceCreateTime' => '<string>',
                            'Iops' => <integer>,
                            'KmsKeyId' => '<string>',
                            'LatestRestorableTime' => '<string>',
                            'LicenseModel' => '<string>',
                            'ListenerEndpoint' => [
                                'Address' => '<string>',
                                'HostedZoneId' => '<string>',
                                'Port' => <integer>,
                            ],
                            'MasterUsername' => '<string>',
                            'MaxAllocatedStorage' => <integer>,
                            'MonitoringInterval' => <integer>,
                            'MonitoringRoleArn' => '<string>',
                            'MultiAz' => true || false,
                            'OptionGroupMemberships' => [
                                [
                                    'OptionGroupName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'PendingModifiedValues' => [
                                'AllocatedStorage' => <integer>,
                                'BackupRetentionPeriod' => <integer>,
                                'CaCertificateIdentifier' => '<string>',
                                'DbInstanceClass' => '<string>',
                                'DbInstanceIdentifier' => '<string>',
                                'DbSubnetGroupName' => '<string>',
                                'EngineVersion' => '<string>',
                                'Iops' => <integer>,
                                'LicenseModel' => '<string>',
                                'MasterUserPassword' => '<string>',
                                'MultiAZ' => true || false,
                                'PendingCloudWatchLogsExports' => [
                                    'LogTypesToDisable' => ['<string>', ...],
                                    'LogTypesToEnable' => ['<string>', ...],
                                ],
                                'Port' => <integer>,
                                'ProcessorFeatures' => [
                                    [
                                        'Name' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'StorageType' => '<string>',
                            ],
                            'PerformanceInsightsEnabled' => true || false,
                            'PerformanceInsightsKmsKeyId' => '<string>',
                            'PerformanceInsightsRetentionPeriod' => <integer>,
                            'PreferredBackupWindow' => '<string>',
                            'PreferredMaintenanceWindow' => '<string>',
                            'ProcessorFeatures' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'PromotionTier' => <integer>,
                            'PubliclyAccessible' => true || false,
                            'ReadReplicaDBClusterIdentifiers' => ['<string>', ...],
                            'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
                            'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
                            'SecondaryAvailabilityZone' => '<string>',
                            'StatusInfos' => [
                                [
                                    'Message' => '<string>',
                                    'Normal' => true || false,
                                    'Status' => '<string>',
                                    'StatusType' => '<string>',
                                ],
                                // ...
                            ],
                            'StorageEncrypted' => true || false,
                            'StorageType' => '<string>',
                            'TdeCredentialArn' => '<string>',
                            'Timezone' => '<string>',
                            'VpcSecurityGroups' => [
                                [
                                    'Status' => '<string>',
                                    'VpcSecurityGroupId' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsRdsDbSnapshot' => [
                            'AllocatedStorage' => <integer>,
                            'AvailabilityZone' => '<string>',
                            'DbInstanceIdentifier' => '<string>',
                            'DbSnapshotIdentifier' => '<string>',
                            'DbiResourceId' => '<string>',
                            'Encrypted' => true || false,
                            'Engine' => '<string>',
                            'EngineVersion' => '<string>',
                            'IamDatabaseAuthenticationEnabled' => true || false,
                            'InstanceCreateTime' => '<string>',
                            'Iops' => <integer>,
                            'KmsKeyId' => '<string>',
                            'LicenseModel' => '<string>',
                            'MasterUsername' => '<string>',
                            'OptionGroupName' => '<string>',
                            'PercentProgress' => <integer>,
                            'Port' => <integer>,
                            'ProcessorFeatures' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'SnapshotCreateTime' => '<string>',
                            'SnapshotType' => '<string>',
                            'SourceDbSnapshotIdentifier' => '<string>',
                            'SourceRegion' => '<string>',
                            'Status' => '<string>',
                            'StorageType' => '<string>',
                            'TdeCredentialArn' => '<string>',
                            'Timezone' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsRedshiftCluster' => [
                            'AllowVersionUpgrade' => true || false,
                            'AutomatedSnapshotRetentionPeriod' => <integer>,
                            'AvailabilityZone' => '<string>',
                            'ClusterAvailabilityStatus' => '<string>',
                            'ClusterCreateTime' => '<string>',
                            'ClusterIdentifier' => '<string>',
                            'ClusterNodes' => [
                                [
                                    'NodeRole' => '<string>',
                                    'PrivateIpAddress' => '<string>',
                                    'PublicIpAddress' => '<string>',
                                ],
                                // ...
                            ],
                            'ClusterParameterGroups' => [
                                [
                                    'ClusterParameterStatusList' => [
                                        [
                                            'ParameterApplyErrorDescription' => '<string>',
                                            'ParameterApplyStatus' => '<string>',
                                            'ParameterName' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ParameterApplyStatus' => '<string>',
                                    'ParameterGroupName' => '<string>',
                                ],
                                // ...
                            ],
                            'ClusterPublicKey' => '<string>',
                            'ClusterRevisionNumber' => '<string>',
                            'ClusterSecurityGroups' => [
                                [
                                    'ClusterSecurityGroupName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'ClusterSnapshotCopyStatus' => [
                                'DestinationRegion' => '<string>',
                                'ManualSnapshotRetentionPeriod' => <integer>,
                                'RetentionPeriod' => <integer>,
                                'SnapshotCopyGrantName' => '<string>',
                            ],
                            'ClusterStatus' => '<string>',
                            'ClusterSubnetGroupName' => '<string>',
                            'ClusterVersion' => '<string>',
                            'DBName' => '<string>',
                            'DeferredMaintenanceWindows' => [
                                [
                                    'DeferMaintenanceEndTime' => '<string>',
                                    'DeferMaintenanceIdentifier' => '<string>',
                                    'DeferMaintenanceStartTime' => '<string>',
                                ],
                                // ...
                            ],
                            'ElasticIpStatus' => [
                                'ElasticIp' => '<string>',
                                'Status' => '<string>',
                            ],
                            'ElasticResizeNumberOfNodeOptions' => '<string>',
                            'Encrypted' => true || false,
                            'Endpoint' => [
                                'Address' => '<string>',
                                'Port' => <integer>,
                            ],
                            'EnhancedVpcRouting' => true || false,
                            'ExpectedNextSnapshotScheduleTime' => '<string>',
                            'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
                            'HsmStatus' => [
                                'HsmClientCertificateIdentifier' => '<string>',
                                'HsmConfigurationIdentifier' => '<string>',
                                'Status' => '<string>',
                            ],
                            'IamRoles' => [
                                [
                                    'ApplyStatus' => '<string>',
                                    'IamRoleArn' => '<string>',
                                ],
                                // ...
                            ],
                            'KmsKeyId' => '<string>',
                            'MaintenanceTrackName' => '<string>',
                            'ManualSnapshotRetentionPeriod' => <integer>,
                            'MasterUsername' => '<string>',
                            'NextMaintenanceWindowStartTime' => '<string>',
                            'NodeType' => '<string>',
                            'NumberOfNodes' => <integer>,
                            'PendingActions' => ['<string>', ...],
                            'PendingModifiedValues' => [
                                'AutomatedSnapshotRetentionPeriod' => <integer>,
                                'ClusterIdentifier' => '<string>',
                                'ClusterType' => '<string>',
                                'ClusterVersion' => '<string>',
                                'EncryptionType' => '<string>',
                                'EnhancedVpcRouting' => true || false,
                                'MaintenanceTrackName' => '<string>',
                                'MasterUserPassword' => '<string>',
                                'NodeType' => '<string>',
                                'NumberOfNodes' => <integer>,
                                'PubliclyAccessible' => true || false,
                            ],
                            'PreferredMaintenanceWindow' => '<string>',
                            'PubliclyAccessible' => true || false,
                            'ResizeInfo' => [
                                'AllowCancelResize' => true || false,
                                'ResizeType' => '<string>',
                            ],
                            'RestoreStatus' => [
                                'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
                                'ElapsedTimeInSeconds' => <integer>,
                                'EstimatedTimeToCompletionInSeconds' => <integer>,
                                'ProgressInMegaBytes' => <integer>,
                                'SnapshotSizeInMegaBytes' => <integer>,
                                'Status' => '<string>',
                            ],
                            'SnapshotScheduleIdentifier' => '<string>',
                            'SnapshotScheduleState' => '<string>',
                            'VpcId' => '<string>',
                            'VpcSecurityGroups' => [
                                [
                                    'Status' => '<string>',
                                    'VpcSecurityGroupId' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsS3Bucket' => [
                            'CreatedAt' => '<string>',
                            'OwnerId' => '<string>',
                            'OwnerName' => '<string>',
                            'ServerSideEncryptionConfiguration' => [
                                'Rules' => [
                                    [
                                        'ApplyServerSideEncryptionByDefault' => [
                                            'KMSMasterKeyID' => '<string>',
                                            'SSEAlgorithm' => '<string>',
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        'AwsS3Object' => [
                            'ContentType' => '<string>',
                            'ETag' => '<string>',
                            'LastModified' => '<string>',
                            'SSEKMSKeyId' => '<string>',
                            'ServerSideEncryption' => '<string>',
                            'VersionId' => '<string>',
                        ],
                        'AwsSecretsManagerSecret' => [
                            'Deleted' => true || false,
                            'Description' => '<string>',
                            'KmsKeyId' => '<string>',
                            'Name' => '<string>',
                            'RotationEnabled' => true || false,
                            'RotationLambdaArn' => '<string>',
                            'RotationOccurredWithinFrequency' => true || false,
                            'RotationRules' => [
                                'AutomaticallyAfterDays' => <integer>,
                            ],
                        ],
                        'AwsSnsTopic' => [
                            'KmsMasterKeyId' => '<string>',
                            'Owner' => '<string>',
                            'Subscription' => [
                                [
                                    'Endpoint' => '<string>',
                                    'Protocol' => '<string>',
                                ],
                                // ...
                            ],
                            'TopicName' => '<string>',
                        ],
                        'AwsSqsQueue' => [
                            'DeadLetterTargetArn' => '<string>',
                            'KmsDataKeyReusePeriodSeconds' => <integer>,
                            'KmsMasterKeyId' => '<string>',
                            'QueueName' => '<string>',
                        ],
                        'AwsSsmPatchCompliance' => [
                            'Patch' => [
                                'ComplianceSummary' => [
                                    'ComplianceType' => '<string>',
                                    'CompliantCriticalCount' => <integer>,
                                    'CompliantHighCount' => <integer>,
                                    'CompliantInformationalCount' => <integer>,
                                    'CompliantLowCount' => <integer>,
                                    'CompliantMediumCount' => <integer>,
                                    'CompliantUnspecifiedCount' => <integer>,
                                    'ExecutionType' => '<string>',
                                    'NonCompliantCriticalCount' => <integer>,
                                    'NonCompliantHighCount' => <integer>,
                                    'NonCompliantInformationalCount' => <integer>,
                                    'NonCompliantLowCount' => <integer>,
                                    'NonCompliantMediumCount' => <integer>,
                                    'NonCompliantUnspecifiedCount' => <integer>,
                                    'OverallSeverity' => '<string>',
                                    'PatchBaselineId' => '<string>',
                                    'PatchGroup' => '<string>',
                                    'Status' => '<string>',
                                ],
                            ],
                        ],
                        'AwsWafWebAcl' => [
                            'DefaultAction' => '<string>',
                            'Name' => '<string>',
                            'Rules' => [
                                [
                                    'Action' => [
                                        'Type' => '<string>',
                                    ],
                                    'ExcludedRules' => [
                                        [
                                            'RuleId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'OverrideAction' => [
                                        'Type' => '<string>',
                                    ],
                                    'Priority' => <integer>,
                                    'RuleId' => '<string>',
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'WebAclId' => '<string>',
                        ],
                        'Container' => [
                            'ImageId' => '<string>',
                            'ImageName' => '<string>',
                            'LaunchedAt' => '<string>',
                            'Name' => '<string>',
                        ],
                        'Other' => ['<string>', ...],
                    ],
                    'Id' => '<string>', // REQUIRED
                    'Partition' => 'aws|aws-cn|aws-us-gov',
                    'Region' => '<string>',
                    'ResourceRole' => '<string>',
                    'Tags' => ['<string>', ...],
                    'Type' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'SchemaVersion' => '<string>', // REQUIRED
            'Severity' => [ // REQUIRED
                'Label' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
                'Normalized' => <integer>,
                'Original' => '<string>',
                'Product' => <float>,
            ],
            'SourceUrl' => '<string>',
            'ThreatIntelIndicators' => [
                [
                    'Category' => 'BACKDOOR|CARD_STEALER|COMMAND_AND_CONTROL|DROP_SITE|EXPLOIT_SITE|KEYLOGGER',
                    'LastObservedAt' => '<string>',
                    'Source' => '<string>',
                    'SourceUrl' => '<string>',
                    'Type' => 'DOMAIN|EMAIL_ADDRESS|HASH_MD5|HASH_SHA1|HASH_SHA256|HASH_SHA512|IPV4_ADDRESS|IPV6_ADDRESS|MUTEX|PROCESS|URL',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Title' => '<string>', // REQUIRED
            'Types' => ['<string>', ...], // REQUIRED
            'UpdatedAt' => '<string>', // REQUIRED
            'UserDefinedFields' => ['<string>', ...],
            'VerificationState' => 'UNKNOWN|TRUE_POSITIVE|FALSE_POSITIVE|BENIGN_POSITIVE',
            'Vulnerabilities' => [
                [
                    'Cvss' => [
                        [
                            'BaseScore' => <float>,
                            'BaseVector' => '<string>',
                            'Version' => '<string>',
                        ],
                        // ...
                    ],
                    'Id' => '<string>', // REQUIRED
                    'ReferenceUrls' => ['<string>', ...],
                    'RelatedVulnerabilities' => ['<string>', ...],
                    'Vendor' => [
                        'Name' => '<string>', // REQUIRED
                        'Url' => '<string>',
                        'VendorCreatedAt' => '<string>',
                        'VendorSeverity' => '<string>',
                        'VendorUpdatedAt' => '<string>',
                    ],
                    'VulnerablePackages' => [
                        [
                            'Architecture' => '<string>',
                            'Epoch' => '<string>',
                            'Name' => '<string>',
                            'Release' => '<string>',
                            'Version' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'Workflow' => [
                'Status' => 'NEW|NOTIFIED|RESOLVED|SUPPRESSED',
            ],
            'WorkflowState' => 'NEW|ASSIGNED|IN_PROGRESS|DEFERRED|RESOLVED',
        ],
        // ...
    ],
]);

Parameter Details

Members
Findings
  • Required: Yes
  • Type: Array of AwsSecurityFinding structures

A list of findings to import. To successfully import a finding, it must follow the AWS Security Finding Format. Maximum of 100 findings per request.

Result Syntax

[
    'FailedCount' => <integer>,
    'FailedFindings' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'Id' => '<string>',
        ],
        // ...
    ],
    'SuccessCount' => <integer>,
]

Result Details

Members
FailedCount
  • Required: Yes
  • Type: int

The number of findings that failed to import.

FailedFindings
  • Type: Array of ImportFindingsError structures

The list of findings that failed to import.

SuccessCount
  • Required: Yes
  • Type: int

The number of findings that were successfully imported.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

BatchUpdateFindings

$result = $client->batchUpdateFindings([/* ... */]);
$promise = $client->batchUpdateFindingsAsync([/* ... */]);

Used by Security Hub customers to update information about their investigation into a finding. Requested by master accounts or member accounts. Master accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.

Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding.

Master and member accounts can use BatchUpdateFindings to update the following finding fields and objects.

  • Confidence

  • Criticality

  • Note

  • RelatedFindings

  • Severity

  • Types

  • UserDefinedFields

  • VerificationState

  • Workflow

You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the AWS Security Hub User Guide.

Parameter Syntax

$result = $client->batchUpdateFindings([
    'Confidence' => <integer>,
    'Criticality' => <integer>,
    'FindingIdentifiers' => [ // REQUIRED
        [
            'Id' => '<string>', // REQUIRED
            'ProductArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Note' => [
        'Text' => '<string>', // REQUIRED
        'UpdatedBy' => '<string>', // REQUIRED
    ],
    'RelatedFindings' => [
        [
            'Id' => '<string>', // REQUIRED
            'ProductArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Severity' => [
        'Label' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
        'Normalized' => <integer>,
        'Product' => <float>,
    ],
    'Types' => ['<string>', ...],
    'UserDefinedFields' => ['<string>', ...],
    'VerificationState' => 'UNKNOWN|TRUE_POSITIVE|FALSE_POSITIVE|BENIGN_POSITIVE',
    'Workflow' => [
        'Status' => 'NEW|NOTIFIED|RESOLVED|SUPPRESSED',
    ],
]);

Parameter Details

Members
Confidence
  • Type: int

The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

Criticality
  • Type: int

The updated value for the level of importance assigned to the resources associated with the findings.

A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

FindingIdentifiers
  • Required: Yes
  • Type: Array of AwsSecurityFindingIdentifier structures

The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.

For each finding, the list provides the finding identifier and the ARN of the finding provider.

Note
  • Type: NoteUpdate structure

The updated note.

RelatedFindings
  • Type: Array of RelatedFinding structures

A list of findings that are related to the updated findings.

Severity
  • Type: SeverityUpdate structure

Used to update the finding severity.

Types
  • Type: Array of strings

One or more finding types in the format of namespace/category/classifier that classify a finding.

Valid namespace values are as follows.

  • Software and Configuration Checks

  • TTPs

  • Effects

  • Unusual Behaviors

  • Sensitive Data Identifications

UserDefinedFields
  • Type: Associative array of custom strings keys (NonEmptyString) to strings

A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

VerificationState
  • Type: string

Indicates the veracity of a finding.

The available values for VerificationState are as follows.

  • UNKNOWN – The default disposition of a security finding

  • TRUE_POSITIVE – The security finding is confirmed

  • FALSE_POSITIVE – The security finding was determined to be a false alarm

  • BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both

Workflow
  • Type: WorkflowUpdate structure

Used to update the workflow status of a finding.

The workflow status indicates the progress of the investigation into the finding.

Result Syntax

[
    'ProcessedFindings' => [
        [
            'Id' => '<string>',
            'ProductArn' => '<string>',
        ],
        // ...
    ],
    'UnprocessedFindings' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'FindingIdentifier' => [
                'Id' => '<string>',
                'ProductArn' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
ProcessedFindings
  • Required: Yes
  • Type: Array of AwsSecurityFindingIdentifier structures

The list of findings that were updated successfully.

UnprocessedFindings
  • Required: Yes
  • Type: Array of BatchUpdateFindingsUnprocessedFinding structures

The list of findings that were not updated.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

CreateActionTarget

$result = $client->createActionTarget([/* ... */]);
$promise = $client->createActionTargetAsync([/* ... */]);

Creates a custom action target in Security Hub.

You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.

Parameter Syntax

$result = $client->createActionTarget([
    'Description' => '<string>', // REQUIRED
    'Id' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
  • Required: Yes
  • Type: string

The description for the custom action target.

Id
  • Required: Yes
  • Type: string

The ID for the custom action target.

Name
  • Required: Yes
  • Type: string

The name of the custom action target.

Result Syntax

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

Result Details

Members
ActionTargetArn
  • Required: Yes
  • Type: string

The ARN for the custom action target.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceConflictException:

    The resource specified in the request conflicts with an existing resource.

CreateInsight

$result = $client->createInsight([/* ... */]);
$promise = $client->createInsightAsync([/* ... */]);

Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation.

To group the related findings in the insight, use the GroupByAttribute.

Parameter Syntax

$result = $client->createInsight([
    'Filters' => [ // REQUIRED
        'AwsAccountId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CompanyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Confidence' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'CreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'Criticality' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'Description' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FirstObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'GeneratorId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Id' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Keyword' => [
            [
                'Value' => '<string>',
            ],
            // ...
        ],
        'LastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'MalwareName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwarePath' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwareState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwareType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationDomain' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationIpV4' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationIpV6' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationPort' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'NetworkDirection' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkProtocol' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceDomain' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceIpV4' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceIpV6' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceMac' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourcePort' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'NoteText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedBy' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ProcessName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessParentPid' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'ProcessPath' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessPid' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'ProcessTerminatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecommendationText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecordState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceImageId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIpV4Addresses' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIpV6Addresses' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceKeyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceSubnetId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceVpcId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyCreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyUserName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsS3BucketOwnerId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsS3BucketOwnerName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerImageId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerImageName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceDetailsOther' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourcePartition' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceRegion' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceTags' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SeverityLabel' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SeverityNormalized' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'SeverityProduct' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'SourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorCategory' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorLastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorSource' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorSourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorValue' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Title' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'UserDefinedFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VerificationState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'GroupByAttribute' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Filters
  • Required: Yes
  • Type: AwsSecurityFindingFilters structure

One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.

GroupByAttribute
  • Required: Yes
  • Type: string

The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.

Name
  • Required: Yes
  • Type: string

The name of the custom insight to create.

Result Syntax

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

Result Details

Members
InsightArn
  • Required: Yes
  • Type: string

The ARN of the insight created.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • ResourceConflictException:

    The resource specified in the request conflicts with an existing resource.

CreateMembers

$result = $client->createMembers([/* ... */]);
$promise = $client->createMembersAsync([/* ... */]);

Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account. If you are integrated with Organizations, then the master account is the Security Hub administrator account that is designated by the organization management account.

CreateMembers is always used to add accounts that are not organization members.

For accounts that are part of an organization, CreateMembers is only used in the following cases:

  • Security Hub is not configured to automatically add new accounts in an organization.

  • The account was disassociated or deleted in Security Hub.

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.

For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.

Accounts that are part of an organization do not receive an invitation. They automatically become a member account in Security Hub.

A permissions policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in a member account, findings are sent to both the member and master accounts.

To remove the association between the master and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

Parameter Syntax

$result = $client->createMembers([
    'AccountDetails' => [ // REQUIRED
        [
            'AccountId' => '<string>', // REQUIRED
            'Email' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
AccountDetails
  • Required: Yes
  • Type: Array of AccountDetails structures

The list of accounts to associate with the Security Hub master account. For each account, the list includes the account ID and optionally the email address.

Result Syntax

[
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'ProcessingResult' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
UnprocessedAccounts
  • Type: Array of Result structures

The list of AWS accounts that were not processed. For each account, the list includes the account ID and the email address.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • ResourceConflictException:

    The resource specified in the request conflicts with an existing resource.

DeclineInvitations

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

Declines invitations to become a member account.

This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.

Parameter Syntax

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

Parameter Details

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

The list of account IDs for the accounts from which to decline the invitations to Security Hub.

Result Syntax

[
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'ProcessingResult' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
UnprocessedAccounts
  • Type: Array of Result structures

The list of AWS accounts that were not processed. For each account, the list includes the account ID and the email address.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

DeleteActionTarget

$result = $client->deleteActionTarget([/* ... */]);
$promise = $client->deleteActionTargetAsync([/* ... */]);

Deletes a custom action target from Security Hub.

Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.

Parameter Syntax

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

Parameter Details

Members
ActionTargetArn
  • Required: Yes
  • Type: string

The ARN of the custom action target to delete.

Result Syntax

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

Result Details

Members
ActionTargetArn
  • Required: Yes
  • Type: string

The ARN of the custom action target that was deleted.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

DeleteInsight

$result = $client->deleteInsight([/* ... */]);
$promise = $client->deleteInsightAsync([/* ... */]);

Deletes the insight specified by the InsightArn.

Parameter Syntax

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

Parameter Details

Members
InsightArn
  • Required: Yes
  • Type: string

The ARN of the insight to delete.

Result Syntax

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

Result Details

Members
InsightArn
  • Required: Yes
  • Type: string

The ARN of the insight that was deleted.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

DeleteInvitations

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

Deletes invitations received by the AWS account to become a member account.

This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.

Parameter Syntax

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

Parameter Details

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

The list of the account IDs that sent the invitations to delete.

Result Syntax

[
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'ProcessingResult' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
UnprocessedAccounts
  • Type: Array of Result structures

The list of AWS accounts for which the invitations were not deleted. For each account, the list includes the account ID and the email address.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

DeleteMembers

$result = $client->deleteMembers([/* ... */]);
$promise = $client->deleteMembersAsync([/* ... */]);

Deletes the specified member accounts from Security Hub.

Can be used to delete member accounts that belong to an organization as well as member accounts that were invited manually.

Parameter Syntax

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

Parameter Details

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

The list of account IDs for the member accounts to delete.

Result Syntax

[
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'ProcessingResult' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
UnprocessedAccounts
  • Type: Array of Result structures

The list of AWS accounts that were not deleted. For each account, the list includes the account ID and the email address.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

DescribeActionTargets

$result = $client->describeActionTargets([/* ... */]);
$promise = $client->describeActionTargetsAsync([/* ... */]);

Returns a list of the custom action targets in Security Hub in your account.

Parameter Syntax

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

Parameter Details

Members
ActionTargetArns
  • Type: Array of strings

A list of custom action target ARNs for the custom action targets to retrieve.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token that is required for pagination. On your first call to the DescribeActionTargets operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Result Syntax

[
    'ActionTargets' => [
        [
            'ActionTargetArn' => '<string>',
            'Description' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ActionTargets
  • Required: Yes
  • Type: Array of ActionTarget structures

A list of ActionTarget objects. Each object includes the ActionTargetArn, Description, and Name of a custom action target available in Security Hub.

NextToken
  • Type: string

The pagination token to use to request the next page of results.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

DescribeHub

$result = $client->describeHub([/* ... */]);
$promise = $client->describeHubAsync([/* ... */]);

Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.

Parameter Syntax

$result = $client->describeHub([
    'HubArn' => '<string>',
]);

Parameter Details

Members
HubArn
  • Type: string

The ARN of the Hub resource to retrieve.

Result Syntax

[
    'AutoEnableControls' => true || false,
    'HubArn' => '<string>',
    'SubscribedAt' => '<string>',
]

Result Details

Members
AutoEnableControls
  • Type: boolean

Whether to automatically enable new controls when they are added to standards that are enabled.

If set to true, then new controls for enabled standards are enabled automatically. If set to false, then new controls are not enabled.

HubArn
  • Type: string

The ARN of the Hub resource that was retrieved.

SubscribedAt
  • Type: string

The date and time when Security Hub was enabled in the account.

Errors

  • InternalException:

    Internal server error.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

DescribeOrganizationConfiguration

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

Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'AutoEnable' => true || false,
    'MemberAccountLimitReached' => true || false,
]

Result Details

Members
AutoEnable
  • Type: boolean

Whether to automatically enable Security Hub for new accounts in the organization.

If set to true, then Security Hub is enabled for new accounts. If set to false, then new accounts are not added automatically.

MemberAccountLimitReached
  • Type: boolean

Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

DescribeProducts

$result = $client->describeProducts([/* ... */]);
$promise = $client->describeProductsAsync([/* ... */]);

Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token that is required for pagination. On your first call to the DescribeProducts operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Result Syntax

[
    'NextToken' => '<string>',
    'Products' => [
        [
            'ActivationUrl' => '<string>',
            'Categories' => ['<string>', ...],
            'CompanyName' => '<string>',
            'Description' => '<string>',
            'IntegrationTypes' => ['<string>', ...],
            'MarketplaceUrl' => '<string>',
            'ProductArn' => '<string>',
            'ProductName' => '<string>',
            'ProductSubscriptionResourcePolicy' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The pagination token to use to request the next page of results.

Products
  • Required: Yes
  • Type: Array of Product structures

A list of products, including details for each product.

Errors

  • InternalException:

    Internal server error.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

DescribeStandards

$result = $client->describeStandards([/* ... */]);
$promise = $client->describeStandardsAsync([/* ... */]);

Returns a list of the available standards in Security Hub.

For each standard, the results include the standard ARN, the name, and a description.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of standards to return.

NextToken
  • Type: string

The token that is required for pagination. On your first call to the DescribeStandards operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Result Syntax

[
    'NextToken' => '<string>',
    'Standards' => [
        [
            'Description' => '<string>',
            'EnabledByDefault' => true || false,
            'Name' => '<string>',
            'StandardsArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The pagination token to use to request the next page of results.

Standards
  • Type: Array of Standard structures

A list of available standards.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

DescribeStandardsControls

$result = $client->describeStandardsControls([/* ... */]);
$promise = $client->describeStandardsControlsAsync([/* ... */]);

Returns a list of security standards controls.

For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of security standard controls to return.

NextToken
  • Type: string

The token that is required for pagination. On your first call to the DescribeStandardsControls operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

StandardsSubscriptionArn
  • Required: Yes
  • Type: string

The ARN of a resource that represents your subscription to a supported standard. To get the subscription ARNs of the standards you have enabled, use the GetEnabledStandards operation.

Result Syntax

[
    'Controls' => [
        [
            'ControlId' => '<string>',
            'ControlStatus' => 'ENABLED|DISABLED',
            'ControlStatusUpdatedAt' => <DateTime>,
            'Description' => '<string>',
            'DisabledReason' => '<string>',
            'RelatedRequirements' => ['<string>', ...],
            'RemediationUrl' => '<string>',
            'SeverityRating' => 'LOW|MEDIUM|HIGH|CRITICAL',
            'StandardsControlArn' => '<string>',
            'Title' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Controls
  • Type: Array of StandardsControl structures

A list of security standards controls.

NextToken
  • Type: string

The pagination token to use to request the next page of results.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

DisableImportFindingsForProduct

$result = $client->disableImportFindingsForProduct([/* ... */]);
$promise = $client->disableImportFindingsForProductAsync([/* ... */]);

Disables the integration of the specified product with Security Hub. After the integration is disabled, findings from that product are no longer sent to Security Hub.

Parameter Syntax

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

Parameter Details

Members
ProductSubscriptionArn
  • Required: Yes
  • Type: string

The ARN of the integrated product to disable the integration for.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

DisableOrganizationAdminAccount

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

Disables a Security Hub administrator account. Can only be called by the organization management account.

Parameter Syntax

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

Parameter Details

Members
AdminAccountId
  • Required: Yes
  • Type: string

The AWS account identifier of the Security Hub administrator account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

DisableSecurityHub

$result = $client->disableSecurityHub([/* ... */]);
$promise = $client->disableSecurityHubAsync([/* ... */]);

Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.

When you disable Security Hub for a master account, it doesn't disable Security Hub for any associated member accounts.

When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your master and member account associations are removed.

If you want to save your existing findings, you must export them before you disable Security Hub.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

DisassociateFromMasterAccount

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

Disassociates the current Security Hub member account from the associated master account.

This operation is only used by accounts that are not part of an organization. For organization accounts, only the master account (the designated Security Hub administrator) can disassociate a member account.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

DisassociateMembers

$result = $client->disassociateMembers([/* ... */]);
$promise = $client->disassociateMembersAsync([/* ... */]);

Disassociates the specified member accounts from the associated master account.

Can be used to disassociate both accounts that are in an organization and accounts that were invited manually.

Parameter Syntax

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

Parameter Details

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

The account IDs of the member accounts to disassociate from the master account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

EnableImportFindingsForProduct

$result = $client->enableImportFindingsForProduct([/* ... */]);
$promise = $client->enableImportFindingsForProductAsync([/* ... */]);

Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub.

When you enable a product integration, a permissions policy that grants permission for the product to send findings to Security Hub is applied.

Parameter Syntax

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

Parameter Details

Members
ProductArn
  • Required: Yes
  • Type: string

The ARN of the product to enable the integration for.

Result Syntax

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

Result Details

Members
ProductSubscriptionArn
  • Type: string

The ARN of your subscription to the product to enable integrations for.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • ResourceConflictException:

    The resource specified in the request conflicts with an existing resource.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

EnableOrganizationAdminAccount

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

Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.

Parameter Syntax

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

Parameter Details

Members
AdminAccountId
  • Required: Yes
  • Type: string

The AWS account identifier of the account to designate as the Security Hub administrator account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

EnableSecurityHub

$result = $client->enableSecurityHub([/* ... */]);
$promise = $client->enableSecurityHubAsync([/* ... */]);

Enables Security Hub for your account in the current Region or the Region you specify in the request.

When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub.

When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the following standards.

  • CIS AWS Foundations

  • AWS Foundational Security Best Practices

You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard.

To not enable the automatically enabled standards, set EnableDefaultStandards to false.

After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation.

To learn more, see Setting Up AWS Security Hub in the AWS Security Hub User Guide.

Parameter Syntax

$result = $client->enableSecurityHub([
    'EnableDefaultStandards' => true || false,
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
EnableDefaultStandards
  • Type: boolean

Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not provide a value for EnableDefaultStandards, it is set to true. To not enable the automatically enabled standards, set EnableDefaultStandards to false.

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

The tags to add to the hub resource when you enable Security Hub.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • ResourceConflictException:

    The resource specified in the request conflicts with an existing resource.

  • AccessDeniedException:

    You don't have permission to perform the action specified in the request.

GetEnabledStandards

$result = $client->getEnabledStandards([/* ... */]);
$promise = $client->getEnabledStandardsAsync([/* ... */]);

Returns a list of the standards that are currently enabled.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of results to return in the response.

NextToken
  • Type: string

The token that is required for pagination. On your first call to the GetEnabledStandards operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

StandardsSubscriptionArns
  • Type: Array of strings

The list of the standards subscription ARNs for the standards to retrieve.

Result Syntax

[
    'NextToken' => '<string>',
    'StandardsSubscriptions' => [
        [
            'StandardsArn' => '<string>',
            'StandardsInput' => ['<string>', ...],
            'StandardsStatus' => 'PENDING|READY|FAILED|DELETING|INCOMPLETE',
            'StandardsSubscriptionArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The pagination token to use to request the next page of results.

StandardsSubscriptions
  • Type: Array of StandardsSubscription structures

The list of StandardsSubscriptions objects that include information about the enabled standards.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

GetFindings

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

Returns a list of findings that match the specified criteria.

Parameter Syntax

$result = $client->getFindings([
    'Filters' => [
        'AwsAccountId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CompanyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Confidence' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'CreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'Criticality' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'Description' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FirstObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'GeneratorId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Id' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Keyword' => [
            [
                'Value' => '<string>',
            ],
            // ...
        ],
        'LastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'MalwareName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwarePath' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwareState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwareType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationDomain' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationIpV4' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationIpV6' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationPort' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'NetworkDirection' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkProtocol' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceDomain' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceIpV4' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceIpV6' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceMac' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourcePort' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'NoteText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedBy' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ProcessName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessParentPid' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'ProcessPath' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessPid' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'ProcessTerminatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecommendationText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecordState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceImageId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIpV4Addresses' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIpV6Addresses' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceKeyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceSubnetId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceVpcId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyCreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyUserName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsS3BucketOwnerId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsS3BucketOwnerName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerImageId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerImageName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceDetailsOther' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourcePartition' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceRegion' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceTags' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SeverityLabel' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SeverityNormalized' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'SeverityProduct' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'SourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorCategory' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorLastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorSource' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorSourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorValue' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Title' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'UserDefinedFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VerificationState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortCriteria' => [
        [
            'Field' => '<string>',
            'SortOrder' => 'asc|desc',
        ],
        // ...
    ],
]);

Parameter Details

Members
Filters
  • Type: AwsSecurityFindingFilters structure

The finding attributes used to define a condition to filter the returned findings.

You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.

Note that in the available filter fields, WorkflowState is deprecated. To search for a finding based on its workflow status, use WorkflowStatus.

MaxResults
  • Type: int

The maximum number of findings to return.

NextToken
  • Type: string

The token that is required for pagination. On your first call to the GetFindings operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

SortCriteria
  • Type: Array of SortCriterion structures

The finding attributes used to sort the list of returned findings.

Result Syntax

[
    'Findings' => [
        [
            'Action' => [
                'ActionType' => '<string>',
                'AwsApiCallAction' => [
                    'AffectedResources' => ['<string>', ...],
                    'Api' => '<string>',
                    'CallerType' => '<string>',
                    'DomainDetails' => [
                        'Domain' => '<string>',
                    ],
                    'FirstSeen' => '<string>',
                    'LastSeen' => '<string>',
                    'RemoteIpDetails' => [
                        'City' => [
                            'CityName' => '<string>',
                        ],
                        'Country' => [
                            'CountryCode' => '<string>',
                            'CountryName' => '<string>',
                        ],
                        'GeoLocation' => [
                            'Lat' => <float>,
                            'Lon' => <float>,
                        ],
                        'IpAddressV4' => '<string>',
                        'Organization' => [
                            'Asn' => <integer>,
                            'AsnOrg' => '<string>',
                            'Isp' => '<string>',
                            'Org' => '<string>',
                        ],
                    ],
                    'ServiceName' => '<string>',
                ],
                'DnsRequestAction' => [
                    'Blocked' => true || false,
                    'Domain' => '<string>',
                    'Protocol' => '<string>',
                ],
                'NetworkConnectionAction' => [
                    'Blocked' => true || false,
                    'ConnectionDirection' => '<string>',
                    'LocalPortDetails' => [
                        'Port' => <integer>,
                        'PortName' => '<string>',
                    ],
                    'Protocol' => '<string>',
                    'RemoteIpDetails' => [
                        'City' => [
                            'CityName' => '<string>',
                        ],
                        'Country' => [
                            'CountryCode' => '<string>',
                            'CountryName' => '<string>',
                        ],
                        'GeoLocation' => [
                            'Lat' => <float>,
                            'Lon' => <float>,
                        ],
                        'IpAddressV4' => '<string>',
                        'Organization' => [
                            'Asn' => <integer>,
                            'AsnOrg' => '<string>',
                            'Isp' => '<string>',
                            'Org' => '<string>',
                        ],
                    ],
                    'RemotePortDetails' => [
                        'Port' => <integer>,
                        'PortName' => '<string>',
                    ],
                ],
                'PortProbeAction' => [
                    'Blocked' => true || false,
                    'PortProbeDetails' => [
                        [
                            'LocalIpDetails' => [
                                'IpAddressV4' => '<string>',
                            ],
                            'LocalPortDetails' => [
                                'Port' => <integer>,
                                'PortName' => '<string>',
                            ],
                            'RemoteIpDetails' => [
                                'City' => [
                                    'CityName' => '<string>',
                                ],
                                'Country' => [
                                    'CountryCode' => '<string>',
                                    'CountryName' => '<string>',
                                ],
                                'GeoLocation' => [
                                    'Lat' => <float>,
                                    'Lon' => <float>,
                                ],
                                'IpAddressV4' => '<string>',
                                'Organization' => [
                                    'Asn' => <integer>,
                                    'AsnOrg' => '<string>',
                                    'Isp' => '<string>',
                                    'Org' => '<string>',
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'AwsAccountId' => '<string>',
            'Compliance' => [
                'RelatedRequirements' => ['<string>', ...],
                'Status' => 'PASSED|WARNING|FAILED|NOT_AVAILABLE',
                'StatusReasons' => [
                    [
                        'Description' => '<string>',
                        'ReasonCode' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Confidence' => <integer>,
            'CreatedAt' => '<string>',
            'Criticality' => <integer>,
            'Description' => '<string>',
            'FirstObservedAt' => '<string>',
            'GeneratorId' => '<string>',
            'Id' => '<string>',
            'LastObservedAt' => '<string>',
            'Malware' => [
                [
                    'Name' => '<string>',
                    'Path' => '<string>',
                    'State' => 'OBSERVED|REMOVAL_FAILED|REMOVED',
                    'Type' => 'ADWARE|BLENDED_THREAT|BOTNET_AGENT|COIN_MINER|EXPLOIT_KIT|KEYLOGGER|MACRO|POTENTIALLY_UNWANTED|SPYWARE|RANSOMWARE|REMOTE_ACCESS|ROOTKIT|TROJAN|VIRUS|WORM',
                ],
                // ...
            ],
            'Network' => [
                'DestinationDomain' => '<string>',
                'DestinationIpV4' => '<string>',
                'DestinationIpV6' => '<string>',
                'DestinationPort' => <integer>,
                'Direction' => 'IN|OUT',
                'OpenPortRange' => [
                    'Begin' => <integer>,
                    'End' => <integer>,
                ],
                'Protocol' => '<string>',
                'SourceDomain' => '<string>',
                'SourceIpV4' => '<string>',
                'SourceIpV6' => '<string>',
                'SourceMac' => '<string>',
                'SourcePort' => <integer>,
            ],
            'NetworkPath' => [
                [
                    'ComponentId' => '<string>',
                    'ComponentType' => '<string>',
                    'Egress' => [
                        'Destination' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'Protocol' => '<string>',
                        'Source' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'Ingress' => [
                        'Destination' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'Protocol' => '<string>',
                        'Source' => [
                            'Address' => ['<string>', ...],
                            'PortRanges' => [
                                [
                                    'Begin' => <integer>,
                                    'End' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                    ],
                ],
                // ...
            ],
            'Note' => [
                'Text' => '<string>',
                'UpdatedAt' => '<string>',
                'UpdatedBy' => '<string>',
            ],
            'PatchSummary' => [
                'FailedCount' => <integer>,
                'Id' => '<string>',
                'InstalledCount' => <integer>,
                'InstalledOtherCount' => <integer>,
                'InstalledPendingReboot' => <integer>,
                'InstalledRejectedCount' => <integer>,
                'MissingCount' => <integer>,
                'Operation' => '<string>',
                'OperationEndTime' => '<string>',
                'OperationStartTime' => '<string>',
                'RebootOption' => '<string>',
            ],
            'Process' => [
                'LaunchedAt' => '<string>',
                'Name' => '<string>',
                'ParentPid' => <integer>,
                'Path' => '<string>',
                'Pid' => <integer>,
                'TerminatedAt' => '<string>',
            ],
            'ProductArn' => '<string>',
            'ProductFields' => ['<string>', ...],
            'RecordState' => 'ACTIVE|ARCHIVED',
            'RelatedFindings' => [
                [
                    'Id' => '<string>',
                    'ProductArn' => '<string>',
                ],
                // ...
            ],
            'Remediation' => [
                'Recommendation' => [
                    'Text' => '<string>',
                    'Url' => '<string>',
                ],
            ],
            'Resources' => [
                [
                    'Details' => [
                        'AwsApiGatewayRestApi' => [
                            'ApiKeySource' => '<string>',
                            'BinaryMediaTypes' => ['<string>', ...],
                            'CreatedDate' => '<string>',
                            'Description' => '<string>',
                            'EndpointConfiguration' => [
                                'Types' => ['<string>', ...],
                            ],
                            'Id' => '<string>',
                            'MinimumCompressionSize' => <integer>,
                            'Name' => '<string>',
                            'Version' => '<string>',
                        ],
                        'AwsApiGatewayStage' => [
                            'AccessLogSettings' => [
                                'DestinationArn' => '<string>',
                                'Format' => '<string>',
                            ],
                            'CacheClusterEnabled' => true || false,
                            'CacheClusterSize' => '<string>',
                            'CacheClusterStatus' => '<string>',
                            'CanarySettings' => [
                                'DeploymentId' => '<string>',
                                'PercentTraffic' => <float>,
                                'StageVariableOverrides' => ['<string>', ...],
                                'UseStageCache' => true || false,
                            ],
                            'ClientCertificateId' => '<string>',
                            'CreatedDate' => '<string>',
                            'DeploymentId' => '<string>',
                            'Description' => '<string>',
                            'DocumentationVersion' => '<string>',
                            'LastUpdatedDate' => '<string>',
                            'MethodSettings' => [
                                [
                                    'CacheDataEncrypted' => true || false,
                                    'CacheTtlInSeconds' => <integer>,
                                    'CachingEnabled' => true || false,
                                    'DataTraceEnabled' => true || false,
                                    'HttpMethod' => '<string>',
                                    'LoggingLevel' => '<string>',
                                    'MetricsEnabled' => true || false,
                                    'RequireAuthorizationForCacheControl' => true || false,
                                    'ResourcePath' => '<string>',
                                    'ThrottlingBurstLimit' => <integer>,
                                    'ThrottlingRateLimit' => <float>,
                                    'UnauthorizedCacheControlHeaderStrategy' => '<string>',
                                ],
                                // ...
                            ],
                            'StageName' => '<string>',
                            'TracingEnabled' => true || false,
                            'Variables' => ['<string>', ...],
                            'WebAclArn' => '<string>',
                        ],
                        'AwsApiGatewayV2Api' => [
                            'ApiEndpoint' => '<string>',
                            'ApiId' => '<string>',
                            'ApiKeySelectionExpression' => '<string>',
                            'CorsConfiguration' => [
                                'AllowCredentials' => true || false,
                                'AllowHeaders' => ['<string>', ...],
                                'AllowMethods' => ['<string>', ...],
                                'AllowOrigins' => ['<string>', ...],
                                'ExposeHeaders' => ['<string>', ...],
                                'MaxAge' => <integer>,
                            ],
                            'CreatedDate' => '<string>',
                            'Description' => '<string>',
                            'Name' => '<string>',
                            'ProtocolType' => '<string>',
                            'RouteSelectionExpression' => '<string>',
                            'Version' => '<string>',
                        ],
                        'AwsApiGatewayV2Stage' => [
                            'AccessLogSettings' => [
                                'DestinationArn' => '<string>',
                                'Format' => '<string>',
                            ],
                            'ApiGatewayManaged' => true || false,
                            'AutoDeploy' => true || false,
                            'CreatedDate' => '<string>',
                            'DefaultRouteSettings' => [
                                'DataTraceEnabled' => true || false,
                                'DetailedMetricsEnabled' => true || false,
                                'LoggingLevel' => '<string>',
                                'ThrottlingBurstLimit' => <integer>,
                                'ThrottlingRateLimit' => <float>,
                            ],
                            'DeploymentId' => '<string>',
                            'Description' => '<string>',
                            'LastDeploymentStatusMessage' => '<string>',
                            'LastUpdatedDate' => '<string>',
                            'RouteSettings' => [
                                'DataTraceEnabled' => true || false,
                                'DetailedMetricsEnabled' => true || false,
                                'LoggingLevel' => '<string>',
                                'ThrottlingBurstLimit' => <integer>,
                                'ThrottlingRateLimit' => <float>,
                            ],
                            'StageName' => '<string>',
                            'StageVariables' => ['<string>', ...],
                        ],
                        'AwsAutoScalingAutoScalingGroup' => [
                            'CreatedTime' => '<string>',
                            'HealthCheckGracePeriod' => <integer>,
                            'HealthCheckType' => '<string>',
                            'LaunchConfigurationName' => '<string>',
                            'LoadBalancerNames' => ['<string>', ...],
                        ],
                        'AwsCertificateManagerCertificate' => [
                            'CertificateAuthorityArn' => '<string>',
                            'CreatedAt' => '<string>',
                            'DomainName' => '<string>',
                            'DomainValidationOptions' => [
                                [
                                    'DomainName' => '<string>',
                                    'ResourceRecord' => [
                                        'Name' => '<string>',
                                        'Type' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    'ValidationDomain' => '<string>',
                                    'ValidationEmails' => ['<string>', ...],
                                    'ValidationMethod' => '<string>',
                                    'ValidationStatus' => '<string>',
                                ],
                                // ...
                            ],
                            'ExtendedKeyUsages' => [
                                [
                                    'Name' => '<string>',
                                    'OId' => '<string>',
                                ],
                                // ...
                            ],
                            'FailureReason' => '<string>',
                            'ImportedAt' => '<string>',
                            'InUseBy' => ['<string>', ...],
                            'IssuedAt' => '<string>',
                            'Issuer' => '<string>',
                            'KeyAlgorithm' => '<string>',
                            'KeyUsages' => [
                                [
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                            'NotAfter' => '<string>',
                            'NotBefore' => '<string>',
                            'Options' => [
                                'CertificateTransparencyLoggingPreference' => '<string>',
                            ],
                            'RenewalEligibility' => '<string>',
                            'RenewalSummary' => [
                                'DomainValidationOptions' => [
                                    [
                                        'DomainName' => '<string>',
                                        'ResourceRecord' => [
                                            'Name' => '<string>',
                                            'Type' => '<string>',
                                            'Value' => '<string>',
                                        ],
                                        'ValidationDomain' => '<string>',
                                        'ValidationEmails' => ['<string>', ...],
                                        'ValidationMethod' => '<string>',
                                        'ValidationStatus' => '<string>',
                                    ],
                                    // ...
                                ],
                                'RenewalStatus' => '<string>',
                                'RenewalStatusReason' => '<string>',
                                'UpdatedAt' => '<string>',
                            ],
                            'Serial' => '<string>',
                            'SignatureAlgorithm' => '<string>',
                            'Status' => '<string>',
                            'Subject' => '<string>',
                            'SubjectAlternativeNames' => ['<string>', ...],
                            'Type' => '<string>',
                        ],
                        'AwsCloudFrontDistribution' => [
                            'CacheBehaviors' => [
                                'Items' => [
                                    [
                                        'ViewerProtocolPolicy' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'DefaultCacheBehavior' => [
                                'ViewerProtocolPolicy' => '<string>',
                            ],
                            'DefaultRootObject' => '<string>',
                            'DomainName' => '<string>',
                            'ETag' => '<string>',
                            'LastModifiedTime' => '<string>',
                            'Logging' => [
                                'Bucket' => '<string>',
                                'Enabled' => true || false,
                                'IncludeCookies' => true || false,
                                'Prefix' => '<string>',
                            ],
                            'OriginGroups' => [
                                'Items' => [
                                    [
                                        'FailoverCriteria' => [
                                            'StatusCodes' => [
                                                'Items' => [<integer>, ...],
                                                'Quantity' => <integer>,
                                            ],
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                            'Origins' => [
                                'Items' => [
                                    [
                                        'DomainName' => '<string>',
                                        'Id' => '<string>',
                                        'OriginPath' => '<string>',
                                        'S3OriginConfig' => [
                                            'OriginAccessIdentity' => '<string>',
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                            'Status' => '<string>',
                            'WebAclId' => '<string>',
                        ],
                        'AwsCloudTrailTrail' => [
                            'CloudWatchLogsLogGroupArn' => '<string>',
                            'CloudWatchLogsRoleArn' => '<string>',
                            'HasCustomEventSelectors' => true || false,
                            'HomeRegion' => '<string>',
                            'IncludeGlobalServiceEvents' => true || false,
                            'IsMultiRegionTrail' => true || false,
                            'IsOrganizationTrail' => true || false,
                            'KmsKeyId' => '<string>',
                            'LogFileValidationEnabled' => true || false,
                            'Name' => '<string>',
                            'S3BucketName' => '<string>',
                            'S3KeyPrefix' => '<string>',
                            'SnsTopicArn' => '<string>',
                            'SnsTopicName' => '<string>',
                            'TrailArn' => '<string>',
                        ],
                        'AwsCodeBuildProject' => [
                            'EncryptionKey' => '<string>',
                            'Environment' => [
                                'Certificate' => '<string>',
                                'ImagePullCredentialsType' => '<string>',
                                'RegistryCredential' => [
                                    'Credential' => '<string>',
                                    'CredentialProvider' => '<string>',
                                ],
                                'Type' => '<string>',
                            ],
                            'Name' => '<string>',
                            'ServiceRole' => '<string>',
                            'Source' => [
                                'GitCloneDepth' => <integer>,
                                'InsecureSsl' => true || false,
                                'Location' => '<string>',
                                'Type' => '<string>',
                            ],
                            'VpcConfig' => [
                                'SecurityGroupIds' => ['<string>', ...],
                                'Subnets' => ['<string>', ...],
                                'VpcId' => '<string>',
                            ],
                        ],
                        'AwsDynamoDbTable' => [
                            'AttributeDefinitions' => [
                                [
                                    'AttributeName' => '<string>',
                                    'AttributeType' => '<string>',
                                ],
                                // ...
                            ],
                            'BillingModeSummary' => [
                                'BillingMode' => '<string>',
                                'LastUpdateToPayPerRequestDateTime' => '<string>',
                            ],
                            'CreationDateTime' => '<string>',
                            'GlobalSecondaryIndexes' => [
                                [
                                    'Backfilling' => true || false,
                                    'IndexArn' => '<string>',
                                    'IndexName' => '<string>',
                                    'IndexSizeBytes' => <integer>,
                                    'IndexStatus' => '<string>',
                                    'ItemCount' => <integer>,
                                    'KeySchema' => [
                                        [
                                            'AttributeName' => '<string>',
                                            'KeyType' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Projection' => [
                                        'NonKeyAttributes' => ['<string>', ...],
                                        'ProjectionType' => '<string>',
                                    ],
                                    'ProvisionedThroughput' => [
                                        'LastDecreaseDateTime' => '<string>',
                                        'LastIncreaseDateTime' => '<string>',
                                        'NumberOfDecreasesToday' => <integer>,
                                        'ReadCapacityUnits' => <integer>,
                                        'WriteCapacityUnits' => <integer>,
                                    ],
                                ],
                                // ...
                            ],
                            'GlobalTableVersion' => '<string>',
                            'ItemCount' => <integer>,
                            'KeySchema' => [
                                [
                                    'AttributeName' => '<string>',
                                    'KeyType' => '<string>',
                                ],
                                // ...
                            ],
                            'LatestStreamArn' => '<string>',
                            'LatestStreamLabel' => '<string>',
                            'LocalSecondaryIndexes' => [
                                [
                                    'IndexArn' => '<string>',
                                    'IndexName' => '<string>',
                                    'KeySchema' => [
                                        [
                                            'AttributeName' => '<string>',
                                            'KeyType' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Projection' => [
                                        'NonKeyAttributes' => ['<string>', ...],
                                        'ProjectionType' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'ProvisionedThroughput' => [
                                'LastDecreaseDateTime' => '<string>',
                                'LastIncreaseDateTime' => '<string>',
                                'NumberOfDecreasesToday' => <integer>,
                                'ReadCapacityUnits' => <integer>,
                                'WriteCapacityUnits' => <integer>,
                            ],
                            'Replicas' => [
                                [
                                    'GlobalSecondaryIndexes' => [
                                        [
                                            'IndexName' => '<string>',
                                            'ProvisionedThroughputOverride' => [
                                                'ReadCapacityUnits' => <integer>,
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'KmsMasterKeyId' => '<string>',
                                    'ProvisionedThroughputOverride' => [
                                        'ReadCapacityUnits' => <integer>,
                                    ],
                                    'RegionName' => '<string>',
                                    'ReplicaStatus' => '<string>',
                                    'ReplicaStatusDescription' => '<string>',
                                ],
                                // ...
                            ],
                            'RestoreSummary' => [
                                'RestoreDateTime' => '<string>',
                                'RestoreInProgress' => true || false,
                                'SourceBackupArn' => '<string>',
                                'SourceTableArn' => '<string>',
                            ],
                            'SseDescription' => [
                                'InaccessibleEncryptionDateTime' => '<string>',
                                'KmsMasterKeyArn' => '<string>',
                                'SseType' => '<string>',
                                'Status' => '<string>',
                            ],
                            'StreamSpecification' => [
                                'StreamEnabled' => true || false,
                                'StreamViewType' => '<string>',
                            ],
                            'TableId' => '<string>',
                            'TableName' => '<string>',
                            'TableSizeBytes' => <integer>,
                            'TableStatus' => '<string>',
                        ],
                        'AwsEc2Eip' => [
                            'AllocationId' => '<string>',
                            'AssociationId' => '<string>',
                            'Domain' => '<string>',
                            'InstanceId' => '<string>',
                            'NetworkBorderGroup' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'NetworkInterfaceOwnerId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'PublicIp' => '<string>',
                            'PublicIpv4Pool' => '<string>',
                        ],
                        'AwsEc2Instance' => [
                            'IamInstanceProfileArn' => '<string>',
                            'ImageId' => '<string>',
                            'IpV4Addresses' => ['<string>', ...],
                            'IpV6Addresses' => ['<string>', ...],
                            'KeyName' => '<string>',
                            'LaunchedAt' => '<string>',
                            'SubnetId' => '<string>',
                            'Type' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsEc2NetworkInterface' => [
                            'Attachment' => [
                                'AttachTime' => '<string>',
                                'AttachmentId' => '<string>',
                                'DeleteOnTermination' => true || false,
                                'DeviceIndex' => <integer>,
                                'InstanceId' => '<string>',
                                'InstanceOwnerId' => '<string>',
                                'Status' => '<string>',
                            ],
                            'IpV6Addresses' => [
                                [
                                    'IpV6Address' => '<string>',
                                ],
                                // ...
                            ],
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddresses' => [
                                [
                                    'PrivateDnsName' => '<string>',
                                    'PrivateIpAddress' => '<string>',
                                ],
                                // ...
                            ],
                            'PublicDnsName' => '<string>',
                            'PublicIp' => '<string>',
                            'SecurityGroups' => [
                                [
                                    'GroupId' => '<string>',
                                    'GroupName' => '<string>',
                                ],
                                // ...
                            ],
                            'SourceDestCheck' => true || false,
                        ],
                        'AwsEc2SecurityGroup' => [
                            'GroupId' => '<string>',
                            'GroupName' => '<string>',
                            'IpPermissions' => [
                                [
                                    'FromPort' => <integer>,
                                    'IpProtocol' => '<string>',
                                    'IpRanges' => [
                                        [
                                            'CidrIp' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Ipv6Ranges' => [
                                        [
                                            'CidrIpv6' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'PrefixListIds' => [
                                        [
                                            'PrefixListId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ToPort' => <integer>,
                                    'UserIdGroupPairs' => [
                                        [
                                            'GroupId' => '<string>',
                                            'GroupName' => '<string>',
                                            'PeeringStatus' => '<string>',
                                            'UserId' => '<string>',
                                            'VpcId' => '<string>',
                                            'VpcPeeringConnectionId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'IpPermissionsEgress' => [
                                [
                                    'FromPort' => <integer>,
                                    'IpProtocol' => '<string>',
                                    'IpRanges' => [
                                        [
                                            'CidrIp' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Ipv6Ranges' => [
                                        [
                                            'CidrIpv6' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'PrefixListIds' => [
                                        [
                                            'PrefixListId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ToPort' => <integer>,
                                    'UserIdGroupPairs' => [
                                        [
                                            'GroupId' => '<string>',
                                            'GroupName' => '<string>',
                                            'PeeringStatus' => '<string>',
                                            'UserId' => '<string>',
                                            'VpcId' => '<string>',
                                            'VpcPeeringConnectionId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'OwnerId' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsEc2Volume' => [
                            'Attachments' => [
                                [
                                    'AttachTime' => '<string>',
                                    'DeleteOnTermination' => true || false,
                                    'InstanceId' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'CreateTime' => '<string>',
                            'Encrypted' => true || false,
                            'KmsKeyId' => '<string>',
                            'Size' => <integer>,
                            'SnapshotId' => '<string>',
                            'Status' => '<string>',
                        ],
                        'AwsEc2Vpc' => [
                            'CidrBlockAssociationSet' => [
                                [
                                    'AssociationId' => '<string>',
                                    'CidrBlock' => '<string>',
                                    'CidrBlockState' => '<string>',
                                ],
                                // ...
                            ],
                            'DhcpOptionsId' => '<string>',
                            'Ipv6CidrBlockAssociationSet' => [
                                [
                                    'AssociationId' => '<string>',
                                    'CidrBlockState' => '<string>',
                                    'Ipv6CidrBlock' => '<string>',
                                ],
                                // ...
                            ],
                            'State' => '<string>',
                        ],
                        'AwsElasticsearchDomain' => [
                            'AccessPolicies' => '<string>',
                            'DomainEndpointOptions' => [
                                'EnforceHTTPS' => true || false,
                                'TLSSecurityPolicy' => '<string>',
                            ],
                            'DomainId' => '<string>',
                            'DomainName' => '<string>',
                            'ElasticsearchVersion' => '<string>',
                            'EncryptionAtRestOptions' => [
                                'Enabled' => true || false,
                                'KmsKeyId' => '<string>',
                            ],
                            'Endpoint' => '<string>',
                            'Endpoints' => ['<string>', ...],
                            'NodeToNodeEncryptionOptions' => [
                                'Enabled' => true || false,
                            ],
                            'VPCOptions' => [
                                'AvailabilityZones' => ['<string>', ...],
                                'SecurityGroupIds' => ['<string>', ...],
                                'SubnetIds' => ['<string>', ...],
                                'VPCId' => '<string>',
                            ],
                        ],
                        'AwsElbLoadBalancer' => [
                            'AvailabilityZones' => ['<string>', ...],
                            'BackendServerDescriptions' => [
                                [
                                    'InstancePort' => <integer>,
                                    'PolicyNames' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'CanonicalHostedZoneName' => '<string>',
                            'CanonicalHostedZoneNameID' => '<string>',
                            'CreatedTime' => '<string>',
                            'DnsName' => '<string>',
                            'HealthCheck' => [
                                'HealthyThreshold' => <integer>,
                                'Interval' => <integer>,
                                'Target' => '<string>',
                                'Timeout' => <integer>,
                                'UnhealthyThreshold' => <integer>,
                            ],
                            'Instances' => [
                                [
                                    'InstanceId' => '<string>',
                                ],
                                // ...
                            ],
                            'ListenerDescriptions' => [
                                [
                                    'Listener' => [
                                        'InstancePort' => <integer>,
                                        'InstanceProtocol' => '<string>',
                                        'LoadBalancerPort' => <integer>,
                                        'Protocol' => '<string>',
                                        'SslCertificateId' => '<string>',
                                    ],
                                    'PolicyNames' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'LoadBalancerAttributes' => [
                                'AccessLog' => [
                                    'EmitInterval' => <integer>,
                                    'Enabled' => true || false,
                                    'S3BucketName' => '<string>',
                                    'S3BucketPrefix' => '<string>',
                                ],
                                'ConnectionDraining' => [
                                    'Enabled' => true || false,
                                    'Timeout' => <integer>,
                                ],
                                'ConnectionSettings' => [
                                    'IdleTimeout' => <integer>,
                                ],
                                'CrossZoneLoadBalancing' => [
                                    'Enabled' => true || false,
                                ],
                            ],
                            'LoadBalancerName' => '<string>',
                            'Policies' => [
                                'AppCookieStickinessPolicies' => [
                                    [
                                        'CookieName' => '<string>',
                                        'PolicyName' => '<string>',
                                    ],
                                    // ...
                                ],
                                'LbCookieStickinessPolicies' => [
                                    [
                                        'CookieExpirationPeriod' => <integer>,
                                        'PolicyName' => '<string>',
                                    ],
                                    // ...
                                ],
                                'OtherPolicies' => ['<string>', ...],
                            ],
                            'Scheme' => '<string>',
                            'SecurityGroups' => ['<string>', ...],
                            'SourceSecurityGroup' => [
                                'GroupName' => '<string>',
                                'OwnerAlias' => '<string>',
                            ],
                            'Subnets' => ['<string>', ...],
                            'VpcId' => '<string>',
                        ],
                        'AwsElbv2LoadBalancer' => [
                            'AvailabilityZones' => [
                                [
                                    'SubnetId' => '<string>',
                                    'ZoneName' => '<string>',
                                ],
                                // ...
                            ],
                            'CanonicalHostedZoneId' => '<string>',
                            'CreatedTime' => '<string>',
                            'DNSName' => '<string>',
                            'IpAddressType' => '<string>',
                            'Scheme' => '<string>',
                            'SecurityGroups' => ['<string>', ...],
                            'State' => [
                                'Code' => '<string>',
                                'Reason' => '<string>',
                            ],
                            'Type' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsIamAccessKey' => [
                            'AccessKeyId' => '<string>',
                            'AccountId' => '<string>',
                            'CreatedAt' => '<string>',
                            'PrincipalId' => '<string>',
                            'PrincipalName' => '<string>',
                            'PrincipalType' => '<string>',
                            'SessionContext' => [
                                'Attributes' => [
                                    'CreationDate' => '<string>',
                                    'MfaAuthenticated' => true || false,
                                ],
                                'SessionIssuer' => [
                                    'AccountId' => '<string>',
                                    'Arn' => '<string>',
                                    'PrincipalId' => '<string>',
                                    'Type' => '<string>',
                                    'UserName' => '<string>',
                                ],
                            ],
                            'Status' => 'Active|Inactive',
                            'UserName' => '<string>',
                        ],
                        'AwsIamGroup' => [
                            'AttachedManagedPolicies' => [
                                [
                                    'PolicyArn' => '<string>',
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                            'CreateDate' => '<string>',
                            'GroupId' => '<string>',
                            'GroupName' => '<string>',
                            'GroupPolicyList' => [
                                [
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                            'Path' => '<string>',
                        ],
                        'AwsIamPolicy' => [
                            'AttachmentCount' => <integer>,
                            'CreateDate' => '<string>',
                            'DefaultVersionId' => '<string>',
                            'Description' => '<string>',
                            'IsAttachable' => true || false,
                            'Path' => '<string>',
                            'PermissionsBoundaryUsageCount' => <integer>,
                            'PolicyId' => '<string>',
                            'PolicyName' => '<string>',
                            'PolicyVersionList' => [
                                [
                                    'CreateDate' => '<string>',
                                    'IsDefaultVersion' => true || false,
                                    'VersionId' => '<string>',
                                ],
                                // ...
                            ],
                            'UpdateDate' => '<string>',
                        ],
                        'AwsIamRole' => [
                            'AssumeRolePolicyDocument' => '<string>',
                            'AttachedManagedPolicies' => [
                                [
                                    'PolicyArn' => '<string>',
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                            'CreateDate' => '<string>',
                            'InstanceProfileList' => [
                                [
                                    'Arn' => '<string>',
                                    'CreateDate' => '<string>',
                                    'InstanceProfileId' => '<string>',
                                    'InstanceProfileName' => '<string>',
                                    'Path' => '<string>',
                                    'Roles' => [
                                        [
                                            'Arn' => '<string>',
                                            'AssumeRolePolicyDocument' => '<string>',
                                            'CreateDate' => '<string>',
                                            'Path' => '<string>',
                                            'RoleId' => '<string>',
                                            'RoleName' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'MaxSessionDuration' => <integer>,
                            'Path' => '<string>',
                            'PermissionsBoundary' => [
                                'PermissionsBoundaryArn' => '<string>',
                                'PermissionsBoundaryType' => '<string>',
                            ],
                            'RoleId' => '<string>',
                            'RoleName' => '<string>',
                            'RolePolicyList' => [
                                [
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsIamUser' => [
                            'AttachedManagedPolicies' => [
                                [
                                    'PolicyArn' => '<string>',
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                            'CreateDate' => '<string>',
                            'GroupList' => ['<string>', ...],
                            'Path' => '<string>',
                            'PermissionsBoundary' => [
                                'PermissionsBoundaryArn' => '<string>',
                                'PermissionsBoundaryType' => '<string>',
                            ],
                            'UserId' => '<string>',
                            'UserName' => '<string>',
                            'UserPolicyList' => [
                                [
                                    'PolicyName' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsKmsKey' => [
                            'AWSAccountId' => '<string>',
                            'CreationDate' => <float>,
                            'Description' => '<string>',
                            'KeyId' => '<string>',
                            'KeyManager' => '<string>',
                            'KeyState' => '<string>',
                            'Origin' => '<string>',
                        ],
                        'AwsLambdaFunction' => [
                            'Code' => [
                                'S3Bucket' => '<string>',
                                'S3Key' => '<string>',
                                'S3ObjectVersion' => '<string>',
                                'ZipFile' => '<string>',
                            ],
                            'CodeSha256' => '<string>',
                            'DeadLetterConfig' => [
                                'TargetArn' => '<string>',
                            ],
                            'Environment' => [
                                'Error' => [
                                    'ErrorCode' => '<string>',
                                    'Message' => '<string>',
                                ],
                                'Variables' => ['<string>', ...],
                            ],
                            'FunctionName' => '<string>',
                            'Handler' => '<string>',
                            'KmsKeyArn' => '<string>',
                            'LastModified' => '<string>',
                            'Layers' => [
                                [
                                    'Arn' => '<string>',
                                    'CodeSize' => <integer>,
                                ],
                                // ...
                            ],
                            'MasterArn' => '<string>',
                            'MemorySize' => <integer>,
                            'RevisionId' => '<string>',
                            'Role' => '<string>',
                            'Runtime' => '<string>',
                            'Timeout' => <integer>,
                            'TracingConfig' => [
                                'Mode' => '<string>',
                            ],
                            'Version' => '<string>',
                            'VpcConfig' => [
                                'SecurityGroupIds' => ['<string>', ...],
                                'SubnetIds' => ['<string>', ...],
                                'VpcId' => '<string>',
                            ],
                        ],
                        'AwsLambdaLayerVersion' => [
                            'CompatibleRuntimes' => ['<string>', ...],
                            'CreatedDate' => '<string>',
                            'Version' => <integer>,
                        ],
                        'AwsRdsDbCluster' => [
                            'ActivityStreamStatus' => '<string>',
                            'AllocatedStorage' => <integer>,
                            'AssociatedRoles' => [
                                [
                                    'RoleArn' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'AvailabilityZones' => ['<string>', ...],
                            'BackupRetentionPeriod' => <integer>,
                            'ClusterCreateTime' => '<string>',
                            'CopyTagsToSnapshot' => true || false,
                            'CrossAccountClone' => true || false,
                            'CustomEndpoints' => ['<string>', ...],
                            'DatabaseName' => '<string>',
                            'DbClusterIdentifier' => '<string>',
                            'DbClusterMembers' => [
                                [
                                    'DbClusterParameterGroupStatus' => '<string>',
                                    'DbInstanceIdentifier' => '<string>',
                                    'IsClusterWriter' => true || false,
                                    'PromotionTier' => <integer>,
                                ],
                                // ...
                            ],
                            'DbClusterOptionGroupMemberships' => [
                                [
                                    'DbClusterOptionGroupName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'DbClusterParameterGroup' => '<string>',
                            'DbClusterResourceId' => '<string>',
                            'DbSubnetGroup' => '<string>',
                            'DeletionProtection' => true || false,
                            'DomainMemberships' => [
                                [
                                    'Domain' => '<string>',
                                    'Fqdn' => '<string>',
                                    'IamRoleName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'EnabledCloudWatchLogsExports' => ['<string>', ...],
                            'Endpoint' => '<string>',
                            'Engine' => '<string>',
                            'EngineMode' => '<string>',
                            'EngineVersion' => '<string>',
                            'HostedZoneId' => '<string>',
                            'HttpEndpointEnabled' => true || false,
                            'IamDatabaseAuthenticationEnabled' => true || false,
                            'KmsKeyId' => '<string>',
                            'MasterUsername' => '<string>',
                            'MultiAz' => true || false,
                            'Port' => <integer>,
                            'PreferredBackupWindow' => '<string>',
                            'PreferredMaintenanceWindow' => '<string>',
                            'ReadReplicaIdentifiers' => ['<string>', ...],
                            'ReaderEndpoint' => '<string>',
                            'Status' => '<string>',
                            'StorageEncrypted' => true || false,
                            'VpcSecurityGroups' => [
                                [
                                    'Status' => '<string>',
                                    'VpcSecurityGroupId' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsRdsDbClusterSnapshot' => [
                            'AllocatedStorage' => <integer>,
                            'AvailabilityZones' => ['<string>', ...],
                            'ClusterCreateTime' => '<string>',
                            'DbClusterIdentifier' => '<string>',
                            'DbClusterSnapshotIdentifier' => '<string>',
                            'Engine' => '<string>',
                            'EngineVersion' => '<string>',
                            'IamDatabaseAuthenticationEnabled' => true || false,
                            'KmsKeyId' => '<string>',
                            'LicenseModel' => '<string>',
                            'MasterUsername' => '<string>',
                            'PercentProgress' => <integer>,
                            'Port' => <integer>,
                            'SnapshotCreateTime' => '<string>',
                            'SnapshotType' => '<string>',
                            'Status' => '<string>',
                            'StorageEncrypted' => true || false,
                            'VpcId' => '<string>',
                        ],
                        'AwsRdsDbInstance' => [
                            'AllocatedStorage' => <integer>,
                            'AssociatedRoles' => [
                                [
                                    'FeatureName' => '<string>',
                                    'RoleArn' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'AutoMinorVersionUpgrade' => true || false,
                            'AvailabilityZone' => '<string>',
                            'BackupRetentionPeriod' => <integer>,
                            'CACertificateIdentifier' => '<string>',
                            'CharacterSetName' => '<string>',
                            'CopyTagsToSnapshot' => true || false,
                            'DBClusterIdentifier' => '<string>',
                            'DBInstanceClass' => '<string>',
                            'DBInstanceIdentifier' => '<string>',
                            'DBName' => '<string>',
                            'DbInstancePort' => <integer>,
                            'DbInstanceStatus' => '<string>',
                            'DbParameterGroups' => [
                                [
                                    'DbParameterGroupName' => '<string>',
                                    'ParameterApplyStatus' => '<string>',
                                ],
                                // ...
                            ],
                            'DbSecurityGroups' => ['<string>', ...],
                            'DbSubnetGroup' => [
                                'DbSubnetGroupArn' => '<string>',
                                'DbSubnetGroupDescription' => '<string>',
                                'DbSubnetGroupName' => '<string>',
                                'SubnetGroupStatus' => '<string>',
                                'Subnets' => [
                                    [
                                        'SubnetAvailabilityZone' => [
                                            'Name' => '<string>',
                                        ],
                                        'SubnetIdentifier' => '<string>',
                                        'SubnetStatus' => '<string>',
                                    ],
                                    // ...
                                ],
                                'VpcId' => '<string>',
                            ],
                            'DbiResourceId' => '<string>',
                            'DeletionProtection' => true || false,
                            'DomainMemberships' => [
                                [
                                    'Domain' => '<string>',
                                    'Fqdn' => '<string>',
                                    'IamRoleName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'EnabledCloudWatchLogsExports' => ['<string>', ...],
                            'Endpoint' => [
                                'Address' => '<string>',
                                'HostedZoneId' => '<string>',
                                'Port' => <integer>,
                            ],
                            'Engine' => '<string>',
                            'EngineVersion' => '<string>',
                            'EnhancedMonitoringResourceArn' => '<string>',
                            'IAMDatabaseAuthenticationEnabled' => true || false,
                            'InstanceCreateTime' => '<string>',
                            'Iops' => <integer>,
                            'KmsKeyId' => '<string>',
                            'LatestRestorableTime' => '<string>',
                            'LicenseModel' => '<string>',
                            'ListenerEndpoint' => [
                                'Address' => '<string>',
                                'HostedZoneId' => '<string>',
                                'Port' => <integer>,
                            ],
                            'MasterUsername' => '<string>',
                            'MaxAllocatedStorage' => <integer>,
                            'MonitoringInterval' => <integer>,
                            'MonitoringRoleArn' => '<string>',
                            'MultiAz' => true || false,
                            'OptionGroupMemberships' => [
                                [
                                    'OptionGroupName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'PendingModifiedValues' => [
                                'AllocatedStorage' => <integer>,
                                'BackupRetentionPeriod' => <integer>,
                                'CaCertificateIdentifier' => '<string>',
                                'DbInstanceClass' => '<string>',
                                'DbInstanceIdentifier' => '<string>',
                                'DbSubnetGroupName' => '<string>',
                                'EngineVersion' => '<string>',
                                'Iops' => <integer>,
                                'LicenseModel' => '<string>',
                                'MasterUserPassword' => '<string>',
                                'MultiAZ' => true || false,
                                'PendingCloudWatchLogsExports' => [
                                    'LogTypesToDisable' => ['<string>', ...],
                                    'LogTypesToEnable' => ['<string>', ...],
                                ],
                                'Port' => <integer>,
                                'ProcessorFeatures' => [
                                    [
                                        'Name' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'StorageType' => '<string>',
                            ],
                            'PerformanceInsightsEnabled' => true || false,
                            'PerformanceInsightsKmsKeyId' => '<string>',
                            'PerformanceInsightsRetentionPeriod' => <integer>,
                            'PreferredBackupWindow' => '<string>',
                            'PreferredMaintenanceWindow' => '<string>',
                            'ProcessorFeatures' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'PromotionTier' => <integer>,
                            'PubliclyAccessible' => true || false,
                            'ReadReplicaDBClusterIdentifiers' => ['<string>', ...],
                            'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
                            'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
                            'SecondaryAvailabilityZone' => '<string>',
                            'StatusInfos' => [
                                [
                                    'Message' => '<string>',
                                    'Normal' => true || false,
                                    'Status' => '<string>',
                                    'StatusType' => '<string>',
                                ],
                                // ...
                            ],
                            'StorageEncrypted' => true || false,
                            'StorageType' => '<string>',
                            'TdeCredentialArn' => '<string>',
                            'Timezone' => '<string>',
                            'VpcSecurityGroups' => [
                                [
                                    'Status' => '<string>',
                                    'VpcSecurityGroupId' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsRdsDbSnapshot' => [
                            'AllocatedStorage' => <integer>,
                            'AvailabilityZone' => '<string>',
                            'DbInstanceIdentifier' => '<string>',
                            'DbSnapshotIdentifier' => '<string>',
                            'DbiResourceId' => '<string>',
                            'Encrypted' => true || false,
                            'Engine' => '<string>',
                            'EngineVersion' => '<string>',
                            'IamDatabaseAuthenticationEnabled' => true || false,
                            'InstanceCreateTime' => '<string>',
                            'Iops' => <integer>,
                            'KmsKeyId' => '<string>',
                            'LicenseModel' => '<string>',
                            'MasterUsername' => '<string>',
                            'OptionGroupName' => '<string>',
                            'PercentProgress' => <integer>,
                            'Port' => <integer>,
                            'ProcessorFeatures' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'SnapshotCreateTime' => '<string>',
                            'SnapshotType' => '<string>',
                            'SourceDbSnapshotIdentifier' => '<string>',
                            'SourceRegion' => '<string>',
                            'Status' => '<string>',
                            'StorageType' => '<string>',
                            'TdeCredentialArn' => '<string>',
                            'Timezone' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        'AwsRedshiftCluster' => [
                            'AllowVersionUpgrade' => true || false,
                            'AutomatedSnapshotRetentionPeriod' => <integer>,
                            'AvailabilityZone' => '<string>',
                            'ClusterAvailabilityStatus' => '<string>',
                            'ClusterCreateTime' => '<string>',
                            'ClusterIdentifier' => '<string>',
                            'ClusterNodes' => [
                                [
                                    'NodeRole' => '<string>',
                                    'PrivateIpAddress' => '<string>',
                                    'PublicIpAddress' => '<string>',
                                ],
                                // ...
                            ],
                            'ClusterParameterGroups' => [
                                [
                                    'ClusterParameterStatusList' => [
                                        [
                                            'ParameterApplyErrorDescription' => '<string>',
                                            'ParameterApplyStatus' => '<string>',
                                            'ParameterName' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ParameterApplyStatus' => '<string>',
                                    'ParameterGroupName' => '<string>',
                                ],
                                // ...
                            ],
                            'ClusterPublicKey' => '<string>',
                            'ClusterRevisionNumber' => '<string>',
                            'ClusterSecurityGroups' => [
                                [
                                    'ClusterSecurityGroupName' => '<string>',
                                    'Status' => '<string>',
                                ],
                                // ...
                            ],
                            'ClusterSnapshotCopyStatus' => [
                                'DestinationRegion' => '<string>',
                                'ManualSnapshotRetentionPeriod' => <integer>,
                                'RetentionPeriod' => <integer>,
                                'SnapshotCopyGrantName' => '<string>',
                            ],
                            'ClusterStatus' => '<string>',
                            'ClusterSubnetGroupName' => '<string>',
                            'ClusterVersion' => '<string>',
                            'DBName' => '<string>',
                            'DeferredMaintenanceWindows' => [
                                [
                                    'DeferMaintenanceEndTime' => '<string>',
                                    'DeferMaintenanceIdentifier' => '<string>',
                                    'DeferMaintenanceStartTime' => '<string>',
                                ],
                                // ...
                            ],
                            'ElasticIpStatus' => [
                                'ElasticIp' => '<string>',
                                'Status' => '<string>',
                            ],
                            'ElasticResizeNumberOfNodeOptions' => '<string>',
                            'Encrypted' => true || false,
                            'Endpoint' => [
                                'Address' => '<string>',
                                'Port' => <integer>,
                            ],
                            'EnhancedVpcRouting' => true || false,
                            'ExpectedNextSnapshotScheduleTime' => '<string>',
                            'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
                            'HsmStatus' => [
                                'HsmClientCertificateIdentifier' => '<string>',
                                'HsmConfigurationIdentifier' => '<string>',
                                'Status' => '<string>',
                            ],
                            'IamRoles' => [
                                [
                                    'ApplyStatus' => '<string>',
                                    'IamRoleArn' => '<string>',
                                ],
                                // ...
                            ],
                            'KmsKeyId' => '<string>',
                            'MaintenanceTrackName' => '<string>',
                            'ManualSnapshotRetentionPeriod' => <integer>,
                            'MasterUsername' => '<string>',
                            'NextMaintenanceWindowStartTime' => '<string>',
                            'NodeType' => '<string>',
                            'NumberOfNodes' => <integer>,
                            'PendingActions' => ['<string>', ...],
                            'PendingModifiedValues' => [
                                'AutomatedSnapshotRetentionPeriod' => <integer>,
                                'ClusterIdentifier' => '<string>',
                                'ClusterType' => '<string>',
                                'ClusterVersion' => '<string>',
                                'EncryptionType' => '<string>',
                                'EnhancedVpcRouting' => true || false,
                                'MaintenanceTrackName' => '<string>',
                                'MasterUserPassword' => '<string>',
                                'NodeType' => '<string>',
                                'NumberOfNodes' => <integer>,
                                'PubliclyAccessible' => true || false,
                            ],
                            'PreferredMaintenanceWindow' => '<string>',
                            'PubliclyAccessible' => true || false,
                            'ResizeInfo' => [
                                'AllowCancelResize' => true || false,
                                'ResizeType' => '<string>',
                            ],
                            'RestoreStatus' => [
                                'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
                                'ElapsedTimeInSeconds' => <integer>,
                                'EstimatedTimeToCompletionInSeconds' => <integer>,
                                'ProgressInMegaBytes' => <integer>,
                                'SnapshotSizeInMegaBytes' => <integer>,
                                'Status' => '<string>',
                            ],
                            'SnapshotScheduleIdentifier' => '<string>',
                            'SnapshotScheduleState' => '<string>',
                            'VpcId' => '<string>',
                            'VpcSecurityGroups' => [
                                [
                                    'Status' => '<string>',
                                    'VpcSecurityGroupId' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'AwsS3Bucket' => [
                            'CreatedAt' => '<string>',
                            'OwnerId' => '<string>',
                            'OwnerName' => '<string>',
                            'ServerSideEncryptionConfiguration' => [
                                'Rules' => [
                                    [
                                        'ApplyServerSideEncryptionByDefault' => [
                                            'KMSMasterKeyID' => '<string>',
                                            'SSEAlgorithm' => '<string>',
                                        ],
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        'AwsS3Object' => [
                            'ContentType' => '<string>',
                            'ETag' => '<string>',
                            'LastModified' => '<string>',
                            'SSEKMSKeyId' => '<string>',
                            'ServerSideEncryption' => '<string>',
                            'VersionId' => '<string>',
                        ],
                        'AwsSecretsManagerSecret' => [
                            'Deleted' => true || false,
                            'Description' => '<string>',
                            'KmsKeyId' => '<string>',
                            'Name' => '<string>',
                            'RotationEnabled' => true || false,
                            'RotationLambdaArn' => '<string>',
                            'RotationOccurredWithinFrequency' => true || false,
                            'RotationRules' => [
                                'AutomaticallyAfterDays' => <integer>,
                            ],
                        ],
                        'AwsSnsTopic' => [
                            'KmsMasterKeyId' => '<string>',
                            'Owner' => '<string>',
                            'Subscription' => [
                                [
                                    'Endpoint' => '<string>',
                                    'Protocol' => '<string>',
                                ],
                                // ...
                            ],
                            'TopicName' => '<string>',
                        ],
                        'AwsSqsQueue' => [
                            'DeadLetterTargetArn' => '<string>',
                            'KmsDataKeyReusePeriodSeconds' => <integer>,
                            'KmsMasterKeyId' => '<string>',
                            'QueueName' => '<string>',
                        ],
                        'AwsSsmPatchCompliance' => [
                            'Patch' => [
                                'ComplianceSummary' => [
                                    'ComplianceType' => '<string>',
                                    'CompliantCriticalCount' => <integer>,
                                    'CompliantHighCount' => <integer>,
                                    'CompliantInformationalCount' => <integer>,
                                    'CompliantLowCount' => <integer>,
                                    'CompliantMediumCount' => <integer>,
                                    'CompliantUnspecifiedCount' => <integer>,
                                    'ExecutionType' => '<string>',
                                    'NonCompliantCriticalCount' => <integer>,
                                    'NonCompliantHighCount' => <integer>,
                                    'NonCompliantInformationalCount' => <integer>,
                                    'NonCompliantLowCount' => <integer>,
                                    'NonCompliantMediumCount' => <integer>,
                                    'NonCompliantUnspecifiedCount' => <integer>,
                                    'OverallSeverity' => '<string>',
                                    'PatchBaselineId' => '<string>',
                                    'PatchGroup' => '<string>',
                                    'Status' => '<string>',
                                ],
                            ],
                        ],
                        'AwsWafWebAcl' => [
                            'DefaultAction' => '<string>',
                            'Name' => '<string>',
                            'Rules' => [
                                [
                                    'Action' => [
                                        'Type' => '<string>',
                                    ],
                                    'ExcludedRules' => [
                                        [
                                            'RuleId' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'OverrideAction' => [
                                        'Type' => '<string>',
                                    ],
                                    'Priority' => <integer>,
                                    'RuleId' => '<string>',
                                    'Type' => '<string>',
                                ],
                                // ...
                            ],
                            'WebAclId' => '<string>',
                        ],
                        'Container' => [
                            'ImageId' => '<string>',
                            'ImageName' => '<string>',
                            'LaunchedAt' => '<string>',
                            'Name' => '<string>',
                        ],
                        'Other' => ['<string>', ...],
                    ],
                    'Id' => '<string>',
                    'Partition' => 'aws|aws-cn|aws-us-gov',
                    'Region' => '<string>',
                    'ResourceRole' => '<string>',
                    'Tags' => ['<string>', ...],
                    'Type' => '<string>',
                ],
                // ...
            ],
            'SchemaVersion' => '<string>',
            'Severity' => [
                'Label' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
                'Normalized' => <integer>,
                'Original' => '<string>',
                'Product' => <float>,
            ],
            'SourceUrl' => '<string>',
            'ThreatIntelIndicators' => [
                [
                    'Category' => 'BACKDOOR|CARD_STEALER|COMMAND_AND_CONTROL|DROP_SITE|EXPLOIT_SITE|KEYLOGGER',
                    'LastObservedAt' => '<string>',
                    'Source' => '<string>',
                    'SourceUrl' => '<string>',
                    'Type' => 'DOMAIN|EMAIL_ADDRESS|HASH_MD5|HASH_SHA1|HASH_SHA256|HASH_SHA512|IPV4_ADDRESS|IPV6_ADDRESS|MUTEX|PROCESS|URL',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Title' => '<string>',
            'Types' => ['<string>', ...],
            'UpdatedAt' => '<string>',
            'UserDefinedFields' => ['<string>', ...],
            'VerificationState' => 'UNKNOWN|TRUE_POSITIVE|FALSE_POSITIVE|BENIGN_POSITIVE',
            'Vulnerabilities' => [
                [
                    'Cvss' => [
                        [
                            'BaseScore' => <float>,
                            'BaseVector' => '<string>',
                            'Version' => '<string>',
                        ],
                        // ...
                    ],
                    'Id' => '<string>',
                    'ReferenceUrls' => ['<string>', ...],
                    'RelatedVulnerabilities' => ['<string>', ...],
                    'Vendor' => [
                        'Name' => '<string>',
                        'Url' => '<string>',
                        'VendorCreatedAt' => '<string>',
                        'VendorSeverity' => '<string>',
                        'VendorUpdatedAt' => '<string>',
                    ],
                    'VulnerablePackages' => [
                        [
                            'Architecture' => '<string>',
                            'Epoch' => '<string>',
                            'Name' => '<string>',
                            'Release' => '<string>',
                            'Version' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'Workflow' => [
                'Status' => 'NEW|NOTIFIED|RESOLVED|SUPPRESSED',
            ],
            'WorkflowState' => 'NEW|ASSIGNED|IN_PROGRESS|DEFERRED|RESOLVED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Findings
  • Required: Yes
  • Type: Array of AwsSecurityFinding structures

The findings that matched the filters specified in the request.

NextToken
  • Type: string

The pagination token to use to request the next page of results.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

GetInsightResults

$result = $client->getInsightResults([/* ... */]);
$promise = $client->getInsightResultsAsync([/* ... */]);

Lists the results of the Security Hub insight specified by the insight ARN.

Parameter Syntax

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

Parameter Details

Members
InsightArn
  • Required: Yes
  • Type: string

The ARN of the insight for which to return results.

Result Syntax

[
    'InsightResults' => [
        'GroupByAttribute' => '<string>',
        'InsightArn' => '<string>',
        'ResultValues' => [
            [
                'Count' => <integer>,
                'GroupByAttributeValue' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
InsightResults
  • Required: Yes
  • Type: InsightResults structure

The insight results returned by the operation.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

GetInsights

$result = $client->getInsights([/* ... */]);
$promise = $client->getInsightsAsync([/* ... */]);

Lists and describes insights for the specified insight ARNs.

Parameter Syntax

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

Parameter Details

Members
InsightArns
  • Type: Array of strings

The ARNs of the insights to describe. If you do not provide any insight ARNs, then GetInsights returns all of your custom insights. It does not return any managed insights.

MaxResults
  • Type: int

The maximum number of items to return in the response.

NextToken
  • Type: string

The token that is required for pagination. On your first call to the GetInsights operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Result Syntax

[
    'Insights' => [
        [
            'Filters' => [
                'AwsAccountId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'CompanyName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ComplianceStatus' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Confidence' => [
                    [
                        'Eq' => <float>,
                        'Gte' => <float>,
                        'Lte' => <float>,
                    ],
                    // ...
                ],
                'CreatedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'Criticality' => [
                    [
                        'Eq' => <float>,
                        'Gte' => <float>,
                        'Lte' => <float>,
                    ],
                    // ...
                ],
                'Description' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'FirstObservedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'GeneratorId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Id' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Keyword' => [
                    [
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'LastObservedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'MalwareName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'MalwarePath' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'MalwareState' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'MalwareType' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'NetworkDestinationDomain' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'NetworkDestinationIpV4' => [
                    [
                        'Cidr' => '<string>',
                    ],
                    // ...
                ],
                'NetworkDestinationIpV6' => [
                    [
                        'Cidr' => '<string>',
                    ],
                    // ...
                ],
                'NetworkDestinationPort' => [
                    [
                        'Eq' => <float>,
                        'Gte' => <float>,
                        'Lte' => <float>,
                    ],
                    // ...
                ],
                'NetworkDirection' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'NetworkProtocol' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'NetworkSourceDomain' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'NetworkSourceIpV4' => [
                    [
                        'Cidr' => '<string>',
                    ],
                    // ...
                ],
                'NetworkSourceIpV6' => [
                    [
                        'Cidr' => '<string>',
                    ],
                    // ...
                ],
                'NetworkSourceMac' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'NetworkSourcePort' => [
                    [
                        'Eq' => <float>,
                        'Gte' => <float>,
                        'Lte' => <float>,
                    ],
                    // ...
                ],
                'NoteText' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'NoteUpdatedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'NoteUpdatedBy' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ProcessLaunchedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'ProcessName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ProcessParentPid' => [
                    [
                        'Eq' => <float>,
                        'Gte' => <float>,
                        'Lte' => <float>,
                    ],
                    // ...
                ],
                'ProcessPath' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ProcessPid' => [
                    [
                        'Eq' => <float>,
                        'Gte' => <float>,
                        'Lte' => <float>,
                    ],
                    // ...
                ],
                'ProcessTerminatedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'ProductArn' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ProductFields' => [
                    [
                        'Comparison' => 'EQUALS|NOT_EQUALS',
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ProductName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'RecommendationText' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'RecordState' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'RelatedFindingsId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'RelatedFindingsProductArn' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsEc2InstanceImageId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsEc2InstanceIpV4Addresses' => [
                    [
                        'Cidr' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsEc2InstanceIpV6Addresses' => [
                    [
                        'Cidr' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsEc2InstanceKeyName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsEc2InstanceLaunchedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsEc2InstanceSubnetId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsEc2InstanceType' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsEc2InstanceVpcId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsIamAccessKeyCreatedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsIamAccessKeyStatus' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsIamAccessKeyUserName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsS3BucketOwnerId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceAwsS3BucketOwnerName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceContainerImageId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceContainerImageName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceContainerLaunchedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'ResourceContainerName' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceDetailsOther' => [
                    [
                        'Comparison' => 'EQUALS|NOT_EQUALS',
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceId' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourcePartition' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceRegion' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceTags' => [
                    [
                        'Comparison' => 'EQUALS|NOT_EQUALS',
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ResourceType' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'SeverityLabel' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'SeverityNormalized' => [
                    [
                        'Eq' => <float>,
                        'Gte' => <float>,
                        'Lte' => <float>,
                    ],
                    // ...
                ],
                'SeverityProduct' => [
                    [
                        'Eq' => <float>,
                        'Gte' => <float>,
                        'Lte' => <float>,
                    ],
                    // ...
                ],
                'SourceUrl' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ThreatIntelIndicatorCategory' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ThreatIntelIndicatorLastObservedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'ThreatIntelIndicatorSource' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ThreatIntelIndicatorSourceUrl' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ThreatIntelIndicatorType' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ThreatIntelIndicatorValue' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Title' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'Type' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'UpdatedAt' => [
                    [
                        'DateRange' => [
                            'Unit' => 'DAYS',
                            'Value' => <integer>,
                        ],
                        'End' => '<string>',
                        'Start' => '<string>',
                    ],
                    // ...
                ],
                'UserDefinedFields' => [
                    [
                        'Comparison' => 'EQUALS|NOT_EQUALS',
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VerificationState' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'WorkflowState' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'WorkflowStatus' => [
                    [
                        'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'GroupByAttribute' => '<string>',
            'InsightArn' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Insights
  • Required: Yes
  • Type: Array of Insight structures

The insights returned by the operation.

NextToken
  • Type: string

The pagination token to use to request the next page of results.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

GetInvitationsCount

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

Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'InvitationsCount' => <integer>,
]

Result Details

Members
InvitationsCount
  • Type: int

The number of all membership invitations sent to this Security Hub member account, not including the currently accepted invitation.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

GetMasterAccount

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

Provides the details for the Security Hub master account for the current member account.

Can be used by both member accounts that are in an organization and accounts that were invited manually.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'Master' => [
        'AccountId' => '<string>',
        'InvitationId' => '<string>',
        'InvitedAt' => <DateTime>,
        'MemberStatus' => '<string>',
    ],
]

Result Details

Members
Master
  • Type: Invitation structure

A list of details about the Security Hub master account for the current member account.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

GetMembers

$result = $client->getMembers([/* ... */]);
$promise = $client->getMembersAsync([/* ... */]);

Returns the details for the Security Hub member accounts for the specified account IDs.

A master account can be either a delegated Security Hub administrator account for an organization or a master account that enabled Security Hub manually.

The results include both member accounts that are in an organization and accounts that were invited manually.

Parameter Syntax

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

Parameter Details

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

The list of account IDs for the Security Hub member accounts to return the details for.

Result Syntax

[
    'Members' => [
        [
            'AccountId' => '<string>',
            'Email' => '<string>',
            'InvitedAt' => <DateTime>,
            'MasterId' => '<string>',
            'MemberStatus' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'ProcessingResult' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Members
  • Type: Array of Member structures

The list of details about the Security Hub member accounts.

UnprocessedAccounts
  • Type: Array of Result structures

The list of AWS accounts that could not be processed. For each account, the list includes the account ID and the email address.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

InviteMembers

$result = $client->inviteMembers([/* ... */]);
$promise = $client->inviteMembersAsync([/* ... */]);

Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from.

This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.

Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.

When the account owner enables Security Hub and accepts the invitation to become a member account, the master account can view the findings generated from the member account.

Parameter Syntax

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

Parameter Details

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

The list of account IDs of the AWS accounts to invite to Security Hub as members.

Result Syntax

[
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'ProcessingResult' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
UnprocessedAccounts
  • Type: Array of Result structures

The list of AWS accounts that could not be processed. For each account, the list includes the account ID and the email address.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

ListEnabledProductsForImport

$result = $client->listEnabledProductsForImport([/* ... */]);
$promise = $client->listEnabledProductsForImportAsync([/* ... */]);

Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of items to return in the response.

NextToken
  • Type: string

The token that is required for pagination. On your first call to the ListEnabledProductsForImport operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Result Syntax

[
    'NextToken' => '<string>',
    'ProductSubscriptions' => ['<string>', ...],
]

Result Details

Members
NextToken
  • Type: string

The pagination token to use to request the next page of results.

ProductSubscriptions
  • Type: Array of strings

The list of ARNs for the resources that represent your subscriptions to products.

Errors

  • InternalException:

    Internal server error.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

ListInvitations

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

Lists all Security Hub membership invitations that were sent to the current AWS account.

This operation is only used by accounts that do not belong to an organization. Organization accounts do not receive invitations.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of items to return in the response.

NextToken
  • Type: string

The token that is required for pagination. On your first call to the ListInvitations operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Result Syntax

[
    'Invitations' => [
        [
            'AccountId' => '<string>',
            'InvitationId' => '<string>',
            'InvitedAt' => <DateTime>,
            'MemberStatus' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Invitations
  • Type: Array of Invitation structures

The details of the invitations returned by the operation.

NextToken
  • Type: string

The pagination token to use to request the next page of results.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

ListMembers

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

Lists details about all member accounts for the current Security Hub master account.

The results include both member accounts that belong to an organization and member accounts that were invited manually.

Parameter Syntax

$result = $client->listMembers([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OnlyAssociated' => true || false,
]);

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of items to return in the response.

NextToken
  • Type: string

The token that is required for pagination. On your first call to the ListMembers operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

OnlyAssociated
  • Type: boolean

Specifies which member accounts to include in the response based on their relationship status with the master account. The default value is TRUE.

If OnlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the master is set to ENABLED.

If OnlyAssociated is set to FALSE, the response includes all existing member accounts.

Result Syntax

[
    'Members' => [
        [
            'AccountId' => '<string>',
            'Email' => '<string>',
            'InvitedAt' => <DateTime>,
            'MasterId' => '<string>',
            'MemberStatus' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Members
  • Type: Array of Member structures

Member details returned by the operation.

NextToken
  • Type: string

The pagination token to use to request the next page of results.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

ListOrganizationAdminAccounts

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

Lists the Security Hub administrator accounts. Can only be called by the organization management account.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of items to return in the response.

NextToken
  • Type: string

The token that is required for pagination. On your first call to the ListOrganizationAdminAccounts operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Result Syntax

[
    'AdminAccounts' => [
        [
            'AccountId' => '<string>',
            'Status' => 'ENABLED|DISABLE_IN_PROGRESS',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
AdminAccounts
  • Type: Array of AdminAccount structures

The list of Security Hub administrator accounts.

NextToken
  • Type: string

The pagination token to use to request the next page of results.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

ListTagsForResource

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

Returns a list of tags associated with a resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The ARN of the resource to retrieve tags for.

Result Syntax

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

Result Details

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

The tags associated with a resource.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

TagResource

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

Adds 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 ARN of the resource to apply the tags to.

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

The tags to add to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

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 ARN of the resource to remove the tags from.

TagKeys
  • Required: Yes
  • Type: Array of strings

The tag keys associated with the tags to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

UpdateActionTarget

$result = $client->updateActionTarget([/* ... */]);
$promise = $client->updateActionTargetAsync([/* ... */]);

Updates the name and description of a custom action target in Security Hub.

Parameter Syntax

$result = $client->updateActionTarget([
    'ActionTargetArn' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Name' => '<string>',
]);

Parameter Details

Members
ActionTargetArn
  • Required: Yes
  • Type: string

The ARN of the custom action target to update.

Description
  • Type: string

The updated description for the custom action target.

Name
  • Type: string

The updated name of the custom action target.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

UpdateFindings

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

UpdateFindings is deprecated. Instead of UpdateFindings, use BatchUpdateFindings.

Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.

Parameter Syntax

$result = $client->updateFindings([
    'Filters' => [ // REQUIRED
        'AwsAccountId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CompanyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Confidence' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'CreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'Criticality' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'Description' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FirstObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'GeneratorId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Id' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Keyword' => [
            [
                'Value' => '<string>',
            ],
            // ...
        ],
        'LastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'MalwareName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwarePath' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwareState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwareType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationDomain' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationIpV4' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationIpV6' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationPort' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'NetworkDirection' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkProtocol' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceDomain' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceIpV4' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceIpV6' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceMac' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourcePort' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'NoteText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedBy' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ProcessName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessParentPid' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'ProcessPath' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessPid' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'ProcessTerminatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecommendationText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecordState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceImageId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIpV4Addresses' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIpV6Addresses' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceKeyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceSubnetId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceVpcId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyCreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyUserName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsS3BucketOwnerId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsS3BucketOwnerName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerImageId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerImageName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceDetailsOther' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourcePartition' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceRegion' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceTags' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SeverityLabel' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SeverityNormalized' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'SeverityProduct' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'SourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorCategory' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorLastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorSource' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorSourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorValue' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Title' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'UserDefinedFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VerificationState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'Note' => [
        'Text' => '<string>', // REQUIRED
        'UpdatedBy' => '<string>', // REQUIRED
    ],
    'RecordState' => 'ACTIVE|ARCHIVED',
]);

Parameter Details

Members
Filters
  • Required: Yes
  • Type: AwsSecurityFindingFilters structure

A collection of attributes that specify which findings you want to update.

Note
  • Type: NoteUpdate structure

The updated note for the finding.

RecordState
  • Type: string

The updated record state for the finding.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

UpdateInsight

$result = $client->updateInsight([/* ... */]);
$promise = $client->updateInsightAsync([/* ... */]);

Updates the Security Hub insight identified by the specified insight ARN.

Parameter Syntax

$result = $client->updateInsight([
    'Filters' => [
        'AwsAccountId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CompanyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComplianceStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Confidence' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'CreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'Criticality' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'Description' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'FirstObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'GeneratorId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Id' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Keyword' => [
            [
                'Value' => '<string>',
            ],
            // ...
        ],
        'LastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'MalwareName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwarePath' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwareState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'MalwareType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationDomain' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationIpV4' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationIpV6' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkDestinationPort' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'NetworkDirection' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkProtocol' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceDomain' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceIpV4' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceIpV6' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'NetworkSourceMac' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NetworkSourcePort' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'NoteText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'NoteUpdatedBy' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ProcessName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessParentPid' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'ProcessPath' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProcessPid' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'ProcessTerminatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ProductName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecommendationText' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RecordState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RelatedFindingsProductArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIamInstanceProfileArn' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceImageId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIpV4Addresses' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceIpV6Addresses' => [
            [
                'Cidr' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceKeyName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceSubnetId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsEc2InstanceVpcId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyCreatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsIamAccessKeyUserName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsS3BucketOwnerId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceAwsS3BucketOwnerName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerImageId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerImageName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerLaunchedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ResourceContainerName' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceDetailsOther' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceId' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourcePartition' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceRegion' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceTags' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SeverityLabel' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SeverityNormalized' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'SeverityProduct' => [
            [
                'Eq' => <float>,
                'Gte' => <float>,
                'Lte' => <float>,
            ],
            // ...
        ],
        'SourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorCategory' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorLastObservedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorSource' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorSourceUrl' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorType' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ThreatIntelIndicatorValue' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Title' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdatedAt' => [
            [
                'DateRange' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
                'End' => '<string>',
                'Start' => '<string>',
            ],
            // ...
        ],
        'UserDefinedFields' => [
            [
                'Comparison' => 'EQUALS|NOT_EQUALS',
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VerificationState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowState' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
        'WorkflowStatus' => [
            [
                'Comparison' => 'EQUALS|PREFIX|NOT_EQUALS|PREFIX_NOT_EQUALS',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'GroupByAttribute' => '<string>',
    'InsightArn' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Members
Filters
  • Type: AwsSecurityFindingFilters structure

The updated filters that define this insight.

GroupByAttribute
  • Type: string

The updated GroupBy attribute that defines this insight.

InsightArn
  • Required: Yes
  • Type: string

The ARN of the insight that you want to update.

Name
  • Type: string

The updated name for the insight.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

UpdateOrganizationConfiguration

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

Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.

Parameter Syntax

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

Parameter Details

Members
AutoEnable
  • Required: Yes
  • Type: boolean

Whether to automatically enable Security Hub for new accounts in the organization.

By default, this is false, and new accounts are not added automatically.

To automatically enable Security Hub for new accounts, set this to true.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

UpdateSecurityHubConfiguration

$result = $client->updateSecurityHubConfiguration([/* ... */]);
$promise = $client->updateSecurityHubConfigurationAsync([/* ... */]);

Updates configuration options for Security Hub.

Parameter Syntax

$result = $client->updateSecurityHubConfiguration([
    'AutoEnableControls' => true || false,
]);

Parameter Details

Members
AutoEnableControls
  • Type: boolean

Whether to automatically enable new controls when they are added to standards that are enabled.

By default, this is set to true, and new controls are enabled automatically. To not automatically enable new controls, set this to false.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • LimitExceededException:

    The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

UpdateStandardsControl

$result = $client->updateStandardsControl([/* ... */]);
$promise = $client->updateStandardsControlAsync([/* ... */]);

Used to control whether an individual security standard control is enabled or disabled.

Parameter Syntax

$result = $client->updateStandardsControl([
    'ControlStatus' => 'ENABLED|DISABLED',
    'DisabledReason' => '<string>',
    'StandardsControlArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ControlStatus
  • Type: string

The updated status of the security standard control.

DisabledReason
  • Type: string

A description of the reason why you are disabling a security standard control. If you are disabling a control, then this is required.

StandardsControlArn
  • Required: Yes
  • Type: string

The ARN of the security standard control to enable or disable.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalException:

    Internal server error.

  • InvalidInputException:

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException:

    There is an issue with the account used to make the request. Either Security Hub is not enabled for the account, or the account does not have permission to perform this action.

  • ResourceNotFoundException:

    The request was rejected because we can't find the specified resource.

Shapes

AccessDeniedException

Description

You don't have permission to perform the action specified in the request.

Members
Code
  • Type: string
Message
  • Type: string

AccountDetails

Description

The details of an AWS account.

Members
AccountId
  • Required: Yes
  • Type: string

The ID of an AWS account.

Email
  • Type: string

The email of an AWS account.

Action

Description

Provides details about one of the following actions that were detected for the finding:

  • A remote IP address issued an AWS API call

  • A DNS request was received

  • A remote IP address attempted to connect to an EC2 instance

  • A remote IP address attempted a port probe on an EC2 instance

Members
ActionType
  • Type: string

The type of action that was detected. The possible action types are:

  • NETWORK_CONNECTION

  • AWS_API_CALL

  • DNS_REQUEST

  • PORT_PROBE

AwsApiCallAction
  • Type: AwsApiCallAction structure

Included if ActionType is AWS_API_CALL. Provides details about the API call that was detected.

DnsRequestAction
  • Type: DnsRequestAction structure

Included if ActionType is DNS_REQUEST. Provides details about the DNS request that was detected.

NetworkConnectionAction
  • Type: NetworkConnectionAction structure

Included if ActionType is NETWORK_CONNECTION. Provides details about the network connection that was detected.

PortProbeAction
  • Type: PortProbeAction structure

Included if ActionType is PORT_PROBE. Provides details about the port probe that was detected.

ActionLocalIpDetails

Description

Provides information about the IP address where the scanned port is located.

Members
IpAddressV4
  • Type: string

The IP address.

ActionLocalPortDetails

Description

For NetworkConnectionAction and PortProbeDetails, LocalPortDetails provides information about the local port that was involved in the action.

Members
Port
  • Type: int

The number of the port.

PortName
  • Type: string

The port name of the local connection.

ActionRemoteIpDetails

Description

For AwsApiAction, NetworkConnectionAction, and PortProbeAction, RemoteIpDetails provides information about the remote IP address that was involved in the action.

Members
City
  • Type: City structure

The city where the remote IP address is located.

Country
  • Type: Country structure

The country where the remote IP address is located.

GeoLocation
  • Type: GeoLocation structure

The coordinates of the location of the remote IP address.

IpAddressV4
  • Type: string

The IP address.

Organization
  • Type: IpOrganizationDetails structure

The internet service provider (ISP) organization associated with the remote IP address.

ActionRemotePortDetails

Description

Provides information about the remote port that was involved in an attempted network connection.

Members
Port
  • Type: int

The number of the port.

PortName
  • Type: string

The port name of the remote connection.

ActionTarget

Description

An ActionTarget object.

Members
ActionTargetArn
  • Required: Yes
  • Type: string

The ARN for the target action.

Description
  • Required: Yes
  • Type: string

The description of the target action.

Name
  • Required: Yes
  • Type: string

The name of the action target.

AdminAccount

Description

Represents a Security Hub administrator account designated by an organization management account.

Members
AccountId
  • Type: string

The AWS account identifier of the Security Hub administrator account.

Status
  • Type: string

The current status of the Security Hub administrator account. Indicates whether the account is currently enabled as a Security Hub administrator.

AvailabilityZone

Description

Information about an Availability Zone.

Members
SubnetId
  • Type: string

The ID of the subnet. You can specify one subnet per Availability Zone.

ZoneName
  • Type: string

The name of the Availability Zone.

AwsApiCallAction

Description

Provided if ActionType is AWS_API_CALL. It provides details about the API call that was detected.

Members
AffectedResources
  • Type: Associative array of custom strings keys (NonEmptyString) to strings

Identifies the resources that were affected by the API call.

Api
  • Type: string

The name of the API method that was issued.

CallerType
  • Type: string

Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain (domain).

DomainDetails
  • Type: AwsApiCallActionDomainDetails structure

Provided if CallerType is domain. Provides information about the DNS domain that the API call originated from.

FirstSeen
  • Type: string

An ISO8601-formatted timestamp that indicates when the API call was first observed.

LastSeen
  • Type: string

An ISO8601-formatted timestamp that indicates when the API call was most recently observed.

RemoteIpDetails
  • Type: ActionRemoteIpDetails structure

Provided if CallerType is remoteIp. Provides information about the remote IP address that the API call originated from.

ServiceName
  • Type: string

The name of the AWS service that the API method belongs to.

AwsApiCallActionDomainDetails

Description

Provided if CallerType is domain. It provides information about the DNS domain that issued the API call.

Members
Domain
  • Type: string

The name of the DNS domain that issued the API call.

AwsApiGatewayAccessLogSettings

Description

Contains information about settings for logging access for the stage.

Members
DestinationArn
  • Type: string

The ARN of the CloudWatch Logs log group that receives the access logs.

Format
  • Type: string

A single-line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

AwsApiGatewayCanarySettings

Description

Contains information about settings for canary deployment in the stage.

Members
DeploymentId
  • Type: string

The deployment identifier for the canary deployment.

PercentTraffic
  • Type: double

The percentage of traffic that is diverted to a canary deployment.

StageVariableOverrides
  • Type: Associative array of custom strings keys (NonEmptyString) to strings

Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.

Each variable is represented as a string-to-string map between the stage variable name and the variable value.

UseStageCache
  • Type: boolean

Indicates whether the canary deployment uses the stage cache.

AwsApiGatewayEndpointConfiguration

Description

Contains information about the endpoints for the API.

Members
Types
  • Type: Array of strings

A list of endpoint types for the REST API.

For an edge-optimized API, the endpoint type is EDGE. For a Regional API, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

AwsApiGatewayMethodSettings

Description

Defines settings for a method for the stage.

Members
CacheDataEncrypted
  • Type: boolean

Indicates whether the cached responses are encrypted.

CacheTtlInSeconds
  • Type: int

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.

CachingEnabled
  • Type: boolean

Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.

DataTraceEnabled
  • Type: boolean

Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.

HttpMethod
  • Type: string

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

LoggingLevel
  • Type: string

The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs.

If the logging level is ERROR, then the logs only include error-level entries.

If the logging level is INFO, then the logs include both ERROR events and extra informational events.

Valid values: OFF | ERROR | INFO

MetricsEnabled
  • Type: boolean

Indicates whether CloudWatch metrics are enabled for the method.

RequireAuthorizationForCacheControl
  • Type: boolean

Indicates whether authorization is required for a cache invalidation request.

ResourcePath
  • Type: string

The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash.

For example, the path value /resource/subresource must be encoded as /~1resource~1subresource.

To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

ThrottlingBurstLimit
  • Type: int

The throttling burst limit for the method.

ThrottlingRateLimit
  • Type: double

The throttling rate limit for the method.

UnauthorizedCacheControlHeaderStrategy
  • Type: string

Indicates how to handle unauthorized requests for cache invalidation.

Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER

AwsApiGatewayRestApiDetails

Description

contains information about a REST API in version 1 of Amazon API Gateway.

Members
ApiKeySource
  • Type: string

The source of the API key for metering requests according to a usage plan.

HEADER indicates whether to read the API key from the X-API-Key header of a request.

AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.

BinaryMediaTypes
  • Type: Array of strings

The list of binary media types supported by the REST API.

CreatedDate
  • Type: string

Indicates when the API was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Description
  • Type: string

A description of the REST API.

EndpointConfiguration
  • Type: AwsApiGatewayEndpointConfiguration structure

The endpoint configuration of the REST API.

Id
  • Type: string

The identifier of the REST API.

MinimumCompressionSize
  • Type: int

The minimum size in bytes of a payload before compression is enabled.

If null, then compression is disabled.

If 0, then all payloads are compressed.

Name
  • Type: string

The name of the REST API.

Version
  • Type: string

The version identifier for the REST API.

AwsApiGatewayStageDetails

Description

Provides information about a version 1 Amazon API Gateway stage.

Members
AccessLogSettings
  • Type: AwsApiGatewayAccessLogSettings structure

Settings for logging access for the stage.

CacheClusterEnabled
  • Type: boolean

Indicates whether a cache cluster is enabled for the stage.

CacheClusterSize
  • Type: string

If a cache cluster is enabled, the size of the cache cluster.

CacheClusterStatus
  • Type: string

If a cache cluster is enabled, the status of the cache cluster.

CanarySettings
  • Type: AwsApiGatewayCanarySettings structure

Information about settings for canary deployment in the stage.

ClientCertificateId
  • Type: string

The identifier of the client certificate for the stage.

CreatedDate
  • Type: string

Indicates when the stage was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

DeploymentId
  • Type: string

The identifier of the deployment that the stage points to.

Description
  • Type: string

A description of the stage.

DocumentationVersion
  • Type: string

The version of the API documentation that is associated with the stage.

LastUpdatedDate
  • Type: string

Indicates when the stage was most recently updated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

MethodSettings
  • Type: Array of AwsApiGatewayMethodSettings structures

Defines the method settings for the stage.

StageName
  • Type: string

The name of the stage.

TracingEnabled
  • Type: boolean

Indicates whether active tracing with AWS X-Ray is enabled for the stage.

Variables
  • Type: Associative array of custom strings keys (NonEmptyString) to strings

A map that defines the stage variables for the stage.

Variable names can have alphanumeric and underscore characters.

Variable values can contain the following characters:

  • Uppercase and lowercase letters

  • Numbers

  • Special characters -._~:/?#&=,

WebAclArn
  • Type: string

The ARN of the web ACL associated with the stage.

AwsApiGatewayV2ApiDetails

Description

Contains information about a version 2 API in Amazon API Gateway.

Members
ApiEndpoint
  • Type: string

The URI of the API.

Uses the format <api-id>.execute-api.<region>.amazonaws.com

The stage name is typically appended to the URI to form a complete path to a deployed API stage.

ApiId
  • Type: string

The identifier of the API.

ApiKeySelectionExpression
  • Type: string

An API key selection expression. Supported only for WebSocket APIs.

CorsConfiguration
  • Type: AwsCorsConfiguration structure

A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.

CreatedDate
  • Type: string

Indicates when the API was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Description
  • Type: string

A description of the API.

Name
  • Type: string

The name of the API.

ProtocolType
  • Type: string

The API protocol for the API.

Valid values: WEBSOCKET | HTTP

RouteSelectionExpression
  • Type: string

The route selection expression for the API.

For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs.

For WebSocket APIs, there is no default value.

Version
  • Type: string

The version identifier for the API.

AwsApiGatewayV2RouteSettings

Description

Contains route settings for a stage.

Members
DataTraceEnabled
  • Type: boolean

Indicates whether data trace logging is enabled. Data trace logging affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.

DetailedMetricsEnabled
  • Type: boolean

Indicates whether detailed metrics are enabled.

LoggingLevel
  • Type: string

The logging level. The logging level affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.

If the logging level is ERROR, then the logs only include error-level entries.

If the logging level is INFO, then the logs include both ERROR events and extra informational events.

Valid values: OFF | ERROR | INFO

ThrottlingBurstLimit
  • Type: int

The throttling burst limit.

ThrottlingRateLimit
  • Type: double

The throttling rate limit.

AwsApiGatewayV2StageDetails

Description

Contains information about a version 2 stage for Amazon API Gateway.

Members
AccessLogSettings
  • Type: AwsApiGatewayAccessLogSettings structure

Information about settings for logging access for the stage.

ApiGatewayManaged
  • Type: boolean

Indicates whether the stage is managed by API Gateway.

AutoDeploy
  • Type: boolean

Indicates whether updates to an API automatically trigger a new deployment.

CreatedDate
  • Type: string

Indicates when the stage was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

DefaultRouteSettings
  • Type: AwsApiGatewayV2RouteSettings structure

Default route settings for the stage.

DeploymentId
  • Type: string

The identifier of the deployment that the stage is associated with.

Description
  • Type: string

The description of the stage.

LastDeploymentStatusMessage
  • Type: string

The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.

LastUpdatedDate
  • Type: string

Indicates when the stage was most recently updated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

RouteSettings
  • Type: AwsApiGatewayV2RouteSettings structure

The route settings for the stage.

StageName
  • Type: string

The name of the stage.

StageVariables
  • Type: Associative array of custom strings keys (NonEmptyString) to strings

A map that defines the stage variables for the stage.

Variable names can have alphanumeric and underscore characters.

Variable values can contain the following characters:

  • Uppercase and lowercase letters

  • Numbers

  • Special characters -._~:/?#&=,

AwsAutoScalingAutoScalingGroupDetails

Description

Provides details about an auto scaling group.

Members
CreatedTime
  • Type: string

Indicates when the auto scaling group was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

HealthCheckGracePeriod
  • Type: int

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the health status of an EC2 instance that has come into service.

HealthCheckType
  • Type: string

The service to use for the health checks.

LaunchConfigurationName
  • Type: string

The name of the launch configuration.

LoadBalancerNames
  • Type: Array of strings

The list of load balancers associated with the group.

AwsCertificateManagerCertificateDetails

Description

Provides details about an AWS Certificate Manager certificate.

Members
CertificateAuthorityArn
  • Type: string

The ARN of the private certificate authority (CA) that will be used to issue the certificate.

CreatedAt
  • Type: string

Indicates when the certificate was requested.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

DomainName
  • Type: string

The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.

DomainValidationOptions
  • Type: Array of AwsCertificateManagerCertificateDomainValidationOption structures

Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request.

Only provided if the certificate type is AMAZON_ISSUED.

ExtendedKeyUsages
  • Type: Array of AwsCertificateManagerCertificateExtendedKeyUsage structures

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

FailureReason
  • Type: string

For a failed certificate request, the reason for the failure.

Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

ImportedAt
  • Type: string

Indicates when the certificate was imported. Provided if the certificate type is IMPORTED.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

InUseBy
  • Type: Array of strings

The list of ARNs for the AWS resources that use the certificate.

IssuedAt
  • Type: string

Indicates when the certificate was issued. Provided if the certificate type is AMAZON_ISSUED.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Issuer
  • Type: string

The name of the certificate authority that issued and signed the certificate.

KeyAlgorithm
  • Type: string

The algorithm that was used to generate the public-private key pair.

Valid values: RSA_2048 | RSA_1024 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1

KeyUsages
  • Type: Array of AwsCertificateManagerCertificateKeyUsage structures

A list of key usage X.509 v3 extension objects.

NotAfter
  • Type: string

The time after which the certificate becomes invalid.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

NotBefore
  • Type: string

The time before which the certificate is not valid.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Options
  • Type: AwsCertificateManagerCertificateOptions structure

Provides a value that specifies whether to add the certificate to a transparency log.

RenewalEligibility
  • Type: string

Whether the certificate is eligible for renewal.

Valid values: ELIGIBLE | INELIGIBLE

RenewalSummary
  • Type: AwsCertificateManagerCertificateRenewalSummary structure

Information about the status of the AWS Certificate Manager managed renewal for the certificate. Provided only when the certificate type is AMAZON_ISSUED.

Serial
  • Type: string

The serial number of the certificate.

SignatureAlgorithm
  • Type: string

The algorithm that was used to sign the certificate.

Status
  • Type: string

The status of the certificate.

Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED

Subject
  • Type: string

The name of the entity that is associated with the public key contained in the certificate.

SubjectAlternativeNames
  • Type: Array of strings

One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate.

The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

Type
  • Type: string

The source of the certificate. For certificates that AWS Certificate Manager provides, Type is AMAZON_ISSUED. For certificates that are imported with ImportCertificate, Type is IMPORTED.

Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE

AwsCertificateManagerCertificateDomainValidationOption

Description

Contains information about one of the following:

  • The initial validation of each domain name that occurs as a result of the RequestCertificate request

  • The validation of each domain name in the certificate, as it pertains to AWS Certificate Manager managed renewal

Members
DomainName
  • Type: string

A fully qualified domain name (FQDN) in the certificate.

ResourceRecord
  • Type: AwsCertificateManagerCertificateResourceRecord structure

The CNAME record that is added to the DNS database for domain validation.

ValidationDomain
  • Type: string

The domain name that AWS Certificate Manager uses to send domain validation emails.

ValidationEmails
  • Type: Array of strings

A list of email addresses that AWS Certificate Manager uses to send domain validation emails.

ValidationMethod
  • Type: string

The method used to validate the domain name.

ValidationStatus
  • Type: string

The validation status of the domain name.

AwsCertificateManagerCertificateExtendedKeyUsage

Description

Contains information about an extended key usage X.509 v3 extension object.

Members
Name
  • Type: string

The name of an extension value. Indicates the purpose for which the certificate public key can be used.

OId
  • Type: string

An object identifier (OID) for the extension value.

The format is numbers separated by periods.

AwsCertificateManagerCertificateKeyUsage

Description

Contains information about a key usage X.509 v3 extension object.

Members
Name
  • Type: string

The key usage extension name.

AwsCertificateManagerCertificateOptions

Description

Contains other options for the certificate.

Members
CertificateTransparencyLoggingPreference
  • Type: string

Whether to add the certificate to a transparency log.

Valid values: DISABLED | ENABLED

AwsCertificateManagerCertificateRenewalSummary

Description

Contains information about the AWS Certificate Manager managed renewal for an AMAZON_ISSUED certificate.

Members
DomainValidationOptions
  • Type: Array of AwsCertificateManagerCertificateDomainValidationOption structures

Information about the validation of each domain name in the certificate, as it pertains to AWS Certificate Manager managed renewal. Provided only when the certificate type is AMAZON_ISSUED.

RenewalStatus
  • Type: string

The status of the AWS Certificate Manager managed renewal of the certificate.

Valid values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION | SUCCESS | FAILED

RenewalStatusReason
  • Type: string

The reason that a renewal request was unsuccessful.

Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

UpdatedAt
  • Type: string

Indicates when the renewal summary was last updated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

AwsCertificateManagerCertificateResourceRecord

Description

Provides details about the CNAME record that is added to the DNS database for domain validation.

Members
Name
  • Type: string

The name of the resource.

Type
  • Type: string

The type of resource.

Value
  • Type: string

The value of the resource.

AwsCloudFrontDistributionCacheBehavior

Description

Information about a cache behavior for the distribution.

Members
ViewerProtocolPolicy
  • Type: string

The protocol that viewers can use to access the files in an origin. You can specify the following options:

  • allow-all - Viewers can use HTTP or HTTPS.

  • redirect-to-https - CloudFront responds to HTTP requests with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new URL to resubmit.

  • https-only - CloudFront responds to HTTP request with an HTTP status code of 403 (Forbidden).

AwsCloudFrontDistributionCacheBehaviors

Description

Provides information about caching for the distribution.

Members
Items
  • Type: Array of AwsCloudFrontDistributionCacheBehavior structures

The cache behaviors for the distribution.

AwsCloudFrontDistributionDefaultCacheBehavior

Description

Contains information about the default cache configuration for the distribution.

Members
ViewerProtocolPolicy
  • Type: string

The protocol that viewers can use to access the files in an origin. You can specify the following options:

  • allow-all - Viewers can use HTTP or HTTPS.

  • redirect-to-https - CloudFront responds to HTTP requests with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new URL to resubmit.

  • https-only - CloudFront responds to HTTP request with an HTTP status code of 403 (Forbidden).

AwsCloudFrontDistributionDetails

Description

A distribution configuration.

Members
CacheBehaviors
  • Type: AwsCloudFrontDistributionCacheBehaviors structure

Provides information about the cache configuration for the distribution.

DefaultCacheBehavior
  • Type: AwsCloudFrontDistributionDefaultCacheBehavior structure

The default cache behavior for the configuration.

DefaultRootObject
  • Type: string

The object that CloudFront sends in response to requests from the origin (for example, index.html) when a viewer requests the root URL for the distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html).

DomainName
  • Type: string

The domain name corresponding to the distribution.

ETag
  • Type: string

The entity tag is a hash of the object.

LastModifiedTime
  • Type: string

Indicates when that the distribution was last modified.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Logging
  • Type: AwsCloudFrontDistributionLogging structure

A complex type that controls whether access logs are written for the distribution.

OriginGroups
  • Type: AwsCloudFrontDistributionOriginGroups structure

Provides information about the origin groups in the distribution.

Origins
  • Type: AwsCloudFrontDistributionOrigins structure

A complex type that contains information about origins for this distribution.

Status
  • Type: string

Indicates the current status of the distribution.

WebAclId
  • Type: string

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

AwsCloudFrontDistributionLogging

Description

A complex type that controls whether access logs are written for the distribution.

Members
Bucket
  • Type: string

The Amazon S3 bucket to store the access logs in.

Enabled
  • Type: boolean

With this field, you can enable or disable the selected distribution.

IncludeCookies
  • Type: boolean

Specifies whether you want CloudFront to include cookies in access logs.

Prefix
  • Type: string

An optional string that you want CloudFront to use as a prefix to the access log filenames for this distribution.

AwsCloudFrontDistributionOriginGroup

Description

Information about an origin group for the distribution.

Members
FailoverCriteria
  • Type: AwsCloudFrontDistributionOriginGroupFailover structure

Provides the criteria for an origin group to fail over.

AwsCloudFrontDistributionOriginGroupFailover

Description

Provides information about when an origin group fails over.

Members
StatusCodes
  • Type: AwsCloudFrontDistributionOriginGroupFailoverStatusCodes structure

Information about the status codes that cause an origin group to fail over.

AwsCloudFrontDistributionOriginGroupFailoverStatusCodes

Description

The status codes that cause an origin group to fail over.

Members
Items
  • Type: Array of ints

The list of status code values that can cause a failover to the next origin.

Quantity
  • Type: int

The number of status codes that can cause a failover.

AwsCloudFrontDistributionOriginGroups

Description

Provides information about origin groups that are associated with the distribution.

Members
Items
  • Type: Array of AwsCloudFrontDistributionOriginGroup structures

The list of origin groups.

AwsCloudFrontDistributionOriginItem

Description

A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server), Amazon Elemental MediaStore, or other server from which CloudFront gets your files.

Members
DomainName
  • Type: string

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin.

Id
  • Type: string

A unique identifier for the origin or origin group.

OriginPath
  • Type: string

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.

S3OriginConfig
  • Type: AwsCloudFrontDistributionOriginS3OriginConfig structure

An origin that is an S3 bucket that is not configured with static website hosting.

AwsCloudFrontDistributionOriginS3OriginConfig

Description

Information about an origin that is an S3 bucket that is not configured with static website hosting.

Members
OriginAccessIdentity
  • Type: string

The CloudFront origin access identity to associate with the origin.

AwsCloudFrontDistributionOrigins

Description

A complex type that contains information about origins and origin groups for this distribution.

Members
Items
  • Type: Array of AwsCloudFrontDistributionOriginItem structures

A complex type that contains origins or origin groups for this distribution.

AwsCloudTrailTrailDetails

Description

Provides details about a CloudTrail trail.

Members
CloudWatchLogsLogGroupArn
  • Type: string

The ARN of the log group that CloudTrail logs are delivered to.

CloudWatchLogsRoleArn
  • Type: string

The ARN of the role that the CloudWatch Logs endpoint assumes when it writes to the log group.

HasCustomEventSelectors
  • Type: boolean

Indicates whether the trail has custom event selectors.

HomeRegion
  • Type: string

The Region where the trail was created.

IncludeGlobalServiceEvents
  • Type: boolean

Indicates whether the trail publishes events from global services such as IAM to the log files.

IsMultiRegionTrail
  • Type: boolean

Indicates whether the trail applies only to the current Region or to all Regions.

IsOrganizationTrail
  • Type: boolean

Whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account.

KmsKeyId
  • Type: string

The AWS KMS key ID to use to encrypt the logs.

LogFileValidationEnabled
  • Type: boolean

Indicates whether CloudTrail log file validation is enabled.

Name
  • Type: string

The name of the trail.

S3BucketName
  • Type: string

The name of the S3 bucket where the log files are published.

S3KeyPrefix
  • Type: string

The S3 key prefix. The key prefix is added after the name of the S3 bucket where the log files are published.

SnsTopicArn
  • Type: string

The ARN of the SNS topic that is used for notifications of log file delivery.

SnsTopicName
  • Type: string

The name of the SNS topic that is used for notifications of log file delivery.

TrailArn
  • Type: string

The ARN of the trail.

AwsCodeBuildProjectDetails

Description

Information about an AWS CodeBuild project.

Members
EncryptionKey
  • Type: string

The AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the build output artifacts.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK alias (using the format alias/alias-name).

Environment
  • Type: AwsCodeBuildProjectEnvironment structure

Information about the build environment for this build project.

Name
  • Type: string

The name of the build project.

ServiceRole
  • Type: string

The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

Source
  • Type: AwsCodeBuildProjectSource structure

Information about the build input source code for this build project.

VpcConfig
  • Type: AwsCodeBuildProjectVpcConfig structure

Information about the VPC configuration that AWS CodeBuild accesses.

AwsCodeBuildProjectEnvironment

Description

Information about the build environment for this build project.

Members
Certificate
  • Type: string

The certificate to use with this build project.

ImagePullCredentialsType
  • Type: string

The type of credentials AWS CodeBuild uses to pull images in your build.

Valid values:

  • CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the AWS CodeBuild service principal.

  • SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.

When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.

RegistryCredential
  • Type: AwsCodeBuildProjectEnvironmentRegistryCredential structure

The credentials for access to a private registry.

Type
  • Type: string

The type of build environment to use for related builds.

The environment type ARM_CONTAINER is available only in Regions US East (N. Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).

The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).

The environment type LINUX_GPU_CONTAINER is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).

Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER

AwsCodeBuildProjectEnvironmentRegistryCredential

Description

The credentials for access to a private registry.

Members
Credential
  • Type: string

The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.

The credential can use the name of the credentials only if they exist in your current AWS Region.

CredentialProvider
  • Type: string

The service that created the credentials to access a private Docker registry.

The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.

AwsCodeBuildProjectSource

Description

Information about the build input source code for this build project.

Members
GitCloneDepth
  • Type: int

Information about the Git clone depth for the build project.

InsecureSsl
  • Type: boolean

Whether to ignore SSL warnings while connecting to the project source code.

Location
  • Type: string

Information about the location of the source code to be built.

Valid values include:

  • For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.

  • For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec file (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).

  • For source code in an S3 input bucket, one of the following.

    • The path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip).

    • The path to the folder that contains the source code (for example, bucket-name/path/to/source-code/folder/).

  • For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec file.

  • For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec file.

Type
  • Type: string

The type of repository that contains the source code to be built. Valid values are:

  • BITBUCKET - The source code is in a Bitbucket repository.

  • CODECOMMIT - The source code is in an AWS CodeCommit repository.

  • CODEPIPELINE - The source code settings are specified in the source action of a pipeline in AWS CodePipeline.

  • GITHUB - The source code is in a GitHub repository.

  • GITHUB_ENTERPRISE - The source code is in a GitHub Enterprise repository.

  • NO_SOURCE - The project does not have input source code.

  • S3 - The source code is in an S3 input bucket.

AwsCodeBuildProjectVpcConfig

Description

Information about the VPC configuration that AWS CodeBuild accesses.

Members
SecurityGroupIds
  • Type: Array of strings

A list of one or more security group IDs in your Amazon VPC.

Subnets
  • Type: Array of strings

A list of one or more subnet IDs in your Amazon VPC.

VpcId
  • Type: string

The ID of the VPC.

AwsCorsConfiguration

Description

Contains the cross-origin resource sharing (CORS) configuration for the API. CORS is only supported for HTTP APIs.

Members
AllowCredentials
  • Type: boolean

Indicates whether the CORS request includes credentials.

AllowHeaders
  • Type: Array of strings

The allowed headers for CORS requests.

AllowMethods
  • Type: Array of strings

The allowed methods for CORS requests.

AllowOrigins
  • Type: Array of strings

The allowed origins for CORS requests.

ExposeHeaders
  • Type: Array of strings

The exposed headers for CORS requests.

MaxAge
  • Type: int

The number of seconds for which the browser caches preflight request results.

AwsDynamoDbTableAttributeDefinition

Description

Contains a definition of an attribute for the table.

Members
AttributeName
  • Type: string

The name of the attribute.

AttributeType
  • Type: string

The type of the attribute.

AwsDynamoDbTableBillingModeSummary

Description

Provides information about the billing for read/write capacity on the table.

Members
BillingMode
  • Type: string

The method used to charge for read and write throughput and to manage capacity.

LastUpdateToPayPerRequestDateTime
  • Type: string

If the billing mode is PAY_PER_REQUEST, indicates when the billing mode was set to that value.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

AwsDynamoDbTableDetails

Description

Provides details about a DynamoDB table.

Members
AttributeDefinitions
  • Type: Array of AwsDynamoDbTableAttributeDefinition structures

A list of attribute definitions for the table.

BillingModeSummary
  • Type: AwsDynamoDbTableBillingModeSummary structure

Information about the billing for read/write capacity on the table.

CreationDateTime
  • Type: string

Indicates when the table was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

GlobalSecondaryIndexes
  • Type: Array of AwsDynamoDbTableGlobalSecondaryIndex structures

List of global secondary indexes for the table.

GlobalTableVersion
  • Type: string

The version of global tables being used.

ItemCount
  • Type: int

The number of items in the table.

KeySchema
  • Type: Array of AwsDynamoDbTableKeySchema structures

The primary key structure for the table.

LatestStreamArn
  • Type: string

The ARN of the latest stream for the table.

LatestStreamLabel
  • Type: string

The label of the latest stream. The label is not a unique identifier.

LocalSecondaryIndexes
  • Type: Array of AwsDynamoDbTableLocalSecondaryIndex structures

The list of local secondary indexes for the table.

ProvisionedThroughput
  • Type: AwsDynamoDbTableProvisionedThroughput structure

Information about the provisioned throughput for the table.

Replicas
  • Type: Array of AwsDynamoDbTableReplica structures

The list of replicas of this table.

RestoreSummary
  • Type: AwsDynamoDbTableRestoreSummary structure

Information about the restore for the table.

SseDescription
  • Type: AwsDynamoDbTableSseDescription structure

Information about the server-side encryption for the table.

StreamSpecification
  • Type: AwsDynamoDbTableStreamSpecification structure

The current DynamoDB Streams configuration for the table.

TableId
  • Type: string

The identifier of the table.

TableName
  • Type: string

The name of the table.

TableSizeBytes
  • Type: long (int|float)

The total size of the table in bytes.

TableStatus
  • Type: string

The current status of the table.

AwsDynamoDbTableGlobalSecondaryIndex

Description

Information abut a global secondary index for the table.

Members
Backfilling
  • Type: boolean

Whether the index is currently backfilling.

IndexArn
  • Type: string

The ARN of the index.

IndexName
  • Type: string

The name of the index.

IndexSizeBytes
  • Type: long (int|float)

The total size in bytes of the index.

IndexStatus
  • Type: string

The current status of the index.

ItemCount
  • Type: int

The number of items in the index.

KeySchema
  • Type: Array of AwsDynamoDbTableKeySchema structures

The key schema for the index.

Projection
  • Type: AwsDynamoDbTableProjection structure

Attributes that are copied from the table into an index.

ProvisionedThroughput
  • Type: AwsDynamoDbTableProvisionedThroughput structure

Information about the provisioned throughput settings for the indexes.

AwsDynamoDbTableKeySchema

Description

A component of the key schema for the DynamoDB table, a global secondary index, or a local secondary index.

Members
AttributeName
  • Type: string

The name of the key schema attribute.

KeyType
  • Type: string

The type of key used for the key schema attribute.

AwsDynamoDbTableLocalSecondaryIndex

Description

Information about a local secondary index for a DynamoDB table.

Members
IndexArn
  • Type: string

The ARN of the index.

IndexName
  • Type: string

The name of the index.

KeySchema
  • Type: Array of AwsDynamoDbTableKeySchema structures

The complete key schema for the index.

Projection
  • Type: AwsDynamoDbTableProjection structure

Attributes that are copied from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

AwsDynamoDbTableProjection

Description

For global and local secondary indexes, identifies the attributes that are copied from the table into the index.

Members
NonKeyAttributes
  • Type: Array of strings

The nonkey attributes that are projected into the index. For each attribute, provide the attribute name.

ProjectionType
  • Type: string

The types of attributes that are projected into the index.

AwsDynamoDbTableProvisionedThroughput

Description

Information about the provisioned throughput for the table or for a global secondary index.

Members
LastDecreaseDateTime
  • Type: string

Indicates when the provisioned throughput was last decreased.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

LastIncreaseDateTime
  • Type: string

Indicates when the provisioned throughput was last increased.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

NumberOfDecreasesToday
  • Type: int

The number of times during the current UTC calendar day that the provisioned throughput was decreased.

ReadCapacityUnits
  • Type: int

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

WriteCapacityUnits
  • Type: int

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

AwsDynamoDbTableProvisionedThroughputOverride

Description

Replica-specific configuration for the provisioned throughput.

Members
ReadCapacityUnits
  • Type: int

The read capacity units for the replica.

AwsDynamoDbTableReplica

Description

Information about a replica of a DynamoDB table.

Members
GlobalSecondaryIndexes
  • Type: Array of AwsDynamoDbTableReplicaGlobalSecondaryIndex structures

List of global secondary indexes for the replica.

KmsMasterKeyId
  • Type: string

The identifier of the AWS KMS customer master key (CMK) that will be used for AWS KMS encryption for the replica.

ProvisionedThroughputOverride
  • Type: AwsDynamoDbTableProvisionedThroughputOverride structure

Replica-specific configuration for the provisioned throughput.

RegionName
  • Type: string

The name of the Region where the replica is located.

ReplicaStatus
  • Type: string

The current status of the replica.

ReplicaStatusDescription
  • Type: string

Detailed information about the replica status.

AwsDynamoDbTableReplicaGlobalSecondaryIndex

Description

Information about a global secondary index for a DynamoDB table replica.

Members
IndexName
  • Type: string

The name of the index.

ProvisionedThroughputOverride
  • Type: AwsDynamoDbTableProvisionedThroughputOverride structure

Replica-specific configuration for the provisioned throughput for the index.

AwsDynamoDbTableRestoreSummary

Description

Information about the restore for the table.

Members
RestoreDateTime
  • Type: string

Indicates the point in time that the table was restored to.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

RestoreInProgress
  • Type: boolean

Whether a restore is currently in progress.

SourceBackupArn
  • Type: string

The ARN of the source backup from which the table was restored.

SourceTableArn
  • Type: string

The ARN of the source table for the backup.

AwsDynamoDbTableSseDescription

Description

Information about the server-side encryption for the table.

Members
InaccessibleEncryptionDateTime
  • Type: string

If the key is inaccessible, the date and time when DynamoDB detected that the key was inaccessible.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

KmsMasterKeyArn
  • Type: string

The ARN of the AWS KMS customer master key (CMK) that is used for the AWS KMS encryption.

SseType
  • Type: string

The type of server-side encryption.

Status
  • Type: string

The status of the server-side encryption.

AwsDynamoDbTableStreamSpecification

Description

The current DynamoDB Streams configuration for the table.

Members
StreamEnabled
  • Type: boolean

Indicates whether DynamoDB Streams is enabled on the table.

StreamViewType
  • Type: string

Determines the information that is written to the table.

AwsEc2EipDetails

Description

Information about an Elastic IP address.

Members
AllocationId
  • Type: string

The identifier that AWS assigns to represent the allocation of the Elastic IP address for use with Amazon VPC.

AssociationId
  • Type: string

The identifier that represents the association of the Elastic IP address with an EC2 instance.

Domain
  • Type: string

The domain in which to allocate the address.

If the address is for use with EC2 instances in a VPC, then Domain is vpc. Otherwise, Domain is standard.

InstanceId
  • Type: string

The identifier of the EC2 instance.

NetworkBorderGroup
  • Type: string

The name of the location from which the Elastic IP address is advertised.

NetworkInterfaceId
  • Type: string

The identifier of the network interface.

NetworkInterfaceOwnerId
  • Type: string

The AWS account ID of the owner of the network interface.

PrivateIpAddress
  • Type: string

The private IP address that is associated with the Elastic IP address.

PublicIp
  • Type: string

A public IP address that is associated with the EC2 instance.

PublicIpv4Pool
  • Type: string

The identifier of an IP address pool. This parameter allows Amazon EC2 to select an IP address from the address pool.

AwsEc2InstanceDetails

Description

The details of an Amazon EC2 instance.

Members
IamInstanceProfileArn
  • Type: string

The IAM profile ARN of the instance.

ImageId
  • Type: string

The Amazon Machine Image (AMI) ID of the instance.

IpV4Addresses
  • Type: Array of strings

The IPv4 addresses associated with the instance.

IpV6Addresses
  • Type: Array of strings

The IPv6 addresses associated with the instance.

KeyName
  • Type: string

The key name associated with the instance.

LaunchedAt
  • Type: string

Indicates when the instance was launched.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

SubnetId
  • Type: string

The identifier of the subnet that the instance was launched in.

Type
  • Type: string

The instance type of the instance.

VpcId
  • Type: string

The identifier of the VPC that the instance was launched in.

AwsEc2NetworkInterfaceAttachment

Description

Information about the network interface attachment.

Members
AttachTime
  • Type: string

Indicates when the attachment initiated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

AttachmentId
  • Type: string

The identifier of the network interface attachment

DeleteOnTermination
  • Type: boolean

Indicates whether the network interface is deleted when the instance is terminated.

DeviceIndex
  • Type: int

The device index of the network interface attachment on the instance.

InstanceId
  • Type: string

The ID of the instance.

InstanceOwnerId
  • Type: string

The AWS account ID of the owner of the instance.

Status
  • Type: string

The attachment state.

Valid values: attaching | attached | detaching | detached

AwsEc2NetworkInterfaceDetails

Description

Details about the network interface

Members
Attachment
  • Type: AwsEc2NetworkInterfaceAttachment structure

The network interface attachment.

IpV6Addresses
  • Type: Array of AwsEc2NetworkInterfaceIpV6AddressDetail structures

The IPv6 addresses associated with the network interface.

NetworkInterfaceId
  • Type: string

The ID of the network interface.

PrivateIpAddresses
  • Type: Array of AwsEc2NetworkInterfacePrivateIpAddressDetail structures

The private IPv4 addresses associated with the network interface.

PublicDnsName
  • Type: string

The public DNS name of the network interface.

PublicIp
  • Type: string

The address of the Elastic IP address bound to the network interface.

SecurityGroups
  • Type: Array of AwsEc2NetworkInterfaceSecurityGroup structures

Security groups for the network interface.

SourceDestCheck
  • Type: boolean

Indicates whether traffic to or from the instance is validated.

AwsEc2NetworkInterfaceIpV6AddressDetail

Description

Provides information about an IPV6 address that is associated with the network interface.

Members
IpV6Address
  • Type: string

The IPV6 address.

AwsEc2NetworkInterfacePrivateIpAddressDetail

Description

Provides information about a private IPv4 address that is with the network interface.

Members
PrivateDnsName
  • Type: string

The private DNS name for the IP address.

PrivateIpAddress
  • Type: string

The IP address.

AwsEc2NetworkInterfaceSecurityGroup

Description

A security group associated with the network interface.

Members
GroupId
  • Type: string

The ID of the security group.

GroupName
  • Type: string

The name of the security group.

AwsEc2SecurityGroupDetails

Description

Details about an EC2 security group.

Members
GroupId
  • Type: string

The ID of the security group.

GroupName
  • Type: string

The name of the security group.

IpPermissions
  • Type: Array of AwsEc2SecurityGroupIpPermission structures

The inbound rules associated with the security group.

IpPermissionsEgress
  • Type: Array of AwsEc2SecurityGroupIpPermission structures

[VPC only] The outbound rules associated with the security group.

OwnerId
  • Type: string

The AWS account ID of the owner of the security group.

VpcId
  • Type: string

[VPC only] The ID of the VPC for the security group.

AwsEc2SecurityGroupIpPermission

Description

An IP permission for an EC2 security group.

Members
FromPort
  • Type: int

The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

IpProtocol
  • Type: string

The IP protocol name (tcp, udp, icmp, icmpv6) or number.

[VPC only] Use -1 to specify all protocols.

When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify.

For tcp, udp, and icmp, you must specify a port range.

For icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.

IpRanges
  • Type: Array of AwsEc2SecurityGroupIpRange structures

The IPv4 ranges.

Ipv6Ranges
  • Type: Array of AwsEc2SecurityGroupIpv6Range structures

The IPv6 ranges.

PrefixListIds
  • Type: Array of AwsEc2SecurityGroupPrefixListId structures

[VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS service to access through a VPC endpoint from instances associated with the security group.

ToPort
  • Type: int

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.

UserIdGroupPairs
  • Type: Array of AwsEc2SecurityGroupUserIdGroupPair structures

The security group and AWS account ID pairs.

AwsEc2SecurityGroupIpRange

Description

A range of IPv4 addresses.

Members
CidrIp
  • Type: string

The IPv4 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv4 address, use the /32 prefix length.

AwsEc2SecurityGroupIpv6Range

Description

A range of IPv6 addresses.

Members
CidrIpv6
  • Type: string

The IPv6 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv6 address, use the /128 prefix length.

AwsEc2SecurityGroupPrefixListId

Description

A prefix list ID.

Members
PrefixListId
  • Type: string

The ID of the prefix.

AwsEc2SecurityGroupUserIdGroupPair

Description

A relationship between a security group and a user.

Members
GroupId
  • Type: string

The ID of the security group.

GroupName
  • Type: string

The name of the security group.

PeeringStatus
  • Type: string

The status of a VPC peering connection, if applicable.

UserId
  • Type: string

The ID of an AWS account.

For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS.

VpcId
  • Type: string

The ID of the VPC for the referenced security group, if applicable.

VpcPeeringConnectionId
  • Type: string

The ID of the VPC peering connection, if applicable.

AwsEc2VolumeAttachment

Description

An attachment to an AWS EC2 volume.

Members
AttachTime
  • Type: string

The datetime when the attachment initiated.

DeleteOnTermination
  • Type: boolean

Whether the EBS volume is deleted when the EC2 instance is terminated.

InstanceId
  • Type: string

The identifier of the EC2 instance.

Status
  • Type: string

The attachment state of the volume.

AwsEc2VolumeDetails

Description

Details about an EC2 volume.

Members
Attachments
  • Type: Array of AwsEc2VolumeAttachment structures

The volume attachments.

CreateTime
  • Type: string

Indicates when the volume was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Encrypted
  • Type: boolean

Whether the volume is encrypted.

KmsKeyId
  • Type: string

The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

Size
  • Type: int

The size of the volume, in GiBs.

SnapshotId
  • Type: string

The snapshot from which the volume was created.

Status
  • Type: string

The volume state.

AwsEc2VpcDetails

Description

Details about an EC2 VPC.

Members
CidrBlockAssociationSet
  • Type: Array of CidrBlockAssociation structures

Information about the IPv4 CIDR blocks associated with the VPC.

DhcpOptionsId
  • Type: string

The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are associated with the VPC. If the default options are associated with the VPC, then this is default.

Ipv6CidrBlockAssociationSet
  • Type: Array of Ipv6CidrBlockAssociation structures

Information about the IPv6 CIDR blocks associated with the VPC.

State
  • Type: string

The current state of the VPC.

AwsElasticsearchDomainDetails

Description

Information about an Elasticsearch domain.

Members
AccessPolicies
  • Type: string

IAM policy document specifying the access policies for the new Amazon ES domain.

DomainEndpointOptions
  • Type: AwsElasticsearchDomainDomainEndpointOptions structure

Additional options for the domain endpoint.

DomainId
  • Type: string

Unique identifier for an Amazon ES domain.

DomainName
  • Type: string

Name of an Amazon ES domain.

Domain names are unique across all domains owned by the same account within an AWS Region.

Domain names must start with a lowercase letter and must be between 3 and 28 characters.

Valid characters are a-z (lowercase only), 0-9, and – (hyphen).

ElasticsearchVersion
  • Type: string

Elasticsearch version.

EncryptionAtRestOptions
  • Type: AwsElasticsearchDomainEncryptionAtRestOptions structure

Details about the configuration for encryption at rest.

Endpoint
  • Type: string

Domain-specific endpoint used to submit index, search, and data upload requests to an Amazon ES domain.

The endpoint is a service URL.

Endpoints
  • Type: Associative array of custom strings keys (NonEmptyString) to strings

The key-value pair that exists if the Amazon ES domain uses VPC endpoints.

NodeToNodeEncryptionOptions
  • Type: AwsElasticsearchDomainNodeToNodeEncryptionOptions structure

Details about the configuration for node-to-node encryption.

VPCOptions
  • Type: AwsElasticsearchDomainVPCOptions structure

Information that Amazon ES derives based on VPCOptions for the domain.

AwsElasticsearchDomainDomainEndpointOptions

Description

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

Members
EnforceHTTPS
  • Type: boolean

Whether to require that all traffic to the domain arrive over HTTPS.

TLSSecurityPolicy
  • Type: string

The TLS security policy to apply to the HTTPS endpoint of the Elasticsearch domain.

Valid values:

  • Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and higher

  • Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.2

AwsElasticsearchDomainEncryptionAtRestOptions

Description

Details about the configuration for encryption at rest.

Members
Enabled
  • Type: boolean

Whether encryption at rest is enabled.

KmsKeyId
  • Type: string

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

AwsElasticsearchDomainNodeToNodeEncryptionOptions

Description

Details about the configuration for node-to-node encryption.

Members
Enabled
  • Type: boolean

Whether node-to-node encryption is enabled.

AwsElasticsearchDomainVPCOptions

Description

Information that Amazon ES derives based on VPCOptions for the domain.

Members
AvailabilityZones
  • Type: Array of strings

The list of Availability Zones associated with the VPC subnets.

SecurityGroupIds
  • Type: Array of strings

The list of security group IDs associated with the VPC endpoints for the domain.

SubnetIds
  • Type: Array of strings

A list of subnet IDs associated with the VPC endpoints for the domain.

VPCId
  • Type: string

ID for the VPC.

AwsElbAppCookieStickinessPolicy

Description

Contains information about a stickiness policy that was created using CreateAppCookieStickinessPolicy.

Members
CookieName
  • Type: string

The name of the application cookie used for stickiness.

PolicyName
  • Type: string

The mnemonic name for the policy being created. The name must be unique within the set of policies for the load balancer.

AwsElbLbCookieStickinessPolicy

Description

Contains information about a stickiness policy that was created using CreateLBCookieStickinessPolicy.

Members
CookieExpirationPeriod
  • Type: long (int|float)

The amount of time, in seconds, after which the cookie is considered stale. If an expiration period is not specified, the stickiness session lasts for the duration of the browser session.

PolicyName
  • Type: string

The name of the policy. The name must be unique within the set of policies for the load balancer.

AwsElbLoadBalancerAccessLog

Description

Contains information about the access log configuration for the load balancer.

Members
EmitInterval
  • Type: int

The interval in minutes for publishing the access logs.

You can publish access logs either every 5 minutes or every 60 minutes.

Enabled
  • Type: boolean

Indicates whether access logs are enabled for the load balancer.

S3BucketName
  • Type: string

The name of the S3 bucket where the access logs are stored.

S3BucketPrefix
  • Type: string

The logical hierarchy that was created for the S3 bucket.

If a prefix is not provided, the log is placed at the root level of the bucket.

AwsElbLoadBalancerAttributes

Description

Contains attributes for the load balancer.

Members
AccessLog
  • Type: AwsElbLoadBalancerAccessLog structure

Information about the access log configuration for the load balancer.

If the access log is enabled, the load balancer captures detailed information about all requests. It delivers the information to a specified S3 bucket.

ConnectionDraining
  • Type: AwsElbLoadBalancerConnectionDraining structure

Information about the connection draining configuration for the load balancer.

If connection draining is enabled, the load balancer allows existing requests to complete before it shifts traffic away from a deregistered or unhealthy instance.

ConnectionSettings
  • Type: AwsElbLoadBalancerConnectionSettings structure

Connection settings for the load balancer.

If an idle timeout is configured, the load balancer allows connections to remain idle for the specified duration. When a connection is idle, no data is sent over the connection.

CrossZoneLoadBalancing
  • Type: AwsElbLoadBalancerCrossZoneLoadBalancing structure

Cross-zone load balancing settings for the load balancer.

If cross-zone load balancing is enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.

AwsElbLoadBalancerBackendServerDescription

Description

Provides information about the configuration of an EC2 instance for the load balancer.

Members
InstancePort
  • Type: int

The port on which the EC2 instance is listening.

PolicyNames
  • Type: Array of strings

The names of the policies that are enabled for the EC2 instance.

AwsElbLoadBalancerConnectionDraining

Description

Contains information about the connection draining configuration for the load balancer.

Members
Enabled
  • Type: boolean

Indicates whether connection draining is enabled for the load balancer.

Timeout
  • Type: int

The maximum time, in seconds, to keep the existing connections open before deregistering the instances.

AwsElbLoadBalancerConnectionSettings

Description

Contains connection settings for the load balancer.

Members
IdleTimeout
  • Type: int

The time, in seconds, that the connection can be idle (no data is sent over the connection) before it is closed by the load balancer.

AwsElbLoadBalancerCrossZoneLoadBalancing

Description

Contains cross-zone load balancing settings for the load balancer.

Members
Enabled
  • Type: boolean

Indicates whether cross-zone load balancing is enabled for the load balancer.

AwsElbLoadBalancerDetails

Description

Contains details about a Classic Load Balancer.

Members
AvailabilityZones
  • Type: Array of strings

The list of Availability Zones for the load balancer.

BackendServerDescriptions
  • Type: Array of AwsElbLoadBalancerBackendServerDescription structures

Information about the configuration of the EC2 instances.

CanonicalHostedZoneName
  • Type: string

The name of the Amazon Route 53 hosted zone for the load balancer.

CanonicalHostedZoneNameID
  • Type: string

The ID of the Amazon Route 53 hosted zone for the load balancer.

CreatedTime
  • Type: string

Indicates when the load balancer was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

DnsName
  • Type: string

The DNS name of the load balancer.

HealthCheck
  • Type: AwsElbLoadBalancerHealthCheck structure

Information about the health checks that are conducted on the load balancer.

Instances
  • Type: Array of AwsElbLoadBalancerInstance structures

List of EC2 instances for the load balancer.

ListenerDescriptions
  • Type: Array of AwsElbLoadBalancerListenerDescription structures

The policies that are enabled for the load balancer listeners.

LoadBalancerAttributes
  • Type: AwsElbLoadBalancerAttributes structure

The attributes for a load balancer.

LoadBalancerName
  • Type: string

The name of the load balancer.

Policies
  • Type: AwsElbLoadBalancerPolicies structure

The policies for a load balancer.

Scheme
  • Type: string

The type of load balancer. Only provided if the load balancer is in a VPC.

If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address.

If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.

SecurityGroups
  • Type: Array of strings

The security groups for the load balancer. Only provided if the load balancer is in a VPC.

SourceSecurityGroup
  • Type: AwsElbLoadBalancerSourceSecurityGroup structure

Information about the security group for the load balancer. This is the security group that is used for inbound rules.

Subnets
  • Type: Array of strings

The list of subnet identifiers for the load balancer.

VpcId
  • Type: string

The identifier of the VPC for the load balancer.

AwsElbLoadBalancerHealthCheck

Description

Contains information about the health checks that are conducted on the load balancer.

Members
HealthyThreshold
  • Type: int

The number of consecutive health check successes required before the instance is moved to the Healthy state.

Interval
  • Type: int

The approximate interval, in seconds, between health checks of an individual instance.

Target
  • Type: string

The instance that is being checked. The target specifies the protocol and port. The available protocols are TCP, SSL, HTTP, and HTTPS. The range of valid ports is 1 through 65535.

For the HTTP and HTTPS protocols, the target also specifies the ping path.

For the TCP protocol, the target is specified as TCP: <port> .

For the SSL protocol, the target is specified as SSL.<port> .

For the HTTP and HTTPS protocols, the target is specified as <protocol>:<port>/<path to ping> .

Timeout
  • Type: int

The amount of time, in seconds, during which no response means a failed health check.

UnhealthyThreshold
  • Type: int

The number of consecutive health check failures that must occur before the instance is moved to the Unhealthy state.

AwsElbLoadBalancerInstance

Description

Provides information about an EC2 instance for a load balancer.

Members
InstanceId
  • Type: string

The instance identifier.

AwsElbLoadBalancerListener

Description

Information about a load balancer listener.

Members
InstancePort
  • Type: int

The port on which the instance is listening.

InstanceProtocol
  • Type: string

The protocol to use to route traffic to instances.

Valid values: HTTP | HTTPS | TCP | SSL

LoadBalancerPort
  • Type: int

The port on which the load balancer is listening.

On EC2-VPC, you can specify any port from the range 1-65535.

On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.

Protocol
  • Type: string

The load balancer transport protocol to use for routing.

Valid values: HTTP | HTTPS | TCP | SSL

SslCertificateId
  • Type: string

The ARN of the server certificate.

AwsElbLoadBalancerListenerDescription

Description

Lists the policies that are enabled for a load balancer listener.

Members
Listener
  • Type: AwsElbLoadBalancerListener structure

Information about the listener.

PolicyNames
  • Type: Array of strings

The policies enabled for the listener.

AwsElbLoadBalancerPolicies

Description

Contains information about the policies for a load balancer.

Members
AppCookieStickinessPolicies
  • Type: Array of AwsElbAppCookieStickinessPolicy structures

The stickiness policies that are created using CreateAppCookieStickinessPolicy.

LbCookieStickinessPolicies
  • Type: Array of AwsElbLbCookieStickinessPolicy structures

The stickiness policies that are created using CreateLBCookieStickinessPolicy.

OtherPolicies
  • Type: Array of strings

The policies other than the stickiness policies.

AwsElbLoadBalancerSourceSecurityGroup

Description

Contains information about the security group for the load balancer.

Members
GroupName
  • Type: string

The name of the security group.

OwnerAlias
  • Type: string

The owner of the security group.

AwsElbv2LoadBalancerDetails

Description

Information about a load balancer.

Members
AvailabilityZones
  • Type: Array of AvailabilityZone structures

The Availability Zones for the load balancer.

CanonicalHostedZoneId
  • Type: string

The ID of the Amazon Route 53 hosted zone associated with the load balancer.

CreatedTime
  • Type: string

Indicates when the load balancer was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

DNSName
  • Type: string

The public DNS name of the load balancer.

IpAddressType
  • Type: string

The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

Scheme
  • Type: string

The nodes of an Internet-facing load balancer have public IP addresses.

SecurityGroups
  • Type: Array of strings

The IDs of the security groups for the load balancer.

State
  • Type: LoadBalancerState structure

The state of the load balancer.

Type
  • Type: string

The type of load balancer.

VpcId
  • Type: string

The ID of the VPC for the load balancer.

AwsIamAccessKeyDetails

Description

IAM access key details related to a finding.

Members
AccessKeyId
  • Type: string

The identifier of the access key.

AccountId
  • Type: string

The AWS account ID of the account for the key.

CreatedAt
  • Type: string

Indicates when the IAM access key was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

PrincipalId
  • Type: string

The ID of the principal associated with an access key.

PrincipalName
  • Type: string

The name of the principal.

PrincipalType
  • Type: string

The type of principal associated with an access key.

SessionContext
  • Type: AwsIamAccessKeySessionContext structure

Information about the session that the key was used for.

Status
  • Type: string

The status of the IAM access key related to a finding.

UserName
  • Type: string

The user associated with the IAM access key related to a finding.

The UserName parameter has been replaced with the PrincipalName parameter because access keys can also be assigned to principals that are not IAM users.

AwsIamAccessKeySessionContext

Description

Provides information about the session that the key was used for.

Members
Attributes
  • Type: AwsIamAccessKeySessionContextAttributes structure

Attributes of the session that the key was used for.

SessionIssuer
  • Type: AwsIamAccessKeySessionContextSessionIssuer structure

Information about the entity that created the session.

AwsIamAccessKeySessionContextAttributes

Description

Attributes of the session that the key was used for.

Members
CreationDate
  • Type: string

Indicates when the session was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

MfaAuthenticated
  • Type: boolean

Indicates whether the session used multi-factor authentication (MFA).

AwsIamAccessKeySessionContextSessionIssuer

Description

Information about the entity that created the session.

Members
AccountId
  • Type: string

The identifier of the AWS account that created the session.

Arn
  • Type: string

The ARN of the session.

PrincipalId
  • Type: string

The principal ID of the principal (user, role, or group) that created the session.

Type
  • Type: string

The type of principal (user, role, or group) that created the session.

UserName
  • Type: string

The name of the principal that created the session.

AwsIamAttachedManagedPolicy

Description

A managed policy that is attached to an IAM principal.

Members
PolicyArn
  • Type: string

The ARN of the policy.

PolicyName
  • Type: string

The name of the policy.

AwsIamGroupDetails

Description

Contains details about an IAM group.

Members
AttachedManagedPolicies
  • Type: Array of AwsIamAttachedManagedPolicy structures

A list of the managed policies that are attached to the IAM group.

CreateDate
  • Type: string

Indicates when the IAM group was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

GroupId
  • Type: string

The identifier of the IAM group.

GroupName
  • Type: string

The name of the IAM group.

GroupPolicyList
  • Type: Array of AwsIamGroupPolicy structures

The list of inline policies that are embedded in the group.

Path
  • Type: string

The path to the group.

AwsIamGroupPolicy

Description

A managed policy that is attached to the IAM group.

Members
PolicyName
  • Type: string

The name of the policy.

AwsIamInstanceProfile

Description

Information about an instance profile.

Members
Arn
  • Type: string

The ARN of the instance profile.

CreateDate
  • Type: string

Indicates when the instance profile was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

InstanceProfileId
  • Type: string

The identifier of the instance profile.

InstanceProfileName
  • Type: string

The name of the instance profile.

Path
  • Type: string

The path to the instance profile.

Roles
  • Type: Array of AwsIamInstanceProfileRole structures

The roles associated with the instance profile.

AwsIamInstanceProfileRole

Description

Information about a role associated with an instance profile.

Members
Arn
  • Type: string

The ARN of the role.

AssumeRolePolicyDocument
  • Type: string

The policy that grants an entity permission to assume the role.

CreateDate
  • Type: string

Indicates when the role was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Path
  • Type: string

The path to the role.

RoleId
  • Type: string

The identifier of the role.

RoleName
  • Type: string

The name of the role.

AwsIamPermissionsBoundary

Description

Information about the policy used to set the permissions boundary for an IAM principal.

Members
PermissionsBoundaryArn
  • Type: string

The ARN of the policy used to set the permissions boundary.

PermissionsBoundaryType
  • Type: string

The usage type for the permissions boundary.

AwsIamPolicyDetails

Description

Represents an IAM permissions policy.

Members
AttachmentCount
  • Type: int

The number of users, groups, and roles that the policy is attached to.

CreateDate
  • Type: string

When the policy was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

DefaultVersionId
  • Type: string

The identifier of the default version of the policy.

Description
  • Type: string

A description of the policy.

IsAttachable
  • Type: boolean

Whether the policy can be attached to a user, group, or role.

Path
  • Type: string

The path to the policy.

PermissionsBoundaryUsageCount
  • Type: int

The number of users and roles that use the policy to set the permissions boundary.

PolicyId
  • Type: string

The unique identifier of the policy.

PolicyName
  • Type: string

The name of the policy.

PolicyVersionList
  • Type: Array of AwsIamPolicyVersion structures

List of versions of the policy.

UpdateDate
  • Type: string

When the policy was most recently updated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

AwsIamPolicyVersion

Description

A version of an IAM policy.

Members
CreateDate
  • Type: string

Indicates when the version was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

IsDefaultVersion
  • Type: boolean

Whether the version is the default version.

VersionId
  • Type: string

The identifier of the policy version.

AwsIamRoleDetails

Description

Contains information about an IAM role, including all of the role's policies.

Members
AssumeRolePolicyDocument
  • Type: string

The trust policy that grants permission to assume the role.

AttachedManagedPolicies
  • Type: Array of AwsIamAttachedManagedPolicy structures

The list of the managed policies that are attached to the role.

CreateDate
  • Type: string

Indicates when the role was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

InstanceProfileList
  • Type: Array of AwsIamInstanceProfile structures

The list of instance profiles that contain this role.

MaxSessionDuration
  • Type: int

The maximum session duration (in seconds) that you want to set for the specified role.

Path
  • Type: string

The path to the role.

PermissionsBoundary
  • Type: AwsIamPermissionsBoundary structure

Information about the policy used to set the permissions boundary for an IAM principal.

RoleId
  • Type: string

The stable and unique string identifying the role.

RoleName
  • Type: string

The friendly name that identifies the role.

RolePolicyList
  • Type: Array of AwsIamRolePolicy structures

The list of inline policies that are embedded in the role.

AwsIamRolePolicy

Description

An inline policy that is embedded in the role.

Members
PolicyName
  • Type: string

The name of the policy.

AwsIamUserDetails

Description

Information about an IAM user.

Members
AttachedManagedPolicies
  • Type: Array of AwsIamAttachedManagedPolicy structures

A list of the managed policies that are attached to the user.

CreateDate
  • Type: string

Indicates when the user was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

GroupList
  • Type: Array of strings

A list of IAM groups that the user belongs to.

Path
  • Type: string

The path to the user.

PermissionsBoundary
  • Type: AwsIamPermissionsBoundary structure

The permissions boundary for the user.

UserId
  • Type: string

The unique identifier for the user.

UserName
  • Type: string

The name of the user.

UserPolicyList
  • Type: Array of AwsIamUserPolicy structures

The list of inline policies that are embedded in the user.

AwsIamUserPolicy

Description

Information about an inline policy that is embedded in the user.

Members
PolicyName
  • Type: string

The name of the policy.

AwsKmsKeyDetails

Description

Contains metadata about a customer master key (CMK).

Members
AWSAccountId
  • Type: string

The twelve-digit account ID of the AWS account that owns the CMK.

CreationDate
  • Type: double

Indicates when the CMK was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Description
  • Type: string

A description of the key.

KeyId
  • Type: string

The globally unique identifier for the CMK.

KeyManager
  • Type: string

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.

KeyState
  • Type: string

The state of the CMK.

Origin
  • Type: string

The source of the CMK's key material.

When this value is AWS_KMS, AWS KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.

AwsLambdaFunctionCode

Description

The code for the Lambda function. You can specify either an object in Amazon S3, or upload a deployment package directly.

Members
S3Bucket
  • Type: string

An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.

S3Key
  • Type: string

The Amazon S3 key of the deployment package.

S3ObjectVersion
  • Type: string

For versioned objects, the version of the deployment package object to use.

ZipFile
  • Type: string

The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.

AwsLambdaFunctionDeadLetterConfig

Description

The dead-letter queue for failed asynchronous invocations.

Members
TargetArn
  • Type: string

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

AwsLambdaFunctionDetails

Description

Details about a function's configuration.

Members
Code
  • Type: AwsLambdaFunctionCode structure

An AwsLambdaFunctionCode object.

CodeSha256
  • Type: string

The SHA256 hash of the function's deployment package.

DeadLetterConfig
  • Type: AwsLambdaFunctionDeadLetterConfig structure

The function's dead letter queue.

Environment
  • Type: AwsLambdaFunctionEnvironment structure

The function's environment variables.

FunctionName
  • Type: string

The name of the function.

Handler
  • Type: string

The function that Lambda calls to begin executing your function.

KmsKeyArn
  • Type: string

The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.

LastModified
  • Type: string

Indicates when the function was last updated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Layers
  • Type: Array of AwsLambdaFunctionLayer structures

The function's layers.

MasterArn
  • Type: string

For Lambda@Edge functions, the ARN of the master function.

MemorySize
  • Type: int

The memory that's allocated to the function.

RevisionId
  • Type: string

The latest updated revision of the function or alias.

Role
  • Type: string

The function's execution role.

Runtime
  • Type: string

The runtime environment for the Lambda function.

Timeout
  • Type: int

The amount of time that Lambda allows a function to run before stopping it.

TracingConfig
  • Type: AwsLambdaFunctionTracingConfig structure

The function's AWS X-Ray tracing configuration.

Version
  • Type: string

The version of the Lambda function.

VpcConfig
  • Type: AwsLambdaFunctionVpcConfig structure

The function's networking configuration.

AwsLambdaFunctionEnvironment

Description

A function's environment variable settings.

Members
Error
  • Type: AwsLambdaFunctionEnvironmentError structure

An AwsLambdaFunctionEnvironmentError object.

Variables
  • Type: Associative array of custom strings keys (NonEmptyString) to strings

Environment variable key-value pairs.

AwsLambdaFunctionEnvironmentError

Description

Error messages for environment variables that couldn't be applied.

Members
ErrorCode
  • Type: string

The error code.

Message
  • Type: string

The error message.

AwsLambdaFunctionLayer

Description

An AWS Lambda layer.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the function layer.

CodeSize
  • Type: int

The size of the layer archive in bytes.

AwsLambdaFunctionTracingConfig

Description

The function's AWS X-Ray tracing configuration.

Members
Mode
  • Type: string

The tracing mode.

AwsLambdaFunctionVpcConfig

Description

The VPC security groups and subnets that are attached to a Lambda function. For more information, see VPC Settings.

Members
SecurityGroupIds
  • Type: Array of strings

A list of VPC security groups IDs.

SubnetIds
  • Type: Array of strings

A list of VPC subnet IDs.

VpcId
  • Type: string

The ID of the VPC.

AwsLambdaLayerVersionDetails

Description

Details about a Lambda layer version.

Members
CompatibleRuntimes
  • Type: Array of strings

The layer's compatible runtimes. Maximum number of five items.

Valid values: nodejs10.x | nodejs12.x | java8 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | dotnetcore1.0 | dotnetcore2.1 | go1.x | ruby2.5 | provided

CreatedDate
  • Type: string

Indicates when the version was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Version
  • Type: long (int|float)

The version number.

AwsRdsDbClusterAssociatedRole

Description

An IAM role that is associated with the Amazon RDS DB cluster.

Members
RoleArn
  • Type: string

The ARN of the IAM role.

Status
  • Type: string

The status of the association between the IAM role and the DB cluster.

AwsRdsDbClusterDetails

Description

Information about an Amazon RDS DB cluster.

Members
ActivityStreamStatus
  • Type: string

The status of the database activity stream.

AllocatedStorage
  • Type: int

For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).

AssociatedRoles
  • Type: Array of AwsRdsDbClusterAssociatedRole structures

A list of the IAM roles that are associated with the DB cluster.

AvailabilityZones
  • Type: Array of strings

A list of Availability Zones (AZs) where instances in the DB cluster can be created.

BackupRetentionPeriod
  • Type: int

The number of days for which automated backups are retained.

ClusterCreateTime
  • Type: string

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

CopyTagsToSnapshot
  • Type: boolean

Whether tags are copied from the DB cluster to snapshots of the DB cluster.

CrossAccountClone
  • Type: boolean

Whether the DB cluster is a clone of a DB cluster owned by a different AWS account.

CustomEndpoints
  • Type: Array of strings

A list of custom endpoints for the DB cluster.

DatabaseName
  • Type: string

The name of the database.

DbClusterIdentifier
  • Type: string

The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.

DbClusterMembers
  • Type: Array of AwsRdsDbClusterMember structures

The list of instances that make up the DB cluster.

DbClusterOptionGroupMemberships
  • Type: Array of AwsRdsDbClusterOptionGroupMembership structures

The list of option group memberships for this DB cluster.

DbClusterParameterGroup
  • Type: string

The name of the DB cluster parameter group for the DB cluster.

DbClusterResourceId
  • Type: string

The identifier of the DB cluster. The identifier must be unique within each AWS Region and is immutable.

DbSubnetGroup
  • Type: string

The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

DeletionProtection
  • Type: boolean

Whether the DB cluster has deletion protection enabled.

DomainMemberships
  • Type: Array of AwsRdsDbDomainMembership structures

The Active Directory domain membership records that are associated with the DB cluster.

EnabledCloudWatchLogsExports
  • Type: Array of strings

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

Endpoint
  • Type: string

The connection endpoint for the primary instance of the DB cluster.

Engine
  • Type: string

The name of the database engine to use for this DB cluster.

EngineMode
  • Type: string

The database engine mode of the DB cluster.

EngineVersion
  • Type: string

The version number of the database engine to use.

HostedZoneId
  • Type: string

Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.

HttpEndpointEnabled
  • Type: boolean

Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

IamDatabaseAuthenticationEnabled
  • Type: boolean

Whether the mapping of IAM accounts to database accounts is enabled.

KmsKeyId
  • Type: string

The ARN of the AWS KMS master key that is used to encrypt the database instances in the DB cluster.

MasterUsername
  • Type: string

The name of the master user for the DB cluster.

MultiAz
  • Type: boolean

Whether the DB cluster has instances in multiple Availability Zones.

Port
  • Type: int

The port number on which the DB instances in the DB cluster accept connections.

PreferredBackupWindow
  • Type: string

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

PreferredMaintenanceWindow
  • Type: string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Uses the format <day>:HH:MM-<day>:HH:MM.

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

ReadReplicaIdentifiers
  • Type: Array of strings

The identifiers of the read replicas that are associated with this DB cluster.

ReaderEndpoint
  • Type: string

The reader endpoint for the DB cluster.

Status
  • Type: string

The current status of this DB cluster.

StorageEncrypted
  • Type: boolean

Whether the DB cluster is encrypted.

VpcSecurityGroups
  • Type: Array of AwsRdsDbInstanceVpcSecurityGroup structures

A list of VPC security groups that the DB cluster belongs to.

AwsRdsDbClusterMember

Description

Information about an instance in the DB cluster.

Members
DbClusterParameterGroupStatus
  • Type: string

The status of the DB cluster parameter group for this member of the DB cluster.

DbInstanceIdentifier
  • Type: string

The instance identifier for this member of the DB cluster.

IsClusterWriter
  • Type: boolean

Whether the cluster member is the primary instance for the DB cluster.

PromotionTier
  • Type: int

Specifies the order in which an Aurora replica is promoted to the primary instance when the existing primary instance fails.

AwsRdsDbClusterOptionGroupMembership

Description

Information about an option group membership for a DB cluster.

Members
DbClusterOptionGroupName
  • Type: string

The name of the DB cluster option group.

Status
  • Type: string

The status of the DB cluster option group.

AwsRdsDbClusterSnapshotDetails

Description

Information about an Amazon RDS DB cluster snapshot.

Members
AllocatedStorage
  • Type: int

Specifies the allocated storage size in gibibytes (GiB).

AvailabilityZones
  • Type: Array of strings

A list of Availability Zones where instances in the DB cluster can be created.

ClusterCreateTime
  • Type: string

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

DbClusterIdentifier
  • Type: string

The DB cluster identifier.

DbClusterSnapshotIdentifier
  • Type: string

The identifier of the DB cluster snapshot.

Engine
  • Type: string

The name of the database engine that you want to use for this DB instance.

EngineVersion
  • Type: string

The version of the database engine to use.

IamDatabaseAuthenticationEnabled
  • Type: boolean

Whether mapping of IAM accounts to database accounts is enabled.

KmsKeyId
  • Type: string

The ARN of the AWS KMS master key that is used to encrypt the database instances in the DB cluster.

LicenseModel
  • Type: string

The license model information for this DB cluster snapshot.

MasterUsername
  • Type: string

The name of the master user for the DB cluster.

PercentProgress
  • Type: int

Specifies the percentage of the estimated data that has been transferred.

Port
  • Type: int

The port number on which the DB instances in the DB cluster accept connections.

SnapshotCreateTime
  • Type: string

Indicates when the snapshot was taken.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

SnapshotType
  • Type: string

The type of DB cluster snapshot.

Status
  • Type: string

The status of this DB cluster snapshot.

StorageEncrypted
  • Type: boolean

Whether the DB cluster is encrypted.

VpcId
  • Type: string

The VPC ID that is associated with the DB cluster snapshot.

AwsRdsDbDomainMembership

Description

Information about an Active Directory domain membership record associated with the DB instance.

Members
Domain
  • Type: string

The identifier of the Active Directory domain.

Fqdn
  • Type: string

The fully qualified domain name of the Active Directory domain.

IamRoleName
  • Type: string

The name of the IAM role to use when making API calls to the Directory Service.

Status
  • Type: string

The status of the Active Directory Domain membership for the DB instance.

AwsRdsDbInstanceAssociatedRole

Description

An AWS Identity and Access Management (IAM) role associated with the DB instance.

Members
FeatureName
  • Type: string

The name of the feature associated with the IAM)role.

RoleArn
  • Type: string

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

Status
  • Type: string

Describes the state of the association between the IAM role and the DB instance. The Status property returns one of the following values:

  • ACTIVE - The IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf.

  • PENDING - The IAM role ARN is being associated with the DB instance.

  • INVALID - The IAM role ARN is associated with the DB instance. But the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf.

AwsRdsDbInstanceDetails

Description

Contains the details of an Amazon RDS DB instance.

Members
AllocatedStorage
  • Type: int

The amount of storage (in gigabytes) to initially allocate for the DB instance.

AssociatedRoles
  • Type: Array of AwsRdsDbInstanceAssociatedRole structures

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

AutoMinorVersionUpgrade
  • Type: boolean

Indicates whether minor version patches are applied automatically.

AvailabilityZone
  • Type: string

The Availability Zone where the DB instance will be created.

BackupRetentionPeriod
  • Type: int

The number of days for which to retain automated backups.

CACertificateIdentifier
  • Type: string

The identifier of the CA certificate for this DB instance.

CharacterSetName
  • Type: string

The name of the character set that this DB instance is associated with.

CopyTagsToSnapshot
  • Type: boolean

Whether to copy resource tags to snapshots of the DB instance.

DBClusterIdentifier
  • Type: string

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

DBInstanceClass
  • Type: string

Contains the name of the compute and memory capacity class of the DB instance.

DBInstanceIdentifier
  • Type: string

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

DBName
  • Type: string

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

DbInstancePort
  • Type: int

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

DbInstanceStatus
  • Type: string

The current status of the DB instance.

DbParameterGroups
  • Type: Array of AwsRdsDbParameterGroup structures

A list of the DB parameter groups to assign to the DB instance.

DbSecurityGroups
  • Type: Array of strings

A list of the DB security groups to assign to the DB instance.

DbSubnetGroup
  • Type: AwsRdsDbSubnetGroup structure

Information about the subnet group that is associated with the DB instance.

DbiResourceId
  • Type: string

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

DeletionProtection
  • Type: boolean

Indicates whether the DB instance has deletion protection enabled.

When deletion protection is enabled, the database cannot be deleted.

DomainMemberships
  • Type: Array of AwsRdsDbDomainMembership structures

The Active Directory domain membership records associated with the DB instance.

EnabledCloudWatchLogsExports
  • Type: Array of strings

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Endpoint
  • Type: AwsRdsDbInstanceEndpoint structure

Specifies the connection endpoint.

Engine
  • Type: string

Provides the name of the database engine to use for this DB instance.

EngineVersion
  • Type: string

Indicates the database engine version.

EnhancedMonitoringResourceArn
  • Type: string

The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

IAMDatabaseAuthenticationEnabled
  • Type: boolean

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines.

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher

InstanceCreateTime
  • Type: string

Indicates when the DB instance was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Iops
  • Type: int

Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

KmsKeyId
  • Type: string

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

LatestRestorableTime
  • Type: string

Specifies the latest time to which a database can be restored with point-in-time restore.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

LicenseModel
  • Type: string

License model information for this DB instance.

ListenerEndpoint
  • Type: AwsRdsDbInstanceEndpoint structure

Specifies the connection endpoint.

MasterUsername
  • Type: string

The master user name of the DB instance.

MaxAllocatedStorage
  • Type: int

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

MonitoringInterval
  • Type: int

The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.

MonitoringRoleArn
  • Type: string

The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

MultiAz
  • Type: boolean

Whether the DB instance is a multiple Availability Zone deployment.

OptionGroupMemberships
  • Type: Array of AwsRdsDbOptionGroupMembership structures

The list of option group memberships for this DB instance.

PendingModifiedValues
  • Type: AwsRdsDbPendingModifiedValues structure

Changes to the DB instance that are currently pending.

PerformanceInsightsEnabled
  • Type: boolean

Indicates whether Performance Insights is enabled for the DB instance.

PerformanceInsightsKmsKeyId
  • Type: string

The identifier of the AWS KMS key used to encrypt the Performance Insights data.

PerformanceInsightsRetentionPeriod
  • Type: int

The number of days to retain Performance Insights data.

PreferredBackupWindow
  • Type: string

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

PreferredMaintenanceWindow
  • Type: string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Uses the format <day>:HH:MM-<day>:HH:MM.

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

ProcessorFeatures
  • Type: Array of AwsRdsDbProcessorFeature structures

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

PromotionTier
  • Type: int

The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

PubliclyAccessible
  • Type: boolean

Specifies the accessibility options for the DB instance.

A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.

A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

ReadReplicaDBClusterIdentifiers
  • Type: Array of strings

List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

ReadReplicaDBInstanceIdentifiers
  • Type: Array of strings

List of identifiers of the read replicas associated with this DB instance.

ReadReplicaSourceDBInstanceIdentifier
  • Type: string

If this DB instance is a read replica, contains the identifier of the source DB instance.

SecondaryAvailabilityZone
  • Type: string

For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

StatusInfos
  • Type: Array of AwsRdsDbStatusInfo structures

The status of a read replica. If the instance isn't a read replica, this is empty.

StorageEncrypted
  • Type: boolean

Specifies whether the DB instance is encrypted.

StorageType
  • Type: string

The storage type for the DB instance.

TdeCredentialArn
  • Type: string

The ARN from the key store with which the instance is associated for TDE encryption.

Timezone
  • Type: string

The time zone of the DB instance.

VpcSecurityGroups
  • Type: Array of AwsRdsDbInstanceVpcSecurityGroup structures

A list of VPC security groups that the DB instance belongs to.

AwsRdsDbInstanceEndpoint

Description

Specifies the connection endpoint.

Members
Address
  • Type: string

Specifies the DNS address of the DB instance.

HostedZoneId
  • Type: string

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Port
  • Type: int

Specifies the port that the database engine is listening on.

AwsRdsDbInstanceVpcSecurityGroup

Description

A VPC security groups that the DB instance belongs to.

Members
Status
  • Type: string

The status of the VPC security group.

VpcSecurityGroupId
  • Type: string

The name of the VPC security group.

AwsRdsDbOptionGroupMembership

Description

An option group membership.

Members
OptionGroupName
  • Type: string

The name of the option group.

Status
  • Type: string

The status of the option group membership.

AwsRdsDbParameterGroup

Description

Provides information about a parameter group for a DB instance.

Members
DbParameterGroupName
  • Type: string

The name of the parameter group.

ParameterApplyStatus
  • Type: string

The status of parameter updates.

AwsRdsDbPendingModifiedValues

Description

Changes to a DB instance that are currently pending.

Members
AllocatedStorage
  • Type: int

The new value of the allocated storage for the DB instance.

BackupRetentionPeriod
  • Type: int

The new backup retention period for the DB instance.

CaCertificateIdentifier
  • Type: string

The new CA certificate identifier for the DB instance.

DbInstanceClass
  • Type: string

The new DB instance class for the DB instance.

DbInstanceIdentifier
  • Type: string

The new DB instance identifier for the DB instance.

DbSubnetGroupName
  • Type: string

The name of the new subnet group for the DB instance.

EngineVersion
  • Type: string

The new engine version for the DB instance.

Iops
  • Type: int

The new provisioned IOPS value for the DB instance.

LicenseModel
  • Type: string

The new license model value for the DB instance.

MasterUserPassword
  • Type: string

The new master user password for the DB instance.

MultiAZ
  • Type: boolean

Indicates that a single Availability Zone DB instance is changing to a multiple Availability Zone deployment.

PendingCloudWatchLogsExports
  • Type: AwsRdsPendingCloudWatchLogsExports structure

A list of log types that are being enabled or disabled.

Port
  • Type: int

The new port for the DB instance.

ProcessorFeatures
  • Type: Array of AwsRdsDbProcessorFeature structures

Processor features that are being updated.

StorageType
  • Type: string

The new storage type for the DB instance.

AwsRdsDbProcessorFeature

Description

A processor feature.

Members
Name
  • Type: string

The name of the processor feature.

Value
  • Type: string

The value of the processor feature.

AwsRdsDbSnapshotDetails

Description

Provides details about an Amazon RDS DB cluster snapshot.

Members
AllocatedStorage
  • Type: int

The amount of storage (in gigabytes) to be initially allocated for the database instance.

AvailabilityZone
  • Type: string

Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.

DbInstanceIdentifier
  • Type: string

A name for the DB instance.

DbSnapshotIdentifier
  • Type: string

The name or ARN of the DB snapshot that is used to restore the DB instance.