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

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Account
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • AmplifyUIBuilder
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • AppConfigData
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationCostProfiler
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • AppRunner
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • BackupGateway
      • Exception
    • Batch
      • Exception
    • BillingConductor
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ChimeSDKIdentity
      • Exception
    • ChimeSDKMediaPipelines
      • Exception
    • ChimeSDKMeetings
      • Exception
    • ChimeSDKMessaging
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudControlApi
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchEvidently
      • Exception
    • CloudWatchLogs
      • Exception
    • CloudWatchRUM
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • 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
    • ConnectWisdomService
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • DefaultsMode
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • Exception
    • drs
      • Exception
    • DynamoDb
      • Exception
    • DynamoDbStreams
      • Exception
    • EBS
      • Exception
    • Ec2
      • Exception
    • EC2InstanceConnect
      • Exception
    • Ecr
      • Exception
    • ECRPublic
      • Exception
    • Ecs
      • Exception
    • Efs
      • Exception
    • EKS
      • Exception
    • ElastiCache
      • Exception
    • ElasticBeanstalk
      • Exception
    • ElasticInference
      • Exception
    • ElasticLoadBalancing
      • Exception
    • ElasticLoadBalancingV2
      • Exception
    • ElasticsearchService
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Exception
    • EMRContainers
      • Exception
    • Endpoint
      • UseDualstackEndpoint
        • Exception
      • UseFipsEndpoint
        • Exception
    • EndpointDiscovery
      • Exception
    • EventBridge
      • Exception
    • Exception
    • finspace
      • Exception
    • FinSpaceData
      • Exception
    • Firehose
      • Exception
    • FIS
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • Exception
    • GameSparks
      • Exception
    • Glacier
      • Exception
    • GlobalAccelerator
      • Exception
    • Glue
      • Exception
    • GlueDataBrew
      • Exception
    • Greengrass
      • Exception
    • GreengrassV2
      • Exception
    • GroundStation
      • Exception
    • GuardDuty
      • Exception
    • Handler
      • GuzzleV5
      • GuzzleV6
    • Health
      • Exception
    • HealthLake
      • Exception
    • Honeycode
      • Exception
    • Iam
      • Exception
    • IdentityStore
      • Exception
    • imagebuilder
      • Exception
    • ImportExport
      • Exception
    • Inspector
      • Exception
    • Inspector2
      • Exception
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTDeviceAdvisor
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTFleetHub
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTTwinMaker
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • ivschat
      • Exception
    • Kafka
      • Exception
    • KafkaConnect
      • Exception
    • kendra
      • Exception
    • Keyspaces
      • 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
    • LookoutEquipment
      • Exception
    • LookoutforVision
      • Exception
    • LookoutMetrics
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • ManagedBlockchain
      • Exception
    • ManagedGrafana
      • Exception
    • MarketplaceCatalog
      • Exception
    • MarketplaceCommerceAnalytics
      • Exception
    • MarketplaceEntitlementService
      • Exception
    • MarketplaceMetering
      • Exception
    • MediaConnect
      • Exception
    • MediaConvert
      • Exception
    • MediaLive
      • Exception
    • MediaPackage
      • Exception
    • MediaPackageVod
      • Exception
    • MediaStore
      • Exception
    • MediaStoreData
      • Exception
    • MediaTailor
      • Exception
    • MemoryDB
      • Exception
    • mgn
      • Exception
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • MigrationHubRefactorSpaces
      • Exception
    • MigrationHubStrategyRecommendations
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • NimbleStudio
      • Exception
    • OpenSearchService
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Panorama
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • PinpointSMSVoiceV2
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrometheusService
      • Exception
    • Proton
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • RecycleBin
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • Rekognition
      • Exception
    • ResilienceHub
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • Route53RecoveryCluster
      • Exception
    • Route53RecoveryControlConfig
      • Exception
    • Route53RecoveryReadiness
      • Exception
    • Route53Resolver
      • Exception
    • S3
      • Crypto
      • Exception
      • RegionalEndpoint
        • Exception
      • UseArnRegion
        • Exception
    • S3Control
      • Exception
    • S3Outposts
      • Exception
    • SageMaker
      • Exception
    • SagemakerEdgeManager
      • Exception
    • SageMakerFeatureStoreRuntime
      • Exception
    • 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
    • SnowDeviceManagement
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSMContacts
      • Exception
    • SSMIncidents
      • 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
    • VoiceID
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • WorkSpacesWeb
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Account\AccountClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • Aws\AmplifyUIBuilder\AmplifyUIBuilderClient
  • Aws\Api\AbstractModel
  • Aws\Api\ApiProvider
  • Aws\Api\DateTimeResult
  • Aws\Api\DocModel
  • Aws\Api\ErrorParser\AbstractErrorParser
  • Aws\Api\ErrorParser\JsonRpcErrorParser
  • Aws\Api\ErrorParser\RestJsonErrorParser
  • Aws\Api\ErrorParser\XmlErrorParser
  • Aws\Api\ListShape
  • Aws\Api\MapShape
  • Aws\Api\Operation
  • Aws\Api\Parser\Crc32ValidatingParser
  • Aws\Api\Parser\DecodingEventStreamIterator
  • Aws\Api\Parser\EventParsingIterator
  • Aws\Api\Parser\JsonParser
  • Aws\Api\Parser\JsonRpcParser
  • Aws\Api\Parser\QueryParser
  • Aws\Api\Parser\RestJsonParser
  • Aws\Api\Parser\RestXmlParser
  • Aws\Api\Parser\XmlParser
  • Aws\Api\Serializer\XmlBody
  • Aws\Api\Service
  • Aws\Api\Shape
  • Aws\Api\ShapeMap
  • Aws\Api\StructureShape
  • Aws\Api\TimestampShape
  • Aws\Api\Validator
  • Aws\ApiGateway\ApiGatewayClient
  • Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient
  • Aws\ApiGatewayV2\ApiGatewayV2Client
  • Aws\AppConfig\AppConfigClient
  • Aws\AppConfigData\AppConfigDataClient
  • Aws\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationCostProfiler\ApplicationCostProfilerClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\AppRunner\AppRunnerClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\Athena\AthenaClient
  • Aws\AuditManager\AuditManagerClient
  • Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\BackupGateway\BackupGatewayClient
  • Aws\Batch\BatchClient
  • Aws\BillingConductor\BillingConductorClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ChimeSDKIdentity\ChimeSDKIdentityClient
  • Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient
  • Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient
  • Aws\ChimeSDKMessaging\ChimeSDKMessagingClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudControlApi\CloudControlApiClient
  • Aws\CloudDirectory\CloudDirectoryClient
  • Aws\CloudFormation\CloudFormationClient
  • Aws\CloudFront\CloudFrontClient
  • Aws\CloudFront\CookieSigner
  • Aws\CloudFront\UrlSigner
  • Aws\CloudHsm\CloudHsmClient
  • Aws\CloudHSMV2\CloudHSMV2Client
  • Aws\CloudSearch\CloudSearchClient
  • Aws\CloudSearchDomain\CloudSearchDomainClient
  • Aws\CloudTrail\CloudTrailClient
  • Aws\CloudTrail\LogFileIterator
  • Aws\CloudTrail\LogFileReader
  • Aws\CloudTrail\LogRecordIterator
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchEvidently\CloudWatchEvidentlyClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CloudWatchRUM\CloudWatchRUMClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\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\ConnectWisdomService\ConnectWisdomServiceClient
  • Aws\CostandUsageReportService\CostandUsageReportServiceClient
  • Aws\CostExplorer\CostExplorerClient
  • Aws\Credentials\AssumeRoleCredentialProvider
  • Aws\Credentials\AssumeRoleWithWebIdentityCredentialProvider
  • Aws\Credentials\CredentialProvider
  • Aws\Credentials\Credentials
  • Aws\Credentials\EcsCredentialProvider
  • Aws\Credentials\InstanceProfileProvider
  • Aws\Crypto\AesDecryptingStream
  • Aws\Crypto\AesEncryptingStream
  • Aws\Crypto\AesGcmDecryptingStream
  • Aws\Crypto\AesGcmEncryptingStream
  • Aws\Crypto\Cipher\Cbc
  • Aws\Crypto\KmsMaterialsProvider
  • Aws\Crypto\KmsMaterialsProviderV2
  • Aws\Crypto\MaterialsProvider
  • Aws\Crypto\MaterialsProviderV2
  • Aws\Crypto\Polyfill\AesGcm
  • Aws\Crypto\Polyfill\ByteArray
  • Aws\Crypto\Polyfill\Gmac
  • Aws\Crypto\Polyfill\Key
  • Aws\CustomerProfiles\CustomerProfilesClient
  • Aws\DatabaseMigrationService\DatabaseMigrationServiceClient
  • Aws\DataExchange\DataExchangeClient
  • Aws\DataPipeline\DataPipelineClient
  • Aws\DataSync\DataSyncClient
  • Aws\DAX\DAXClient
  • Aws\DefaultsMode\Configuration
  • Aws\DefaultsMode\ConfigurationProvider
  • Aws\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DoctrineCacheAdapter
  • Aws\drs\drsClient
  • Aws\DynamoDb\BinaryValue
  • Aws\DynamoDb\DynamoDbClient
  • Aws\DynamoDb\LockingSessionConnection
  • Aws\DynamoDb\Marshaler
  • Aws\DynamoDb\NumberValue
  • Aws\DynamoDb\SessionHandler
  • Aws\DynamoDb\SetValue
  • Aws\DynamoDb\StandardSessionConnection
  • Aws\DynamoDb\WriteRequestBatch
  • Aws\DynamoDbStreams\DynamoDbStreamsClient
  • Aws\EBS\EBSClient
  • Aws\Ec2\Ec2Client
  • Aws\EC2InstanceConnect\EC2InstanceConnectClient
  • Aws\Ecr\EcrClient
  • Aws\ECRPublic\ECRPublicClient
  • Aws\Ecs\EcsClient
  • Aws\Efs\EfsClient
  • Aws\EKS\EKSClient
  • Aws\ElastiCache\ElastiCacheClient
  • Aws\ElasticBeanstalk\ElasticBeanstalkClient
  • Aws\ElasticInference\ElasticInferenceClient
  • Aws\ElasticLoadBalancing\ElasticLoadBalancingClient
  • Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client
  • Aws\ElasticsearchService\ElasticsearchServiceClient
  • Aws\ElasticTranscoder\ElasticTranscoderClient
  • Aws\Emr\EmrClient
  • Aws\EMRContainers\EMRContainersClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\Endpoint\UseDualstackEndpoint\Configuration
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationProvider
  • Aws\Endpoint\UseFipsEndpoint\Configuration
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EventBridge\EventBridgeClient
  • Aws\finspace\finspaceClient
  • Aws\FinSpaceData\FinSpaceDataClient
  • Aws\Firehose\FirehoseClient
  • Aws\FIS\FISClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • Aws\GameSparks\GameSparksClient
  • Aws\Glacier\GlacierClient
  • Aws\Glacier\MultipartUploader
  • Aws\Glacier\TreeHash
  • Aws\GlobalAccelerator\GlobalAcceleratorClient
  • Aws\Glue\GlueClient
  • Aws\GlueDataBrew\GlueDataBrewClient
  • Aws\Greengrass\GreengrassClient
  • Aws\GreengrassV2\GreengrassV2Client
  • Aws\GroundStation\GroundStationClient
  • Aws\GuardDuty\GuardDutyClient
  • Aws\Handler\GuzzleV5\GuzzleHandler
  • Aws\Handler\GuzzleV5\GuzzleStream
  • Aws\Handler\GuzzleV5\PsrStream
  • Aws\Handler\GuzzleV6\GuzzleHandler
  • Aws\HandlerList
  • Aws\HashingStream
  • Aws\Health\HealthClient
  • Aws\HealthLake\HealthLakeClient
  • Aws\History
  • Aws\Honeycode\HoneycodeClient
  • Aws\Iam\IamClient
  • Aws\IdempotencyTokenMiddleware
  • Aws\IdentityStore\IdentityStoreClient
  • Aws\imagebuilder\imagebuilderClient
  • Aws\ImportExport\ImportExportClient
  • Aws\Inspector2\Inspector2Client
  • Aws\Inspector\InspectorClient
  • Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
  • Aws\IoT1ClickProjects\IoT1ClickProjectsClient
  • Aws\Iot\IotClient
  • Aws\IoTAnalytics\IoTAnalyticsClient
  • Aws\IotDataPlane\IotDataPlaneClient
  • Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient
  • Aws\IoTEvents\IoTEventsClient
  • Aws\IoTEventsData\IoTEventsDataClient
  • Aws\IoTFleetHub\IoTFleetHubClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTTwinMaker\IoTTwinMakerClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\ivschat\ivschatClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\KafkaConnect\KafkaConnectClient
  • Aws\kendra\kendraClient
  • Aws\Keyspaces\KeyspacesClient
  • 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\LookoutEquipment\LookoutEquipmentClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LookoutMetrics\LookoutMetricsClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • Aws\ManagedGrafana\ManagedGrafanaClient
  • Aws\MarketplaceCatalog\MarketplaceCatalogClient
  • Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
  • Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
  • Aws\MarketplaceMetering\MarketplaceMeteringClient
  • Aws\MediaConnect\MediaConnectClient
  • Aws\MediaConvert\MediaConvertClient
  • Aws\MediaLive\MediaLiveClient
  • Aws\MediaPackage\MediaPackageClient
  • Aws\MediaPackageVod\MediaPackageVodClient
  • Aws\MediaStore\MediaStoreClient
  • Aws\MediaStoreData\MediaStoreDataClient
  • Aws\MediaTailor\MediaTailorClient
  • Aws\MemoryDB\MemoryDBClient
  • Aws\mgn\mgnClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient
  • Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
  • Aws\Mobile\MobileClient
  • Aws\MockHandler
  • Aws\MQ\MQClient
  • Aws\MTurk\MTurkClient
  • Aws\Multipart\UploadState
  • Aws\MultiRegionClient
  • Aws\MWAA\MWAAClient
  • Aws\Neptune\NeptuneClient
  • Aws\NetworkFirewall\NetworkFirewallClient
  • Aws\NetworkManager\NetworkManagerClient
  • Aws\NimbleStudio\NimbleStudioClient
  • Aws\OpenSearchService\OpenSearchServiceClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Panorama\PanoramaClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrometheusService\PrometheusServiceClient
  • Aws\Proton\ProtonClient
  • Aws\Psr16CacheAdapter
  • Aws\PsrCacheAdapter
  • Aws\QLDB\QLDBClient
  • Aws\QLDBSession\QLDBSessionClient
  • Aws\QuickSight\QuickSightClient
  • Aws\RAM\RAMClient
  • Aws\Rds\AuthTokenGenerator
  • Aws\Rds\RdsClient
  • Aws\RDSDataService\RDSDataServiceClient
  • Aws\RecycleBin\RecycleBinClient
  • Aws\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResilienceHub\ResilienceHubClient
  • 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\Route53RecoveryCluster\Route53RecoveryClusterClient
  • Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
  • Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
  • Aws\Route53Resolver\Route53ResolverClient
  • Aws\S3\BatchDelete
  • Aws\S3\Crypto\HeadersMetadataStrategy
  • Aws\S3\Crypto\InstructionFileMetadataStrategy
  • Aws\S3\Crypto\S3EncryptionClient
  • Aws\S3\Crypto\S3EncryptionClientV2
  • Aws\S3\Crypto\S3EncryptionMultipartUploader
  • Aws\S3\Crypto\S3EncryptionMultipartUploaderV2
  • Aws\S3\GetBucketLocationParser
  • Aws\S3\MultipartUploader
  • Aws\S3\ObjectCopier
  • Aws\S3\ObjectUploader
  • Aws\S3\PostObject
  • Aws\S3\PostObjectV4
  • Aws\S3\RegionalEndpoint\Configuration
  • Aws\S3\RegionalEndpoint\ConfigurationProvider
  • Aws\S3\S3Client
  • Aws\S3\S3MultiRegionClient
  • Aws\S3\S3UriParser
  • Aws\S3\StreamWrapper
  • Aws\S3\Transfer
  • Aws\S3\UseArnRegion\Configuration
  • Aws\S3\UseArnRegion\ConfigurationProvider
  • Aws\S3\ValidateResponseChecksumParser
  • Aws\S3Control\S3ControlClient
  • Aws\S3Outposts\S3OutpostsClient
  • Aws\SageMaker\SageMakerClient
  • Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
  • Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
  • Aws\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\SnowDeviceManagement\SnowDeviceManagementClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSMContacts\SSMContactsClient
  • Aws\SSMIncidents\SSMIncidentsClient
  • 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\VoiceID\VoiceIDClient
  • Aws\Waf\WafClient
  • Aws\WafRegional\WafRegionalClient
  • Aws\WAFV2\WAFV2Client
  • Aws\Waiter
  • Aws\WellArchitected\WellArchitectedClient
  • Aws\WorkDocs\WorkDocsClient
  • Aws\WorkLink\WorkLinkClient
  • Aws\WorkMail\WorkMailClient
  • Aws\WorkMailMessageFlow\WorkMailMessageFlowClient
  • Aws\WorkSpaces\WorkSpacesClient
  • Aws\WorkSpacesWeb\WorkSpacesWebClient
  • Aws\WrappedHttpHandler
  • Aws\XRay\XRayClient

Interfaces

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

Traits

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

Exceptions

  • Aws\AccessAnalyzer\Exception\AccessAnalyzerException
  • Aws\Account\Exception\AccountException
  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\AmplifyUIBuilder\Exception\AmplifyUIBuilderException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\AppConfigData\Exception\AppConfigDataException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationCostProfiler\Exception\ApplicationCostProfilerException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • Aws\AppRunner\Exception\AppRunnerException
  • Aws\Appstream\Exception\AppstreamException
  • Aws\AppSync\Exception\AppSyncException
  • Aws\Arn\Exception\InvalidArnException
  • Aws\Athena\Exception\AthenaException
  • Aws\AuditManager\Exception\AuditManagerException
  • Aws\AugmentedAIRuntime\Exception\AugmentedAIRuntimeException
  • Aws\AutoScaling\Exception\AutoScalingException
  • Aws\AutoScalingPlans\Exception\AutoScalingPlansException
  • Aws\Backup\Exception\BackupException
  • Aws\BackupGateway\Exception\BackupGatewayException
  • Aws\Batch\Exception\BatchException
  • Aws\BillingConductor\Exception\BillingConductorException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ChimeSDKIdentity\Exception\ChimeSDKIdentityException
  • Aws\ChimeSDKMediaPipelines\Exception\ChimeSDKMediaPipelinesException
  • Aws\ChimeSDKMeetings\Exception\ChimeSDKMeetingsException
  • Aws\ChimeSDKMessaging\Exception\ChimeSDKMessagingException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudControlApi\Exception\CloudControlApiException
  • Aws\CloudDirectory\Exception\CloudDirectoryException
  • Aws\CloudFormation\Exception\CloudFormationException
  • Aws\CloudFront\Exception\CloudFrontException
  • Aws\CloudHsm\Exception\CloudHsmException
  • Aws\CloudHSMV2\Exception\CloudHSMV2Exception
  • Aws\CloudSearch\Exception\CloudSearchException
  • Aws\CloudSearchDomain\Exception\CloudSearchDomainException
  • Aws\CloudTrail\Exception\CloudTrailException
  • Aws\CloudWatch\Exception\CloudWatchException
  • Aws\CloudWatchEvents\Exception\CloudWatchEventsException
  • Aws\CloudWatchEvidently\Exception\CloudWatchEvidentlyException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CloudWatchRUM\Exception\CloudWatchRUMException
  • Aws\CodeArtifact\Exception\CodeArtifactException
  • Aws\CodeBuild\Exception\CodeBuildException
  • Aws\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\ConnectWisdomService\Exception\ConnectWisdomServiceException
  • Aws\CostandUsageReportService\Exception\CostandUsageReportServiceException
  • Aws\CostExplorer\Exception\CostExplorerException
  • Aws\CustomerProfiles\Exception\CustomerProfilesException
  • Aws\DatabaseMigrationService\Exception\DatabaseMigrationServiceException
  • Aws\DataExchange\Exception\DataExchangeException
  • Aws\DataPipeline\Exception\DataPipelineException
  • Aws\DataSync\Exception\DataSyncException
  • Aws\DAX\Exception\DAXException
  • Aws\DefaultsMode\Exception\ConfigurationException
  • Aws\Detective\Exception\DetectiveException
  • Aws\DeviceFarm\Exception\DeviceFarmException
  • Aws\DevOpsGuru\Exception\DevOpsGuruException
  • Aws\DirectConnect\Exception\DirectConnectException
  • Aws\DirectoryService\Exception\DirectoryServiceException
  • Aws\DLM\Exception\DLMException
  • Aws\DocDB\Exception\DocDBException
  • Aws\drs\Exception\drsException
  • Aws\DynamoDb\Exception\DynamoDbException
  • Aws\DynamoDbStreams\Exception\DynamoDbStreamsException
  • Aws\EBS\Exception\EBSException
  • Aws\Ec2\Exception\Ec2Exception
  • Aws\EC2InstanceConnect\Exception\EC2InstanceConnectException
  • Aws\Ecr\Exception\EcrException
  • Aws\ECRPublic\Exception\ECRPublicException
  • Aws\Ecs\Exception\EcsException
  • Aws\Efs\Exception\EfsException
  • Aws\EKS\Exception\EKSException
  • Aws\ElastiCache\Exception\ElastiCacheException
  • Aws\ElasticBeanstalk\Exception\ElasticBeanstalkException
  • Aws\ElasticInference\Exception\ElasticInferenceException
  • Aws\ElasticLoadBalancing\Exception\ElasticLoadBalancingException
  • Aws\ElasticLoadBalancingV2\Exception\ElasticLoadBalancingV2Exception
  • Aws\ElasticsearchService\Exception\ElasticsearchServiceException
  • Aws\ElasticTranscoder\Exception\ElasticTranscoderException
  • Aws\Emr\Exception\EmrException
  • Aws\EMRContainers\Exception\EMRContainersException
  • Aws\Endpoint\UseDualstackEndpoint\Exception\ConfigurationException
  • Aws\Endpoint\UseFipsEndpoint\Exception\ConfigurationException
  • Aws\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CommonRuntimeException
  • Aws\Exception\CouldNotCreateChecksumException
  • Aws\Exception\CredentialsException
  • Aws\Exception\CryptoException
  • Aws\Exception\CryptoPolyfillException
  • Aws\Exception\EventStreamDataException
  • Aws\Exception\IncalculablePayloadException
  • Aws\Exception\InvalidJsonException
  • Aws\Exception\InvalidRegionException
  • Aws\Exception\MultipartUploadException
  • Aws\Exception\UnresolvedApiException
  • Aws\Exception\UnresolvedEndpointException
  • Aws\Exception\UnresolvedSignatureException
  • Aws\finspace\Exception\finspaceException
  • Aws\FinSpaceData\Exception\FinSpaceDataException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FIS\Exception\FISException
  • Aws\FMS\Exception\FMSException
  • Aws\ForecastQueryService\Exception\ForecastQueryServiceException
  • Aws\ForecastService\Exception\ForecastServiceException
  • Aws\FraudDetector\Exception\FraudDetectorException
  • Aws\FSx\Exception\FSxException
  • Aws\GameLift\Exception\GameLiftException
  • Aws\GameSparks\Exception\GameSparksException
  • Aws\Glacier\Exception\GlacierException
  • Aws\GlobalAccelerator\Exception\GlobalAcceleratorException
  • Aws\Glue\Exception\GlueException
  • Aws\GlueDataBrew\Exception\GlueDataBrewException
  • Aws\Greengrass\Exception\GreengrassException
  • Aws\GreengrassV2\Exception\GreengrassV2Exception
  • Aws\GroundStation\Exception\GroundStationException
  • Aws\GuardDuty\Exception\GuardDutyException
  • Aws\Health\Exception\HealthException
  • Aws\HealthLake\Exception\HealthLakeException
  • Aws\Honeycode\Exception\HoneycodeException
  • Aws\Iam\Exception\IamException
  • Aws\IdentityStore\Exception\IdentityStoreException
  • Aws\imagebuilder\Exception\imagebuilderException
  • Aws\ImportExport\Exception\ImportExportException
  • Aws\Inspector2\Exception\Inspector2Exception
  • Aws\Inspector\Exception\InspectorException
  • Aws\IoT1ClickDevicesService\Exception\IoT1ClickDevicesServiceException
  • Aws\IoT1ClickProjects\Exception\IoT1ClickProjectsException
  • Aws\Iot\Exception\IotException
  • Aws\IoTAnalytics\Exception\IoTAnalyticsException
  • Aws\IotDataPlane\Exception\IotDataPlaneException
  • Aws\IoTDeviceAdvisor\Exception\IoTDeviceAdvisorException
  • Aws\IoTEvents\Exception\IoTEventsException
  • Aws\IoTEventsData\Exception\IoTEventsDataException
  • Aws\IoTFleetHub\Exception\IoTFleetHubException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
  • Aws\IoTSiteWise\Exception\IoTSiteWiseException
  • Aws\IoTThingsGraph\Exception\IoTThingsGraphException
  • Aws\IoTTwinMaker\Exception\IoTTwinMakerException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\ivschat\Exception\ivschatException
  • Aws\Kafka\Exception\KafkaException
  • Aws\KafkaConnect\Exception\KafkaConnectException
  • Aws\kendra\Exception\kendraException
  • Aws\Keyspaces\Exception\KeyspacesException
  • Aws\Kinesis\Exception\KinesisException
  • Aws\KinesisAnalytics\Exception\KinesisAnalyticsException
  • Aws\KinesisAnalyticsV2\Exception\KinesisAnalyticsV2Exception
  • Aws\KinesisVideo\Exception\KinesisVideoException
  • Aws\KinesisVideoArchivedMedia\Exception\KinesisVideoArchivedMediaException
  • Aws\KinesisVideoMedia\Exception\KinesisVideoMediaException
  • Aws\KinesisVideoSignalingChannels\Exception\KinesisVideoSignalingChannelsException
  • Aws\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\LookoutEquipment\Exception\LookoutEquipmentException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\LookoutMetrics\Exception\LookoutMetricsException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • Aws\ManagedGrafana\Exception\ManagedGrafanaException
  • Aws\MarketplaceCatalog\Exception\MarketplaceCatalogException
  • Aws\MarketplaceCommerceAnalytics\Exception\MarketplaceCommerceAnalyticsException
  • Aws\MarketplaceEntitlementService\Exception\MarketplaceEntitlementServiceException
  • Aws\MarketplaceMetering\Exception\MarketplaceMeteringException
  • Aws\MediaConnect\Exception\MediaConnectException
  • Aws\MediaConvert\Exception\MediaConvertException
  • Aws\MediaLive\Exception\MediaLiveException
  • Aws\MediaPackage\Exception\MediaPackageException
  • Aws\MediaPackageVod\Exception\MediaPackageVodException
  • Aws\MediaStore\Exception\MediaStoreException
  • Aws\MediaStoreData\Exception\MediaStoreDataException
  • Aws\MediaTailor\Exception\MediaTailorException
  • Aws\MemoryDB\Exception\MemoryDBException
  • Aws\mgn\Exception\mgnException
  • Aws\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • Aws\MigrationHubRefactorSpaces\Exception\MigrationHubRefactorSpacesException
  • Aws\MigrationHubStrategyRecommendations\Exception\MigrationHubStrategyRecommendationsException
  • Aws\Mobile\Exception\MobileException
  • Aws\MQ\Exception\MQException
  • Aws\MTurk\Exception\MTurkException
  • Aws\MWAA\Exception\MWAAException
  • Aws\Neptune\Exception\NeptuneException
  • Aws\NetworkFirewall\Exception\NetworkFirewallException
  • Aws\NetworkManager\Exception\NetworkManagerException
  • Aws\NimbleStudio\Exception\NimbleStudioException
  • Aws\OpenSearchService\Exception\OpenSearchServiceException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • Aws\Panorama\Exception\PanoramaException
  • Aws\Personalize\Exception\PersonalizeException
  • Aws\PersonalizeEvents\Exception\PersonalizeEventsException
  • Aws\PersonalizeRuntime\Exception\PersonalizeRuntimeException
  • Aws\PI\Exception\PIException
  • Aws\Pinpoint\Exception\PinpointException
  • Aws\PinpointEmail\Exception\PinpointEmailException
  • Aws\PinpointSMSVoice\Exception\PinpointSMSVoiceException
  • Aws\PinpointSMSVoiceV2\Exception\PinpointSMSVoiceV2Exception
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrometheusService\Exception\PrometheusServiceException
  • Aws\Proton\Exception\ProtonException
  • Aws\QLDB\Exception\QLDBException
  • Aws\QLDBSession\Exception\QLDBSessionException
  • Aws\QuickSight\Exception\QuickSightException
  • Aws\RAM\Exception\RAMException
  • Aws\Rds\Exception\RdsException
  • Aws\RDSDataService\Exception\RDSDataServiceException
  • Aws\RecycleBin\Exception\RecycleBinException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResilienceHub\Exception\ResilienceHubException
  • 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\Route53RecoveryCluster\Exception\Route53RecoveryClusterException
  • Aws\Route53RecoveryControlConfig\Exception\Route53RecoveryControlConfigException
  • Aws\Route53RecoveryReadiness\Exception\Route53RecoveryReadinessException
  • Aws\Route53Resolver\Exception\Route53ResolverException
  • Aws\S3\Exception\DeleteMultipleObjectsException
  • Aws\S3\Exception\PermanentRedirectException
  • Aws\S3\Exception\S3Exception
  • Aws\S3\Exception\S3MultipartUploadException
  • Aws\S3\RegionalEndpoint\Exception\ConfigurationException
  • Aws\S3\UseArnRegion\Exception\ConfigurationException
  • Aws\S3Control\Exception\S3ControlException
  • Aws\S3Outposts\Exception\S3OutpostsException
  • Aws\SageMaker\Exception\SageMakerException
  • Aws\SagemakerEdgeManager\Exception\SagemakerEdgeManagerException
  • Aws\SageMakerFeatureStoreRuntime\Exception\SageMakerFeatureStoreRuntimeException
  • Aws\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\SnowDeviceManagement\Exception\SnowDeviceManagementException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSMContacts\Exception\SSMContactsException
  • Aws\SSMIncidents\Exception\SSMIncidentsException
  • Aws\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\VoiceID\Exception\VoiceIDException
  • Aws\Waf\Exception\WafException
  • Aws\WafRegional\Exception\WafRegionalException
  • Aws\WAFV2\Exception\WAFV2Exception
  • Aws\WellArchitected\Exception\WellArchitectedException
  • Aws\WorkDocs\Exception\WorkDocsException
  • Aws\WorkLink\Exception\WorkLinkException
  • Aws\WorkMail\Exception\WorkMailException
  • Aws\WorkMailMessageFlow\Exception\WorkMailMessageFlowException
  • Aws\WorkSpaces\Exception\WorkSpacesException
  • Aws\WorkSpacesWeb\Exception\WorkSpacesWebException
  • Aws\XRay\Exception\XRayException

