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

Namespaces

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

Classes

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

Interfaces

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

Traits

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

Exceptions

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

Functions

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

Schemas 2019-12-02

Client: Aws\Schemas\SchemasClient
Service ID: schemas
Version: 2019-12-02

This page describes the parameters and results for the operations of the Schemas (2019-12-02), and shows how to use the Aws\Schemas\SchemasClient object to call the described operations. This documentation is specific to the 2019-12-02 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 */).

  • CreateDiscoverer ( array $params = [] )

    Creates a discoverer.

  • CreateRegistry ( array $params = [] )

    Creates a registry.

  • CreateSchema ( array $params = [] )

    Creates a schema definition.

  • DeleteDiscoverer ( array $params = [] )

    Deletes a discoverer.

  • DeleteRegistry ( array $params = [] )

    Deletes a Registry.

  • DeleteResourcePolicy ( array $params = [] )

    Delete the resource-based policy attached to the specified registry.

  • DeleteSchema ( array $params = [] )

    Delete a schema definition.

  • DeleteSchemaVersion ( array $params = [] )

    Delete the schema version definition

  • DescribeCodeBinding ( array $params = [] )

    Describe the code binding URI.

  • DescribeDiscoverer ( array $params = [] )

    Describes the discoverer.

  • DescribeRegistry ( array $params = [] )

    Describes the registry.

  • DescribeSchema ( array $params = [] )

    Retrieve the schema definition.

  • ExportSchema ( array $params = [] )

    Exports a schema to a different specification.

  • GetCodeBindingSource ( array $params = [] )

    Get the code binding source URI.

  • GetDiscoveredSchema ( array $params = [] )

    Get the discovered schema that was generated based on sampled events.

  • GetResourcePolicy ( array $params = [] )

    Retrieves the resource-based policy attached to a given registry.

  • ListDiscoverers ( array $params = [] )

    List the discoverers.

  • ListRegistries ( array $params = [] )

    List the registries.

  • ListSchemaVersions ( array $params = [] )

    Provides a list of the schema versions and related information.

  • ListSchemas ( array $params = [] )

    List the schemas.

  • ListTagsForResource ( array $params = [] )

    Get tags for resource.

  • PutCodeBinding ( array $params = [] )

    Put code binding URI

  • PutResourcePolicy ( array $params = [] )

    The name of the policy.

  • SearchSchemas ( array $params = [] )

    Search the schemas

  • StartDiscoverer ( array $params = [] )

    Starts the discoverer

  • StopDiscoverer ( array $params = [] )

    Stops the discoverer

  • TagResource ( array $params = [] )

    Add tags to a resource.

  • UntagResource ( array $params = [] )

    Removes tags from a resource.

  • UpdateDiscoverer ( array $params = [] )

    Updates the discoverer

  • UpdateRegistry ( array $params = [] )

    Updates a registry.

  • UpdateSchema ( array $params = [] )

    Updates the schema definition Inactive schemas will be deleted after two years.

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:

  • ListDiscoverers
  • ListRegistries
  • ListSchemaVersions
  • ListSchemas
  • SearchSchemas

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
CodeBindingExists DescribeCodeBinding 2 30

Operations

CreateDiscoverer

$result = $client->createDiscoverer([/* ... */]);
$promise = $client->createDiscovererAsync([/* ... */]);

Creates a discoverer.

Parameter Syntax