Functions

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

AWS Config 2014-11-12

Client: Aws\ConfigService\ConfigServiceClient
Service ID: config
Version: 2014-11-12

This page describes the parameters and results for the operations of the AWS Config (2014-11-12), and shows how to use the Aws\ConfigService\ConfigServiceClient object to call the described operations. This documentation is specific to the 2014-11-12 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 */).

  • BatchGetAggregateResourceConfig ( array $params = [] )

    Returns the current configuration items for resources that are present in your Config aggregator.

  • BatchGetResourceConfig ( array $params = [] )

    Returns the BaseConfigurationItem for one or more requested resources.

  • DeleteAggregationAuthorization ( array $params = [] )

    Deletes the authorization granted to the specified configuration aggregator account in a specified region.

  • DeleteConfigRule ( array $params = [] )

    Deletes the specified Config rule and all of its evaluation results.

  • DeleteConfigurationAggregator ( array $params = [] )

    Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.

  • DeleteConfigurationRecorder ( array $params = [] )

    Deletes the configuration recorder.

  • DeleteConformancePack ( array $params = [] )

    Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.

  • DeleteDeliveryChannel ( array $params = [] )

    Deletes the delivery channel.

  • DeleteEvaluationResults ( array $params = [] )

    Deletes the evaluation results for the specified Config rule.

  • DeleteOrganizationConfigRule ( array $params = [] )

    Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.

  • DeleteOrganizationConformancePack ( array $params = [] )

    Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.

  • DeletePendingAggregationRequest ( array $params = [] )

    Deletes pending authorization requests for a specified aggregator account in a specified region.

  • DeleteRemediationConfiguration ( array $params = [] )

    Deletes the remediation configuration.

  • DeleteRemediationExceptions ( array $params = [] )

    Deletes one or more remediation exceptions mentioned in the resource keys.

  • DeleteResourceConfig ( array $params = [] )

    Records the configuration state for a custom resource that has been deleted.

  • DeleteRetentionConfiguration ( array $params = [] )

    Deletes the retention configuration.

  • DeleteStoredQuery ( array $params = [] )

    Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.

  • DeliverConfigSnapshot ( array $params = [] )

    Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.

  • DescribeAggregateComplianceByConfigRules ( array $params = [] )

    Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.

  • DescribeAggregateComplianceByConformancePacks ( array $params = [] )

    Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack.

  • DescribeAggregationAuthorizations ( array $params = [] )

    Returns a list of authorizations granted to various aggregator accounts and regions.

  • DescribeComplianceByConfigRule ( array $params = [] )

    Indicates whether the specified Config rules are compliant.

  • DescribeComplianceByResource ( array $params = [] )

    Indicates whether the specified Amazon Web Services resources are compliant.

  • DescribeConfigRuleEvaluationStatus ( array $params = [] )

    Returns status information for each of your Config managed rules.

  • DescribeConfigRules ( array $params = [] )

    Returns details about your Config rules.

  • DescribeConfigurationAggregatorSourcesStatus ( array $params = [] )

    Returns status information for sources within an aggregator.

  • DescribeConfigurationAggregators ( array $params = [] )

    Returns the details of one or more configuration aggregators.

  • DescribeConfigurationRecorderStatus ( array $params = [] )

    Returns the current status of the specified configuration recorder.

  • DescribeConfigurationRecorders ( array $params = [] )

    Returns the details for the specified configuration recorders.

  • DescribeConformancePackCompliance ( array $params = [] )

    Returns compliance details for each rule in that conformance pack.

  • DescribeConformancePackStatus ( array $params = [] )

    Provides one or more conformance packs deployment status.

  • DescribeConformancePacks ( array $params = [] )

    Returns a list of one or more conformance packs.

  • DescribeDeliveryChannelStatus ( array $params = [] )

    Returns the current status of the specified delivery channel.

  • DescribeDeliveryChannels ( array $params = [] )

    Returns details about the specified delivery channel.

  • DescribeOrganizationConfigRuleStatuses ( array $params = [] )

    Provides organization Config rule deployment status for an organization.

  • DescribeOrganizationConfigRules ( array $params = [] )

    Returns a list of organization Config rules.

  • DescribeOrganizationConformancePackStatuses ( array $params = [] )

    Provides organization conformance pack deployment status for an organization.

  • DescribeOrganizationConformancePacks ( array $params = [] )

    Returns a list of organization conformance packs.

  • DescribePendingAggregationRequests ( array $params = [] )

    Returns a list of all pending aggregation requests.

  • DescribeRemediationConfigurations ( array $params = [] )

    Returns the details of one or more remediation configurations.

  • DescribeRemediationExceptions ( array $params = [] )

    Returns the details of one or more remediation exceptions.

  • DescribeRemediationExecutionStatus ( array $params = [] )

    Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed.

  • DescribeRetentionConfigurations ( array $params = [] )

    Returns the details of one or more retention configurations.

  • GetAggregateComplianceDetailsByConfigRule ( array $params = [] )

    Returns the evaluation results for the specified Config rule for a specific resource in a rule.

  • GetAggregateConfigRuleComplianceSummary ( array $params = [] )

    Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

  • GetAggregateConformancePackComplianceSummary ( array $params = [] )

    Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator.

  • GetAggregateDiscoveredResourceCounts ( array $params = [] )

    Returns the resource counts across accounts and regions that are present in your Config aggregator.

  • GetAggregateResourceConfig ( array $params = [] )

    Returns configuration item that is aggregated for your specific resource in a specific source account and region.

  • GetComplianceDetailsByConfigRule ( array $params = [] )

    Returns the evaluation results for the specified Config rule.

  • GetComplianceDetailsByResource ( array $params = [] )

    Returns the evaluation results for the specified Amazon Web Services resource.

  • GetComplianceSummaryByConfigRule ( array $params = [] )

    Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

  • GetComplianceSummaryByResourceType ( array $params = [] )

    Returns the number of resources that are compliant and the number that are noncompliant.

  • GetConformancePackComplianceDetails ( array $params = [] )

    Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.

  • GetConformancePackComplianceSummary ( array $params = [] )

    Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.

  • GetCustomRulePolicy ( array $params = [] )

    Returns the policy definition containing the logic for your Config Custom Policy rule.

  • GetDiscoveredResourceCounts ( array $params = [] )

    Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.

  • GetOrganizationConfigRuleDetailedStatus ( array $params = [] )

    Returns detailed status for each member account within an organization for a given organization Config rule.

  • GetOrganizationConformancePackDetailedStatus ( array $params = [] )

    Returns detailed status for each member account within an organization for a given organization conformance pack.

  • GetOrganizationCustomRulePolicy ( array $params = [] )

    Returns the policy definition containing the logic for your organization Config Custom Policy rule.

  • GetResourceConfigHistory ( array $params = [] )

    Returns a list of ConfigurationItems for the specified resource.

  • GetStoredQuery ( array $params = [] )

    Returns the details of a specific stored query.

  • ListAggregateDiscoveredResources ( array $params = [] )

    Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions.

  • ListDiscoveredResources ( array $params = [] )

    Accepts a resource type and returns a list of resource identifiers for the resources of that type.

  • ListStoredQueries ( array $params = [] )

    Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region.

  • ListTagsForResource ( array $params = [] )

    List the tags for Config resource.

  • PutAggregationAuthorization ( array $params = [] )

    Authorizes the aggregator account and region to collect data from the source account and region.

  • PutConfigRule ( array $params = [] )

    Adds or updates an Config rule for evaluating whether your Amazon Web Services resources comply with your desired configurations.

  • PutConfigurationAggregator ( array $params = [] )

    Creates and updates the configuration aggregator with the selected source accounts and regions.

  • PutConfigurationRecorder ( array $params = [] )

    Creates a new configuration recorder to record the selected resource configurations.

  • PutConformancePack ( array $params = [] )

    Creates or updates a conformance pack.

  • PutDeliveryChannel ( array $params = [] )

    Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.

  • PutEvaluations ( array $params = [] )

    Used by an Lambda function to deliver evaluation results to Config.

  • PutExternalEvaluation ( array $params = [] )

    Add or updates the evaluations for process checks.

  • PutOrganizationConfigRule ( array $params = [] )

    Adds or updates organization Config rule for your entire organization evaluating whether your Amazon Web Services resources comply with your desired configurations.

  • PutOrganizationConformancePack ( array $params = [] )

    Deploys conformance packs across member accounts in an Amazon Web Services Organization.

  • PutRemediationConfigurations ( array $params = [] )

    Adds or updates the remediation configuration with a specific Config rule with the selected target or action.

  • PutRemediationExceptions ( array $params = [] )

    A remediation exception is when a specific resource is no longer considered for auto-remediation.

  • PutResourceConfig ( array $params = [] )

    Records the configuration state for the resource provided in the request.

  • PutRetentionConfiguration ( array $params = [] )

    Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information.

  • PutStoredQuery ( array $params = [] )

    Saves a new query or updates an existing saved query.

  • SelectAggregateResourceConfig ( array $params = [] )

    Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.

  • SelectResourceConfig ( array $params = [] )

    Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.

  • StartConfigRulesEvaluation ( array $params = [] )

    Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources.

  • StartConfigurationRecorder ( array $params = [] )

    Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

  • StartRemediationExecution ( array $params = [] )

    Runs an on-demand remediation for the specified Config rules against the last known remediation configuration.

  • StopConfigurationRecorder ( array $params = [] )

    Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

  • TagResource ( array $params = [] )

    Associates the specified tags to a resource with the specified resourceArn.

  • UntagResource ( array $params = [] )

    Deletes specified tags from a resource.

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:

  • DescribeAggregateComplianceByConfigRules
  • DescribeAggregateComplianceByConformancePacks
  • DescribeAggregationAuthorizations
  • DescribeComplianceByConfigRule
  • DescribeComplianceByResource
  • DescribeConfigRuleEvaluationStatus
  • DescribeConfigRules
  • DescribeConfigurationAggregatorSourcesStatus
  • DescribeConfigurationAggregators
  • DescribeConformancePackCompliance
  • DescribeConformancePackStatus
  • DescribeConformancePacks
  • DescribeOrganizationConfigRuleStatuses
  • DescribeOrganizationConfigRules
  • DescribeOrganizationConformancePackStatuses
  • DescribeOrganizationConformancePacks
  • DescribePendingAggregationRequests
  • DescribeRemediationExceptions
  • DescribeRemediationExecutionStatus
  • DescribeRetentionConfigurations
  • GetAggregateComplianceDetailsByConfigRule
  • GetAggregateConfigRuleComplianceSummary
  • GetAggregateConformancePackComplianceSummary
  • GetAggregateDiscoveredResourceCounts
  • GetComplianceDetailsByConfigRule
  • GetComplianceDetailsByResource
  • GetConformancePackComplianceDetails
  • GetConformancePackComplianceSummary
  • GetDiscoveredResourceCounts
  • GetOrganizationConfigRuleDetailedStatus
  • GetOrganizationConformancePackDetailedStatus
  • GetResourceConfigHistory
  • ListAggregateDiscoveredResources
  • ListDiscoveredResources
  • ListStoredQueries
  • ListTagsForResource
  • SelectAggregateResourceConfig
  • SelectResourceConfig

Operations

BatchGetAggregateResourceConfig

$result = $client->batchGetAggregateResourceConfig([/* ... */]);
$promise = $client->batchGetAggregateResourceConfigAsync([/* ... */]);

Returns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers list.

  • The API does not return results for deleted resources.

  • The API does not return tags and relationships.

Parameter Syntax

$result = $client->batchGetAggregateResourceConfig([
    'ConfigurationAggregatorName' => '<string>', // REQUIRED
    'ResourceIdentifiers' => [ // REQUIRED
        [
            'ResourceId' => '<string>', // REQUIRED
            'ResourceName' => '<string>',
            'ResourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository', // REQUIRED
            'SourceAccountId' => '<string>', // REQUIRED
            'SourceRegion' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

ResourceIdentifiers
  • Required: Yes
  • Type: Array of AggregateResourceIdentifier structures

A list of aggregate ResourceIdentifiers objects.

Result Syntax

[
    'BaseConfigurationItems' => [
        [
            'accountId' => '<string>',
            'arn' => '<string>',
            'availabilityZone' => '<string>',
            'awsRegion' => '<string>',
            'configuration' => '<string>',
            'configurationItemCaptureTime' => <DateTime>,
            'configurationItemStatus' => 'OK|ResourceDiscovered|ResourceNotRecorded|ResourceDeleted|ResourceDeletedNotRecorded',
            'configurationStateId' => '<string>',
            'resourceCreationTime' => <DateTime>,
            'resourceId' => '<string>',
            'resourceName' => '<string>',
            'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
            'supplementaryConfiguration' => ['<string>', ...],
            'version' => '<string>',
        ],
        // ...
    ],
    'UnprocessedResourceIdentifiers' => [
        [
            'ResourceId' => '<string>',
            'ResourceName' => '<string>',
            'ResourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
            'SourceAccountId' => '<string>',
            'SourceRegion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
BaseConfigurationItems
  • Type: Array of BaseConfigurationItem structures

A list that contains the current configuration of one or more resources.

UnprocessedResourceIdentifiers
  • Type: Array of AggregateResourceIdentifier structures

A list of resource identifiers that were not processed with current scope. The list is empty if all the resources are processed.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

BatchGetResourceConfig

$result = $client->batchGetResourceConfig([/* ... */]);
$promise = $client->batchGetResourceConfigAsync([/* ... */]);

Returns the BaseConfigurationItem for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list.

  • The API does not return results for deleted resources.

  • The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.

Parameter Syntax

$result = $client->batchGetResourceConfig([
    'resourceKeys' => [ // REQUIRED
        [
            'resourceId' => '<string>', // REQUIRED
            'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
resourceKeys
  • Required: Yes
  • Type: Array of ResourceKey structures

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

Result Syntax

[
    'baseConfigurationItems' => [
        [
            'accountId' => '<string>',
            'arn' => '<string>',
            'availabilityZone' => '<string>',
            'awsRegion' => '<string>',
            'configuration' => '<string>',
            'configurationItemCaptureTime' => <DateTime>,
            'configurationItemStatus' => 'OK|ResourceDiscovered|ResourceNotRecorded|ResourceDeleted|ResourceDeletedNotRecorded',
            'configurationStateId' => '<string>',
            'resourceCreationTime' => <DateTime>,
            'resourceId' => '<string>',
            'resourceName' => '<string>',
            'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
            'supplementaryConfiguration' => ['<string>', ...],
            'version' => '<string>',
        ],
        // ...
    ],
    'unprocessedResourceKeys' => [
        [
            'resourceId' => '<string>',
            'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
        ],
        // ...
    ],
]

Result Details

Members
baseConfigurationItems
  • Type: Array of BaseConfigurationItem structures

A list that contains the current configuration of one or more resources.

unprocessedResourceKeys
  • Type: Array of ResourceKey structures

A list of resource keys that were not processed with the current response. The unprocessesResourceKeys value is in the same form as ResourceKeys, so the value can be directly provided to a subsequent BatchGetResourceConfig operation. If there are no unprocessed resource keys, the response contains an empty unprocessedResourceKeys list.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • NoAvailableConfigurationRecorderException:

    There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

DeleteAggregationAuthorization

$result = $client->deleteAggregationAuthorization([/* ... */]);
$promise = $client->deleteAggregationAuthorizationAsync([/* ... */]);

Deletes the authorization granted to the specified configuration aggregator account in a specified region.

Parameter Syntax

$result = $client->deleteAggregationAuthorization([
    'AuthorizedAccountId' => '<string>', // REQUIRED
    'AuthorizedAwsRegion' => '<string>', // REQUIRED
]);

Parameter Details

Members
AuthorizedAccountId
  • Required: Yes
  • Type: string

The 12-digit account ID of the account authorized to aggregate data.

AuthorizedAwsRegion
  • Required: Yes
  • Type: string

The region authorized to collect aggregated data.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

DeleteConfigRule

$result = $client->deleteConfigRule([/* ... */]);
$promise = $client->deleteConfigRuleAsync([/* ... */]);

Deletes the specified Config rule and all of its evaluation results.

Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.

You can check the state of a rule by using the DescribeConfigRules request.

Parameter Syntax

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

Parameter Details

Members
ConfigRuleName
  • Required: Yes
  • Type: string

The name of the Config rule that you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

  • ResourceInUseException:

    You see this exception in the following cases:

    • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

    • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

    • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

    • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

    • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

    • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

DeleteConfigurationAggregator

$result = $client->deleteConfigurationAggregator([/* ... */]);
$promise = $client->deleteConfigurationAggregatorAsync([/* ... */]);

Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.

Parameter Syntax

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

Parameter Details

Members
ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

DeleteConfigurationRecorder

$result = $client->deleteConfigurationRecorder([/* ... */]);
$promise = $client->deleteConfigurationRecorderAsync([/* ... */]);

Deletes the configuration recorder.

After the configuration recorder is deleted, Config will not record resource configuration changes until you create a new configuration recorder.

This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory action, but you will not be able to access this information in the Config console until you create a new configuration recorder.

Parameter Syntax

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

Parameter Details

Members
ConfigurationRecorderName
  • Required: Yes
  • Type: string

The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the DescribeConfigurationRecorders action.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchConfigurationRecorderException:

    You have specified a configuration recorder that does not exist.

DeleteConformancePack

$result = $client->deleteConformancePack([/* ... */]);
$promise = $client->deleteConformancePackAsync([/* ... */]);

Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.

Config sets the conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.

Parameter Syntax

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

Parameter Details

Members
ConformancePackName
  • Required: Yes
  • Type: string

Name of the conformance pack you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchConformancePackException:

    You specified one or more conformance packs that do not exist.

  • ResourceInUseException:

    You see this exception in the following cases:

    • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

    • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

    • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

    • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

    • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

    • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

DeleteDeliveryChannel

$result = $client->deleteDeliveryChannel([/* ... */]);
$promise = $client->deleteDeliveryChannelAsync([/* ... */]);

Deletes the delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

Parameter Syntax

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

Parameter Details

Members
DeliveryChannelName
  • Required: Yes
  • Type: string

The name of the delivery channel to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchDeliveryChannelException:

    You have specified a delivery channel that does not exist.

  • LastDeliveryChannelDeleteFailedException:

    You cannot delete the delivery channel you specified because the configuration recorder is running.

DeleteEvaluationResults

$result = $client->deleteEvaluationResults([/* ... */]);
$promise = $client->deleteEvaluationResultsAsync([/* ... */]);

Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources against the rule.

Parameter Syntax

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

Parameter Details

Members
ConfigRuleName
  • Required: Yes
  • Type: string

The name of the Config rule for which you want to delete the evaluation results.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

  • ResourceInUseException:

    You see this exception in the following cases:

    • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

    • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

    • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

    • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

    • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

    • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

DeleteOrganizationConfigRule

$result = $client->deleteOrganizationConfigRule([/* ... */]);
$promise = $client->deleteOrganizationConfigRuleAsync([/* ... */]);

Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.

Only a master account and a delegated administrator account can delete an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.

Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.

Parameter Syntax

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

Parameter Details

Members
OrganizationConfigRuleName
  • Required: Yes
  • Type: string

The name of organization Config rule that you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchOrganizationConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an organization Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

  • ResourceInUseException:

    You see this exception in the following cases:

    • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

    • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

    • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

    • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

    • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

    • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

  • OrganizationAccessDeniedException:

    For PutConfigurationAggregator API, you can see this exception for the following reasons:

    • No permission to call EnableAWSServiceAccess API

    • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

    For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

DeleteOrganizationConformancePack

$result = $client->deleteOrganizationConformancePack([/* ... */]);
$promise = $client->deleteOrganizationConformancePackAsync([/* ... */]);

Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.

Only a master account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.

Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.

Parameter Syntax

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

Parameter Details

Members
OrganizationConformancePackName
  • Required: Yes
  • Type: string

The name of organization conformance pack that you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchOrganizationConformancePackException:

    Config organization conformance pack that you passed in the filter does not exist.

    For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.

  • ResourceInUseException:

    You see this exception in the following cases:

    • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

    • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

    • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

    • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

    • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

    • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

  • OrganizationAccessDeniedException:

    For PutConfigurationAggregator API, you can see this exception for the following reasons:

    • No permission to call EnableAWSServiceAccess API

    • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

    For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

DeletePendingAggregationRequest

$result = $client->deletePendingAggregationRequest([/* ... */]);
$promise = $client->deletePendingAggregationRequestAsync([/* ... */]);

Deletes pending authorization requests for a specified aggregator account in a specified region.

Parameter Syntax

$result = $client->deletePendingAggregationRequest([
    'RequesterAccountId' => '<string>', // REQUIRED
    'RequesterAwsRegion' => '<string>', // REQUIRED
]);

Parameter Details

Members
RequesterAccountId
  • Required: Yes
  • Type: string

The 12-digit account ID of the account requesting to aggregate data.

RequesterAwsRegion
  • Required: Yes
  • Type: string

The region requesting to aggregate data.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

DeleteRemediationConfiguration

$result = $client->deleteRemediationConfiguration([/* ... */]);
$promise = $client->deleteRemediationConfigurationAsync([/* ... */]);

Deletes the remediation configuration.

Parameter Syntax

$result = $client->deleteRemediationConfiguration([
    'ConfigRuleName' => '<string>', // REQUIRED
    'ResourceType' => '<string>',
]);

Parameter Details

Members
ConfigRuleName
  • Required: Yes
  • Type: string

The name of the Config rule for which you want to delete remediation configuration.

ResourceType
  • Type: string

The type of a resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchRemediationConfigurationException:

    You specified an Config rule without a remediation configuration.

  • RemediationInProgressException:

    Remediation action is in progress. You can either cancel execution in Amazon Web Services Systems Manager or wait and try again later.

  • InsufficientPermissionsException:

    Indicates one of the following errors:

    • For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.

    • For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.

    • For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM GetRole action or create a service linked role.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions:

      • To call IAM GetRole action or create a service linked role.

      • To read Amazon S3 bucket.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

DeleteRemediationExceptions

$result = $client->deleteRemediationExceptions([/* ... */]);
$promise = $client->deleteRemediationExceptionsAsync([/* ... */]);

Deletes one or more remediation exceptions mentioned in the resource keys.

Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

Parameter Syntax

$result = $client->deleteRemediationExceptions([
    'ConfigRuleName' => '<string>', // REQUIRED
    'ResourceKeys' => [ // REQUIRED
        [
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ConfigRuleName
  • Required: Yes
  • Type: string

The name of the Config rule for which you want to delete remediation exception configuration.

ResourceKeys
  • Required: Yes
  • Type: Array of RemediationExceptionResourceKey structures

An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.

Result Syntax

[
    'FailedBatches' => [
        [
            'FailedItems' => [
                [
                    'ResourceId' => '<string>',
                    'ResourceType' => '<string>',
                ],
                // ...
            ],
            'FailureMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
FailedBatches
  • Type: Array of FailedDeleteRemediationExceptionsBatch structures

Returns a list of failed delete remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.

Errors

  • NoSuchRemediationExceptionException:

    You tried to delete a remediation exception that does not exist.

DeleteResourceConfig

$result = $client->deleteResourceConfig([/* ... */]);
$promise = $client->deleteResourceConfigAsync([/* ... */]);

Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History.

Parameter Syntax

$result = $client->deleteResourceConfig([
    'ResourceId' => '<string>', // REQUIRED
    'ResourceType' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceId
  • Required: Yes
  • Type: string

Unique identifier of the resource.

ResourceType
  • Required: Yes
  • Type: string

The type of the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • NoRunningConfigurationRecorderException:

    There is no configuration recorder running.

DeleteRetentionConfiguration

$result = $client->deleteRetentionConfiguration([/* ... */]);
$promise = $client->deleteRetentionConfigurationAsync([/* ... */]);

Deletes the retention configuration.

Parameter Syntax

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

Parameter Details

Members
RetentionConfigurationName
  • Required: Yes
  • Type: string

The name of the retention configuration to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • NoSuchRetentionConfigurationException:

    You have specified a retention configuration that does not exist.

DeleteStoredQuery

$result = $client->deleteStoredQuery([/* ... */]);
$promise = $client->deleteStoredQueryAsync([/* ... */]);

Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.

Parameter Syntax

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

Parameter Details

Members
QueryName
  • Required: Yes
  • Type: string

The name of the query that you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • ResourceNotFoundException:

    You have specified a resource that does not exist.

DeliverConfigSnapshot

$result = $client->deliverConfigSnapshot([/* ... */]);
$promise = $client->deliverConfigSnapshotAsync([/* ... */]);

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified.

  • Notification of the start of the delivery.

  • Notification of the completion of the delivery, if the delivery was successfully completed.

  • Notification of delivery failure, if the delivery failed.

Parameter Syntax

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

Parameter Details

Members
deliveryChannelName
  • Required: Yes
  • Type: string

The name of the delivery channel through which the snapshot is delivered.

Result Syntax

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

Result Details

Members
configSnapshotId
  • Type: string

The ID of the snapshot that is being created.

Errors

  • NoSuchDeliveryChannelException:

    You have specified a delivery channel that does not exist.

  • NoAvailableConfigurationRecorderException:

    There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

  • NoRunningConfigurationRecorderException:

    There is no configuration recorder running.

DescribeAggregateComplianceByConfigRules

$result = $client->describeAggregateComplianceByConfigRules([/* ... */]);
$promise = $client->describeAggregateComplianceByConfigRulesAsync([/* ... */]);

Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Parameter Syntax

$result = $client->describeAggregateComplianceByConfigRules([
    'ConfigurationAggregatorName' => '<string>', // REQUIRED
    'Filters' => [
        'AccountId' => '<string>',
        'AwsRegion' => '<string>',
        'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA',
        'ConfigRuleName' => '<string>',
    ],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

Filters
  • Type: ConfigRuleComplianceFilters structure

Filters the results by ConfigRuleComplianceFilters object.

Limit
  • Type: int

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'AggregateComplianceByConfigRules' => [
        [
            'AccountId' => '<string>',
            'AwsRegion' => '<string>',
            'Compliance' => [
                'ComplianceContributorCount' => [
                    'CapExceeded' => true || false,
                    'CappedCount' => <integer>,
                ],
                'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA',
            ],
            'ConfigRuleName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
AggregateComplianceByConfigRules
  • Type: Array of AggregateComplianceByConfigRule structures

Returns a list of AggregateComplianceByConfigRule object.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

DescribeAggregateComplianceByConformancePacks

$result = $client->describeAggregateComplianceByConformancePacks([/* ... */]);
$promise = $client->describeAggregateComplianceByConformancePacksAsync([/* ... */]);

Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Parameter Syntax

$result = $client->describeAggregateComplianceByConformancePacks([
    'ConfigurationAggregatorName' => '<string>', // REQUIRED
    'Filters' => [
        'AccountId' => '<string>',
        'AwsRegion' => '<string>',
        'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA',
        'ConformancePackName' => '<string>',
    ],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

Filters
  • Type: AggregateConformancePackComplianceFilters structure

Filters the result by AggregateConformancePackComplianceFilters object.

Limit
  • Type: int

The maximum number of conformance packs compliance details returned on each page. The default is maximum. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'AggregateComplianceByConformancePacks' => [
        [
            'AccountId' => '<string>',
            'AwsRegion' => '<string>',
            'Compliance' => [
                'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA',
                'CompliantRuleCount' => <integer>,
                'NonCompliantRuleCount' => <integer>,
                'TotalRuleCount' => <integer>,
            ],
            'ConformancePackName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
AggregateComplianceByConformancePacks
  • Type: Array of AggregateComplianceByConformancePack structures

Returns the AggregateComplianceByConformancePack object.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

DescribeAggregationAuthorizations

$result = $client->describeAggregationAuthorizations([/* ... */]);
$promise = $client->describeAggregationAuthorizationsAsync([/* ... */]);

Returns a list of authorizations granted to various aggregator accounts and regions.

Parameter Syntax

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

Parameter Details

Members
Limit
  • Type: int

The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'AggregationAuthorizations' => [
        [
            'AggregationAuthorizationArn' => '<string>',
            'AuthorizedAccountId' => '<string>',
            'AuthorizedAwsRegion' => '<string>',
            'CreationTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
AggregationAuthorizations
  • Type: Array of AggregationAuthorization structures

Returns a list of authorizations granted to various aggregator accounts and regions.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

DescribeComplianceByConfigRule

$result = $client->describeComplianceByConfigRule([/* ... */]);
$promise = $client->describeComplianceByConfigRuleAsync([/* ... */]);

Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.

A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.

If Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:

  • Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • The rule's Lambda function is failing to send evaluation results to Config. Verify that the role you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations permission.

  • The rule's Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Parameter Syntax

$result = $client->describeComplianceByConfigRule([
    'ComplianceTypes' => ['<string>', ...],
    'ConfigRuleNames' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Members
ComplianceTypes
  • Type: Array of strings

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT.

ConfigRuleNames
  • Type: Array of strings

Specify one or more Config rule names to filter the results by rule.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'ComplianceByConfigRules' => [
        [
            'Compliance' => [
                'ComplianceContributorCount' => [
                    'CapExceeded' => true || false,
                    'CappedCount' => <integer>,
                ],
                'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA',
            ],
            'ConfigRuleName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ComplianceByConfigRules
  • Type: Array of ComplianceByConfigRule structures

Indicates whether each of the specified Config rules is compliant.

NextToken
  • Type: string

The string that you use in a subsequent request to get the next page of results in a paginated response.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • NoSuchConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

DescribeComplianceByResource

$result = $client->describeComplianceByResource([/* ... */]);
$promise = $client->describeComplianceByResourceAsync([/* ... */]);

Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.

A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.

If Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:

  • Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • The rule's Lambda function is failing to send evaluation results to Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations permission.

  • The rule's Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Parameter Syntax

$result = $client->describeComplianceByResource([
    'ComplianceTypes' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'ResourceId' => '<string>',
    'ResourceType' => '<string>',
]);

Parameter Details

Members
ComplianceTypes
  • Type: Array of strings

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

Limit
  • Type: int

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

ResourceId
  • Type: string

The ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.

ResourceType
  • Type: string

The types of Amazon Web Services resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

Result Syntax

[
    'ComplianceByResources' => [
        [
            'Compliance' => [
                'ComplianceContributorCount' => [
                    'CapExceeded' => true || false,
                    'CappedCount' => <integer>,
                ],
                'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA',
            ],
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ComplianceByResources
  • Type: Array of ComplianceByResource structures

Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.

NextToken
  • Type: string

The string that you use in a subsequent request to get the next page of results in a paginated response.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

DescribeConfigRuleEvaluationStatus

$result = $client->describeConfigRuleEvaluationStatus([/* ... */]);
$promise = $client->describeConfigRuleEvaluationStatusAsync([/* ... */]);

Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.

Parameter Syntax

$result = $client->describeConfigRuleEvaluationStatus([
    'ConfigRuleNames' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConfigRuleNames
  • Type: Array of strings

The name of the Config managed rules for which you want status information. If you do not specify any names, Config returns status information for all Config managed rules that you use.

Limit
  • Type: int

The number of rule evaluation results that you want returned.

This parameter is required if the rule limit for your account is more than the default of 150 rules.

For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'ConfigRulesEvaluationStatus' => [
        [
            'ConfigRuleArn' => '<string>',
            'ConfigRuleId' => '<string>',
            'ConfigRuleName' => '<string>',
            'FirstActivatedTime' => <DateTime>,
            'FirstEvaluationStarted' => true || false,
            'LastDeactivatedTime' => <DateTime>,
            'LastDebugLogDeliveryStatus' => '<string>',
            'LastDebugLogDeliveryStatusReason' => '<string>',
            'LastDebugLogDeliveryTime' => <DateTime>,
            'LastErrorCode' => '<string>',
            'LastErrorMessage' => '<string>',
            'LastFailedEvaluationTime' => <DateTime>,
            'LastFailedInvocationTime' => <DateTime>,
            'LastSuccessfulEvaluationTime' => <DateTime>,
            'LastSuccessfulInvocationTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ConfigRulesEvaluationStatus
  • Type: Array of ConfigRuleEvaluationStatus structures

Status information about your Config managed rules.

NextToken
  • Type: string

The string that you use in a subsequent request to get the next page of results in a paginated response.

Errors

  • NoSuchConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

DescribeConfigRules

$result = $client->describeConfigRules([/* ... */]);
$promise = $client->describeConfigRulesAsync([/* ... */]);

Returns details about your Config rules.

Parameter Syntax

$result = $client->describeConfigRules([
    'ConfigRuleNames' => ['<string>', ...],
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConfigRuleNames
  • Type: Array of strings

The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'ConfigRules' => [
        [
            'ConfigRuleArn' => '<string>',
            'ConfigRuleId' => '<string>',
            'ConfigRuleName' => '<string>',
            'ConfigRuleState' => 'ACTIVE|DELETING|DELETING_RESULTS|EVALUATING',
            'CreatedBy' => '<string>',
            'Description' => '<string>',
            'InputParameters' => '<string>',
            'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours',
            'Scope' => [
                'ComplianceResourceId' => '<string>',
                'ComplianceResourceTypes' => ['<string>', ...],
                'TagKey' => '<string>',
                'TagValue' => '<string>',
            ],
            'Source' => [
                'CustomPolicyDetails' => [
                    'EnableDebugLogDelivery' => true || false,
                    'PolicyRuntime' => '<string>',
                    'PolicyText' => '<string>',
                ],
                'Owner' => 'CUSTOM_LAMBDA|AWS|CUSTOM_POLICY',
                'SourceDetails' => [
                    [
                        'EventSource' => 'aws.config',
                        'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours',
                        'MessageType' => 'ConfigurationItemChangeNotification|ConfigurationSnapshotDeliveryCompleted|ScheduledNotification|OversizedConfigurationItemChangeNotification',
                    ],
                    // ...
                ],
                'SourceIdentifier' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ConfigRules
  • Type: Array of ConfigRule structures

The details about your Config rules.

NextToken
  • Type: string

The string that you use in a subsequent request to get the next page of results in a paginated response.

Errors

  • NoSuchConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

DescribeConfigurationAggregatorSourcesStatus

$result = $client->describeConfigurationAggregatorSourcesStatus([/* ... */]);
$promise = $client->describeConfigurationAggregatorSourcesStatusAsync([/* ... */]);

Returns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.

Parameter Syntax

$result = $client->describeConfigurationAggregatorSourcesStatus([
    'ConfigurationAggregatorName' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'UpdateStatus' => ['<string>', ...],
]);

Parameter Details

Members
ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

Limit
  • Type: int

The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

UpdateStatus
  • Type: Array of strings

Filters the status type.

  • Valid value FAILED indicates errors while moving data.

  • Valid value SUCCEEDED indicates the data was successfully moved.

  • Valid value OUTDATED indicates the data is not the most recent.

Result Syntax

[
    'AggregatedSourceStatusList' => [
        [
            'AwsRegion' => '<string>',
            'LastErrorCode' => '<string>',
            'LastErrorMessage' => '<string>',
            'LastUpdateStatus' => 'FAILED|SUCCEEDED|OUTDATED',
            'LastUpdateTime' => <DateTime>,
            'SourceId' => '<string>',
            'SourceType' => 'ACCOUNT|ORGANIZATION',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
AggregatedSourceStatusList
  • Type: Array of AggregatedSourceStatus structures

Returns an AggregatedSourceStatus object.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

DescribeConfigurationAggregators

$result = $client->describeConfigurationAggregators([/* ... */]);
$promise = $client->describeConfigurationAggregatorsAsync([/* ... */]);

Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.

Parameter Syntax

$result = $client->describeConfigurationAggregators([
    'ConfigurationAggregatorNames' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConfigurationAggregatorNames
  • Type: Array of strings

The name of the configuration aggregators.

Limit
  • Type: int

The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'ConfigurationAggregators' => [
        [
            'AccountAggregationSources' => [
                [
                    'AccountIds' => ['<string>', ...],
                    'AllAwsRegions' => true || false,
                    'AwsRegions' => ['<string>', ...],
                ],
                // ...
            ],
            'ConfigurationAggregatorArn' => '<string>',
            'ConfigurationAggregatorName' => '<string>',
            'CreatedBy' => '<string>',
            'CreationTime' => <DateTime>,
            'LastUpdatedTime' => <DateTime>,
            'OrganizationAggregationSource' => [
                'AllAwsRegions' => true || false,
                'AwsRegions' => ['<string>', ...],
                'RoleArn' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ConfigurationAggregators
  • Type: Array of ConfigurationAggregator structures

Returns a ConfigurationAggregators object.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

DescribeConfigurationRecorderStatus

$result = $client->describeConfigurationRecorderStatus([/* ... */]);
$promise = $client->describeConfigurationRecorderStatusAsync([/* ... */]);

Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.

Currently, you can specify only one configuration recorder per region in your account.

Parameter Syntax

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

Parameter Details

Members
ConfigurationRecorderNames
  • Type: Array of strings

The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.

Result Syntax

[
    'ConfigurationRecordersStatus' => [
        [
            'lastErrorCode' => '<string>',
            'lastErrorMessage' => '<string>',
            'lastStartTime' => <DateTime>,
            'lastStatus' => 'Pending|Success|Failure',
            'lastStatusChangeTime' => <DateTime>,
            'lastStopTime' => <DateTime>,
            'name' => '<string>',
            'recording' => true || false,
        ],
        // ...
    ],
]

Result Details

Members
ConfigurationRecordersStatus
  • Type: Array of ConfigurationRecorderStatus structures

A list that contains status of the specified recorders.

Errors

  • NoSuchConfigurationRecorderException:

    You have specified a configuration recorder that does not exist.

DescribeConfigurationRecorders

$result = $client->describeConfigurationRecorders([/* ... */]);
$promise = $client->describeConfigurationRecordersAsync([/* ... */]);

Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.

Currently, you can specify only one configuration recorder per region in your account.

Parameter Syntax

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

Parameter Details

Members
ConfigurationRecorderNames
  • Type: Array of strings

A list of configuration recorder names.

Result Syntax

[
    'ConfigurationRecorders' => [
        [
            'name' => '<string>',
            'recordingGroup' => [
                'allSupported' => true || false,
                'includeGlobalResourceTypes' => true || false,
                'resourceTypes' => ['<string>', ...],
            ],
            'roleARN' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
ConfigurationRecorders
  • Type: Array of ConfigurationRecorder structures

A list that contains the descriptions of the specified configuration recorders.

Errors

  • NoSuchConfigurationRecorderException:

    You have specified a configuration recorder that does not exist.

DescribeConformancePackCompliance

$result = $client->describeConformancePackCompliance([/* ... */]);
$promise = $client->describeConformancePackComplianceAsync([/* ... */]);

Returns compliance details for each rule in that conformance pack.

You must provide exact rule names.

Parameter Syntax

$result = $client->describeConformancePackCompliance([
    'ConformancePackName' => '<string>', // REQUIRED
    'Filters' => [
        'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA',
        'ConfigRuleNames' => ['<string>', ...],
    ],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConformancePackName
  • Required: Yes
  • Type: string

Name of the conformance pack.

Filters
  • Type: ConformancePackComplianceFilters structure

A ConformancePackComplianceFilters object.

Limit
  • Type: int

The maximum number of Config rules within a conformance pack are returned on each page.

NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Result Syntax

[
    'ConformancePackName' => '<string>',
    'ConformancePackRuleComplianceList' => [
        [
            'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA',
            'ConfigRuleName' => '<string>',
            'Controls' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ConformancePackName
  • Required: Yes
  • Type: string

Name of the conformance pack.

ConformancePackRuleComplianceList
  • Required: Yes
  • Type: Array of ConformancePackRuleCompliance structures

Returns a list of ConformancePackRuleCompliance objects.

NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Errors

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • NoSuchConfigRuleInConformancePackException:

    Config rule that you passed in the filter does not exist.

  • NoSuchConformancePackException:

    You specified one or more conformance packs that do not exist.

DescribeConformancePackStatus

$result = $client->describeConformancePackStatus([/* ... */]);
$promise = $client->describeConformancePackStatusAsync([/* ... */]);

Provides one or more conformance packs deployment status.

If there are no conformance packs then you will see an empty result.

Parameter Syntax

$result = $client->describeConformancePackStatus([
    'ConformancePackNames' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConformancePackNames
  • Type: Array of strings

Comma-separated list of conformance pack names.

Limit
  • Type: int

The maximum number of conformance packs status returned on each page.

NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Result Syntax

[
    'ConformancePackStatusDetails' => [
        [
            'ConformancePackArn' => '<string>',
            'ConformancePackId' => '<string>',
            'ConformancePackName' => '<string>',
            'ConformancePackState' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
            'ConformancePackStatusReason' => '<string>',
            'LastUpdateCompletedTime' => <DateTime>,
            'LastUpdateRequestedTime' => <DateTime>,
            'StackArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ConformancePackStatusDetails
  • Type: Array of ConformancePackStatusDetail structures

A list of ConformancePackStatusDetail objects.

NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Errors

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

DescribeConformancePacks

$result = $client->describeConformancePacks([/* ... */]);
$promise = $client->describeConformancePacksAsync([/* ... */]);

Returns a list of one or more conformance packs.

Parameter Syntax

$result = $client->describeConformancePacks([
    'ConformancePackNames' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConformancePackNames
  • Type: Array of strings

Comma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs.

Limit
  • Type: int

The maximum number of conformance packs returned on each page.

NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Result Syntax

[
    'ConformancePackDetails' => [
        [
            'ConformancePackArn' => '<string>',
            'ConformancePackId' => '<string>',
            'ConformancePackInputParameters' => [
                [
                    'ParameterName' => '<string>',
                    'ParameterValue' => '<string>',
                ],
                // ...
            ],
            'ConformancePackName' => '<string>',
            'CreatedBy' => '<string>',
            'DeliveryS3Bucket' => '<string>',
            'DeliveryS3KeyPrefix' => '<string>',
            'LastUpdateRequestedTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ConformancePackDetails
  • Type: Array of ConformancePackDetail structures

Returns a list of ConformancePackDetail objects.

NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Errors

  • NoSuchConformancePackException:

    You specified one or more conformance packs that do not exist.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

DescribeDeliveryChannelStatus

$result = $client->describeDeliveryChannelStatus([/* ... */]);
$promise = $client->describeDeliveryChannelStatusAsync([/* ... */]);

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.

Currently, you can specify only one delivery channel per region in your account.

Parameter Syntax

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

Parameter Details

Members
DeliveryChannelNames
  • Type: Array of strings

A list of delivery channel names.

Result Syntax

[
    'DeliveryChannelsStatus' => [
        [
            'configHistoryDeliveryInfo' => [
                'lastAttemptTime' => <DateTime>,
                'lastErrorCode' => '<string>',
                'lastErrorMessage' => '<string>',
                'lastStatus' => 'Success|Failure|Not_Applicable',
                'lastSuccessfulTime' => <DateTime>,
                'nextDeliveryTime' => <DateTime>,
            ],
            'configSnapshotDeliveryInfo' => [
                'lastAttemptTime' => <DateTime>,
                'lastErrorCode' => '<string>',
                'lastErrorMessage' => '<string>',
                'lastStatus' => 'Success|Failure|Not_Applicable',
                'lastSuccessfulTime' => <DateTime>,
                'nextDeliveryTime' => <DateTime>,
            ],
            'configStreamDeliveryInfo' => [
                'lastErrorCode' => '<string>',
                'lastErrorMessage' => '<string>',
                'lastStatus' => 'Success|Failure|Not_Applicable',
                'lastStatusChangeTime' => <DateTime>,
            ],
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
DeliveryChannelsStatus
  • Type: Array of DeliveryChannelStatus structures

A list that contains the status of a specified delivery channel.

Errors

  • NoSuchDeliveryChannelException:

    You have specified a delivery channel that does not exist.

DescribeDeliveryChannels

$result = $client->describeDeliveryChannels([/* ... */]);
$promise = $client->describeDeliveryChannelsAsync([/* ... */]);

Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.

Currently, you can specify only one delivery channel per region in your account.

Parameter Syntax

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

Parameter Details

Members
DeliveryChannelNames
  • Type: Array of strings

A list of delivery channel names.

Result Syntax

[
    'DeliveryChannels' => [
        [
            'configSnapshotDeliveryProperties' => [
                'deliveryFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours',
            ],
            'name' => '<string>',
            's3BucketName' => '<string>',
            's3KeyPrefix' => '<string>',
            's3KmsKeyArn' => '<string>',
            'snsTopicARN' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
DeliveryChannels
  • Type: Array of DeliveryChannel structures

A list that contains the descriptions of the specified delivery channel.

Errors

  • NoSuchDeliveryChannelException:

    You have specified a delivery channel that does not exist.

DescribeOrganizationConfigRuleStatuses

$result = $client->describeOrganizationConfigRuleStatuses([/* ... */]);
$promise = $client->describeOrganizationConfigRuleStatusesAsync([/* ... */]);

Provides organization Config rule deployment status for an organization.

The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.

Parameter Syntax

$result = $client->describeOrganizationConfigRuleStatuses([
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'OrganizationConfigRuleNames' => ['<string>', ...],
]);

Parameter Details

Members
Limit
  • Type: int

The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

OrganizationConfigRuleNames
  • Type: Array of strings

The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.

Result Syntax

[
    'NextToken' => '<string>',
    'OrganizationConfigRuleStatuses' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'LastUpdateTime' => <DateTime>,
            'OrganizationConfigRuleName' => '<string>',
            'OrganizationRuleStatus' => 'CREATE_SUCCESSFUL|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_SUCCESSFUL|DELETE_FAILED|DELETE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_IN_PROGRESS|UPDATE_FAILED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

OrganizationConfigRuleStatuses
  • Type: Array of OrganizationConfigRuleStatus structures

A list of OrganizationConfigRuleStatus objects.

Errors

  • NoSuchOrganizationConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an organization Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • OrganizationAccessDeniedException:

    For PutConfigurationAggregator API, you can see this exception for the following reasons:

    • No permission to call EnableAWSServiceAccess API

    • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

    For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

DescribeOrganizationConfigRules

$result = $client->describeOrganizationConfigRules([/* ... */]);
$promise = $client->describeOrganizationConfigRulesAsync([/* ... */]);

Returns a list of organization Config rules.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.

Parameter Syntax

$result = $client->describeOrganizationConfigRules([
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'OrganizationConfigRuleNames' => ['<string>', ...],
]);

Parameter Details

Members
Limit
  • Type: int

The maximum number of organization Config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

OrganizationConfigRuleNames
  • Type: Array of strings

The names of organization Config rules for which you want details. If you do not specify any names, Config returns details for all your organization Config rules.

Result Syntax

[
    'NextToken' => '<string>',
    'OrganizationConfigRules' => [
        [
            'ExcludedAccounts' => ['<string>', ...],
            'LastUpdateTime' => <DateTime>,
            'OrganizationConfigRuleArn' => '<string>',
            'OrganizationConfigRuleName' => '<string>',
            'OrganizationCustomPolicyRuleMetadata' => [
                'DebugLogDeliveryAccounts' => ['<string>', ...],
                'Description' => '<string>',
                'InputParameters' => '<string>',
                'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours',
                'OrganizationConfigRuleTriggerTypes' => ['<string>', ...],
                'PolicyRuntime' => '<string>',
                'ResourceIdScope' => '<string>',
                'ResourceTypesScope' => ['<string>', ...],
                'TagKeyScope' => '<string>',
                'TagValueScope' => '<string>',
            ],
            'OrganizationCustomRuleMetadata' => [
                'Description' => '<string>',
                'InputParameters' => '<string>',
                'LambdaFunctionArn' => '<string>',
                'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours',
                'OrganizationConfigRuleTriggerTypes' => ['<string>', ...],
                'ResourceIdScope' => '<string>',
                'ResourceTypesScope' => ['<string>', ...],
                'TagKeyScope' => '<string>',
                'TagValueScope' => '<string>',
            ],
            'OrganizationManagedRuleMetadata' => [
                'Description' => '<string>',
                'InputParameters' => '<string>',
                'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours',
                'ResourceIdScope' => '<string>',
                'ResourceTypesScope' => ['<string>', ...],
                'RuleIdentifier' => '<string>',
                'TagKeyScope' => '<string>',
                'TagValueScope' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

OrganizationConfigRules
  • Type: Array of OrganizationConfigRule structures

Returns a list of OrganizationConfigRule objects.

Errors

  • NoSuchOrganizationConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an organization Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • OrganizationAccessDeniedException:

    For PutConfigurationAggregator API, you can see this exception for the following reasons:

    • No permission to call EnableAWSServiceAccess API

    • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

    For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

DescribeOrganizationConformancePackStatuses

$result = $client->describeOrganizationConformancePackStatuses([/* ... */]);
$promise = $client->describeOrganizationConformancePackStatusesAsync([/* ... */]);

Provides organization conformance pack deployment status for an organization.

The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.

Parameter Syntax

$result = $client->describeOrganizationConformancePackStatuses([
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'OrganizationConformancePackNames' => ['<string>', ...],
]);

Parameter Details

Members
Limit
  • Type: int

The maximum number of OrganizationConformancePackStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

OrganizationConformancePackNames
  • Type: Array of strings

The names of organization conformance packs for which you want status details. If you do not specify any names, Config returns details for all your organization conformance packs.

Result Syntax

[
    'NextToken' => '<string>',
    'OrganizationConformancePackStatuses' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'LastUpdateTime' => <DateTime>,
            'OrganizationConformancePackName' => '<string>',
            'Status' => 'CREATE_SUCCESSFUL|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_SUCCESSFUL|DELETE_FAILED|DELETE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_IN_PROGRESS|UPDATE_FAILED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

OrganizationConformancePackStatuses
  • Type: Array of OrganizationConformancePackStatus structures

A list of OrganizationConformancePackStatus objects.

Errors

  • NoSuchOrganizationConformancePackException:

    Config organization conformance pack that you passed in the filter does not exist.

    For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • OrganizationAccessDeniedException:

    For PutConfigurationAggregator API, you can see this exception for the following reasons:

    • No permission to call EnableAWSServiceAccess API

    • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

    For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

DescribeOrganizationConformancePacks

$result = $client->describeOrganizationConformancePacks([/* ... */]);
$promise = $client->describeOrganizationConformancePacksAsync([/* ... */]);

Returns a list of organization conformance packs.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.

Parameter Syntax

$result = $client->describeOrganizationConformancePacks([
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'OrganizationConformancePackNames' => ['<string>', ...],
]);

Parameter Details

Members
Limit
  • Type: int

The maximum number of organization config packs returned on each page. If you do no specify a number, Config uses the default. The default is 100.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

OrganizationConformancePackNames
  • Type: Array of strings

The name that you assign to an organization conformance pack.

Result Syntax

[
    'NextToken' => '<string>',
    'OrganizationConformancePacks' => [
        [
            'ConformancePackInputParameters' => [
                [
                    'ParameterName' => '<string>',
                    'ParameterValue' => '<string>',
                ],
                // ...
            ],
            'DeliveryS3Bucket' => '<string>',
            'DeliveryS3KeyPrefix' => '<string>',
            'ExcludedAccounts' => ['<string>', ...],
            'LastUpdateTime' => <DateTime>,
            'OrganizationConformancePackArn' => '<string>',
            'OrganizationConformancePackName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

OrganizationConformancePacks
  • Type: Array of OrganizationConformancePack structures

Returns a list of OrganizationConformancePacks objects.

Errors

  • NoSuchOrganizationConformancePackException:

    Config organization conformance pack that you passed in the filter does not exist.

    For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • OrganizationAccessDeniedException:

    For PutConfigurationAggregator API, you can see this exception for the following reasons:

    • No permission to call EnableAWSServiceAccess API

    • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

    For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

DescribePendingAggregationRequests

$result = $client->describePendingAggregationRequests([/* ... */]);
$promise = $client->describePendingAggregationRequestsAsync([/* ... */]);

Returns a list of all pending aggregation requests.

Parameter Syntax

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

Parameter Details

Members
Limit
  • Type: int

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'NextToken' => '<string>',
    'PendingAggregationRequests' => [
        [
            'RequesterAccountId' => '<string>',
            'RequesterAwsRegion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

PendingAggregationRequests
  • Type: Array of PendingAggregationRequest structures

Returns a PendingAggregationRequests object.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

DescribeRemediationConfigurations

$result = $client->describeRemediationConfigurations([/* ... */]);
$promise = $client->describeRemediationConfigurationsAsync([/* ... */]);

Returns the details of one or more remediation configurations.

Parameter Syntax

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

Parameter Details

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

A list of Config rule names of remediation configurations for which you want details.

Result Syntax

[
    'RemediationConfigurations' => [
        [
            'Arn' => '<string>',
            'Automatic' => true || false,
            'ConfigRuleName' => '<string>',
            'CreatedByService' => '<string>',
            'ExecutionControls' => [
                'SsmControls' => [
                    'ConcurrentExecutionRatePercentage' => <integer>,
                    'ErrorPercentage' => <integer>,
                ],
            ],
            'MaximumAutomaticAttempts' => <integer>,
            'Parameters' => [
                '<StringWithCharLimit256>' => [
                    'ResourceValue' => [
                        'Value' => 'RESOURCE_ID',
                    ],
                    'StaticValue' => [
                        'Values' => ['<string>', ...],
                    ],
                ],
                // ...
            ],
            'ResourceType' => '<string>',
            'RetryAttemptSeconds' => <integer>,
            'TargetId' => '<string>',
            'TargetType' => 'SSM_DOCUMENT',
            'TargetVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
RemediationConfigurations
  • Type: Array of RemediationConfiguration structures

Returns a remediation configuration object.

Errors

There are no errors described for this operation.

DescribeRemediationExceptions

$result = $client->describeRemediationExceptions([/* ... */]);
$promise = $client->describeRemediationExceptionsAsync([/* ... */]);

Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.

Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.

Parameter Syntax

$result = $client->describeRemediationExceptions([
    'ConfigRuleName' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'ResourceKeys' => [
        [
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ConfigRuleName
  • Required: Yes
  • Type: string

The name of the Config rule.

Limit
  • Type: int

The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

ResourceKeys
  • Type: Array of RemediationExceptionResourceKey structures

An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.

Result Syntax

[
    'NextToken' => '<string>',
    'RemediationExceptions' => [
        [
            'ConfigRuleName' => '<string>',
            'ExpirationTime' => <DateTime>,
            'Message' => '<string>',
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

RemediationExceptions
  • Type: Array of RemediationException structures

Returns a list of remediation exception objects.

Errors

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

DescribeRemediationExecutionStatus

$result = $client->describeRemediationExecutionStatus([/* ... */]);
$promise = $client->describeRemediationExecutionStatusAsync([/* ... */]);

Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.

Parameter Syntax

$result = $client->describeRemediationExecutionStatus([
    'ConfigRuleName' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'ResourceKeys' => [
        [
            'resourceId' => '<string>', // REQUIRED
            'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ConfigRuleName
  • Required: Yes
  • Type: string

A list of Config rule names.

Limit
  • Type: int

The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

ResourceKeys
  • Type: Array of ResourceKey structures

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

Result Syntax

[
    'NextToken' => '<string>',
    'RemediationExecutionStatuses' => [
        [
            'InvocationTime' => <DateTime>,
            'LastUpdatedTime' => <DateTime>,
            'ResourceKey' => [
                'resourceId' => '<string>',
                'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
            ],
            'State' => 'QUEUED|IN_PROGRESS|SUCCEEDED|FAILED',
            'StepDetails' => [
                [
                    'ErrorMessage' => '<string>',
                    'Name' => '<string>',
                    'StartTime' => <DateTime>,
                    'State' => 'SUCCEEDED|PENDING|FAILED',
                    'StopTime' => <DateTime>,
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

RemediationExecutionStatuses
  • Type: Array of RemediationExecutionStatus structures

Returns a list of remediation execution statuses objects.

Errors

  • NoSuchRemediationConfigurationException:

    You specified an Config rule without a remediation configuration.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

DescribeRetentionConfigurations

$result = $client->describeRetentionConfigurations([/* ... */]);
$promise = $client->describeRetentionConfigurationsAsync([/* ... */]);

Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.

Currently, Config supports only one retention configuration per region in your account.

Parameter Syntax

$result = $client->describeRetentionConfigurations([
    'NextToken' => '<string>',
    'RetentionConfigurationNames' => ['<string>', ...],
]);

Parameter Details

Members
NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

RetentionConfigurationNames
  • Type: Array of strings

A list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account.

Currently, Config supports only one retention configuration per region in your account.

Result Syntax

[
    'NextToken' => '<string>',
    'RetentionConfigurations' => [
        [
            'Name' => '<string>',
            'RetentionPeriodInDays' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

RetentionConfigurations
  • Type: Array of RetentionConfiguration structures

Returns a retention configuration object.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • NoSuchRetentionConfigurationException:

    You have specified a retention configuration that does not exist.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

GetAggregateComplianceDetailsByConfigRule

$result = $client->getAggregateComplianceDetailsByConfigRule([/* ... */]);
$promise = $client->getAggregateComplianceDetailsByConfigRuleAsync([/* ... */]);

Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.

Parameter Syntax

$result = $client->getAggregateComplianceDetailsByConfigRule([
    'AccountId' => '<string>', // REQUIRED
    'AwsRegion' => '<string>', // REQUIRED
    'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA',
    'ConfigRuleName' => '<string>', // REQUIRED
    'ConfigurationAggregatorName' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
AccountId
  • Required: Yes
  • Type: string

The 12-digit account ID of the source account.

AwsRegion
  • Required: Yes
  • Type: string

The source region from where the data is aggregated.

ComplianceType
  • Type: string

The resource compliance status.

For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.

ConfigRuleName
  • Required: Yes
  • Type: string

The name of the Config rule for which you want compliance information.

ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

Limit
  • Type: int

The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'AggregateEvaluationResults' => [
        [
            'AccountId' => '<string>',
            'Annotation' => '<string>',
            'AwsRegion' => '<string>',
            'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA',
            'ConfigRuleInvokedTime' => <DateTime>,
            'EvaluationResultIdentifier' => [
                'EvaluationResultQualifier' => [
                    'ConfigRuleName' => '<string>',
                    'ResourceId' => '<string>',
                    'ResourceType' => '<string>',
                ],
                'OrderingTimestamp' => <DateTime>,
            ],
            'ResultRecordedTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
AggregateEvaluationResults
  • Type: Array of AggregateEvaluationResult structures

Returns an AggregateEvaluationResults object.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

GetAggregateConfigRuleComplianceSummary

$result = $client->getAggregateConfigRuleComplianceSummary([/* ... */]);
$promise = $client->getAggregateConfigRuleComplianceSummaryAsync([/* ... */]);

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Parameter Syntax

$result = $client->getAggregateConfigRuleComplianceSummary([
    'ConfigurationAggregatorName' => '<string>', // REQUIRED
    'Filters' => [
        'AccountId' => '<string>',
        'AwsRegion' => '<string>',
    ],
    'GroupByKey' => 'ACCOUNT_ID|AWS_REGION',
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

Filters
  • Type: ConfigRuleComplianceSummaryFilters structure

Filters the results based on the ConfigRuleComplianceSummaryFilters object.

GroupByKey
  • Type: string

Groups the result based on ACCOUNT_ID or AWS_REGION.

Limit
  • Type: int

The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'AggregateComplianceCounts' => [
        [
            'ComplianceSummary' => [
                'ComplianceSummaryTimestamp' => <DateTime>,
                'CompliantResourceCount' => [
                    'CapExceeded' => true || false,
                    'CappedCount' => <integer>,
                ],
                'NonCompliantResourceCount' => [
                    'CapExceeded' => true || false,
                    'CappedCount' => <integer>,
                ],
            ],
            'GroupName' => '<string>',
        ],
        // ...
    ],
    'GroupByKey' => '<string>',
    'NextToken' => '<string>',
]

Result Details

Members
AggregateComplianceCounts
  • Type: Array of AggregateComplianceCount structures

Returns a list of AggregateComplianceCounts object.

GroupByKey
  • Type: string

Groups the result based on ACCOUNT_ID or AWS_REGION.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

GetAggregateConformancePackComplianceSummary

$result = $client->getAggregateConformancePackComplianceSummary([/* ... */]);
$promise = $client->getAggregateConformancePackComplianceSummaryAsync([/* ... */]);

Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Parameter Syntax

$result = $client->getAggregateConformancePackComplianceSummary([
    'ConfigurationAggregatorName' => '<string>', // REQUIRED
    'Filters' => [
        'AccountId' => '<string>',
        'AwsRegion' => '<string>',
    ],
    'GroupByKey' => 'ACCOUNT_ID|AWS_REGION',
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

Filters
  • Type: AggregateConformancePackComplianceSummaryFilters structure

Filters the results based on the AggregateConformancePackComplianceSummaryFilters object.

GroupByKey
  • Type: string

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

Limit
  • Type: int

The maximum number of results returned on each page. The default is maximum. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'AggregateConformancePackComplianceSummaries' => [
        [
            'ComplianceSummary' => [
                'CompliantConformancePackCount' => <integer>,
                'NonCompliantConformancePackCount' => <integer>,
            ],
            'GroupName' => '<string>',
        ],
        // ...
    ],
    'GroupByKey' => '<string>',
    'NextToken' => '<string>',
]

Result Details

Members
AggregateConformancePackComplianceSummaries
  • Type: Array of AggregateConformancePackComplianceSummary structures

Returns a list of AggregateConformancePackComplianceSummary object.

GroupByKey
  • Type: string

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

GetAggregateDiscoveredResourceCounts

$result = $client->getAggregateDiscoveredResourceCounts([/* ... */]);
$promise = $client->getAggregateDiscoveredResourceCountsAsync([/* ... */]);

Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.

For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.

Parameter Syntax

$result = $client->getAggregateDiscoveredResourceCounts([
    'ConfigurationAggregatorName' => '<string>', // REQUIRED
    'Filters' => [
        'AccountId' => '<string>',
        'Region' => '<string>',
        'ResourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
    ],
    'GroupByKey' => 'RESOURCE_TYPE|ACCOUNT_ID|AWS_REGION',
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

Filters
  • Type: ResourceCountFilters structure

Filters the results based on the ResourceCountFilters object.

GroupByKey
  • Type: string

The key to group the resource counts.

Limit
  • Type: int

The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'GroupByKey' => '<string>',
    'GroupedResourceCounts' => [
        [
            'GroupName' => '<string>',
            'ResourceCount' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'TotalDiscoveredResources' => <integer>,
]

Result Details

Members
GroupByKey
  • Type: string

The key passed into the request object. If GroupByKey is not provided, the result will be empty.

GroupedResourceCounts
  • Type: Array of GroupedResourceCount structures

Returns a list of GroupedResourceCount objects.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

TotalDiscoveredResources
  • Required: Yes
  • Type: long (int|float)

The total number of resources that are present in an aggregator with the filters that you provide.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

GetAggregateResourceConfig

$result = $client->getAggregateResourceConfig([/* ... */]);
$promise = $client->getAggregateResourceConfigAsync([/* ... */]);

Returns configuration item that is aggregated for your specific resource in a specific source account and region.

Parameter Syntax

$result = $client->getAggregateResourceConfig([
    'ConfigurationAggregatorName' => '<string>', // REQUIRED
    'ResourceIdentifier' => [ // REQUIRED
        'ResourceId' => '<string>', // REQUIRED
        'ResourceName' => '<string>',
        'ResourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository', // REQUIRED
        'SourceAccountId' => '<string>', // REQUIRED
        'SourceRegion' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

ResourceIdentifier
  • Required: Yes
  • Type: AggregateResourceIdentifier structure

An object that identifies aggregate resource.

Result Syntax

[
    'ConfigurationItem' => [
        'accountId' => '<string>',
        'arn' => '<string>',
        'availabilityZone' => '<string>',
        'awsRegion' => '<string>',
        'configuration' => '<string>',
        'configurationItemCaptureTime' => <DateTime>,
        'configurationItemMD5Hash' => '<string>',
        'configurationItemStatus' => 'OK|ResourceDiscovered|ResourceNotRecorded|ResourceDeleted|ResourceDeletedNotRecorded',
        'configurationStateId' => '<string>',
        'relatedEvents' => ['<string>', ...],
        'relationships' => [
            [
                'relationshipName' => '<string>',
                'resourceId' => '<string>',
                'resourceName' => '<string>',
                'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
            ],
            // ...
        ],
        'resourceCreationTime' => <DateTime>,
        'resourceId' => '<string>',
        'resourceName' => '<string>',
        'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
        'supplementaryConfiguration' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'version' => '<string>',
    ],
]

Result Details

Members
ConfigurationItem
  • Type: ConfigurationItem structure

Returns a ConfigurationItem object.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

  • OversizedConfigurationItemException:

    The configuration item size is outside the allowable range.

  • ResourceNotDiscoveredException:

    You have specified a resource that is either unknown or has not been discovered.

GetComplianceDetailsByConfigRule

$result = $client->getComplianceDetailsByConfigRule([/* ... */]);
$promise = $client->getComplianceDetailsByConfigRuleAsync([/* ... */]);

Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

Parameter Syntax

$result = $client->getComplianceDetailsByConfigRule([
    'ComplianceTypes' => ['<string>', ...],
    'ConfigRuleName' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ComplianceTypes
  • Type: Array of strings

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

ConfigRuleName
  • Required: Yes
  • Type: string

The name of the Config rule for which you want compliance information.

Limit
  • Type: int

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'EvaluationResults' => [
        [
            'Annotation' => '<string>',
            'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA',
            'ConfigRuleInvokedTime' => <DateTime>,
            'EvaluationResultIdentifier' => [
                'EvaluationResultQualifier' => [
                    'ConfigRuleName' => '<string>',
                    'ResourceId' => '<string>',
                    'ResourceType' => '<string>',
                ],
                'OrderingTimestamp' => <DateTime>,
            ],
            'ResultRecordedTime' => <DateTime>,
            'ResultToken' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
EvaluationResults
  • Type: Array of EvaluationResult structures

Indicates whether the Amazon Web Services resource complies with the specified Config rule.

NextToken
  • Type: string

The string that you use in a subsequent request to get the next page of results in a paginated response.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • NoSuchConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

GetComplianceDetailsByResource

$result = $client->getComplianceDetailsByResource([/* ... */]);
$promise = $client->getComplianceDetailsByResourceAsync([/* ... */]);

Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.

Parameter Syntax

$result = $client->getComplianceDetailsByResource([
    'ComplianceTypes' => ['<string>', ...],
    'NextToken' => '<string>',
    'ResourceId' => '<string>', // REQUIRED
    'ResourceType' => '<string>', // REQUIRED
]);

Parameter Details

Members
ComplianceTypes
  • Type: Array of strings

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

ResourceId
  • Required: Yes
  • Type: string

The ID of the Amazon Web Services resource for which you want compliance information.

ResourceType
  • Required: Yes
  • Type: string

The type of the Amazon Web Services resource for which you want compliance information.

Result Syntax

[
    'EvaluationResults' => [
        [
            'Annotation' => '<string>',
            'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA',
            'ConfigRuleInvokedTime' => <DateTime>,
            'EvaluationResultIdentifier' => [
                'EvaluationResultQualifier' => [
                    'ConfigRuleName' => '<string>',
                    'ResourceId' => '<string>',
                    'ResourceType' => '<string>',
                ],
                'OrderingTimestamp' => <DateTime>,
            ],
            'ResultRecordedTime' => <DateTime>,
            'ResultToken' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
EvaluationResults
  • Type: Array of EvaluationResult structures

Indicates whether the specified Amazon Web Services resource complies each Config rule.

NextToken
  • Type: string

The string that you use in a subsequent request to get the next page of results in a paginated response.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

GetComplianceSummaryByConfigRule

$result = $client->getComplianceSummaryByConfigRule([/* ... */]);
$promise = $client->getComplianceSummaryByConfigRuleAsync([/* ... */]);

Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'ComplianceSummary' => [
        'ComplianceSummaryTimestamp' => <DateTime>,
        'CompliantResourceCount' => [
            'CapExceeded' => true || false,
            'CappedCount' => <integer>,
        ],
        'NonCompliantResourceCount' => [
            'CapExceeded' => true || false,
            'CappedCount' => <integer>,
        ],
    ],
]

Result Details

Members
ComplianceSummary
  • Type: ComplianceSummary structure

The number of Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.

Errors

There are no errors described for this operation.

GetComplianceSummaryByResourceType

$result = $client->getComplianceSummaryByResourceType([/* ... */]);
$promise = $client->getComplianceSummaryByResourceTypeAsync([/* ... */]);

Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.

Parameter Syntax

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

Parameter Details

Members
ResourceTypes
  • Type: Array of strings

Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.

For this request, you can specify an Amazon Web Services resource type such as AWS::EC2::Instance. You can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

Result Syntax

[
    'ComplianceSummariesByResourceType' => [
        [
            'ComplianceSummary' => [
                'ComplianceSummaryTimestamp' => <DateTime>,
                'CompliantResourceCount' => [
                    'CapExceeded' => true || false,
                    'CappedCount' => <integer>,
                ],
                'NonCompliantResourceCount' => [
                    'CapExceeded' => true || false,
                    'CappedCount' => <integer>,
                ],
            ],
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
ComplianceSummariesByResourceType
  • Type: Array of ComplianceSummaryByResourceType structures

The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

GetConformancePackComplianceDetails

$result = $client->getConformancePackComplianceDetails([/* ... */]);
$promise = $client->getConformancePackComplianceDetailsAsync([/* ... */]);

Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.

Parameter Syntax

$result = $client->getConformancePackComplianceDetails([
    'ConformancePackName' => '<string>', // REQUIRED
    'Filters' => [
        'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA',
        'ConfigRuleNames' => ['<string>', ...],
        'ResourceIds' => ['<string>', ...],
        'ResourceType' => '<string>',
    ],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConformancePackName
  • Required: Yes
  • Type: string

Name of the conformance pack.

Filters
  • Type: ConformancePackEvaluationFilters structure

A ConformancePackEvaluationFilters object.

Limit
  • Type: int

The maximum number of evaluation results returned on each page. If you do no specify a number, Config uses the default. The default is 100.

NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Result Syntax

[
    'ConformancePackName' => '<string>',
    'ConformancePackRuleEvaluationResults' => [
        [
            'Annotation' => '<string>',
            'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA',
            'ConfigRuleInvokedTime' => <DateTime>,
            'EvaluationResultIdentifier' => [
                'EvaluationResultQualifier' => [
                    'ConfigRuleName' => '<string>',
                    'ResourceId' => '<string>',
                    'ResourceType' => '<string>',
                ],
                'OrderingTimestamp' => <DateTime>,
            ],
            'ResultRecordedTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ConformancePackName
  • Required: Yes
  • Type: string

Name of the conformance pack.

ConformancePackRuleEvaluationResults
  • Type: Array of ConformancePackEvaluationResult structures

Returns a list of ConformancePackEvaluationResult objects.

NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Errors

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • NoSuchConformancePackException:

    You specified one or more conformance packs that do not exist.

  • NoSuchConfigRuleInConformancePackException:

    Config rule that you passed in the filter does not exist.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

GetConformancePackComplianceSummary

$result = $client->getConformancePackComplianceSummary([/* ... */]);
$promise = $client->getConformancePackComplianceSummaryAsync([/* ... */]);

Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.

Parameter Syntax

$result = $client->getConformancePackComplianceSummary([
    'ConformancePackNames' => ['<string>', ...], // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

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

Names of conformance packs.

Limit
  • Type: int

The maximum number of conformance packs returned on each page.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Result Syntax

[
    'ConformancePackComplianceSummaryList' => [
        [
            'ConformancePackComplianceStatus' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA',
            'ConformancePackName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ConformancePackComplianceSummaryList
  • Type: Array of ConformancePackComplianceSummary structures

A list of ConformancePackComplianceSummary objects.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Errors

  • NoSuchConformancePackException:

    You specified one or more conformance packs that do not exist.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

GetCustomRulePolicy

$result = $client->getCustomRulePolicy([/* ... */]);
$promise = $client->getCustomRulePolicyAsync([/* ... */]);

Returns the policy definition containing the logic for your Config Custom Policy rule.

Parameter Syntax

$result = $client->getCustomRulePolicy([
    'ConfigRuleName' => '<string>',
]);

Parameter Details

Members
ConfigRuleName
  • Type: string

The name of your Config Custom Policy rule.

Result Syntax

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

Result Details

Members
PolicyText
  • Type: string

The policy definition containing the logic for your Config Custom Policy rule.

Errors

  • NoSuchConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

GetDiscoveredResourceCounts

$result = $client->getDiscoveredResourceCounts([/* ... */]);
$promise = $client->getDiscoveredResourceCountsAsync([/* ... */]);

Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.

Example

  1. Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.

  2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

  3. Config returns the following:

    • The resource types (EC2 instances, IAM users, and S3 buckets).

    • The number of each resource type (25, 20, and 15).

    • The total number of all resources (60).

The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:

  • You are a new Config customer.

  • You just enabled resource recording.

It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.

Parameter Syntax

$result = $client->getDiscoveredResourceCounts([
    'limit' => <integer>,
    'nextToken' => '<string>',
    'resourceTypes' => ['<string>', ...],
]);

Parameter Details

Members
limit
  • Type: int

The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

nextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

resourceTypes
  • Type: Array of strings

The comma-separated list that specifies the resource types that you want Config to return (for example, "AWS::EC2::Instance", "AWS::IAM::User").

If a value for resourceTypes is not specified, Config returns all resource types that Config is recording in the region for your account.

If the configuration recorder is turned off, Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects.

Result Syntax

[
    'nextToken' => '<string>',
    'resourceCounts' => [
        [
            'count' => <integer>,
            'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
        ],
        // ...
    ],
    'totalDiscoveredResources' => <integer>,
]

Result Details

Members
nextToken
  • Type: string

The string that you use in a subsequent request to get the next page of results in a paginated response.

resourceCounts
  • Type: Array of ResourceCount structures

The list of ResourceCount objects. Each object is listed in descending order by the number of resources.

totalDiscoveredResources
  • Type: long (int|float)

The total number of resources that Config is recording in the region for your account. If you specify resource types in the request, Config returns only the total number of resources for those resource types.

Example

  1. Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.

  2. You make a call to the GetDiscoveredResourceCounts action and specify the resource type, "AWS::EC2::Instances", in the request.

  3. Config returns 25 for totalDiscoveredResources.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

GetOrganizationConfigRuleDetailedStatus

$result = $client->getOrganizationConfigRuleDetailedStatus([/* ... */]);
$promise = $client->getOrganizationConfigRuleDetailedStatusAsync([/* ... */]);

Returns detailed status for each member account within an organization for a given organization Config rule.

Parameter Syntax

$result = $client->getOrganizationConfigRuleDetailedStatus([
    'Filters' => [
        'AccountId' => '<string>',
        'MemberAccountRuleStatus' => 'CREATE_SUCCESSFUL|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_SUCCESSFUL|DELETE_FAILED|DELETE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_IN_PROGRESS|UPDATE_FAILED',
    ],
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'OrganizationConfigRuleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Filters
  • Type: StatusDetailFilters structure

A StatusDetailFilters object.

Limit
  • Type: int

The maximum number of OrganizationConfigRuleDetailedStatus returned on each page. If you do not specify a number, Config uses the default. The default is 100.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

OrganizationConfigRuleName
  • Required: Yes
  • Type: string

The name of your organization Config rule for which you want status details for member accounts.

Result Syntax

[
    'NextToken' => '<string>',
    'OrganizationConfigRuleDetailedStatus' => [
        [
            'AccountId' => '<string>',
            'ConfigRuleName' => '<string>',
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'LastUpdateTime' => <DateTime>,
            'MemberAccountRuleStatus' => 'CREATE_SUCCESSFUL|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_SUCCESSFUL|DELETE_FAILED|DELETE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_IN_PROGRESS|UPDATE_FAILED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

OrganizationConfigRuleDetailedStatus
  • Type: Array of MemberAccountStatus structures

A list of MemberAccountStatus objects.

Errors

  • NoSuchOrganizationConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an organization Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • OrganizationAccessDeniedException:

    For PutConfigurationAggregator API, you can see this exception for the following reasons:

    • No permission to call EnableAWSServiceAccess API

    • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

    For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

GetOrganizationConformancePackDetailedStatus

$result = $client->getOrganizationConformancePackDetailedStatus([/* ... */]);
$promise = $client->getOrganizationConformancePackDetailedStatusAsync([/* ... */]);

Returns detailed status for each member account within an organization for a given organization conformance pack.

Parameter Syntax

$result = $client->getOrganizationConformancePackDetailedStatus([
    'Filters' => [
        'AccountId' => '<string>',
        'Status' => 'CREATE_SUCCESSFUL|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_SUCCESSFUL|DELETE_FAILED|DELETE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_IN_PROGRESS|UPDATE_FAILED',
    ],
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'OrganizationConformancePackName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Filters
  • Type: OrganizationResourceDetailedStatusFilters structure

An OrganizationResourceDetailedStatusFilters object.

Limit
  • Type: int

The maximum number of OrganizationConformancePackDetailedStatuses returned on each page. If you do not specify a number, Config uses the default. The default is 100.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

OrganizationConformancePackName
  • Required: Yes
  • Type: string

The name of organization conformance pack for which you want status details for member accounts.

Result Syntax

[
    'NextToken' => '<string>',
    'OrganizationConformancePackDetailedStatuses' => [
        [
            'AccountId' => '<string>',
            'ConformancePackName' => '<string>',
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'LastUpdateTime' => <DateTime>,
            'Status' => 'CREATE_SUCCESSFUL|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_SUCCESSFUL|DELETE_FAILED|DELETE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_IN_PROGRESS|UPDATE_FAILED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

OrganizationConformancePackDetailedStatuses
  • Type: Array of OrganizationConformancePackDetailedStatus structures

A list of OrganizationConformancePackDetailedStatus objects.

Errors

  • NoSuchOrganizationConformancePackException:

    Config organization conformance pack that you passed in the filter does not exist.

    For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • OrganizationAccessDeniedException:

    For PutConfigurationAggregator API, you can see this exception for the following reasons:

    • No permission to call EnableAWSServiceAccess API

    • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

    For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

GetOrganizationCustomRulePolicy

$result = $client->getOrganizationCustomRulePolicy([/* ... */]);
$promise = $client->getOrganizationCustomRulePolicyAsync([/* ... */]);

Returns the policy definition containing the logic for your organization Config Custom Policy rule.

Parameter Syntax

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

Parameter Details

Members
OrganizationConfigRuleName
  • Required: Yes
  • Type: string

The name of your organization Config Custom Policy rule.

Result Syntax

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

Result Details

Members
PolicyText
  • Type: string

The policy definition containing the logic for your organization Config Custom Policy rule.

Errors

  • NoSuchOrganizationConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an organization Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

  • OrganizationAccessDeniedException:

    For PutConfigurationAggregator API, you can see this exception for the following reasons:

    • No permission to call EnableAWSServiceAccess API

    • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

    For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

GetResourceConfigHistory

$result = $client->getResourceConfigHistory([/* ... */]);
$promise = $client->getResourceConfigHistoryAsync([/* ... */]);

Returns a list of ConfigurationItems for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems for the specified retention period.

The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.

Parameter Syntax

$result = $client->getResourceConfigHistory([
    'chronologicalOrder' => 'Reverse|Forward',
    'earlierTime' => <integer || string || DateTime>,
    'laterTime' => <integer || string || DateTime>,
    'limit' => <integer>,
    'nextToken' => '<string>',
    'resourceId' => '<string>', // REQUIRED
    'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository', // REQUIRED
]);

Parameter Details

Members
chronologicalOrder
  • Type: string

The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.

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

The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded.

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

The time stamp that indicates a later time. If not specified, current time is taken.

limit
  • Type: int

The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

nextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

resourceId
  • Required: Yes
  • Type: string

The ID of the resource (for example., sg-xxxxxx).

resourceType
  • Required: Yes
  • Type: string

The resource type.

Result Syntax

[
    'configurationItems' => [
        [
            'accountId' => '<string>',
            'arn' => '<string>',
            'availabilityZone' => '<string>',
            'awsRegion' => '<string>',
            'configuration' => '<string>',
            'configurationItemCaptureTime' => <DateTime>,
            'configurationItemMD5Hash' => '<string>',
            'configurationItemStatus' => 'OK|ResourceDiscovered|ResourceNotRecorded|ResourceDeleted|ResourceDeletedNotRecorded',
            'configurationStateId' => '<string>',
            'relatedEvents' => ['<string>', ...],
            'relationships' => [
                [
                    'relationshipName' => '<string>',
                    'resourceId' => '<string>',
                    'resourceName' => '<string>',
                    'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
                ],
                // ...
            ],
            'resourceCreationTime' => <DateTime>,
            'resourceId' => '<string>',
            'resourceName' => '<string>',
            'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
            'supplementaryConfiguration' => ['<string>', ...],
            'tags' => ['<string>', ...],
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
configurationItems
  • Type: Array of ConfigurationItem structures

A list that contains the configuration history of one or more resources.

nextToken
  • Type: string

The string that you use in a subsequent request to get the next page of results in a paginated response.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InvalidTimeRangeException:

    The specified time range is not valid. The earlier time is not chronologically before the later time.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • NoAvailableConfigurationRecorderException:

    There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

  • ResourceNotDiscoveredException:

    You have specified a resource that is either unknown or has not been discovered.

GetStoredQuery

$result = $client->getStoredQuery([/* ... */]);
$promise = $client->getStoredQueryAsync([/* ... */]);

Returns the details of a specific stored query.

Parameter Syntax

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

Parameter Details

Members
QueryName
  • Required: Yes
  • Type: string

The name of the query.

Result Syntax

[
    'StoredQuery' => [
        'Description' => '<string>',
        'Expression' => '<string>',
        'QueryArn' => '<string>',
        'QueryId' => '<string>',
        'QueryName' => '<string>',
    ],
]

Result Details

Members
StoredQuery
  • Type: StoredQuery structure

Returns a StoredQuery object.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • ResourceNotFoundException:

    You have specified a resource that does not exist.

ListAggregateDiscoveredResources

$result = $client->listAggregateDiscoveredResources([/* ... */]);
$promise = $client->listAggregateDiscoveredResourcesAsync([/* ... */]);

Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.

For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.

Parameter Syntax

$result = $client->listAggregateDiscoveredResources([
    'ConfigurationAggregatorName' => '<string>', // REQUIRED
    'Filters' => [
        'AccountId' => '<string>',
        'Region' => '<string>',
        'ResourceId' => '<string>',
        'ResourceName' => '<string>',
    ],
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'ResourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository', // REQUIRED
]);

Parameter Details

Members
ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

Filters
  • Type: ResourceFilters structure

Filters the results based on the ResourceFilters object.

Limit
  • Type: int

The maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

ResourceType
  • Required: Yes
  • Type: string

The type of resources that you want Config to list in the response.

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceIdentifiers' => [
        [
            'ResourceId' => '<string>',
            'ResourceName' => '<string>',
            'ResourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
            'SourceAccountId' => '<string>',
            'SourceRegion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

ResourceIdentifiers
  • Type: Array of AggregateResourceIdentifier structures

Returns a list of ResourceIdentifiers objects.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

ListDiscoveredResources

$result = $client->listDiscoveredResources([/* ... */]);
$promise = $client->listDiscoveredResourcesAsync([/* ... */]);

Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.

You can specify either resource IDs or a resource name, but not both, in the same request.

The response is paginated. By default, Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

Parameter Syntax

$result = $client->listDiscoveredResources([
    'includeDeletedResources' => true || false,
    'limit' => <integer>,
    'nextToken' => '<string>',
    'resourceIds' => ['<string>', ...],
    'resourceName' => '<string>',
    'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository', // REQUIRED
]);

Parameter Details

Members
includeDeletedResources
  • Type: boolean

Specifies whether Config includes deleted resources in the results. By default, deleted resources are not included.

limit
  • Type: int

The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

nextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

resourceIds
  • Type: Array of strings

The IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.

resourceName
  • Type: string

The custom name of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.

resourceType
  • Required: Yes
  • Type: string

The type of resources that you want Config to list in the response.

Result Syntax

[
    'nextToken' => '<string>',
    'resourceIdentifiers' => [
        [
            'resourceDeletionTime' => <DateTime>,
            'resourceId' => '<string>',
            'resourceName' => '<string>',
            'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The string that you use in a subsequent request to get the next page of results in a paginated response.

resourceIdentifiers
  • Type: Array of ResourceIdentifier structures

The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • NoAvailableConfigurationRecorderException:

    There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

ListStoredQueries

$result = $client->listStoredQueries([/* ... */]);
$promise = $client->listStoredQueriesAsync([/* ... */]);

Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of results to be returned with a single call.

NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Result Syntax

[
    'NextToken' => '<string>',
    'StoredQueryMetadata' => [
        [
            'Description' => '<string>',
            'QueryArn' => '<string>',
            'QueryId' => '<string>',
            'QueryName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

StoredQueryMetadata
  • Type: Array of StoredQueryMetadata structures

A list of StoredQueryMetadata objects.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

ListTagsForResource

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

List the tags for Config resource.

Parameter Syntax

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

Parameter Details

Members
Limit
  • Type: int

The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, Config uses the default.

NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

ResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Tags
  • Type: Array of Tag structures

The tags for the resource.

Errors

  • ResourceNotFoundException:

    You have specified a resource that does not exist.

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

PutAggregationAuthorization

$result = $client->putAggregationAuthorization([/* ... */]);
$promise = $client->putAggregationAuthorizationAsync([/* ... */]);

Authorizes the aggregator account and region to collect data from the source account and region.

Parameter Syntax

$result = $client->putAggregationAuthorization([
    'AuthorizedAccountId' => '<string>', // REQUIRED
    'AuthorizedAwsRegion' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
AuthorizedAccountId
  • Required: Yes
  • Type: string

The 12-digit account ID of the account authorized to aggregate data.

AuthorizedAwsRegion
  • Required: Yes
  • Type: string

The region authorized to collect aggregated data.

Tags
  • Type: Array of Tag structures

An array of tag object.

Result Syntax

[
    'AggregationAuthorization' => [
        'AggregationAuthorizationArn' => '<string>',
        'AuthorizedAccountId' => '<string>',
        'AuthorizedAwsRegion' => '<string>',
        'CreationTime' => <DateTime>,
    ],
]

Result Details

Members
AggregationAuthorization
  • Type: AggregationAuthorization structure

Returns an AggregationAuthorization object.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

PutConfigRule

$result = $client->putConfigRule([/* ... */]);
$promise = $client->putConfigRuleAsync([/* ... */]);

Adds or updates an Config rule for evaluating whether your Amazon Web Services resources comply with your desired configurations.

You can use this action for Config custom rules and Config managed rules. A Config custom rule is a rule that you develop and maintain. An Config managed rule is a customizable, predefined rule that Config provides.

If you are adding a new Config custom rule, you must first create the Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. Specify the ARN for the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.

If you are adding an Config managed rule, specify the rule's identifier for the SourceIdentifier key. To reference Config managed rule identifiers, see About Config managed rules.

For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by Config for new rules.

If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.

The maximum number of rules that Config supports is 150.

For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.

For more information about developing and using Config rules, see Evaluating Amazon Web Services resource Configurations with Config in the Config Developer Guide.

Parameter Syntax

$result = $client->putConfigRule([
    'ConfigRule' => [ // REQUIRED
        'ConfigRuleArn' => '<string>',
        'ConfigRuleId' => '<string>',
        'ConfigRuleName' => '<string>',
        'ConfigRuleState' => 'ACTIVE|DELETING|DELETING_RESULTS|EVALUATING',
        'CreatedBy' => '<string>',
        'Description' => '<string>',
        'InputParameters' => '<string>',
        'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours',
        'Scope' => [
            'ComplianceResourceId' => '<string>',
            'ComplianceResourceTypes' => ['<string>', ...],
            'TagKey' => '<string>',
            'TagValue' => '<string>',
        ],
        'Source' => [ // REQUIRED
            'CustomPolicyDetails' => [
                'EnableDebugLogDelivery' => true || false,
                'PolicyRuntime' => '<string>', // REQUIRED
                'PolicyText' => '<string>', // REQUIRED
            ],
            'Owner' => 'CUSTOM_LAMBDA|AWS|CUSTOM_POLICY', // REQUIRED
            'SourceDetails' => [
                [
                    'EventSource' => 'aws.config',
                    'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours',
                    'MessageType' => 'ConfigurationItemChangeNotification|ConfigurationSnapshotDeliveryCompleted|ScheduledNotification|OversizedConfigurationItemChangeNotification',
                ],
                // ...
            ],
            'SourceIdentifier' => '<string>',
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ConfigRule
  • Required: Yes
  • Type: ConfigRule structure

The rule that you want to add to your account.

Tags
  • Type: Array of Tag structures

An array of tag object.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • MaxNumberOfConfigRulesExceededException:

    Failed to add the Config rule because the account already contains the maximum number of 150 rules. Consider deleting any deactivated rules before you add new rules.

  • ResourceInUseException:

    You see this exception in the following cases:

    • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

    • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

    • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

    • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

    • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

    • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

  • InsufficientPermissionsException:

    Indicates one of the following errors:

    • For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.

    • For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.

    • For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM GetRole action or create a service linked role.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions:

      • To call IAM GetRole action or create a service linked role.

      • To read Amazon S3 bucket.

  • NoAvailableConfigurationRecorderException:

    There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

PutConfigurationAggregator

$result = $client->putConfigurationAggregator([/* ... */]);
$promise = $client->putConfigurationAggregatorAsync([/* ... */]);

Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.

accountIds that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators to get the previous accounts and then append new ones.

Config should be enabled in source accounts and regions you want to aggregate.

If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls EnableAwsServiceAccess API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator.

To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.

Parameter Syntax

$result = $client->putConfigurationAggregator([
    'AccountAggregationSources' => [
        [
            'AccountIds' => ['<string>', ...], // REQUIRED
            'AllAwsRegions' => true || false,
            'AwsRegions' => ['<string>', ...],
        ],
        // ...
    ],
    'ConfigurationAggregatorName' => '<string>', // REQUIRED
    'OrganizationAggregationSource' => [
        'AllAwsRegions' => true || false,
        'AwsRegions' => ['<string>', ...],
        'RoleArn' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
AccountAggregationSources
  • Type: Array of AccountAggregationSource structures

A list of AccountAggregationSource object.

ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

OrganizationAggregationSource
  • Type: OrganizationAggregationSource structure

An OrganizationAggregationSource object.

Tags
  • Type: Array of Tag structures

An array of tag object.

Result Syntax

[
    'ConfigurationAggregator' => [
        'AccountAggregationSources' => [
            [
                'AccountIds' => ['<string>', ...],
                'AllAwsRegions' => true || false,
                'AwsRegions' => ['<string>', ...],
            ],
            // ...
        ],
        'ConfigurationAggregatorArn' => '<string>',
        'ConfigurationAggregatorName' => '<string>',
        'CreatedBy' => '<string>',
        'CreationTime' => <DateTime>,
        'LastUpdatedTime' => <DateTime>,
        'OrganizationAggregationSource' => [
            'AllAwsRegions' => true || false,
            'AwsRegions' => ['<string>', ...],
            'RoleArn' => '<string>',
        ],
    ],
]

Result Details

Members
ConfigurationAggregator
  • Type: ConfigurationAggregator structure

Returns a ConfigurationAggregator object.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • LimitExceededException:

    For StartConfigRulesEvaluation API, this exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.

    For PutConfigurationAggregator API, this exception is thrown if the number of accounts and aggregators exceeds the limit.

  • InvalidRoleException:

    You have provided a null or empty role ARN.

  • OrganizationAccessDeniedException:

    For PutConfigurationAggregator API, you can see this exception for the following reasons:

    • No permission to call EnableAWSServiceAccess API

    • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

    For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

  • NoAvailableOrganizationException:

    Organization is no longer available.

  • OrganizationAllFeaturesNotEnabledException:

    Config resource cannot be created because your organization does not have all features enabled.

PutConfigurationRecorder

$result = $client->putConfigurationRecorder([/* ... */]);
$promise = $client->putConfigurationRecorderAsync([/* ... */]);

Creates a new configuration recorder to record the selected resource configurations.

You can use this action to change the role roleARN or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.

Currently, you can specify only one configuration recorder per region in your account.

If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.

Parameter Syntax

$result = $client->putConfigurationRecorder([
    'ConfigurationRecorder' => [ // REQUIRED
        'name' => '<string>',
        'recordingGroup' => [
            'allSupported' => true || false,
            'includeGlobalResourceTypes' => true || false,
            'resourceTypes' => ['<string>', ...],
        ],
        'roleARN' => '<string>',
    ],
]);

Parameter Details

Members
ConfigurationRecorder
  • Required: Yes
  • Type: ConfigurationRecorder structure

The configuration recorder object that records each configuration change made to the resources.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • MaxNumberOfConfigurationRecordersExceededException:

    You have reached the limit of the number of recorders you can create.

  • InvalidConfigurationRecorderNameException:

    You have provided a configuration recorder name that is not valid.

  • InvalidRoleException:

    You have provided a null or empty role ARN.

  • InvalidRecordingGroupException:

    Config throws an exception if the recording group does not contain a valid list of resource types. Invalid values might also be incorrectly formatted.

PutConformancePack

$result = $client->putConformancePack([/* ... */]);
$promise = $client->putConformancePackAsync([/* ... */]);

Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across Amazon Web Services Organization.

This API creates a service linked role AWSServiceRoleForConfigConforms in your account. The service linked role is created only when the role does not exist in your account.

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

Parameter Syntax

$result = $client->putConformancePack([
    'ConformancePackInputParameters' => [
        [
            'ParameterName' => '<string>', // REQUIRED
            'ParameterValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ConformancePackName' => '<string>', // REQUIRED
    'DeliveryS3Bucket' => '<string>',
    'DeliveryS3KeyPrefix' => '<string>',
    'TemplateBody' => '<string>',
    'TemplateS3Uri' => '<string>',
]);

Parameter Details

Members
ConformancePackInputParameters
  • Type: Array of ConformancePackInputParameter structures

A list of ConformancePackInputParameter objects.

ConformancePackName
  • Required: Yes
  • Type: string

Name of the conformance pack you want to create.

DeliveryS3Bucket
  • Type: string

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

DeliveryS3KeyPrefix
  • Type: string

The prefix for the Amazon S3 bucket.

This field is optional.

TemplateBody
  • Type: string

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

You can only use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and a remediation action (AWS::Config::RemediationConfiguration).

TemplateS3Uri
  • Type: string

Location of file containing the template body (s3://bucketname/prefix). The uri must point to the conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same region as the conformance pack.

You must have access to read Amazon S3 bucket.

Result Syntax

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

Result Details

Members
ConformancePackArn
  • Type: string

ARN of the conformance pack.

Errors

  • InsufficientPermissionsException:

    Indicates one of the following errors:

    • For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.

    • For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.

    • For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM GetRole action or create a service linked role.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions:

      • To call IAM GetRole action or create a service linked role.

      • To read Amazon S3 bucket.

  • ConformancePackTemplateValidationException:

    You have specified a template that is not valid or supported.

  • ResourceInUseException:

    You see this exception in the following cases:

    • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

    • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

    • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

    • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

    • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

    • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • MaxNumberOfConformancePacksExceededException:

    You have reached the limit (6) of the number of conformance packs in an account (6 conformance pack with 25 Config rules per pack).

PutDeliveryChannel

$result = $client->putDeliveryChannel([/* ... */]);
$promise = $client->putDeliveryChannelAsync([/* ... */]);

Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.

Before you can create a delivery channel, you must create a configuration recorder.

You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.

You can have only one delivery channel per region in your account.

Parameter Syntax

$result = $client->putDeliveryChannel([
    'DeliveryChannel' => [ // REQUIRED
        'configSnapshotDeliveryProperties' => [
            'deliveryFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours',
        ],
        'name' => '<string>',
        's3BucketName' => '<string>',
        's3KeyPrefix' => '<string>',
        's3KmsKeyArn' => '<string>',
        'snsTopicARN' => '<string>',
    ],
]);

Parameter Details

Members
DeliveryChannel
  • Required: Yes
  • Type: DeliveryChannel structure

The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • MaxNumberOfDeliveryChannelsExceededException:

    You have reached the limit of the number of delivery channels you can create.

  • NoAvailableConfigurationRecorderException:

    There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

  • InvalidDeliveryChannelNameException:

    The specified delivery channel name is not valid.

  • NoSuchBucketException:

    The specified Amazon S3 bucket does not exist.

  • InvalidS3KeyPrefixException:

    The specified Amazon S3 key prefix is not valid.

  • InvalidS3KmsKeyArnException:

    The specified Amazon KMS Key ARN is not valid.

  • InvalidSNSTopicARNException:

    The specified Amazon SNS topic does not exist.

  • InsufficientDeliveryPolicyException:

    Your Amazon S3 bucket policy does not permit Config to write to it.

PutEvaluations

$result = $client->putEvaluations([/* ... */]);
$promise = $client->putEvaluationsAsync([/* ... */]);

Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule.

Parameter Syntax

$result = $client->putEvaluations([
    'Evaluations' => [
        [
            'Annotation' => '<string>',
            'ComplianceResourceId' => '<string>', // REQUIRED
            'ComplianceResourceType' => '<string>', // REQUIRED
            'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', // REQUIRED
            'OrderingTimestamp' => <integer || string || DateTime>, // REQUIRED
        ],
        // ...
    ],
    'ResultToken' => '<string>', // REQUIRED
    'TestMode' => true || false,
]);

Parameter Details

Members
Evaluations
  • Type: Array of Evaluation structures

The assessments that the Lambda function performs. Each evaluation identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that invokes the Lambda function.

ResultToken
  • Required: Yes
  • Type: string

An encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation.

TestMode
  • Type: boolean

Use this parameter to specify a test run for PutEvaluations. You can verify whether your Lambda function will deliver evaluation results to Config. No updates occur to your existing evaluations, and evaluation results are not sent to Config.

When TestMode is true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null.

Result Syntax

[
    'FailedEvaluations' => [
        [
            'Annotation' => '<string>',
            'ComplianceResourceId' => '<string>',
            'ComplianceResourceType' => '<string>',
            'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA',
            'OrderingTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
FailedEvaluations
  • Type: Array of Evaluation structures

Requests that failed because of a client or server error.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • InvalidResultTokenException:

    The specified ResultToken is invalid.

  • NoSuchConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

PutExternalEvaluation

$result = $client->putExternalEvaluation([/* ... */]);
$promise = $client->putExternalEvaluationAsync([/* ... */]);

Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the Config rule is provided.

Parameter Syntax

$result = $client->putExternalEvaluation([
    'ConfigRuleName' => '<string>', // REQUIRED
    'ExternalEvaluation' => [ // REQUIRED
        'Annotation' => '<string>',
        'ComplianceResourceId' => '<string>', // REQUIRED
        'ComplianceResourceType' => '<string>', // REQUIRED
        'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', // REQUIRED
        'OrderingTimestamp' => <integer || string || DateTime>, // REQUIRED
    ],
]);

Parameter Details

Members
ConfigRuleName
  • Required: Yes
  • Type: string

The name of the Config rule.

ExternalEvaluation
  • Required: Yes
  • Type: ExternalEvaluation structure

An ExternalEvaluation object that provides details about compliance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

PutOrganizationConfigRule

$result = $client->putOrganizationConfigRule([/* ... */]);
$promise = $client->putOrganizationConfigRuleAsync([/* ... */]);

Adds or updates organization Config rule for your entire organization evaluating whether your Amazon Web Services resources comply with your desired configurations.

Only a master account and a delegated administrator can create or update an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.

This API enables organization service access through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. Config verifies the existence of role with GetRole action.

To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegated-administrator for config-multiaccountsetup.amazonaws.com.

You can use this action to create both Config custom rules and Config managed rules. If you are adding a new Config custom rule, you must first create Lambda function in the master account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed-account that can be assumed by the Lambda function. When you use the PutOrganizationConfigRule action to add the rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. If you are adding an Config managed rule, specify the rule's identifier for the RuleIdentifier key.

The maximum number of organization Config rules that Config supports is 150 and 3 delegated administrator per organization.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

Specify either OrganizationCustomRuleMetadata or OrganizationManagedRuleMetadata.

Parameter Syntax

$result = $client->putOrganizationConfigRule([
    'ExcludedAccounts' => ['<string>', ...],
    'OrganizationConfigRuleName' => '<string>', // REQUIRED
    'OrganizationCustomPolicyRuleMetadata' => [
        'DebugLogDeliveryAccounts' => ['<string>', ...],
        'Description' => '<string>',
        'InputParameters' => '<string>',
        'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours',
        'OrganizationConfigRuleTriggerTypes' => ['<string>', ...],
        'PolicyRuntime' => '<string>', // REQUIRED
        'PolicyText' => '<string>', // REQUIRED
        'ResourceIdScope' => '<string>',
        'ResourceTypesScope' => ['<string>', ...],
        'TagKeyScope' => '<string>',
        'TagValueScope' => '<string>',
    ],
    'OrganizationCustomRuleMetadata' => [
        'Description' => '<string>',
        'InputParameters' => '<string>',
        'LambdaFunctionArn' => '<string>', // REQUIRED
        'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours',
        'OrganizationConfigRuleTriggerTypes' => ['<string>', ...], // REQUIRED
        'ResourceIdScope' => '<string>',
        'ResourceTypesScope' => ['<string>', ...],
        'TagKeyScope' => '<string>',
        'TagValueScope' => '<string>',
    ],
    'OrganizationManagedRuleMetadata' => [
        'Description' => '<string>',
        'InputParameters' => '<string>',
        'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours',
        'ResourceIdScope' => '<string>',
        'ResourceTypesScope' => ['<string>', ...],
        'RuleIdentifier' => '<string>', // REQUIRED
        'TagKeyScope' => '<string>',
        'TagValueScope' => '<string>',
    ],
]);

Parameter Details

Members
ExcludedAccounts
  • Type: Array of strings

A comma-separated list of accounts that you want to exclude from an organization Config rule.

OrganizationConfigRuleName
  • Required: Yes
  • Type: string

The name that you assign to an organization Config rule.

OrganizationCustomPolicyRuleMetadata
  • Type: OrganizationCustomPolicyRuleMetadata structure

An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

OrganizationCustomRuleMetadata
  • Type: OrganizationCustomRuleMetadata structure

An OrganizationCustomRuleMetadata object.

OrganizationManagedRuleMetadata
  • Type: OrganizationManagedRuleMetadata structure

An OrganizationManagedRuleMetadata object.

Result Syntax

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

Result Details

Members
OrganizationConfigRuleArn
  • Type: string

The Amazon Resource Name (ARN) of an organization Config rule.

Errors

  • MaxNumberOfOrganizationConfigRulesExceededException:

    You have reached the limit of the number of organization Config rules you can create.

  • ResourceInUseException:

    You see this exception in the following cases:

    • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

    • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

    • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

    • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

    • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

    • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • OrganizationAccessDeniedException:

    For PutConfigurationAggregator API, you can see this exception for the following reasons:

    • No permission to call EnableAWSServiceAccess API

    • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

    For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

  • NoAvailableOrganizationException:

    Organization is no longer available.

  • OrganizationAllFeaturesNotEnabledException:

    Config resource cannot be created because your organization does not have all features enabled.

  • InsufficientPermissionsException:

    Indicates one of the following errors:

    • For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.

    • For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.

    • For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM GetRole action or create a service linked role.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions:

      • To call IAM GetRole action or create a service linked role.

      • To read Amazon S3 bucket.

PutOrganizationConformancePack

$result = $client->putOrganizationConformancePack([/* ... */]);
$promise = $client->putOrganizationConformancePackAsync([/* ... */]);

Deploys conformance packs across member accounts in an Amazon Web Services Organization.

Only a master account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.

This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.

You can create 50 conformance packs with 25 Config rules in each pack and 3 delegated administrator per organization.

Parameter Syntax

$result = $client->putOrganizationConformancePack([
    'ConformancePackInputParameters' => [
        [
            'ParameterName' => '<string>', // REQUIRED
            'ParameterValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'DeliveryS3Bucket' => '<string>',
    'DeliveryS3KeyPrefix' => '<string>',
    'ExcludedAccounts' => ['<string>', ...],
    'OrganizationConformancePackName' => '<string>', // REQUIRED
    'TemplateBody' => '<string>',
    'TemplateS3Uri' => '<string>',
]);

Parameter Details

Members
ConformancePackInputParameters
  • Type: Array of ConformancePackInputParameter structures

A list of ConformancePackInputParameter objects.

DeliveryS3Bucket
  • Type: string

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional. If used, it must be prefixed with awsconfigconforms.

DeliveryS3KeyPrefix
  • Type: string

The prefix for the Amazon S3 bucket.

This field is optional.

ExcludedAccounts
  • Type: Array of strings

A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.

OrganizationConformancePackName
  • Required: Yes
  • Type: string

Name of the organization conformance pack you want to create.

TemplateBody
  • Type: string

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

TemplateS3Uri
  • Type: string

Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).

You must have access to read Amazon S3 bucket.

Result Syntax

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

Result Details

Members
OrganizationConformancePackArn
  • Type: string

ARN of the organization conformance pack.

Errors

  • MaxNumberOfOrganizationConformancePacksExceededException:

    You have reached the limit (6) of the number of organization conformance packs in an account (6 conformance pack with 25 Config rules per pack per account).

  • ResourceInUseException:

    You see this exception in the following cases:

    • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

    • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

    • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

    • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

    • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

    • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • OrganizationAccessDeniedException:

    For PutConfigurationAggregator API, you can see this exception for the following reasons:

    • No permission to call EnableAWSServiceAccess API

    • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

    • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

    For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

  • InsufficientPermissionsException:

    Indicates one of the following errors:

    • For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.

    • For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.

    • For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM GetRole action or create a service linked role.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions:

      • To call IAM GetRole action or create a service linked role.

      • To read Amazon S3 bucket.

  • OrganizationConformancePackTemplateValidationException:

    You have specified a template that is not valid or supported.

  • OrganizationAllFeaturesNotEnabledException:

    Config resource cannot be created because your organization does not have all features enabled.

  • NoAvailableOrganizationException:

    Organization is no longer available.

PutRemediationConfigurations

$result = $client->putRemediationConfigurations([/* ... */]);
$promise = $client->putRemediationConfigurationsAsync([/* ... */]);

Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.

If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.

This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.

Parameter Syntax

$result = $client->putRemediationConfigurations([
    'RemediationConfigurations' => [ // REQUIRED
        [
            'Arn' => '<string>',
            'Automatic' => true || false,
            'ConfigRuleName' => '<string>', // REQUIRED
            'CreatedByService' => '<string>',
            'ExecutionControls' => [
                'SsmControls' => [
                    'ConcurrentExecutionRatePercentage' => <integer>,
                    'ErrorPercentage' => <integer>,
                ],
            ],
            'MaximumAutomaticAttempts' => <integer>,
            'Parameters' => [
                '<StringWithCharLimit256>' => [
                    'ResourceValue' => [
                        'Value' => 'RESOURCE_ID', // REQUIRED
                    ],
                    'StaticValue' => [
                        'Values' => ['<string>', ...], // REQUIRED
                    ],
                ],
                // ...
            ],
            'ResourceType' => '<string>',
            'RetryAttemptSeconds' => <integer>,
            'TargetId' => '<string>', // REQUIRED
            'TargetType' => 'SSM_DOCUMENT', // REQUIRED
            'TargetVersion' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
RemediationConfigurations
  • Required: Yes
  • Type: Array of RemediationConfiguration structures

A list of remediation configuration objects.

Result Syntax

[
    'FailedBatches' => [
        [
            'FailedItems' => [
                [
                    'Arn' => '<string>',
                    'Automatic' => true || false,
                    'ConfigRuleName' => '<string>',
                    'CreatedByService' => '<string>',
                    'ExecutionControls' => [
                        'SsmControls' => [
                            'ConcurrentExecutionRatePercentage' => <integer>,
                            'ErrorPercentage' => <integer>,
                        ],
                    ],
                    'MaximumAutomaticAttempts' => <integer>,
                    'Parameters' => [
                        '<StringWithCharLimit256>' => [
                            'ResourceValue' => [
                                'Value' => 'RESOURCE_ID',
                            ],
                            'StaticValue' => [
                                'Values' => ['<string>', ...],
                            ],
                        ],
                        // ...
                    ],
                    'ResourceType' => '<string>',
                    'RetryAttemptSeconds' => <integer>,
                    'TargetId' => '<string>',
                    'TargetType' => 'SSM_DOCUMENT',
                    'TargetVersion' => '<string>',
                ],
                // ...
            ],
            'FailureMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
FailedBatches
  • Type: Array of FailedRemediationBatch structures

Returns a list of failed remediation batch objects.

Errors

  • InsufficientPermissionsException:

    Indicates one of the following errors:

    • For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.

    • For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.

    • For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM GetRole action or create a service linked role.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions:

      • To call IAM GetRole action or create a service linked role.

      • To read Amazon S3 bucket.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

PutRemediationExceptions

$result = $client->putRemediationExceptions([/* ... */]);
$promise = $client->putRemediationExceptionsAsync([/* ... */]);

A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specific resource with a specific Config rule.

Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

Parameter Syntax

$result = $client->putRemediationExceptions([
    'ConfigRuleName' => '<string>', // REQUIRED
    'ExpirationTime' => <integer || string || DateTime>,
    'Message' => '<string>',
    'ResourceKeys' => [ // REQUIRED
        [
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ConfigRuleName
  • Required: Yes
  • Type: string

The name of the Config rule for which you want to create remediation exception.

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

The exception is automatically deleted after the expiration date.

Message
  • Type: string

The message contains an explanation of the exception.

ResourceKeys
  • Required: Yes
  • Type: Array of RemediationExceptionResourceKey structures

An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.

Result Syntax

[
    'FailedBatches' => [
        [
            'FailedItems' => [
                [
                    'ConfigRuleName' => '<string>',
                    'ExpirationTime' => <DateTime>,
                    'Message' => '<string>',
                    'ResourceId' => '<string>',
                    'ResourceType' => '<string>',
                ],
                // ...
            ],
            'FailureMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
FailedBatches
  • Type: Array of FailedRemediationExceptionBatch structures

Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • InsufficientPermissionsException:

    Indicates one of the following errors:

    • For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.

    • For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.

    • For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM GetRole action or create a service linked role.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions:

      • To call IAM GetRole action or create a service linked role.

      • To read Amazon S3 bucket.

PutResourceConfig

$result = $client->putResourceConfig([/* ... */]);
$promise = $client->putResourceConfigAsync([/* ... */]);

Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.

The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.

When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.

Write-only schema properites are not recorded as part of the published configuration item.

Parameter Syntax

$result = $client->putResourceConfig([
    'Configuration' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
    'ResourceName' => '<string>',
    'ResourceType' => '<string>', // REQUIRED
    'SchemaVersionId' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
Configuration
  • Required: Yes
  • Type: string

The configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation.

The configuration JSON must not exceed 64 KB.

ResourceId
  • Required: Yes
  • Type: string

Unique identifier of the resource.

ResourceName
  • Type: string

Name of the resource.

ResourceType
  • Required: Yes
  • Type: string

The type of the resource. The custom resource type must be registered with CloudFormation.

You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.

SchemaVersionId
  • Required: Yes
  • Type: string

Version of the schema registered for the ResourceType in CloudFormation.

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

Tags associated with the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • InsufficientPermissionsException:

    Indicates one of the following errors:

    • For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.

    • For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.

    • For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM GetRole action or create a service linked role.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions:

      • To call IAM GetRole action or create a service linked role.

      • To read Amazon S3 bucket.

  • NoRunningConfigurationRecorderException:

    There is no configuration recorder running.

  • MaxActiveResourcesExceededException:

    You have reached the limit (100,000) of active custom resource types in your account. Delete unused resources using DeleteResourceConfig.

PutRetentionConfiguration

$result = $client->putRetentionConfiguration([/* ... */]);
$promise = $client->putRetentionConfigurationAsync([/* ... */]);

Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object.

Currently, Config supports only one retention configuration per region in your account.

Parameter Syntax

$result = $client->putRetentionConfiguration([
    'RetentionPeriodInDays' => <integer>, // REQUIRED
]);

Parameter Details

Members
RetentionPeriodInDays
  • Required: Yes
  • Type: int

Number of days Config stores your historical information.

Currently, only applicable to the configuration item history.

Result Syntax

[
    'RetentionConfiguration' => [
        'Name' => '<string>',
        'RetentionPeriodInDays' => <integer>,
    ],
]

Result Details

Members
RetentionConfiguration
  • Type: RetentionConfiguration structure

Returns a retention configuration object.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • MaxNumberOfRetentionConfigurationsExceededException:

    Failed to add the retention configuration because a retention configuration with that name already exists.

PutStoredQuery

$result = $client->putStoredQuery([/* ... */]);
$promise = $client->putStoredQueryAsync([/* ... */]);

Saves a new query or updates an existing saved query. The QueryName must be unique for a single Amazon Web Services account and a single Amazon Web Services Region. You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.

Parameter Syntax

$result = $client->putStoredQuery([
    'StoredQuery' => [ // REQUIRED
        'Description' => '<string>',
        'Expression' => '<string>',
        'QueryArn' => '<string>',
        'QueryId' => '<string>',
        'QueryName' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
StoredQuery
  • Required: Yes
  • Type: StoredQuery structure

A list of StoredQuery objects. The mandatory fields are QueryName and Expression.

When you are creating a query, you must provide a query name and an expression. When you are updating a query, you must provide a query name but updating the description is optional.

Tags
  • Type: Array of Tag structures

A list of Tags object.

Result Syntax

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

Result Details

Members
QueryArn
  • Type: string

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • TooManyTagsException:

    You have reached the limit of the number of tags you can use. You have more than 50 tags.

  • ResourceConcurrentModificationException:

    Two users are trying to modify the same query at the same time. Wait for a moment and try again.

SelectAggregateResourceConfig

$result = $client->selectAggregateResourceConfig([/* ... */]);
$promise = $client->selectAggregateResourceConfigAsync([/* ... */]);

Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.

For more information about query components, see the Query Components section in the Config Developer Guide.

If you run an aggregation query (i.e., using GROUP BY or using aggregate functions such as COUNT; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId) and do not specify the MaxResults or the Limit query parameters, the default page size is set to 500.

If you run a non-aggregation query (i.e., not using GROUP BY or aggregate function; e.g., SELECT * WHERE resourceType = 'AWS::IAM::Role') and do not specify the MaxResults or the Limit query parameters, the default page size is set to 25.

Parameter Syntax

$result = $client->selectAggregateResourceConfig([
    'ConfigurationAggregatorName' => '<string>', // REQUIRED
    'Expression' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConfigurationAggregatorName
  • Required: Yes
  • Type: string

The name of the configuration aggregator.

Expression
  • Required: Yes
  • Type: string

The SQL query SELECT command.

Limit
  • Type: int

The maximum number of query results returned on each page.

MaxResults
  • Type: int

The maximum number of query results returned on each page. Config also allows the Limit request parameter.

NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Result Syntax

[
    'NextToken' => '<string>',
    'QueryInfo' => [
        'SelectFields' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
    ],
    'Results' => ['<string>', ...],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

QueryInfo
  • Type: QueryInfo structure

Details about the query.

Results
  • Type: Array of strings

Returns the results for the SQL query.

Errors

  • InvalidExpressionException:

    The syntax of the query is incorrect.

  • NoSuchConfigurationAggregatorException:

    You have specified a configuration aggregator that does not exist.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

SelectResourceConfig

$result = $client->selectResourceConfig([/* ... */]);
$promise = $client->selectResourceConfigAsync([/* ... */]);

Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.

For more information about query components, see the Query Components section in the Config Developer Guide.

Parameter Syntax

$result = $client->selectResourceConfig([
    'Expression' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Expression
  • Required: Yes
  • Type: string

The SQL query SELECT command.

Limit
  • Type: int

The maximum number of query results returned on each page.

NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Result Syntax

[
    'NextToken' => '<string>',
    'QueryInfo' => [
        'SelectFields' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
    ],
    'Results' => ['<string>', ...],
]

Result Details

Members
NextToken
  • Type: string

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

QueryInfo
  • Type: QueryInfo structure

Returns the QueryInfo object.

Results
  • Type: Array of strings

Returns the results for the SQL query.

Errors

  • InvalidExpressionException:

    The syntax of the query is incorrect.

  • InvalidLimitException:

    The specified limit is outside the allowable range.

  • InvalidNextTokenException:

    The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

StartConfigRulesEvaluation

$result = $client->startConfigRulesEvaluation([/* ... */]);
$promise = $client->startConfigRulesEvaluationAsync([/* ... */]);

Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test that a rule you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources.

You can specify up to 25 Config rules per request.

An existing StartConfigRulesEvaluation call for the specified rules must complete before you can call the API again. If you chose to have Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.

You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, Config evaluates your resources against the rule automatically.

The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:

  1. You have a custom rule that evaluates your IAM resources every 24 hours.

  2. You update your Lambda function to add additional conditions to your rule.

  3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

  4. Config invokes your Lambda function and evaluates your IAM resources.

  5. Your custom rule will still run periodic evaluations every 24 hours.

Parameter Syntax

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

Parameter Details

Members
ConfigRuleNames
  • Type: Array of strings

The list of names of Config rules that you want to run evaluations for.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchConfigRuleException:

    The Config rule in the request is not valid. Verify that the rule is an Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

  • LimitExceededException:

    For StartConfigRulesEvaluation API, this exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.

    For PutConfigurationAggregator API, this exception is thrown if the number of accounts and aggregators exceeds the limit.

  • ResourceInUseException:

    You see this exception in the following cases:

    • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

    • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

    • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

    • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

    • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

    • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

StartConfigurationRecorder

$result = $client->startConfigurationRecorder([/* ... */]);
$promise = $client->startConfigurationRecorderAsync([/* ... */]);

Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

You must have created at least one delivery channel to successfully start the configuration recorder.

Parameter Syntax

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

Parameter Details

Members
ConfigurationRecorderName
  • Required: Yes
  • Type: string

The name of the recorder object that records each configuration change made to the resources.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchConfigurationRecorderException:

    You have specified a configuration recorder that does not exist.

  • NoAvailableDeliveryChannelException:

    There is no delivery channel available to record configurations.

StartRemediationExecution

$result = $client->startRemediationExecution([/* ... */]);
$promise = $client->startRemediationExecutionAsync([/* ... */]);

Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.

You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.

Parameter Syntax

$result = $client->startRemediationExecution([
    'ConfigRuleName' => '<string>', // REQUIRED
    'ResourceKeys' => [ // REQUIRED
        [
            'resourceId' => '<string>', // REQUIRED
            'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ConfigRuleName
  • Required: Yes
  • Type: string

The list of names of Config rules that you want to run remediation execution for.

ResourceKeys
  • Required: Yes
  • Type: Array of ResourceKey structures

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

Result Syntax

[
    'FailedItems' => [
        [
            'resourceId' => '<string>',
            'resourceType' => 'AWS::EC2::CustomerGateway|AWS::EC2::EIP|AWS::EC2::Host|AWS::EC2::Instance|AWS::EC2::InternetGateway|AWS::EC2::NetworkAcl|AWS::EC2::NetworkInterface|AWS::EC2::RouteTable|AWS::EC2::SecurityGroup|AWS::EC2::Subnet|AWS::CloudTrail::Trail|AWS::EC2::Volume|AWS::EC2::VPC|AWS::EC2::VPNConnection|AWS::EC2::VPNGateway|AWS::EC2::RegisteredHAInstance|AWS::EC2::NatGateway|AWS::EC2::EgressOnlyInternetGateway|AWS::EC2::VPCEndpoint|AWS::EC2::VPCEndpointService|AWS::EC2::FlowLog|AWS::EC2::VPCPeeringConnection|AWS::Elasticsearch::Domain|AWS::IAM::Group|AWS::IAM::Policy|AWS::IAM::Role|AWS::IAM::User|AWS::ElasticLoadBalancingV2::LoadBalancer|AWS::ACM::Certificate|AWS::RDS::DBInstance|AWS::RDS::DBSubnetGroup|AWS::RDS::DBSecurityGroup|AWS::RDS::DBSnapshot|AWS::RDS::DBCluster|AWS::RDS::DBClusterSnapshot|AWS::RDS::EventSubscription|AWS::S3::Bucket|AWS::S3::AccountPublicAccessBlock|AWS::Redshift::Cluster|AWS::Redshift::ClusterSnapshot|AWS::Redshift::ClusterParameterGroup|AWS::Redshift::ClusterSecurityGroup|AWS::Redshift::ClusterSubnetGroup|AWS::Redshift::EventSubscription|AWS::SSM::ManagedInstanceInventory|AWS::CloudWatch::Alarm|AWS::CloudFormation::Stack|AWS::ElasticLoadBalancing::LoadBalancer|AWS::AutoScaling::AutoScalingGroup|AWS::AutoScaling::LaunchConfiguration|AWS::AutoScaling::ScalingPolicy|AWS::AutoScaling::ScheduledAction|AWS::DynamoDB::Table|AWS::CodeBuild::Project|AWS::WAF::RateBasedRule|AWS::WAF::Rule|AWS::WAF::RuleGroup|AWS::WAF::WebACL|AWS::WAFRegional::RateBasedRule|AWS::WAFRegional::Rule|AWS::WAFRegional::RuleGroup|AWS::WAFRegional::WebACL|AWS::CloudFront::Distribution|AWS::CloudFront::StreamingDistribution|AWS::Lambda::Function|AWS::NetworkFirewall::Firewall|AWS::NetworkFirewall::FirewallPolicy|AWS::NetworkFirewall::RuleGroup|AWS::ElasticBeanstalk::Application|AWS::ElasticBeanstalk::ApplicationVersion|AWS::ElasticBeanstalk::Environment|AWS::WAFv2::WebACL|AWS::WAFv2::RuleGroup|AWS::WAFv2::IPSet|AWS::WAFv2::RegexPatternSet|AWS::WAFv2::ManagedRuleSet|AWS::XRay::EncryptionConfig|AWS::SSM::AssociationCompliance|AWS::SSM::PatchCompliance|AWS::Shield::Protection|AWS::ShieldRegional::Protection|AWS::Config::ConformancePackCompliance|AWS::Config::ResourceCompliance|AWS::ApiGateway::Stage|AWS::ApiGateway::RestApi|AWS::ApiGatewayV2::Stage|AWS::ApiGatewayV2::Api|AWS::CodePipeline::Pipeline|AWS::ServiceCatalog::CloudFormationProvisionedProduct|AWS::ServiceCatalog::CloudFormationProduct|AWS::ServiceCatalog::Portfolio|AWS::SQS::Queue|AWS::KMS::Key|AWS::QLDB::Ledger|AWS::SecretsManager::Secret|AWS::SNS::Topic|AWS::SSM::FileData|AWS::Backup::BackupPlan|AWS::Backup::BackupSelection|AWS::Backup::BackupVault|AWS::Backup::RecoveryPoint|AWS::ECR::Repository|AWS::ECS::Cluster|AWS::ECS::Service|AWS::ECS::TaskDefinition|AWS::EFS::AccessPoint|AWS::EFS::FileSystem|AWS::EKS::Cluster|AWS::OpenSearch::Domain|AWS::EC2::TransitGateway|AWS::Kinesis::Stream|AWS::Kinesis::StreamConsumer|AWS::CodeDeploy::Application|AWS::CodeDeploy::DeploymentConfig|AWS::CodeDeploy::DeploymentGroup|AWS::EC2::LaunchTemplate|AWS::ECR::PublicRepository|AWS::GuardDuty::Detector|AWS::EMR::SecurityConfiguration|AWS::SageMaker::CodeRepository',
        ],
        // ...
    ],
    'FailureMessage' => '<string>',
]

Result Details

Members
FailedItems
  • Type: Array of ResourceKey structures

For resources that have failed to start execution, the API returns a resource key object.

FailureMessage
  • Type: string

Returns a failure message. For example, the resource is already compliant.

Errors

  • InvalidParameterValueException:

    One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

  • InsufficientPermissionsException:

    Indicates one of the following errors:

    • For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.

    • For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.

    • For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM GetRole action or create a service linked role.

    • For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions:

      • To call IAM GetRole action or create a service linked role.

      • To read Amazon S3 bucket.

  • NoSuchRemediationConfigurationException:

    You specified an Config rule without a remediation configuration.

StopConfigurationRecorder

$result = $client->stopConfigurationRecorder([/* ... */]);
$promise = $client->stopConfigurationRecorderAsync([/* ... */]);

Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Members
ConfigurationRecorderName
  • Required: Yes
  • Type: string

The name of the recorder object that records each configuration change made to the resources.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NoSuchConfigurationRecorderException:

    You have specified a configuration recorder that does not exist.

TagResource

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

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

Tags
  • Required: Yes
  • Type: Array of Tag structures

An array of tag object.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • ResourceNotFoundException:

    You have specified a resource that does not exist.

  • TooManyTagsException:

    You have reached the limit of the number of tags you can use. You have more than 50 tags.

UntagResource

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

Deletes specified tags from a resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

TagKeys
  • Required: Yes
  • Type: Array of strings

The keys of the tags to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The requested action is not valid.

    For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

    For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

  • ResourceNotFoundException:

    You have specified a resource that does not exist.

Shapes

AccountAggregationSource

Description

A collection of accounts and regions.

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

The 12-digit account ID of the account being aggregated.

AllAwsRegions
  • Type: boolean

If true, aggregate existing Config regions and future regions.

AwsRegions
  • Type: Array of strings

The source regions being aggregated.

AggregateComplianceByConfigRule

Description

Indicates whether an Config rule is compliant based on account ID, region, compliance, and rule name.

A rule is compliant if all of the resources that the rule evaluated comply with it. It is noncompliant if any of these resources do not comply.

Members
AccountId
  • Type: string

The 12-digit account ID of the source account.

AwsRegion
  • Type: string

The source region from where the data is aggregated.

Compliance
  • Type: Compliance structure

Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

ConfigRuleName
  • Type: string

The name of the Config rule.

AggregateComplianceByConformancePack

Description

Provides aggregate compliance of the conformance pack. Indicates whether a conformance pack is compliant based on the name of the conformance pack, account ID, and region.

A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.

Members
AccountId
  • Type: string

The 12-digit Amazon Web Services account ID of the source account.

AwsRegion
  • Type: string

The source Amazon Web Services Region from where the data is aggregated.

Compliance
  • Type: AggregateConformancePackCompliance structure

The compliance status of the conformance pack.

ConformancePackName
  • Type: string

The name of the conformance pack.

AggregateComplianceCount

Description

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

Members
ComplianceSummary
  • Type: ComplianceSummary structure

The number of compliant and noncompliant Config rules.

GroupName
  • Type: string

The 12-digit account ID or region based on the GroupByKey value.

AggregateConformancePackCompliance

Description

Provides the number of compliant and noncompliant rules within a conformance pack. Also provides the compliance status of the conformance pack and the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.

Members
ComplianceType
  • Type: string

The compliance status of the conformance pack.

CompliantRuleCount
  • Type: int

The number of compliant Config Rules.

NonCompliantRuleCount
  • Type: int

The number of noncompliant Config Rules.

TotalRuleCount
  • Type: int

Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.

AggregateConformancePackComplianceCount

Description

The number of conformance packs that are compliant and noncompliant.

Members
CompliantConformancePackCount
  • Type: int

Number of compliant conformance packs.

NonCompliantConformancePackCount
  • Type: int

Number of noncompliant conformance packs.

AggregateConformancePackComplianceFilters

Description

Filters the conformance packs based on an account ID, region, compliance type, and the name of the conformance pack.

Members
AccountId
  • Type: string

The 12-digit Amazon Web Services account ID of the source account.

AwsRegion
  • Type: string

The source Amazon Web Services Region from where the data is aggregated.

ComplianceType
  • Type: string

The compliance status of the conformance pack.

ConformancePackName
  • Type: string

The name of the conformance pack.

AggregateConformancePackComplianceSummary

Description

Provides a summary of compliance based on either account ID or region.

Members
ComplianceSummary
  • Type: AggregateConformancePackComplianceCount structure

Returns an AggregateConformancePackComplianceCount object.

GroupName
  • Type: string

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

AggregateConformancePackComplianceSummaryFilters

Description

Filters the results based on account ID and region.

Members
AccountId
  • Type: string

The 12-digit Amazon Web Services account ID of the source account.

AwsRegion
  • Type: string

The source Amazon Web Services Region from where the data is aggregated.

AggregateEvaluationResult

Description

The details of an Config evaluation for an account ID and region in an aggregator. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

Members
AccountId
  • Type: string

The 12-digit account ID of the source account.

Annotation
  • Type: string

Supplementary information about how the agrregate evaluation determined the compliance.

AwsRegion
  • Type: string

The source region from where the data is aggregated.

ComplianceType
  • Type: string

The resource compliance status.

For the AggregationEvaluationResult data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.

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

The time when the Config rule evaluated the Amazon Web Services resource.

EvaluationResultIdentifier
  • Type: EvaluationResultIdentifier structure

Uniquely identifies the evaluation result.

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

The time when Config recorded the aggregate evaluation result.

AggregateResourceIdentifier

Description

The details that identify a resource that is collected by Config aggregator, including the resource type, ID, (if available) the custom resource name, the source account, and source region.

Members
ResourceId
  • Required: Yes
  • Type: string

The ID of the Amazon Web Services resource.

ResourceName
  • Type: string

The name of the Amazon Web Services resource.

ResourceType
  • Required: Yes
  • Type: string

The type of the Amazon Web Services resource.

SourceAccountId
  • Required: Yes
  • Type: string

The 12-digit account ID of the source account.

SourceRegion
  • Required: Yes
  • Type: string

The source region where data is aggregated.

AggregatedSourceStatus

Description

The current sync status between the source and the aggregator account.

Members
AwsRegion
  • Type: string

The region authorized to collect aggregated data.

LastErrorCode
  • Type: string

The error code that Config returned when the source account aggregation last failed.

LastErrorMessage
  • Type: string

The message indicating that the source account aggregation failed due to an error.

LastUpdateStatus
  • Type: string

Filters the last updated status type.

  • Valid value FAILED indicates errors while moving data.

  • Valid value SUCCEEDED indicates the data was successfully moved.

  • Valid value OUTDATED indicates the data is not the most recent.

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

The time of the last update.

SourceId
  • Type: string

The source account ID or an organization.

SourceType
  • Type: string

The source account or an organization.

AggregationAuthorization

Description

An object that represents the authorizations granted to aggregator accounts and regions.

Members
AggregationAuthorizationArn
  • Type: string

The Amazon Resource Name (ARN) of the aggregation object.

AuthorizedAccountId
  • Type: string

The 12-digit account ID of the account authorized to aggregate data.

AuthorizedAwsRegion
  • Type: string

The region authorized to collect aggregated data.

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

The time stamp when the aggregation authorization was created.

BaseConfigurationItem

Description

The detailed configuration of a specified resource.

Members
accountId
  • Type: string

The 12-digit Amazon Web Services account ID associated with the resource.

arn
  • Type: string

The Amazon Resource Name (ARN) of the resource.

availabilityZone
  • Type: string

The Availability Zone associated with the resource.

awsRegion
  • Type: string

The region where the resource resides.

configuration
  • Type: string

The description of the resource configuration.

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

The time when the configuration recording was initiated.

configurationItemStatus
  • Type: string

The configuration item status. The valid values are:

  • OK – The resource configuration has been updated

  • ResourceDiscovered – The resource was newly discovered

  • ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

  • ResourceDeleted – The resource was deleted

  • ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

The CIs do not incur any cost.

configurationStateId
  • Type: string

An identifier that indicates the ordering of the configuration items of a resource.

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

The time stamp when the resource was created.

resourceId
  • Type: string

The ID of the resource (for example., sg-xxxxxx).

resourceName
  • Type: string

The custom name of the resource, if available.

resourceType
  • Type: string

The type of Amazon Web Services resource.

supplementaryConfiguration
  • Type: Associative array of custom strings keys (SupplementaryConfigurationName) to strings

Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

version
  • Type: string

The version number of the resource configuration.

Compliance

Description

Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

Members
ComplianceContributorCount
  • Type: ComplianceContributorCount structure

The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

ComplianceType
  • Type: string

Indicates whether an Amazon Web Services resource or Config rule is compliant.

A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.

Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config rule.

For the Compliance data type, Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.

ComplianceByConfigRule

Description

Indicates whether an Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it. A rule is noncompliant if any of these resources do not comply.

Members
Compliance
  • Type: Compliance structure

Indicates whether the Config rule is compliant.

ConfigRuleName
  • Type: string

The name of the Config rule.

ComplianceByResource

Description

Indicates whether an Amazon Web Services resource that is evaluated according to one or more Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

Members
Compliance
  • Type: Compliance structure

Indicates whether the Amazon Web Services resource complies with all of the Config rules that evaluated it.

ResourceId
  • Type: string

The ID of the Amazon Web Services resource that was evaluated.

ResourceType
  • Type: string

The type of the Amazon Web Services resource that was evaluated.

ComplianceContributorCount

Description

The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item, up to a maximum number.

Members
CapExceeded
  • Type: boolean

Indicates whether the maximum count is reached.

CappedCount
  • Type: int

The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

ComplianceSummary

Description

The number of Config rules or Amazon Web Services resources that are compliant and noncompliant.

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

The time that Config created the compliance summary.

CompliantResourceCount
  • Type: ComplianceContributorCount structure

The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.

NonCompliantResourceCount
  • Type: ComplianceContributorCount structure

The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.

ComplianceSummaryByResourceType

Description

The number of Amazon Web Services resources of a specific type that are compliant or noncompliant, up to a maximum of 100 for each.

Members
ComplianceSummary
  • Type: ComplianceSummary structure

The number of Amazon Web Services resources that are compliant or noncompliant, up to a maximum of 100 for each.

ResourceType
  • Type: string

The type of Amazon Web Services resource.

ConfigExportDeliveryInfo

Description

Provides status of the delivery of the snapshot or the configuration history to the specified Amazon S3 bucket. Also provides the status of notifications about the Amazon S3 delivery to the specified Amazon SNS topic.

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

The time of the last attempted delivery.

lastErrorCode
  • Type: string

The error code from the last attempted delivery.

lastErrorMessage
  • Type: string

The error message from the last attempted delivery.

lastStatus
  • Type: string

Status of the last attempted delivery.

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

The time of the last successful delivery.

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

The time that the next delivery occurs.

ConfigRule

Description

An Config rule represents an Lambda function that you create for a custom rule or a predefined function for an Config managed rule. The function evaluates configuration items to assess whether your Amazon Web Services resources comply with your desired configurations. This function can run when Config detects a configuration change to an Amazon Web Services resource and at a periodic frequency that you choose (for example, every 24 hours).

You can use the Amazon Web Services CLI and Amazon Web Services SDKs if you want to create a rule that triggers evaluations for your resources when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

For more information about developing and using Config rules, see Evaluating Amazon Web Services resource Configurations with Config in the Config Developer Guide.

Members
ConfigRuleArn
  • Type: string

The Amazon Resource Name (ARN) of the Config rule.

ConfigRuleId
  • Type: string

The ID of the Config rule.

ConfigRuleName
  • Type: string

The name that you assign to the Config rule. The name is required if you are adding a new rule.

ConfigRuleState
  • Type: string

Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.

Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.

Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.

Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

CreatedBy
  • Type: string

Service principal name of the service that created the rule.

The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.

Description
  • Type: string

The description that you provide for the Config rule.

InputParameters
  • Type: string

A string, in JSON format, that is passed to the Config rule Lambda function.

MaximumExecutionFrequency
  • Type: string

The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:

  • You are using an Config managed rule that is triggered at a periodic frequency.

  • Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Scope
  • Type: Scope structure

Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.

The scope can be empty.

Source
  • Required: Yes
  • Type: Source structure

Provides the rule owner (Amazon Web Services or customer), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.

ConfigRuleComplianceFilters

Description

Filters the compliance results based on account ID, region, compliance type, and rule name.

Members
AccountId
  • Type: string

The 12-digit account ID of the source account.

AwsRegion
  • Type: string

The source region where the data is aggregated.

ComplianceType
  • Type: string

The rule compliance status.

For the ConfigRuleComplianceFilters data type, Config supports only COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and the INSUFFICIENT_DATA values.

ConfigRuleName
  • Type: string

The name of the Config rule.

ConfigRuleComplianceSummaryFilters

Description

Filters the results based on the account IDs and regions.

Members
AccountId
  • Type: string

The 12-digit account ID of the source account.

AwsRegion
  • Type: string

The source region where the data is aggregated.

ConfigRuleEvaluationStatus

Description

Status information for your Config Managed rules and Config Custom Policy rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.

This action does not return status information about Config Custom Lambda rules.

Members
ConfigRuleArn
  • Type: string

The Amazon Resource Name (ARN) of the Config rule.

ConfigRuleId
  • Type: string

The ID of the Config rule.

ConfigRuleName
  • Type: string

The name of the Config rule.

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

The time that you first activated the Config rule.

FirstEvaluationStarted
  • Type: boolean

Indicates whether Config has evaluated your resources against the rule at least once.

  • true - Config has evaluated your Amazon Web Services resources against the rule at least once.

  • false - Config has not finished evaluating your Amazon Web Services resources against the rule at least once.

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

The time that you last turned off the Config rule.

LastDebugLogDeliveryStatus
  • Type: string

The status of the last attempted delivery of a debug log for your Config Custom Policy rules. Either Successful or Failed.

LastDebugLogDeliveryStatusReason
  • Type: string

The reason Config was not able to deliver a debug log. This is for the last failed attempt to retrieve a debug log for your Config Custom Policy rules.

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

The time Config last attempted to deliver a debug log for your Config Custom Policy rules.

LastErrorCode
  • Type: string

The error code that Config returned when the rule last failed.

LastErrorMessage
  • Type: string

The error message that Config returned when the rule last failed.

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

The time that Config last failed to evaluate your Amazon Web Services resources against the rule.

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

The time that Config last failed to invoke the Config rule to evaluate your Amazon Web Services resources.

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

The time that Config last successfully evaluated your Amazon Web Services resources against the rule.

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

The time that Config last successfully invoked the Config rule to evaluate your Amazon Web Services resources.

ConfigSnapshotDeliveryProperties

Description

Provides options for how often Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.

The frequency for a rule that triggers evaluations for your resources when Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent:

  • The value for the deliveryFrequency parameter within the delivery channel configuration, which sets how often Config delivers configuration snapshots. This value also sets how often Config invokes evaluations for Config rules.

  • The value for the MaximumExecutionFrequency parameter, which sets the maximum frequency with which Config invokes evaluations for the rule. For more information, see ConfigRule.

If the deliveryFrequency value is less frequent than the MaximumExecutionFrequency value for a rule, Config invokes the rule only as often as the deliveryFrequency value.

  1. For example, you want your rule to run evaluations when Config delivers the configuration snapshot.

  2. You specify the MaximumExecutionFrequency value for Six_Hours.

  3. You then specify the delivery channel deliveryFrequency value for TwentyFour_Hours.

  4. Because the value for deliveryFrequency is less frequent than MaximumExecutionFrequency, Config invokes evaluations for the rule every 24 hours.

You should set the MaximumExecutionFrequency value to be at least as frequent as the deliveryFrequency value. You can view the deliveryFrequency value by using the DescribeDeliveryChannnels action.

To update the deliveryFrequency with which Config delivers your configuration snapshots, use the PutDeliveryChannel action.

Members
deliveryFrequency
  • Type: string

The frequency with which Config delivers configuration snapshots.

ConfigStreamDeliveryInfo

Description

A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.

Members
lastErrorCode
  • Type: string

The error code from the last attempted delivery.

lastErrorMessage
  • Type: string

The error message from the last attempted delivery.

lastStatus
  • Type: string

Status of the last attempted delivery.

Note Providing an SNS topic on a DeliveryChannel for Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable.

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

The time from the last status change.

ConfigurationAggregator

Description

The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.

Members
AccountAggregationSources
  • Type: Array of AccountAggregationSource structures

Provides a list of source accounts and regions to be aggregated.

ConfigurationAggregatorArn
  • Type: string

The Amazon Resource Name (ARN) of the aggregator.

ConfigurationAggregatorName
  • Type: string

The name of the aggregator.

CreatedBy
  • Type: string

Amazon Web Services service that created the configuration aggregator.

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

The time stamp when the configuration aggregator was created.

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

The time of the last update.

OrganizationAggregationSource
  • Type: OrganizationAggregationSource structure

Provides an organization and list of regions to be aggregated.

ConfigurationItem

Description

A list that contains detailed configurations of a specified resource.

Members
accountId
  • Type: string

The 12-digit Amazon Web Services account ID associated with the resource.

arn
  • Type: string

Amazon Resource Name (ARN) associated with the resource.

availabilityZone
  • Type: string

The Availability Zone associated with the resource.

awsRegion
  • Type: string

The region where the resource resides.

configuration
  • Type: string

The description of the resource configuration.

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

The time when the configuration recording was initiated.

configurationItemMD5Hash
  • Type: string

Unique MD5 hash that represents the configuration item's state.

You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.

configurationItemStatus
  • Type: string

The configuration item status. The valid values are:

  • OK – The resource configuration has been updated

  • ResourceDiscovered – The resource was newly discovered

  • ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

  • ResourceDeleted – The resource was deleted

  • ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

The CIs do not incur any cost.

configurationStateId
  • Type: string

An identifier that indicates the ordering of the configuration items of a resource.

relatedEvents
  • Type: Array of strings

A list of CloudTrail event IDs.

A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.

An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.

relationships
  • Type: Array of Relationship structures

A list of related Amazon Web Services resources.

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

The time stamp when the resource was created.

resourceId
  • Type: string

The ID of the resource (for example, sg-xxxxxx).

resourceName
  • Type: string

The custom name of the resource, if available.

resourceType
  • Type: string

The type of Amazon Web Services resource.

supplementaryConfiguration
  • Type: Associative array of custom strings keys (SupplementaryConfigurationName) to strings

Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

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

A mapping of key value tags associated with the resource.

version
  • Type: string

The version number of the resource configuration.

ConfigurationRecorder

Description

An object that represents the recording of configuration changes of an Amazon Web Services resource.

Members
name
  • Type: string

The name of the recorder. By default, Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.

recordingGroup
  • Type: RecordingGroup structure

Specifies the types of Amazon Web Services resources for which Config records configuration changes.

roleARN
  • Type: string

Amazon Resource Name (ARN) of the IAM role used to describe the Amazon Web Services resources associated with the account.

ConfigurationRecorderStatus

Description

The current status of the configuration recorder.

Members
lastErrorCode
  • Type: string

The error code indicating that the recording failed.

lastErrorMessage
  • Type: string

The message indicating that the recording failed due to an error.

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

The time the recorder was last started.

lastStatus
  • Type: string

The last (previous) status of the recorder.

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

The time when the status was last changed.

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

The time the recorder was last stopped.

name
  • Type: string

The name of the configuration recorder.

recording
  • Type: boolean

Specifies whether or not the recorder is currently recording.

ConformancePackComplianceFilters

Description

Filters the conformance pack by compliance types and Config rule names.

Members
ComplianceType
  • Type: string

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

ConfigRuleNames
  • Type: Array of strings

Filters the results by Config rule names.

ConformancePackComplianceSummary

Description

Summary includes the name and status of the conformance pack.

Members
ConformancePackComplianceStatus
  • Required: Yes
  • Type: string

The status of the conformance pack. The allowed values are COMPLIANT, NON_COMPLIANT and INSUFFICIENT_DATA.

ConformancePackName
  • Required: Yes
  • Type: string

The name of the conformance pack name.

ConformancePackDetail

Description

Returns details of a conformance pack. A conformance pack is a collection of Config rules and remediation actions that can be easily deployed in an account and a region.

Members
ConformancePackArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the conformance pack.

ConformancePackId
  • Required: Yes
  • Type: string

ID of the conformance pack.

ConformancePackInputParameters
  • Type: Array of ConformancePackInputParameter structures

A list of ConformancePackInputParameter objects.

ConformancePackName
  • Required: Yes
  • Type: string

Name of the conformance pack.

CreatedBy
  • Type: string

Amazon Web Services service that created the conformance pack.

DeliveryS3Bucket
  • Type: string

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

DeliveryS3KeyPrefix
  • Type: string

The prefix for the Amazon S3 bucket.

This field is optional.

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

Last time when conformation pack update was requested.

ConformancePackEvaluationFilters

Description

Filters a conformance pack by Config rule names, compliance types, Amazon Web Services resource types, and resource IDs.

Members
ComplianceType
  • Type: string

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

ConfigRuleNames
  • Type: Array of strings

Filters the results by Config rule names.

ResourceIds
  • Type: Array of strings

Filters the results by resource IDs.

This is valid only when you provide resource type. If there is no resource type, you will see an error.

ResourceType
  • Type: string

Filters the results by the resource type (for example, "AWS::EC2::Instance").

ConformancePackEvaluationResult

Description

The details of a conformance pack evaluation. Provides Config rule and Amazon Web Services resource type that was evaluated, the compliance of the conformance pack, related time stamps, and supplementary information.

Members
Annotation
  • Type: string

Supplementary information about how the evaluation determined the compliance.

ComplianceType
  • Required: Yes
  • Type: string

The compliance type. The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

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

The time when Config rule evaluated Amazon Web Services resource.

EvaluationResultIdentifier
  • Required: Yes
  • Type: EvaluationResultIdentifier structure

Uniquely identifies an evaluation result.

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

The time when Config recorded the evaluation result.

ConformancePackInputParameter

Description

Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.

Members
ParameterName
  • Required: Yes
  • Type: string

One part of a key-value pair.

ParameterValue
  • Required: Yes
  • Type: string

Another part of the key-value pair.

ConformancePackRuleCompliance

Description

Compliance information of one or more Config rules within a conformance pack. You can filter using Config rule names and compliance types.

Members
ComplianceType
  • Type: string

Compliance of the Config rule.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

ConfigRuleName
  • Type: string

Name of the Config rule.

Controls
  • Type: Array of strings

Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives. A control can align with a specific compliance regime or map to internal controls defined by an organization.

ConformancePackStatusDetail

Description

Status details of a conformance pack.

Members
ConformancePackArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of comformance pack.

ConformancePackId
  • Required: Yes
  • Type: string

ID of the conformance pack.

ConformancePackName
  • Required: Yes
  • Type: string

Name of the conformance pack.

ConformancePackState
  • Required: Yes
  • Type: string

Indicates deployment status of conformance pack.

Config sets the state of the conformance pack to:

  • CREATE_IN_PROGRESS when a conformance pack creation is in progress for an account.

  • CREATE_COMPLETE when a conformance pack has been successfully created in your account.

  • CREATE_FAILED when a conformance pack creation failed in your account.

  • DELETE_IN_PROGRESS when a conformance pack deletion is in progress.

  • DELETE_FAILED when a conformance pack deletion failed in your account.

ConformancePackStatusReason
  • Type: string

The reason of conformance pack creation failure.

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

Last time when conformation pack creation and update was successful.

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

Last time when conformation pack creation and update was requested.

StackArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of CloudFormation stack.

ConformancePackTemplateValidationException

Description

You have specified a template that is not valid or supported.

Members

CustomPolicyDetails

Description

Provides the runtime system, policy definition, and whether debug logging enabled. You can specify the following CustomPolicyDetails parameter values only for Config Custom Policy rules.

Members
EnableDebugLogDelivery
  • Type: boolean

The boolean expression for enabling debug logging for your Config Custom Policy rule. The default value is false.

PolicyRuntime
  • Required: Yes
  • Type: string

The runtime system for your Config Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

PolicyText
  • Required: Yes
  • Type: string

The policy definition containing the logic for your Config Custom Policy rule.

DeliveryChannel

Description

The channel through which Config delivers notifications and updated configuration states.

Members
configSnapshotDeliveryProperties
  • Type: ConfigSnapshotDeliveryProperties structure

The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

name
  • Type: string

The name of the delivery channel. By default, Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.

s3BucketName
  • Type: string

The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.

If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.

s3KeyPrefix
  • Type: string

The prefix for the specified Amazon S3 bucket.

s3KmsKeyArn
  • Type: string

The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.

snsTopicARN
  • Type: string

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.

If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.

DeliveryChannelStatus

Description

The status of a specified delivery channel.

Valid values: Success | Failure

Members
configHistoryDeliveryInfo
  • Type: ConfigExportDeliveryInfo structure

A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.

configSnapshotDeliveryInfo
  • Type: ConfigExportDeliveryInfo structure

A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.

configStreamDeliveryInfo
  • Type: ConfigStreamDeliveryInfo structure

A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.

name
  • Type: string

The name of the delivery channel.

Evaluation

Description

Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.

Members
Annotation
  • Type: string

Supplementary information about how the evaluation determined the compliance.

ComplianceResourceId
  • Required: Yes
  • Type: string

The ID of the Amazon Web Services resource that was evaluated.

ComplianceResourceType
  • Required: Yes
  • Type: string

The type of Amazon Web Services resource that was evaluated.

ComplianceType
  • Required: Yes
  • Type: string

Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

For the Evaluation data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.

Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.

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

The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

EvaluationResult

Description

The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

Members
Annotation
  • Type: string

Supplementary information about how the evaluation determined the compliance.

ComplianceType
  • Type: string

Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.

For the EvaluationResult data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

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

The time when the Config rule evaluated the Amazon Web Services resource.

EvaluationResultIdentifier
  • Type: EvaluationResultIdentifier structure

Uniquely identifies the evaluation result.

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

The time when Config recorded the evaluation result.

ResultToken
  • Type: string

An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.

EvaluationResultIdentifier

Description

Uniquely identifies an evaluation result.

Members
EvaluationResultQualifier
  • Type: EvaluationResultQualifier structure

Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.

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

The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.

EvaluationResultQualifier

Description

Identifies an Config rule that evaluated an Amazon Web Services resource, and provides the type and ID of the resource that the rule evaluated.

Members
ConfigRuleName
  • Type: string

The name of the Config rule that was used in the evaluation.

ResourceId
  • Type: string

The ID of the evaluated Amazon Web Services resource.

ResourceType
  • Type: string

The type of Amazon Web Services resource that was evaluated.

ExecutionControls

Description

The controls that Config uses for executing remediations.

Members
SsmControls
  • Type: SsmControls structure

A SsmControls object.

ExternalEvaluation

Description

Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.

Members
Annotation
  • Type: string

Supplementary information about the reason of compliance. For example, this task was completed on a specific date.

ComplianceResourceId
  • Required: Yes
  • Type: string

The evaluated compliance resource ID. Config accepts only Amazon Web Services account ID.

ComplianceResourceType
  • Required: Yes
  • Type: string

The evaluated compliance resource type. Config accepts AWS::::Account resource type.

ComplianceType
  • Required: Yes
  • Type: string

The compliance of the Amazon Web Services resource. The valid values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

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

The time when the compliance was recorded.

FailedDeleteRemediationExceptionsBatch

Description

List of each of the failed delete remediation exceptions with specific reasons.

Members
FailedItems
  • Type: Array of RemediationExceptionResourceKey structures

Returns remediation exception resource key object of the failed items.

FailureMessage
  • Type: string

Returns a failure message for delete remediation exception. For example, Config creates an exception due to an internal error.

FailedRemediationBatch

Description

List of each of the failed remediations with specific reasons.

Members
FailedItems
  • Type: Array of RemediationConfiguration structures

Returns remediation configurations of the failed items.

FailureMessage
  • Type: string

Returns a failure message. For example, the resource is already compliant.

FailedRemediationExceptionBatch

Description

List of each of the failed remediation exceptions with specific reasons.

Members
FailedItems
  • Type: Array of RemediationException structures

Returns remediation exception resource key object of the failed items.

FailureMessage
  • Type: string

Returns a failure message. For example, the auto-remediation has failed.

FieldInfo

Description

Details about the fields such as name of the field.

Members
Name
  • Type: string

Name of the field.

GroupedResourceCount

Description

The count of resources that are grouped by the group name.

Members
GroupName
  • Required: Yes
  • Type: string

The name of the group that can be region, account ID, or resource type. For example, region1, region2 if the region was chosen as GroupByKey.

ResourceCount
  • Required: Yes
  • Type: long (int|float)

The number of resources in the group.

InsufficientDeliveryPolicyException

Description

Your Amazon S3 bucket policy does not permit Config to write to it.

Members

InsufficientPermissionsException

Description

Indicates one of the following errors:

  • For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.

  • For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.

  • For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM GetRole action or create a service linked role.

  • For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions:

    • To call IAM GetRole action or create a service linked role.

    • To read Amazon S3 bucket.

Members

InvalidConfigurationRecorderNameException

Description

You have provided a configuration recorder name that is not valid.

Members

InvalidDeliveryChannelNameException

Description

The specified delivery channel name is not valid.

Members

InvalidExpressionException

Description

The syntax of the query is incorrect.

Members

InvalidLimitException

Description

The specified limit is outside the allowable range.

Members

InvalidNextTokenException

Description

The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

Members

InvalidParameterValueException

Description

One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

Members

InvalidRecordingGroupException

Description

Config throws an exception if the recording group does not contain a valid list of resource types. Invalid values might also be incorrectly formatted.

Members

InvalidResultTokenException

Description

The specified ResultToken is invalid.

Members

InvalidRoleException

Description

You have provided a null or empty role ARN.

Members

InvalidS3KeyPrefixException

Description

The specified Amazon S3 key prefix is not valid.

Members

InvalidS3KmsKeyArnException

Description

The specified Amazon KMS Key ARN is not valid.

Members

InvalidSNSTopicARNException

Description

The specified Amazon SNS topic does not exist.

Members

InvalidTimeRangeException

Description

The specified time range is not valid. The earlier time is not chronologically before the later time.

Members

LastDeliveryChannelDeleteFailedException

Description

You cannot delete the delivery channel you specified because the configuration recorder is running.

Members

LimitExceededException

Description

For StartConfigRulesEvaluation API, this exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.

For PutConfigurationAggregator API, this exception is thrown if the number of accounts and aggregators exceeds the limit.

Members

MaxActiveResourcesExceededException

Description

You have reached the limit (100,000) of active custom resource types in your account. Delete unused resources using DeleteResourceConfig.

Members

MaxNumberOfConfigRulesExceededException

Description

Failed to add the Config rule because the account already contains the maximum number of 150 rules. Consider deleting any deactivated rules before you add new rules.

Members

MaxNumberOfConfigurationRecordersExceededException

Description

You have reached the limit of the number of recorders you can create.

Members

MaxNumberOfConformancePacksExceededException

Description

You have reached the limit (6) of the number of conformance packs in an account (6 conformance pack with 25 Config rules per pack).

Members

MaxNumberOfDeliveryChannelsExceededException

Description

You have reached the limit of the number of delivery channels you can create.

Members

MaxNumberOfOrganizationConfigRulesExceededException

Description

You have reached the limit of the number of organization Config rules you can create.

Members

MaxNumberOfOrganizationConformancePacksExceededException

Description

You have reached the limit (6) of the number of organization conformance packs in an account (6 conformance pack with 25 Config rules per pack per account).

Members

MaxNumberOfRetentionConfigurationsExceededException

Description

Failed to add the retention configuration because a retention configuration with that name already exists.

Members

MemberAccountStatus

Description

Organization Config rule creation or deletion status in each member account. This includes the name of the rule, the status, error code and error message when the rule creation or deletion failed.

Members
AccountId
  • Required: Yes
  • Type: string

The 12-digit account ID of a member account.

ConfigRuleName
  • Required: Yes
  • Type: string

The name of Config rule deployed in the member account.

ErrorCode
  • Type: string

An error code that is returned when Config rule creation or deletion failed in the member account.

ErrorMessage
  • Type: string

An error message indicating that Config rule account creation or deletion has failed due to an error in the member account.

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

The timestamp of the last status update.

MemberAccountRuleStatus
  • Required: Yes
  • Type: string

Indicates deployment status for Config rule in the member account. When master account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When master account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the master account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when Config rule has been created in the member account.

  • CREATE_IN_PROGRESS when Config rule is being created in the member account.

  • CREATE_FAILED when Config rule creation has failed in the member account.

  • DELETE_FAILED when Config rule deletion has failed in the member account.

  • DELETE_IN_PROGRESS when Config rule is being deleted in the member account.

  • DELETE_SUCCESSFUL when Config rule has been deleted in the member account.

  • UPDATE_SUCCESSFUL when Config rule has been updated in the member account.

  • UPDATE_IN_PROGRESS when Config rule is being updated in the member account.

  • UPDATE_FAILED when Config rule deletion has failed in the member account.

NoAvailableConfigurationRecorderException

Description

There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

Members

NoAvailableDeliveryChannelException

Description

There is no delivery channel available to record configurations.

Members

NoAvailableOrganizationException

Description

Organization is no longer available.

Members

NoRunningConfigurationRecorderException

Description

There is no configuration recorder running.

Members

NoSuchBucketException

Description

The specified Amazon S3 bucket does not exist.

Members

NoSuchConfigRuleException

Description

The Config rule in the request is not valid. Verify that the rule is an Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

Members

NoSuchConfigRuleInConformancePackException

Description

Config rule that you passed in the filter does not exist.

Members

NoSuchConfigurationAggregatorException

Description

You have specified a configuration aggregator that does not exist.

Members

NoSuchConfigurationRecorderException

Description

You have specified a configuration recorder that does not exist.

Members

NoSuchConformancePackException

Description

You specified one or more conformance packs that do not exist.

Members

NoSuchDeliveryChannelException

Description

You have specified a delivery channel that does not exist.

Members

NoSuchOrganizationConfigRuleException

Description

The Config rule in the request is not valid. Verify that the rule is an organization Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

Members

NoSuchOrganizationConformancePackException

Description

Config organization conformance pack that you passed in the filter does not exist.

For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.

Members

NoSuchRemediationConfigurationException

Description

You specified an Config rule without a remediation configuration.

Members

NoSuchRemediationExceptionException

Description

You tried to delete a remediation exception that does not exist.

Members

NoSuchRetentionConfigurationException

Description

You have specified a retention configuration that does not exist.

Members

OrganizationAccessDeniedException

Description

For PutConfigurationAggregator API, you can see this exception for the following reasons:

  • No permission to call EnableAWSServiceAccess API

  • The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

  • The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.

  • You are not a registered delegated administrator for Config with permissions to call ListDelegatedAdministrators API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.

For all OrganizationConfigRule and OrganizationConformancePack APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

Members

OrganizationAggregationSource

Description

This object contains regions to set up the aggregator and an IAM role to retrieve organization details.

Members
AllAwsRegions
  • Type: boolean

If true, aggregate existing Config regions and future regions.

AwsRegions
  • Type: Array of strings

The source regions being aggregated.

RoleArn
  • Required: Yes
  • Type: string

ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.

OrganizationAllFeaturesNotEnabledException

Description

Config resource cannot be created because your organization does not have all features enabled.

Members

OrganizationConfigRule

Description

An organization Config rule that has information about Config rules that Config creates in member accounts.

Members
ExcludedAccounts
  • Type: Array of strings

A comma-separated list of accounts excluded from organization Config rule.

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

The timestamp of the last update.

OrganizationConfigRuleArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of organization Config rule.

OrganizationConfigRuleName
  • Required: Yes
  • Type: string

The name that you assign to organization Config rule.

OrganizationCustomPolicyRuleMetadata
  • Type: OrganizationCustomPolicyRuleMetadataNoPolicy structure

An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

OrganizationCustomRuleMetadata
  • Type: OrganizationCustomRuleMetadata structure

An OrganizationCustomRuleMetadata object.

OrganizationManagedRuleMetadata
  • Type: OrganizationManagedRuleMetadata structure

An OrganizationManagedRuleMetadata object.

OrganizationConfigRuleStatus

Description

Returns the status for an organization Config rule in an organization.

Members
ErrorCode
  • Type: string

An error code that is returned when organization Config rule creation or deletion has failed.

ErrorMessage
  • Type: string

An error message indicating that organization Config rule creation or deletion failed due to an error.

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

The timestamp of the last update.

OrganizationConfigRuleName
  • Required: Yes
  • Type: string

The name that you assign to organization Config rule.

OrganizationRuleStatus
  • Required: Yes
  • Type: string

Indicates deployment status of an organization Config rule. When master account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When master account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the master account deletes OrganizationConfigRule in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when an organization Config rule has been successfully created in all the member accounts.

  • CREATE_IN_PROGRESS when an organization Config rule creation is in progress.

  • CREATE_FAILED when an organization Config rule creation failed in one or more member accounts within that organization.

  • DELETE_FAILED when an organization Config rule deletion failed in one or more member accounts within that organization.

  • DELETE_IN_PROGRESS when an organization Config rule deletion is in progress.

  • DELETE_SUCCESSFUL when an organization Config rule has been successfully deleted from all the member accounts.

  • UPDATE_SUCCESSFUL when an organization Config rule has been successfully updated in all the member accounts.

  • UPDATE_IN_PROGRESS when an organization Config rule update is in progress.

  • UPDATE_FAILED when an organization Config rule update failed in one or more member accounts within that organization.

OrganizationConformancePack

Description

An organization conformance pack that has information about conformance packs that Config creates in member accounts.

Members
ConformancePackInputParameters
  • Type: Array of ConformancePackInputParameter structures

A list of ConformancePackInputParameter objects.

DeliveryS3Bucket
  • Type: string

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

DeliveryS3KeyPrefix
  • Type: string

Any folder structure you want to add to an Amazon S3 bucket.

This field is optional.

ExcludedAccounts
  • Type: Array of strings

A comma-separated list of accounts excluded from organization conformance pack.

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

Last time when organization conformation pack was updated.

OrganizationConformancePackArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of organization conformance pack.

OrganizationConformancePackName
  • Required: Yes
  • Type: string

The name you assign to an organization conformance pack.

OrganizationConformancePackDetailedStatus

Description

Organization conformance pack creation or deletion status in each member account. This includes the name of the conformance pack, the status, error code and error message when the conformance pack creation or deletion failed.

Members
AccountId
  • Required: Yes
  • Type: string

The 12-digit account ID of a member account.

ConformancePackName
  • Required: Yes
  • Type: string

The name of conformance pack deployed in the member account.

ErrorCode
  • Type: string

An error code that is returned when conformance pack creation or deletion failed in the member account.

ErrorMessage
  • Type: string

An error message indicating that conformance pack account creation or deletion has failed due to an error in the member account.

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

The timestamp of the last status update.

Status
  • Required: Yes
  • Type: string

Indicates deployment status for conformance pack in a member account. When master account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When master account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the master account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

  • CREATE_SUCCESSFUL when conformance pack has been created in the member account.

  • CREATE_IN_PROGRESS when conformance pack is being created in the member account.

  • CREATE_FAILED when conformance pack creation has failed in the member account.

  • DELETE_FAILED when conformance pack deletion has failed in the member account.

  • DELETE_IN_PROGRESS when conformance pack is being deleted in the member account.

  • DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.

  • UPDATE_SUCCESSFUL when conformance pack has been updated in the member account.

  • UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.

  • UPDATE_FAILED when conformance pack deletion has failed in the member account.

OrganizationConformancePackStatus

Description

Returns the status for an organization conformance pack in an organization.

Members
ErrorCode
  • Type: string

An error code that is returned when organization conformance pack creation or deletion has failed in a member account.

ErrorMessage
  • Type: string

An error message indicating that organization conformance pack creation or deletion failed due to an error.

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

The timestamp of the last update.

OrganizationConformancePackName
  • Required: Yes
  • Type: string

The name that you assign to organization conformance pack.

Status
  • Required: Yes
  • Type: string

Indicates deployment status of an organization conformance pack. When master account calls PutOrganizationConformancePack for the first time, conformance pack status is created in all the member accounts. When master account calls PutOrganizationConformancePack for the second time, conformance pack status is updated in all the member accounts. Additionally, conformance pack status is updated when one or more member accounts join or leave an organization. Conformance pack status is deleted when the master account deletes OrganizationConformancePack in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

  • CREATE_SUCCESSFUL when an organization conformance pack has been successfully created in all the member accounts.

  • CREATE_IN_PROGRESS when an organization conformance pack creation is in progress.

  • CREATE_FAILED when an organization conformance pack creation failed in one or more member accounts within that organization.

  • DELETE_FAILED when an organization conformance pack deletion failed in one or more member accounts within that organization.

  • DELETE_IN_PROGRESS when an organization conformance pack deletion is in progress.

  • DELETE_SUCCESSFUL when an organization conformance pack has been successfully deleted from all the member accounts.

  • UPDATE_SUCCESSFUL when an organization conformance pack has been successfully updated in all the member accounts.

  • UPDATE_IN_PROGRESS when an organization conformance pack update is in progress.

  • UPDATE_FAILED when an organization conformance pack update failed in one or more member accounts within that organization.

OrganizationConformancePackTemplateValidationException

Description

You have specified a template that is not valid or supported.

Members

OrganizationCustomPolicyRuleMetadata

Description

An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

Members
DebugLogDeliveryAccounts
  • Type: Array of strings

A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

Description
  • Type: string

The description that you provide for your organization Config Custom Policy rule.

InputParameters
  • Type: string

A string, in JSON format, that is passed to your organization Config Custom Policy rule.

MaximumExecutionFrequency
  • Type: string

The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

OrganizationConfigRuleTriggerTypes
  • Type: Array of strings

The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

  • ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

PolicyRuntime
  • Required: Yes
  • Type: string

The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

PolicyText
  • Required: Yes
  • Type: string

The policy definition containing the logic for your organization Config Custom Policy rule.

ResourceIdScope
  • Type: string

The ID of the Amazon Web Services resource that was evaluated.

ResourceTypesScope
  • Type: Array of strings

The type of the Amazon Web Services resource that was evaluated.

TagKeyScope
  • Type: string

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

TagValueScope
  • Type: string

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

OrganizationCustomPolicyRuleMetadataNoPolicy

Description

An object that specifies metadata for your organization Config Custom Policy rule including the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that trigger Config to evaluate Amazon Web Services resources against a rule.

Members
DebugLogDeliveryAccounts
  • Type: Array of strings

A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

Description
  • Type: string

The description that you provide for your organization Config Custom Policy rule.

InputParameters
  • Type: string

A string, in JSON format, that is passed to your organization Config Custom Policy rule.

MaximumExecutionFrequency
  • Type: string

The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

OrganizationConfigRuleTriggerTypes
  • Type: Array of strings

The type of notification that triggers Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change triggered notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

PolicyRuntime
  • Type: string

The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

ResourceIdScope
  • Type: string

The ID of the Amazon Web Services resource that was evaluated.

ResourceTypesScope
  • Type: Array of strings

The type of the Amazon Web Services resource that was evaluated.

TagKeyScope
  • Type: string

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

TagValueScope
  • Type: string

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

OrganizationCustomRuleMetadata

Description

An object that specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

Members
Description
  • Type: string

The description that you provide for your organization Config rule.

InputParameters
  • Type: string

A string, in JSON format, that is passed to your organization Config rule Lambda function.

LambdaFunctionArn
  • Required: Yes
  • Type: string

The lambda function ARN.

MaximumExecutionFrequency
  • Type: string

The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

OrganizationConfigRuleTriggerTypes
  • Required: Yes
  • Type: Array of strings

The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

  • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

ResourceIdScope
  • Type: string

The ID of the Amazon Web Services resource that was evaluated.

ResourceTypesScope
  • Type: Array of strings

The type of the Amazon Web Services resource that was evaluated.

TagKeyScope
  • Type: string

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

TagValueScope
  • Type: string

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

OrganizationManagedRuleMetadata

Description

An object that specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

Members
Description
  • Type: string

The description that you provide for your organization Config rule.

InputParameters
  • Type: string

A string, in JSON format, that is passed to your organization Config rule Lambda function.

MaximumExecutionFrequency
  • Type: string

The maximum frequency with which Config runs evaluations for a rule. You are using an Config managed rule that is triggered at a periodic frequency.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

ResourceIdScope
  • Type: string

The ID of the Amazon Web Services resource that was evaluated.

ResourceTypesScope
  • Type: Array of strings

The type of the Amazon Web Services resource that was evaluated.

RuleIdentifier
  • Required: Yes
  • Type: string

For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

TagKeyScope
  • Type: string

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

TagValueScope
  • Type: string

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

OrganizationResourceDetailedStatusFilters

Description

Status filter object to filter results based on specific member account ID or status type for an organization conformance pack.

Members
AccountId
  • Type: string

The 12-digit account ID of the member account within an organization.

Status
  • Type: string

Indicates deployment status for conformance pack in a member account. When master account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When master account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the master account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

  • CREATE_SUCCESSFUL when conformance pack has been created in the member account.

  • CREATE_IN_PROGRESS when conformance pack is being created in the member account.

  • CREATE_FAILED when conformance pack creation has failed in the member account.

  • DELETE_FAILED when conformance pack deletion has failed in the member account.

  • DELETE_IN_PROGRESS when conformance pack is being deleted in the member account.

  • DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.

  • UPDATE_SUCCESSFUL when conformance pack has been updated in the member account.

  • UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.

  • UPDATE_FAILED when conformance pack deletion has failed in the member account.

OversizedConfigurationItemException

Description

The configuration item size is outside the allowable range.

Members

PendingAggregationRequest

Description

An object that represents the account ID and region of an aggregator account that is requesting authorization but is not yet authorized.

Members
RequesterAccountId
  • Type: string

The 12-digit account ID of the account requesting to aggregate data.

RequesterAwsRegion
  • Type: string

The region requesting to aggregate data.

QueryInfo

Description

Details about the query.

Members
SelectFields
  • Type: Array of FieldInfo structures

Returns a FieldInfo object.

RecordingGroup

Description

Specifies the types of Amazon Web Services resource for which Config records configuration changes.

In the recording group, you specify whether all supported types or specific types of resources are recorded.

By default, Config records configuration changes for all supported types of regional resources that Config discovers in the region in which it is running. Regional resources are tied to a region and can be used only in that region. Examples of regional resources are EC2 instances and EBS volumes.

You can also have Config record configuration changes for supported types of global resources (for example, IAM resources). Global resources are not tied to an individual region and can be used in all regions.

The configuration details for any global resource are the same in all regions. If you customize Config in multiple regions to record global resources, it will create multiple configuration items each time a global resource changes: one configuration item for each region. These configuration items will contain identical data. To prevent duplicate configuration items, you should consider customizing Config in only one region to record global resources, unless you want the configuration items to be available in multiple regions.

If you don't want Config to record all resources, you can specify which types of resources it will record with the resourceTypes parameter.

For a list of supported resource types, see Supported Resource Types.

For more information, see Selecting Which Resources Config Records.

Members
allSupported
  • Type: boolean

Specifies whether Config records configuration changes for every supported type of regional resource.

If you set this option to true, when Config adds support for a new type of regional resource, it starts recording resources of that type automatically.

If you set this option to true, you cannot enumerate a list of resourceTypes.

includeGlobalResourceTypes
  • Type: boolean

Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

Before you can set this option to true, you must set the allSupported option to true.

If you set this option to true, when Config adds support for a new type of global resource, it starts recording resources of that type automatically.

The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing Config in only one region to record global resources.

resourceTypes
  • Type: Array of strings

A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

To record all configuration changes, you must set the allSupported option to true.

If you set this option to false, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

For a list of valid resourceTypes values, see the resourceType Value column in Supported Amazon Web Services resource Types.

Relationship

Description

The relationship of the related resource to the main resource.

Members
relationshipName
  • Type: string

The type of relationship with the related resource.

resourceId
  • Type: string

The ID of the related resource (for example, sg-xxxxxx).

resourceName
  • Type: string

The custom name of the related resource, if available.

resourceType
  • Type: string

The resource type of the related resource.

RemediationConfiguration

Description

An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.

Members
Arn
  • Type: string

Amazon Resource Name (ARN) of remediation configuration.

Automatic
  • Type: boolean

The remediation is triggered automatically.

ConfigRuleName
  • Required: Yes
  • Type: string

The name of the Config rule.

CreatedByService
  • Type: string

Name of the service that owns the service linked rule, if applicable.

ExecutionControls
  • Type: ExecutionControls structure

An ExecutionControls object.

MaximumAutomaticAttempts
  • Type: int

The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.

For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

Parameters
  • Type: Associative array of custom strings keys (StringWithCharLimit256) to RemediationParameterValue structures

An object of the RemediationParameterValue.

ResourceType
  • Type: string

The type of a resource.

RetryAttemptSeconds
  • Type: long (int|float)

Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds.

For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

TargetId
  • Required: Yes
  • Type: string

Target ID is the name of the public document.

TargetType
  • Required: Yes
  • Type: string

The type of the target. Target executes remediation. For example, SSM document.

TargetVersion
  • Type: string

Version of the target. For example, version of the SSM document.

If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.

RemediationException

Description

An object that represents the details about the remediation exception. The details include the rule name, an explanation of an exception, the time when the exception will be deleted, the resource ID, and resource type.

Members
ConfigRuleName
  • Required: Yes
  • Type: string

The name of the Config rule.

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

The time when the remediation exception will be deleted.

Message
  • Type: string

An explanation of an remediation exception.

ResourceId
  • Required: Yes
  • Type: string

The ID of the resource (for example., sg-xxxxxx).

ResourceType
  • Required: Yes
  • Type: string

The type of a resource.

RemediationExceptionResourceKey

Description

The details that identify a resource within Config, including the resource type and resource ID.

Members
ResourceId
  • Type: string

The ID of the resource (for example., sg-xxxxxx).

ResourceType
  • Type: string

The type of a resource.

RemediationExecutionStatus

Description

Provides details of the current status of the invoked remediation action for that resource.

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

Start time when the remediation was executed.

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

The time when the remediation execution was last updated.

ResourceKey
  • Type: ResourceKey structure

The details that identify a resource within Config, including the resource type and resource ID.

State
  • Type: string

ENUM of the values.

StepDetails
  • Type: Array of RemediationExecutionStep structures

Details of every step.

RemediationExecutionStep

Description

Name of the step from the SSM document.

Members
ErrorMessage
  • Type: string

An error message if the step was interrupted during execution.

Name
  • Type: string

The details of the step.

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

The time when the step started.

State
  • Type: string

The valid status of the step.

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

The time when the step stopped.

RemediationInProgressException

Description

Remediation action is in progress. You can either cancel execution in Amazon Web Services Systems Manager or wait and try again later.

Members

RemediationParameterValue

Description

The value is either a dynamic (resource) value or a static value. You must select either a dynamic value or a static value.

Members
ResourceValue
  • Type: ResourceValue structure

The value is dynamic and changes at run-time.

StaticValue
  • Type: StaticValue structure

The value is static and does not change at run-time.

ResourceConcurrentModificationException

Description

Two users are trying to modify the same query at the same time. Wait for a moment and try again.

Members
message
  • Type: string

ResourceCount

Description

An object that contains the resource type and the number of resources.

Members
count
  • Type: long (int|float)

The number of resources.

resourceType
  • Type: string

The resource type (for example, "AWS::EC2::Instance").

ResourceCountFilters

Description

Filters the resource count based on account ID, region, and resource type.

Members
AccountId
  • Type: string

The 12-digit ID of the account.

Region
  • Type: string

The region where the account is located.

ResourceType
  • Type: string

The type of the Amazon Web Services resource.

ResourceFilters

Description

Filters the results by resource account ID, region, resource ID, and resource name.

Members
AccountId
  • Type: string

The 12-digit source account ID.

Region
  • Type: string

The source region.

ResourceId
  • Type: string

The ID of the resource.

ResourceName
  • Type: string

The name of the resource.

ResourceIdentifier

Description

The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.

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

The time that the resource was deleted.

resourceId
  • Type: string

The ID of the resource (for example, sg-xxxxxx).

resourceName
  • Type: string

The custom name of the resource (if available).

resourceType
  • Type: string

The type of resource.

ResourceInUseException

Description

You see this exception in the following cases:

  • For DeleteConfigRule, Config is deleting this rule. Try your request again later.

  • For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.

  • For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

  • For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.

  • For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.

  • For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

  • For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

Members

ResourceKey

Description

The details that identify a resource within Config, including the resource type and resource ID.

Members
resourceId
  • Required: Yes
  • Type: string

The ID of the resource (for example., sg-xxxxxx).

resourceType
  • Required: Yes
  • Type: string

The resource type.

ResourceNotDiscoveredException

Description

You have specified a resource that is either unknown or has not been discovered.

Members

ResourceNotFoundException

Description

You have specified a resource that does not exist.

Members

ResourceValue

Description

The dynamic value of the resource.

Members
Value
  • Required: Yes
  • Type: string

The value is a resource ID.

RetentionConfiguration

Description

An object with the name of the retention configuration and the retention period in days. The object stores the configuration for data retention in Config.

Members
Name
  • Required: Yes
  • Type: string

The name of the retention configuration object.

RetentionPeriodInDays
  • Required: Yes
  • Type: int

Number of days Config stores your historical information.

Currently, only applicable to the configuration item history.

Scope

Description

Defines which resources trigger an evaluation for an Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

Members
ComplianceResourceId
  • Type: string

The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

ComplianceResourceTypes
  • Type: Array of strings

The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

TagKey
  • Type: string

The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.

TagValue
  • Type: string

The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

Source

Description

Provides the CustomPolicyDetails, the rule owner (Amazon Web Services or customer), the rule identifier, and the events that cause the evaluation of your Amazon Web Services resources.

Members
CustomPolicyDetails
  • Type: CustomPolicyDetails structure

Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to CUSTOM_POLICY.

Owner
  • Required: Yes
  • Type: string

Indicates whether Amazon Web Services or the customer owns and manages the Config rule.

Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see Config Managed Rules in the Config developer guide.

Config Custom Rules are rules that you can develop either with Guard (CUSTOM_POLICY) or Lambda (CUSTOM_LAMBDA). For more information, see Config Custom Rules in the Config developer guide.

SourceDetails
  • Type: Array of SourceDetail structures

Provides the source and the message types that cause Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

If the owner is set to CUSTOM_POLICY, the only acceptable values for the Config rule trigger message type are ConfigurationItemChangeNotification and OversizedConfigurationItemChangeNotification.

SourceIdentifier
  • Type: string

For Config Managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see List of Config Managed Rules.

For Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name.

For Config Custom Policy rules, this field will be ignored.

SourceDetail

Description

Provides the source and the message types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules.

Members
EventSource
  • Type: string

The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.

MaximumExecutionFrequency
  • Type: string

The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you choose Three_Hours, Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.

MessageType
  • Type: string

The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

  • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

  • ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers a configuration snapshot.

If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification.

SsmControls

Description

Amazon Web Services Systems Manager (SSM) specific remediation controls.

Members
ConcurrentExecutionRatePercentage
  • Type: int

The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.

ErrorPercentage
  • Type: int

The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.

StaticValue

Description

The static value of the resource.

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

A list of values. For example, the ARN of the assumed role.

StatusDetailFilters

Description

Status filter object to filter results based on specific member account ID or status type for an organization Config rule.

Members
AccountId
  • Type: string

The 12-digit account ID of the member account within an organization.

MemberAccountRuleStatus
  • Type: string

Indicates deployment status for Config rule in the member account. When master account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When master account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the master account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when Config rule has been created in the member account.

  • CREATE_IN_PROGRESS when Config rule is being created in the member account.

  • CREATE_FAILED when Config rule creation has failed in the member account.

  • DELETE_FAILED when Config rule deletion has failed in the member account.

  • DELETE_IN_PROGRESS when Config rule is being deleted in the member account.

  • DELETE_SUCCESSFUL when Config rule has been deleted in the member account.

  • UPDATE_SUCCESSFUL when Config rule has been updated in the member account.

  • UPDATE_IN_PROGRESS when Config rule is being updated in the member account.

  • UPDATE_FAILED when Config rule deletion has failed in the member account.

StoredQuery

Description

Provides the details of a stored query.

Members
Description
  • Type: string

A unique description for the query.

Expression
  • Type: string

The expression of the query. For example, SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = 'AWS::S3::Bucket' AND supplementaryConfiguration.BucketVersioningConfiguration.status = 'Off'.

QueryArn
  • Type: string

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

QueryId
  • Type: string

The ID of the query.

QueryName
  • Required: Yes
  • Type: string

The name of the query.

StoredQueryMetadata

Description

Returns details of a specific query.

Members
Description
  • Type: string

A unique description for the query.

QueryArn
  • Required: Yes
  • Type: string

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

QueryId
  • Required: Yes
  • Type: string

The ID of the query.

QueryName
  • Required: Yes
  • Type: string

The name of the query.

Tag

Description

The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Members
Key
  • Type: string

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

Value
  • Type: string

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

TooManyTagsException

Description

You have reached the limit of the number of tags you can use. You have more than 50 tags.

Members

ValidationException

Description

The requested action is not valid.

For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

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