$result = $client->createDiscoverer([
    'CrossAccount' => true || false,
    'Description' => '<string>',
    'SourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
CrossAccount
  • Type: boolean
Description
  • Type: string
SourceArn
  • Required: Yes
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

Result Syntax

[
    'CrossAccount' => true || false,
    'Description' => '<string>',
    'DiscovererArn' => '<string>',
    'DiscovererId' => '<string>',
    'SourceArn' => '<string>',
    'State' => 'STARTED|STOPPED',
    'Tags' => ['<string>', ...],
]

Result Details

Members
CrossAccount
  • Type: boolean
Description
  • Type: string
DiscovererArn
  • Type: string
DiscovererId
  • Type: string
SourceArn
  • Type: string
State
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

Errors

  • BadRequestException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

  • ConflictException:

    This error does not currently have a description.

CreateRegistry

$result = $client->createRegistry([/* ... */]);
$promise = $client->createRegistryAsync([/* ... */]);

Creates a registry.

Parameter Syntax

$result = $client->createRegistry([
    'Description' => '<string>',
    'RegistryName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
Description
  • Type: string
RegistryName
  • Required: Yes
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

Result Syntax

[
    'Description' => '<string>',
    'RegistryArn' => '<string>',
    'RegistryName' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
Description
  • Type: string
RegistryArn
  • Type: string
RegistryName
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

Errors

  • BadRequestException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

  • ConflictException:

    This error does not currently have a description.

CreateSchema

$result = $client->createSchema([/* ... */]);
$promise = $client->createSchemaAsync([/* ... */]);

Creates a schema definition.

Inactive schemas will be deleted after two years.

Parameter Syntax

$result = $client->createSchema([
    'Content' => '<string>', // REQUIRED
    'Description' => '<string>',
    'RegistryName' => '<string>', // REQUIRED
    'SchemaName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'Type' => 'OpenApi3', // REQUIRED
]);

Parameter Details

Members
Content
  • Required: Yes
  • Type: string
Description
  • Type: string
RegistryName
  • Required: Yes
  • Type: string
SchemaName
  • Required: Yes
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

Type
  • Required: Yes
  • Type: string

Result Syntax

[
    'Description' => '<string>',
    'LastModified' => <DateTime>,
    'SchemaArn' => '<string>',
    'SchemaName' => '<string>',
    'SchemaVersion' => '<string>',
    'Tags' => ['<string>', ...],
    'Type' => '<string>',
    'VersionCreatedDate' => <DateTime>,
]

Result Details

Members
Description
  • Type: string
LastModified
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
SchemaArn
  • Type: string
SchemaName
  • Type: string
SchemaVersion
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

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

Errors

  • ServiceUnavailableException:

    This error does not currently have a description.

  • BadRequestException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

DeleteDiscoverer

$result = $client->deleteDiscoverer([/* ... */]);
$promise = $client->deleteDiscovererAsync([/* ... */]);

Deletes a discoverer.

Parameter Syntax

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

Parameter Details

Members
DiscovererId
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

DeleteRegistry

$result = $client->deleteRegistry([/* ... */]);
$promise = $client->deleteRegistryAsync([/* ... */]);

Deletes a Registry.

Parameter Syntax

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

Parameter Details

Members
RegistryName
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Delete the resource-based policy attached to the specified registry.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'RegistryName' => '<string>',
]);

Parameter Details

Members
RegistryName
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

DeleteSchema

$result = $client->deleteSchema([/* ... */]);
$promise = $client->deleteSchemaAsync([/* ... */]);

Delete a schema definition.

Parameter Syntax

$result = $client->deleteSchema([
    'RegistryName' => '<string>', // REQUIRED
    'SchemaName' => '<string>', // REQUIRED
]);

Parameter Details

Members
RegistryName
  • Required: Yes
  • Type: string
SchemaName
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

DeleteSchemaVersion

$result = $client->deleteSchemaVersion([/* ... */]);
$promise = $client->deleteSchemaVersionAsync([/* ... */]);

Delete the schema version definition

Parameter Syntax

$result = $client->deleteSchemaVersion([
    'RegistryName' => '<string>', // REQUIRED
    'SchemaName' => '<string>', // REQUIRED
    'SchemaVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members
RegistryName
  • Required: Yes
  • Type: string
SchemaName
  • Required: Yes
  • Type: string
SchemaVersion
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

DescribeCodeBinding

$result = $client->describeCodeBinding([/* ... */]);
$promise = $client->describeCodeBindingAsync([/* ... */]);

Describe the code binding URI.

Parameter Syntax

$result = $client->describeCodeBinding([
    'Language' => '<string>', // REQUIRED
    'RegistryName' => '<string>', // REQUIRED
    'SchemaName' => '<string>', // REQUIRED
    'SchemaVersion' => '<string>',
]);

Parameter Details

Members
Language
  • Required: Yes
  • Type: string
RegistryName
  • Required: Yes
  • Type: string
SchemaName
  • Required: Yes
  • Type: string
SchemaVersion
  • Type: string

Result Syntax

[
    'CreationDate' => <DateTime>,
    'LastModified' => <DateTime>,
    'SchemaVersion' => '<string>',
    'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED',
]

Result Details

Members
CreationDate
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
LastModified
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
SchemaVersion
  • Type: string
Status
  • Type: string

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • TooManyRequestsException:

    This error does not currently have a description.

DescribeDiscoverer

$result = $client->describeDiscoverer([/* ... */]);
$promise = $client->describeDiscovererAsync([/* ... */]);

Describes the discoverer.

Parameter Syntax

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

Parameter Details

Members
DiscovererId
  • Required: Yes
  • Type: string

Result Syntax

[
    'CrossAccount' => true || false,
    'Description' => '<string>',
    'DiscovererArn' => '<string>',
    'DiscovererId' => '<string>',
    'SourceArn' => '<string>',
    'State' => 'STARTED|STOPPED',
    'Tags' => ['<string>', ...],
]

Result Details

Members
CrossAccount
  • Type: boolean
Description
  • Type: string
DiscovererArn
  • Type: string
DiscovererId
  • Type: string
SourceArn
  • Type: string
State
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

DescribeRegistry

$result = $client->describeRegistry([/* ... */]);
$promise = $client->describeRegistryAsync([/* ... */]);

Describes the registry.

Parameter Syntax

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

Parameter Details

Members
RegistryName
  • Required: Yes
  • Type: string

Result Syntax

[
    'Description' => '<string>',
    'RegistryArn' => '<string>',
    'RegistryName' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
Description
  • Type: string
RegistryArn
  • Type: string
RegistryName
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

DescribeSchema

$result = $client->describeSchema([/* ... */]);
$promise = $client->describeSchemaAsync([/* ... */]);

Retrieve the schema definition.

Parameter Syntax

$result = $client->describeSchema([
    'RegistryName' => '<string>', // REQUIRED
    'SchemaName' => '<string>', // REQUIRED
    'SchemaVersion' => '<string>',
]);

Parameter Details

Members
RegistryName
  • Required: Yes
  • Type: string
SchemaName
  • Required: Yes
  • Type: string
SchemaVersion
  • Type: string

Result Syntax

[
    'Content' => '<string>',
    'Description' => '<string>',
    'LastModified' => <DateTime>,
    'SchemaArn' => '<string>',
    'SchemaName' => '<string>',
    'SchemaVersion' => '<string>',
    'Tags' => ['<string>', ...],
    'Type' => '<string>',
    'VersionCreatedDate' => <DateTime>,
]

Result Details

Members
Content
  • Type: string
Description
  • Type: string
LastModified
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
SchemaArn
  • Type: string
SchemaName
  • Type: string
SchemaVersion
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

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

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

ExportSchema

$result = $client->exportSchema([/* ... */]);
$promise = $client->exportSchemaAsync([/* ... */]);

Exports a schema to a different specification.

Parameter Syntax

$result = $client->exportSchema([
    'RegistryName' => '<string>', // REQUIRED
    'SchemaName' => '<string>', // REQUIRED
    'SchemaVersion' => '<string>',
    'Type' => '<string>', // REQUIRED
]);

Parameter Details

Members
RegistryName
  • Required: Yes
  • Type: string
SchemaName
  • Required: Yes
  • Type: string
SchemaVersion
  • Type: string
Type
  • Required: Yes
  • Type: string

Result Syntax

[
    'Content' => '<string>',
    'SchemaArn' => '<string>',
    'SchemaName' => '<string>',
    'SchemaVersion' => '<string>',
    'Type' => '<string>',
]

Result Details

Members
Content
  • Type: string
SchemaArn
  • Type: string
SchemaName
  • Type: string
SchemaVersion
  • Type: string
Type
  • Type: string

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

  • TooManyRequestsException:

    This error does not currently have a description.

GetCodeBindingSource

$result = $client->getCodeBindingSource([/* ... */]);
$promise = $client->getCodeBindingSourceAsync([/* ... */]);

Get the code binding source URI.

Parameter Syntax

$result = $client->getCodeBindingSource([
    'Language' => '<string>', // REQUIRED
    'RegistryName' => '<string>', // REQUIRED
    'SchemaName' => '<string>', // REQUIRED
    'SchemaVersion' => '<string>',
]);

Parameter Details

Members
Language
  • Required: Yes
  • Type: string
RegistryName
  • Required: Yes
  • Type: string
SchemaName
  • Required: Yes
  • Type: string
SchemaVersion
  • Type: string

Result Syntax

[
    'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members
Body
  • Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • TooManyRequestsException:

    This error does not currently have a description.

GetDiscoveredSchema

$result = $client->getDiscoveredSchema([/* ... */]);
$promise = $client->getDiscoveredSchemaAsync([/* ... */]);

Get the discovered schema that was generated based on sampled events.

Parameter Syntax

$result = $client->getDiscoveredSchema([
    'Events' => ['<string>', ...], // REQUIRED
    'Type' => 'OpenApi3', // REQUIRED
]);

Parameter Details

Members
Events
  • Required: Yes
  • Type: Array of strings
Type
  • Required: Yes
  • Type: string

Result Syntax

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

Result Details

Members
Content
  • Type: string

Errors

  • ServiceUnavailableException:

    This error does not currently have a description.

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Retrieves the resource-based policy attached to a given registry.

Parameter Syntax

$result = $client->getResourcePolicy([
    'RegistryName' => '<string>',
]);

Parameter Details

Members
RegistryName
  • Type: string

Result Syntax

[
    'Policy' => '<string>',
    'RevisionId' => '<string>',
]

Result Details

Members
Policy
  • Type: string (string|number|array|map or anything parsable by json_encode)
RevisionId
  • Type: string

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

ListDiscoverers

$result = $client->listDiscoverers([/* ... */]);
$promise = $client->listDiscoverersAsync([/* ... */]);

List the discoverers.

Parameter Syntax

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

Parameter Details

Members
DiscovererIdPrefix
  • Type: string
Limit
  • Type: int
NextToken
  • Type: string
SourceArnPrefix
  • Type: string

Result Syntax

[
    'Discoverers' => [
        [
            'CrossAccount' => true || false,
            'DiscovererArn' => '<string>',
            'DiscovererId' => '<string>',
            'SourceArn' => '<string>',
            'State' => 'STARTED|STOPPED',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Discoverers
  • Type: Array of DiscovererSummary structures
NextToken
  • Type: string

Errors

  • ServiceUnavailableException:

    This error does not currently have a description.

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

ListRegistries

$result = $client->listRegistries([/* ... */]);
$promise = $client->listRegistriesAsync([/* ... */]);

List the registries.

Parameter Syntax

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

Parameter Details

Members
Limit
  • Type: int
NextToken
  • Type: string
RegistryNamePrefix
  • Type: string
Scope
  • Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Registries' => [
        [
            'RegistryArn' => '<string>',
            'RegistryName' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string
Registries
  • Type: Array of RegistrySummary structures

Errors

  • ServiceUnavailableException:

    This error does not currently have a description.

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

ListSchemaVersions

$result = $client->listSchemaVersions([/* ... */]);
$promise = $client->listSchemaVersionsAsync([/* ... */]);

Provides a list of the schema versions and related information.

Parameter Syntax

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

Parameter Details

Members
Limit
  • Type: int
NextToken
  • Type: string
RegistryName
  • Required: Yes
  • Type: string
SchemaName
  • Required: Yes
  • Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'SchemaVersions' => [
        [
            'SchemaArn' => '<string>',
            'SchemaName' => '<string>',
            'SchemaVersion' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string
SchemaVersions
  • Type: Array of SchemaVersionSummary structures

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

ListSchemas

$result = $client->listSchemas([/* ... */]);
$promise = $client->listSchemasAsync([/* ... */]);

List the schemas.

Parameter Syntax

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

Parameter Details

Members
Limit
  • Type: int
NextToken
  • Type: string
RegistryName
  • Required: Yes
  • Type: string
SchemaNamePrefix
  • Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Schemas' => [
        [
            'LastModified' => <DateTime>,
            'SchemaArn' => '<string>',
            'SchemaName' => '<string>',
            'Tags' => ['<string>', ...],
            'VersionCount' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string
Schemas
  • Type: Array of SchemaSummary structures

Errors

  • ServiceUnavailableException:

    This error does not currently have a description.

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

ListTagsForResource

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

Get tags for resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

Result Syntax

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

Result Details

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

Key-value pairs associated with a resource.

Errors

  • NotFoundException:

    This error does not currently have a description.

  • BadRequestException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

PutCodeBinding

$result = $client->putCodeBinding([/* ... */]);
$promise = $client->putCodeBindingAsync([/* ... */]);

Put code binding URI

Parameter Syntax

$result = $client->putCodeBinding([
    'Language' => '<string>', // REQUIRED
    'RegistryName' => '<string>', // REQUIRED
    'SchemaName' => '<string>', // REQUIRED
    'SchemaVersion' => '<string>',
]);

Parameter Details

Members
Language
  • Required: Yes
  • Type: string
RegistryName
  • Required: Yes
  • Type: string
SchemaName
  • Required: Yes
  • Type: string
SchemaVersion
  • Type: string

Result Syntax

[
    'CreationDate' => <DateTime>,
    'LastModified' => <DateTime>,
    'SchemaVersion' => '<string>',
    'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED',
]

Result Details

Members
CreationDate
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
LastModified
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
SchemaVersion
  • Type: string
Status
  • Type: string

Errors

  • GoneException:

    This error does not currently have a description.

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • TooManyRequestsException:

    This error does not currently have a description.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

The name of the policy.

Parameter Syntax

$result = $client->putResourcePolicy([
    'Policy' => '<string>', // REQUIRED
    'RegistryName' => '<string>',
    'RevisionId' => '<string>',
]);

Parameter Details

Members
Policy
  • Required: Yes
  • Type: string (string|number|array|map or anything parsable by json_encode)
RegistryName
  • Type: string
RevisionId
  • Type: string

Result Syntax

[
    'Policy' => '<string>',
    'RevisionId' => '<string>',
]

Result Details

Members
Policy
  • Type: string (string|number|array|map or anything parsable by json_encode)
RevisionId
  • Type: string

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • PreconditionFailedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

SearchSchemas

$result = $client->searchSchemas([/* ... */]);
$promise = $client->searchSchemasAsync([/* ... */]);

Search the schemas

Parameter Syntax

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

Parameter Details

Members
Keywords
  • Required: Yes
  • Type: string
Limit
  • Type: int
NextToken
  • Type: string
RegistryName
  • Required: Yes
  • Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Schemas' => [
        [
            'RegistryName' => '<string>',
            'SchemaArn' => '<string>',
            'SchemaName' => '<string>',
            'SchemaVersions' => [
                [
                    'CreatedDate' => <DateTime>,
                    'SchemaVersion' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string
Schemas
  • Type: Array of SearchSchemaSummary structures

Errors

  • ServiceUnavailableException:

    This error does not currently have a description.

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

StartDiscoverer

$result = $client->startDiscoverer([/* ... */]);
$promise = $client->startDiscovererAsync([/* ... */]);

Starts the discoverer

Parameter Syntax

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

Parameter Details

Members
DiscovererId
  • Required: Yes
  • Type: string

Result Syntax

[
    'DiscovererId' => '<string>',
    'State' => 'STARTED|STOPPED',
]

Result Details

Members
DiscovererId
  • Type: string
State
  • Type: string

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

StopDiscoverer

$result = $client->stopDiscoverer([/* ... */]);
$promise = $client->stopDiscovererAsync([/* ... */]);

Stops the discoverer

Parameter Syntax

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

Parameter Details

Members
DiscovererId
  • Required: Yes
  • Type: string

Result Syntax

[
    'DiscovererId' => '<string>',
    'State' => 'STARTED|STOPPED',
]

Result Details

Members
DiscovererId
  • Type: string
State
  • Type: string

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

TagResource

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

Add tags to a resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string
Tags
  • Required: Yes
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NotFoundException:

    This error does not currently have a description.

  • BadRequestException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

UntagResource

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

Removes tags from a resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string
TagKeys
  • Required: Yes
  • Type: Array of strings

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NotFoundException:

    This error does not currently have a description.

  • BadRequestException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

UpdateDiscoverer

$result = $client->updateDiscoverer([/* ... */]);
$promise = $client->updateDiscovererAsync([/* ... */]);

Updates the discoverer

Parameter Syntax

$result = $client->updateDiscoverer([
    'CrossAccount' => true || false,
    'Description' => '<string>',
    'DiscovererId' => '<string>', // REQUIRED
]);

Parameter Details

Members
CrossAccount
  • Type: boolean
Description
  • Type: string
DiscovererId
  • Required: Yes
  • Type: string

Result Syntax

[
    'CrossAccount' => true || false,
    'Description' => '<string>',
    'DiscovererArn' => '<string>',
    'DiscovererId' => '<string>',
    'SourceArn' => '<string>',
    'State' => 'STARTED|STOPPED',
    'Tags' => ['<string>', ...],
]

Result Details

Members
CrossAccount
  • Type: boolean
Description
  • Type: string
DiscovererArn
  • Type: string
DiscovererId
  • Type: string
SourceArn
  • Type: string
State
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

UpdateRegistry

$result = $client->updateRegistry([/* ... */]);
$promise = $client->updateRegistryAsync([/* ... */]);

Updates a registry.

Parameter Syntax

$result = $client->updateRegistry([
    'Description' => '<string>',
    'RegistryName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
  • Type: string
RegistryName
  • Required: Yes
  • Type: string

Result Syntax

[
    'Description' => '<string>',
    'RegistryArn' => '<string>',
    'RegistryName' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
Description
  • Type: string
RegistryArn
  • Type: string
RegistryName
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

Errors

  • BadRequestException:

    This error does not currently have a description.

  • UnauthorizedException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

UpdateSchema

$result = $client->updateSchema([/* ... */]);
$promise = $client->updateSchemaAsync([/* ... */]);

Updates the schema definition

Inactive schemas will be deleted after two years.

Parameter Syntax

$result = $client->updateSchema([
    'ClientTokenId' => '<string>',
    'Content' => '<string>',
    'Description' => '<string>',
    'RegistryName' => '<string>', // REQUIRED
    'SchemaName' => '<string>', // REQUIRED
    'Type' => 'OpenApi3',
]);

Parameter Details

Members
ClientTokenId
  • Type: string
Content
  • Type: string
Description
  • Type: string
RegistryName
  • Required: Yes
  • Type: string
SchemaName
  • Required: Yes
  • Type: string
Type
  • Type: string

Result Syntax

[
    'Description' => '<string>',
    'LastModified' => <DateTime>,
    'SchemaArn' => '<string>',
    'SchemaName' => '<string>',
    'SchemaVersion' => '<string>',
    'Tags' => ['<string>', ...],
    'Type' => '<string>',
    'VersionCreatedDate' => <DateTime>,
]

Result Details

Members
Description
  • Type: string
LastModified
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
SchemaArn
  • Type: string
SchemaName
  • Type: string
SchemaVersion
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Key-value pairs associated with a resource.

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

Errors

  • BadRequestException:

    This error does not currently have a description.

  • InternalServerErrorException:

    This error does not currently have a description.

  • ForbiddenException:

    This error does not currently have a description.

  • NotFoundException:

    This error does not currently have a description.

  • ServiceUnavailableException:

    This error does not currently have a description.

Shapes

BadRequestException

Members
Code
  • Required: Yes
  • Type: string
Message
  • Required: Yes
  • Type: string

CodeBindingOutput

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

The time and date that the code binding was created.

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

The date and time that code bindings were modified.

SchemaVersion
  • Type: string

The version number of the schema.

Status
  • Type: string

The current status of code binding generation.

ConflictException

Members
Code
  • Required: Yes
  • Type: string
Message
  • Required: Yes
  • Type: string

CreateDiscovererInput

Members
CrossAccount
  • Type: boolean

Support discovery of schemas in events sent to the bus from another account. (default: true)

Description
  • Type: string

A description for the discoverer.

SourceArn
  • Required: Yes
  • Type: string

The ARN of the event bus.

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

Tags associated with the resource.

CreateRegistryInput

Members
Description
  • Type: string

A description of the registry to be created.

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

Tags to associate with the registry.

CreateSchemaInput

Members
Content
  • Required: Yes
  • Type: string

The source of the schema definition.

Description
  • Type: string

A description of the schema.

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

Tags associated with the schema.

Type
  • Required: Yes
  • Type: string

The type of schema.

DescribeSchemaOutput

Members
Content
  • Type: string

The source of the schema definition.

Description
  • Type: string

The description of the schema.

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

The date and time that schema was modified.

SchemaArn
  • Type: string

The ARN of the schema.

SchemaName
  • Type: string

The name of the schema.

SchemaVersion
  • Type: string

The version number of the schema

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

Tags associated with the resource.

Type
  • Type: string

The type of the schema.

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

The date the schema version was created.

DiscovererOutput

Members
CrossAccount
  • Type: boolean

The Status if the discoverer will discover schemas from events sent from another account.

Description
  • Type: string

The description of the discoverer.

DiscovererArn
  • Type: string

The ARN of the discoverer.

DiscovererId
  • Type: string

The ID of the discoverer.

SourceArn
  • Type: string

The ARN of the event bus.

State
  • Type: string

The state of the discoverer.

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

Tags associated with the resource.

DiscovererStateOutput

Members
DiscovererId
  • Type: string

The ID of the discoverer.

State
  • Type: string

The state of the discoverer.

DiscovererSummary

Members
CrossAccount
  • Type: boolean

The Status if the discoverer will discover schemas from events sent from another account.

DiscovererArn
  • Type: string

The ARN of the discoverer.

DiscovererId
  • Type: string

The ID of the discoverer.

SourceArn
  • Type: string

The ARN of the event bus.

State
  • Type: string

The state of the discoverer.

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

Tags associated with the resource.

ErrorOutput

Members
Code
  • Required: Yes
  • Type: string

The error code.

Message
  • Required: Yes
  • Type: string

The message string of the error output.

ExportSchemaOutput

Members
Content
  • Type: string

The content of the schema.

SchemaArn
  • Type: string

The ARN of the schema to export.

SchemaName
  • Type: string

The name of the schema to export.

SchemaVersion
  • Type: string

The version of the schema to export.

Type
  • Type: string

The type of schema to export.

ForbiddenException

Members
Code
  • Required: Yes
  • Type: string
Message
  • Required: Yes
  • Type: string

GetDiscoveredSchemaInput

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

An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.

Type
  • Required: Yes
  • Type: string

The type of event.

GetDiscoveredSchemaOutput

Description

Members
Content
  • Type: string

The source of the schema definition.

GetResourcePolicyOutput

Description

Information about the policy.

Members
Policy
  • Type: string (string|number|array|map or anything parsable by json_encode)

The resource-based policy.

RevisionId
  • Type: string

The revision ID.

GoneException

Members
Code
  • Required: Yes
  • Type: string
Message
  • Required: Yes
  • Type: string

InternalServerErrorException

Members
Code
  • Required: Yes
  • Type: string
Message
  • Required: Yes
  • Type: string

ListDiscoverersOutput

Members
Discoverers
  • Type: Array of DiscovererSummary structures
NextToken
  • Type: string

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

ListRegistriesOutput

Description

List the registries.

Members
NextToken
  • Type: string

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

Registries
  • Type: Array of RegistrySummary structures

An array of registry summaries.

ListSchemaVersionsOutput

Members
NextToken
  • Type: string

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

SchemaVersions
  • Type: Array of SchemaVersionSummary structures

An array of schema version summaries.

ListSchemasOutput

Members
NextToken
  • Type: string

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

Schemas
  • Type: Array of SchemaSummary structures

An array of schema summaries.

ListTagsForResourceOutput

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

Key-value pairs associated with a resource.

NotFoundException

Members
Code
  • Required: Yes
  • Type: string
Message
  • Required: Yes
  • Type: string

PreconditionFailedException

Members
Code
  • Required: Yes
  • Type: string
Message
  • Required: Yes
  • Type: string

PutResourcePolicyInput

Description

Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

Members
Policy
  • Required: Yes
  • Type: string (string|number|array|map or anything parsable by json_encode)

The resource-based policy.

RevisionId
  • Type: string

The revision ID of the policy.

PutResourcePolicyOutput

Description

The resource-based policy.

Members
Policy
  • Type: string (string|number|array|map or anything parsable by json_encode)

The resource-based policy.

RevisionId
  • Type: string

The revision ID of the policy.

RegistryOutput

Members
Description
  • Type: string

The description of the registry.

RegistryArn
  • Type: string

The ARN of the registry.

RegistryName
  • Type: string

The name of the registry.

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

Tags associated with the registry.

RegistrySummary

Members
RegistryArn
  • Type: string

The ARN of the registry.

RegistryName
  • Type: string

The name of the registry.

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

Tags associated with the registry.

SchemaOutput

Members
Description
  • Type: string

The description of the schema.

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

The date and time that schema was modified.

SchemaArn
  • Type: string

The ARN of the schema.

SchemaName
  • Type: string

The name of the schema.

SchemaVersion
  • Type: string

The version number of the schema

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

Key-value pairs associated with a resource.

Type
  • Type: string

The type of the schema.

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

The date the schema version was created.

SchemaSummary

Description

A summary of schema details.

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

The date and time that schema was modified.

SchemaArn
  • Type: string

The ARN of the schema.

SchemaName
  • Type: string

The name of the schema.

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

Tags associated with the schema.

VersionCount
  • Type: long (int|float)

The number of versions available for the schema.

SchemaVersionSummary

Members
SchemaArn
  • Type: string

The ARN of the schema version.

SchemaName
  • Type: string

The name of the schema.

SchemaVersion
  • Type: string

The version number of the schema.

Type
  • Type: string

SearchSchemaSummary

Members
RegistryName
  • Type: string

The name of the registry.

SchemaArn
  • Type: string

The ARN of the schema.

SchemaName
  • Type: string

The name of the schema.

SchemaVersions
  • Type: Array of SearchSchemaVersionSummary structures

An array of schema version summaries.

SearchSchemaVersionSummary

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

The date the schema version was created.

SchemaVersion
  • Type: string

The version number of the schema

Type
  • Type: string

SearchSchemasOutput

Members
NextToken
  • Type: string

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

Schemas
  • Type: Array of SearchSchemaSummary structures

An array of SearchSchemaSummary information.

ServiceUnavailableException

Members
Code
  • Required: Yes
  • Type: string
Message
  • Required: Yes
  • Type: string

TagResourceInput

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

Tags associated with the resource.

TooManyRequestsException

Members
Code
  • Required: Yes
  • Type: string
Message
  • Required: Yes
  • Type: string

UnauthorizedException

Members
Code
  • Required: Yes
  • Type: string
Message
  • Required: Yes
  • Type: string

UpdateDiscovererInput

Members
CrossAccount
  • Type: boolean

Support discovery of schemas in events sent to the bus from another account. (default: true)

Description
  • Type: string

The description of the discoverer to update.

UpdateRegistryInput

Members
Description
  • Type: string

The description of the registry to update.

UpdateSchemaInput

Members
ClientTokenId
  • Type: string

The ID of the client token.

Content
  • Type: string

The source of the schema definition.

Description
  • Type: string

The description of the schema.

Type
  • Type: string

The schema type for the events schema.

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