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

Namespaces

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

Classes

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

Interfaces

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

Traits

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

Exceptions

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

Functions

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

AmazonMQ 2017-11-27

Client: Aws\MQ\MQClient
Service ID: mq
Version: 2017-11-27

This page describes the parameters and results for the operations of the AmazonMQ (2017-11-27), and shows how to use the Aws\MQ\MQClient object to call the described operations. This documentation is specific to the 2017-11-27 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 */).

  • CreateBroker ( array $params = [] )

    Creates a broker.

  • CreateConfiguration ( array $params = [] )

    Creates a new configuration for the specified configuration name.

  • CreateTags ( array $params = [] )

    Add a tag to a resource.

  • CreateUser ( array $params = [] )

    Creates an ActiveMQ user.

  • DeleteBroker ( array $params = [] )

    Deletes a broker.

  • DeleteTags ( array $params = [] )

    Removes a tag from a resource.

  • DeleteUser ( array $params = [] )

    Deletes an ActiveMQ user.

  • DescribeBroker ( array $params = [] )

    Returns information about the specified broker.

  • DescribeBrokerEngineTypes ( array $params = [] )

    Describe available engine types and versions.

  • DescribeBrokerInstanceOptions ( array $params = [] )

    Describe available broker instance options.

  • DescribeConfiguration ( array $params = [] )

    Returns information about the specified configuration.

  • DescribeConfigurationRevision ( array $params = [] )

    Returns the specified configuration revision for the specified configuration.

  • DescribeUser ( array $params = [] )

    Returns information about an ActiveMQ user.

  • ListBrokers ( array $params = [] )

    Returns a list of all brokers.

  • ListConfigurationRevisions ( array $params = [] )

    Returns a list of all revisions for the specified configuration.

  • ListConfigurations ( array $params = [] )

    Returns a list of all configurations.

  • ListTags ( array $params = [] )

    Lists tags for a resource.

  • ListUsers ( array $params = [] )

    Returns a list of all ActiveMQ users.

  • RebootBroker ( array $params = [] )

    Reboots a broker.

  • UpdateBroker ( array $params = [] )

    Adds a pending configuration change to a broker.

  • UpdateConfiguration ( array $params = [] )

    Updates the specified configuration.

  • UpdateUser ( array $params = [] )

    Updates the information for an ActiveMQ user.

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:

  • ListBrokers

Operations

CreateBroker

$result = $client->createBroker([/* ... */]);
$promise = $client->createBrokerAsync([/* ... */]);
Creates a broker. Note: This API is asynchronous.

Parameter Syntax

$result = $client->createBroker([
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'AutoMinorVersionUpgrade' => true || false,
    'BrokerName' => '<string>',
    'Configuration' => [
        'Id' => '<string>',
        'Revision' => <integer>,
    ],
    'CreatorRequestId' => '<string>',
    'DeploymentMode' => 'SINGLE_INSTANCE|ACTIVE_STANDBY_MULTI_AZ|CLUSTER_MULTI_AZ',
    'EncryptionOptions' => [
        'KmsKeyId' => '<string>',
        'UseAwsOwnedKey' => true || false, // REQUIRED
    ],
    'EngineType' => 'ACTIVEMQ|RABBITMQ',
    'EngineVersion' => '<string>',
    'HostInstanceType' => '<string>',
    'LdapServerMetadata' => [
        'Hosts' => ['<string>', ...],
        'RoleBase' => '<string>',
        'RoleName' => '<string>',
        'RoleSearchMatching' => '<string>',
        'RoleSearchSubtree' => true || false,
        'ServiceAccountPassword' => '<string>',
        'ServiceAccountUsername' => '<string>',
        'UserBase' => '<string>',
        'UserRoleName' => '<string>',
        'UserSearchMatching' => '<string>',
        'UserSearchSubtree' => true || false,
    ],
    'Logs' => [
        'Audit' => true || false,
        'General' => true || false,
    ],
    'MaintenanceWindowStartTime' => [
        'DayOfWeek' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
        'TimeOfDay' => '<string>',
        'TimeZone' => '<string>',
    ],
    'PubliclyAccessible' => true || false,
    'SecurityGroups' => ['<string>', ...],
    'StorageType' => 'EBS|EFS',
    'SubnetIds' => ['<string>', ...],
    'Tags' => ['<string>', ...],
    'Users' => [
        [
            'ConsoleAccess' => true || false,
            'Groups' => ['<string>', ...],
            'Password' => '<string>',
            'Username' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
AuthenticationStrategy
  • Type: string
The authentication strategy used to secure the broker.
AutoMinorVersionUpgrade
  • Type: boolean
BrokerName
  • Type: string
Configuration
  • Type: ConfigurationId structure
A list of information about the configuration. Does not apply to RabbitMQ brokers.
CreatorRequestId
  • Type: string
DeploymentMode
  • Type: string
The deployment mode of the broker.
EncryptionOptions
  • Type: EncryptionOptions structure
Encryption options for the broker.
EngineType
  • Type: string
The type of broker engine. Note: Currently, Amazon MQ supports ActiveMQ and RabbitMQ.
EngineVersion
  • Type: string
HostInstanceType
  • Type: string
LdapServerMetadata
  • Type: LdapServerMetadataInput structure
The metadata of the LDAP server used to authenticate and authorize connections to the broker. Currently not supported for RabbitMQ engine type.
Logs
  • Type: Logs structure
The list of information about logs to be enabled for the specified broker.
MaintenanceWindowStartTime
  • Type: WeeklyStartTime structure
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
PubliclyAccessible
  • Type: boolean
SecurityGroups
  • Type: Array of strings
StorageType
  • Type: string
The storage type of the broker. EFS is currently not Supported for RabbitMQ engine type.
SubnetIds
  • Type: Array of strings
Tags
  • Type: Associative array of custom strings keys (__string) to strings
Users
  • Type: Array of User structures

Result Syntax

[
    'BrokerArn' => '<string>',
    'BrokerId' => '<string>',
]

Result Details

Members
BrokerArn
  • Type: string
BrokerId
  • Type: string

Errors

  • BadRequestException:

    Returns information about an error.

  • UnauthorizedException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ConflictException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

CreateConfiguration

$result = $client->createConfiguration([/* ... */]);
$promise = $client->createConfigurationAsync([/* ... */]);
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

Parameter Syntax

$result = $client->createConfiguration([
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'EngineType' => 'ACTIVEMQ|RABBITMQ',
    'EngineVersion' => '<string>',
    'Name' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
AuthenticationStrategy
  • Type: string
The authentication strategy used to secure the broker.
EngineType
  • Type: string
The type of broker engine. Note: Currently, Amazon MQ supports ActiveMQ and RabbitMQ.
EngineVersion
  • Type: string
Name
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Result Syntax

[
    'Arn' => '<string>',
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'Created' => <DateTime>,
    'Id' => '<string>',
    'LatestRevision' => [
        'Created' => <DateTime>,
        'Description' => '<string>',
        'Revision' => <integer>,
    ],
    'Name' => '<string>',
]

Result Details

Members
Arn
  • Type: string
AuthenticationStrategy
  • Type: string
The authentication strategy used to secure the broker.
Created
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Id
  • Type: string
LatestRevision
  • Type: ConfigurationRevision structure
Returns information about the specified configuration revision.
Name
  • Type: string

Errors

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ConflictException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

CreateTags

$result = $client->createTags([/* ... */]);
$promise = $client->createTagsAsync([/* ... */]);
Add a tag to a resource.

Parameter Syntax

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

Parameter Details

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);
Creates an ActiveMQ user.

Parameter Syntax

$result = $client->createUser([
    'BrokerId' => '<string>', // REQUIRED
    'ConsoleAccess' => true || false,
    'Groups' => ['<string>', ...],
    'Password' => '<string>',
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members
BrokerId
  • Required: Yes
  • Type: string
ConsoleAccess
  • Type: boolean
Groups
  • Type: Array of strings
Password
  • Type: string
Username
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ConflictException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

DeleteBroker

$result = $client->deleteBroker([/* ... */]);
$promise = $client->deleteBrokerAsync([/* ... */]);
Deletes a broker. Note: This API is asynchronous.

Parameter Syntax

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

Parameter Details

Members
BrokerId
  • Required: Yes
  • Type: string

Result Syntax

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

Result Details

Members
BrokerId
  • Type: string

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

DeleteTags

$result = $client->deleteTags([/* ... */]);
$promise = $client->deleteTagsAsync([/* ... */]);
Removes a tag from a resource.

Parameter Syntax

$result = $client->deleteTags([
    '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:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);
Deletes an ActiveMQ user.

Parameter Syntax

$result = $client->deleteUser([
    'BrokerId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members
BrokerId
  • Required: Yes
  • Type: string
Username
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

DescribeBroker

$result = $client->describeBroker([/* ... */]);
$promise = $client->describeBrokerAsync([/* ... */]);
Returns information about the specified broker.

Parameter Syntax

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

Parameter Details

Members
BrokerId
  • Required: Yes
  • Type: string

Result Syntax

[
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'AutoMinorVersionUpgrade' => true || false,
    'BrokerArn' => '<string>',
    'BrokerId' => '<string>',
    'BrokerInstances' => [
        [
            'ConsoleURL' => '<string>',
            'Endpoints' => ['<string>', ...],
            'IpAddress' => '<string>',
        ],
        // ...
    ],
    'BrokerName' => '<string>',
    'BrokerState' => 'CREATION_IN_PROGRESS|CREATION_FAILED|DELETION_IN_PROGRESS|RUNNING|REBOOT_IN_PROGRESS',
    'Configurations' => [
        'Current' => [
            'Id' => '<string>',
            'Revision' => <integer>,
        ],
        'History' => [
            [
                'Id' => '<string>',
                'Revision' => <integer>,
            ],
            // ...
        ],
        'Pending' => [
            'Id' => '<string>',
            'Revision' => <integer>,
        ],
    ],
    'Created' => <DateTime>,
    'DeploymentMode' => 'SINGLE_INSTANCE|ACTIVE_STANDBY_MULTI_AZ|CLUSTER_MULTI_AZ',
    'EncryptionOptions' => [
        'KmsKeyId' => '<string>',
        'UseAwsOwnedKey' => true || false,
    ],
    'EngineType' => 'ACTIVEMQ|RABBITMQ',
    'EngineVersion' => '<string>',
    'HostInstanceType' => '<string>',
    'LdapServerMetadata' => [
        'Hosts' => ['<string>', ...],
        'RoleBase' => '<string>',
        'RoleName' => '<string>',
        'RoleSearchMatching' => '<string>',
        'RoleSearchSubtree' => true || false,
        'ServiceAccountUsername' => '<string>',
        'UserBase' => '<string>',
        'UserRoleName' => '<string>',
        'UserSearchMatching' => '<string>',
        'UserSearchSubtree' => true || false,
    ],
    'Logs' => [
        'Audit' => true || false,
        'AuditLogGroup' => '<string>',
        'General' => true || false,
        'GeneralLogGroup' => '<string>',
        'Pending' => [
            'Audit' => true || false,
            'General' => true || false,
        ],
    ],
    'MaintenanceWindowStartTime' => [
        'DayOfWeek' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
        'TimeOfDay' => '<string>',
        'TimeZone' => '<string>',
    ],
    'PendingAuthenticationStrategy' => 'SIMPLE|LDAP',
    'PendingEngineVersion' => '<string>',
    'PendingHostInstanceType' => '<string>',
    'PendingLdapServerMetadata' => [
        'Hosts' => ['<string>', ...],
        'RoleBase' => '<string>',
        'RoleName' => '<string>',
        'RoleSearchMatching' => '<string>',
        'RoleSearchSubtree' => true || false,
        'ServiceAccountUsername' => '<string>',
        'UserBase' => '<string>',
        'UserRoleName' => '<string>',
        'UserSearchMatching' => '<string>',
        'UserSearchSubtree' => true || false,
    ],
    'PendingSecurityGroups' => ['<string>', ...],
    'PubliclyAccessible' => true || false,
    'SecurityGroups' => ['<string>', ...],
    'StorageType' => 'EBS|EFS',
    'SubnetIds' => ['<string>', ...],
    'Tags' => ['<string>', ...],
    'Users' => [
        [
            'PendingChange' => 'CREATE|UPDATE|DELETE',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
AuthenticationStrategy
  • Type: string
The authentication strategy used to secure the broker.
AutoMinorVersionUpgrade
  • Type: boolean
BrokerArn
  • Type: string
BrokerId
  • Type: string
BrokerInstances
  • Type: Array of BrokerInstance structures
BrokerName
  • Type: string
BrokerState
  • Type: string
The status of the broker.
Configurations
  • Type: Configurations structure
Broker configuration information
Created
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
DeploymentMode
  • Type: string
The deployment mode of the broker.
EncryptionOptions
  • Type: EncryptionOptions structure
Encryption options for the broker.
EngineType
  • Type: string
The type of broker engine. Note: Currently, Amazon MQ supports ActiveMQ and RabbitMQ.
EngineVersion
  • Type: string
HostInstanceType
  • Type: string
LdapServerMetadata
  • Type: LdapServerMetadataOutput structure
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Logs
  • Type: LogsSummary structure
The list of information about logs currently enabled and pending to be deployed for the specified broker.
MaintenanceWindowStartTime
  • Type: WeeklyStartTime structure
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
PendingAuthenticationStrategy
  • Type: string
The authentication strategy used to secure the broker.
PendingEngineVersion
  • Type: string
PendingHostInstanceType
  • Type: string
PendingLdapServerMetadata
  • Type: LdapServerMetadataOutput structure
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
PendingSecurityGroups
  • Type: Array of strings
PubliclyAccessible
  • Type: boolean
SecurityGroups
  • Type: Array of strings
StorageType
  • Type: string
The storage type of the broker. EFS is currently not Supported for RabbitMQ engine type.
SubnetIds
  • Type: Array of strings
Tags
  • Type: Associative array of custom strings keys (__string) to strings
Users
  • Type: Array of UserSummary structures

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

DescribeBrokerEngineTypes

$result = $client->describeBrokerEngineTypes([/* ... */]);
$promise = $client->describeBrokerEngineTypesAsync([/* ... */]);
Describe available engine types and versions.

Parameter Syntax

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

Parameter Details

Members
EngineType
  • Type: string
MaxResults
  • Type: int
NextToken
  • Type: string

Result Syntax

[
    'BrokerEngineTypes' => [
        [
            'EngineType' => 'ACTIVEMQ|RABBITMQ',
            'EngineVersions' => [
                [
                    'Name' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]

Result Details

Members
BrokerEngineTypes
  • Type: Array of BrokerEngineType structures
MaxResults
  • Type: int
NextToken
  • Type: string

Errors

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

DescribeBrokerInstanceOptions

$result = $client->describeBrokerInstanceOptions([/* ... */]);
$promise = $client->describeBrokerInstanceOptionsAsync([/* ... */]);
Describe available broker instance options.

Parameter Syntax

$result = $client->describeBrokerInstanceOptions([
    'EngineType' => '<string>',
    'HostInstanceType' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StorageType' => '<string>',
]);

Parameter Details

Members
EngineType
  • Type: string
HostInstanceType
  • Type: string
MaxResults
  • Type: int
NextToken
  • Type: string
StorageType
  • Type: string

Result Syntax

[
    'BrokerInstanceOptions' => [
        [
            'AvailabilityZones' => [
                [
                    'Name' => '<string>',
                ],
                // ...
            ],
            'EngineType' => 'ACTIVEMQ|RABBITMQ',
            'HostInstanceType' => '<string>',
            'StorageType' => 'EBS|EFS',
            'SupportedDeploymentModes' => ['<string>', ...],
            'SupportedEngineVersions' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]

Result Details

Members
BrokerInstanceOptions
  • Type: Array of BrokerInstanceOption structures
MaxResults
  • Type: int
NextToken
  • Type: string

Errors

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

DescribeConfiguration

$result = $client->describeConfiguration([/* ... */]);
$promise = $client->describeConfigurationAsync([/* ... */]);
Returns information about the specified configuration.

Parameter Syntax

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

Parameter Details

Members
ConfigurationId
  • Required: Yes
  • Type: string

Result Syntax

[
    'Arn' => '<string>',
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'Created' => <DateTime>,
    'Description' => '<string>',
    'EngineType' => 'ACTIVEMQ|RABBITMQ',
    'EngineVersion' => '<string>',
    'Id' => '<string>',
    'LatestRevision' => [
        'Created' => <DateTime>,
        'Description' => '<string>',
        'Revision' => <integer>,
    ],
    'Name' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
Arn
  • Type: string
AuthenticationStrategy
  • Type: string
The authentication strategy used to secure the broker.
Created
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Description
  • Type: string
EngineType
  • Type: string
The type of broker engine. Note: Currently, Amazon MQ supports ActiveMQ and RabbitMQ.
EngineVersion
  • Type: string
Id
  • Type: string
LatestRevision
  • Type: ConfigurationRevision structure
Returns information about the specified configuration revision.
Name
  • Type: string
Tags
  • Type: Associative array of custom strings keys (__string) to strings

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

DescribeConfigurationRevision

$result = $client->describeConfigurationRevision([/* ... */]);
$promise = $client->describeConfigurationRevisionAsync([/* ... */]);
Returns the specified configuration revision for the specified configuration.

Parameter Syntax

$result = $client->describeConfigurationRevision([
    'ConfigurationId' => '<string>', // REQUIRED
    'ConfigurationRevision' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConfigurationId
  • Required: Yes
  • Type: string
ConfigurationRevision
  • Required: Yes
  • Type: string

Result Syntax

[
    'ConfigurationId' => '<string>',
    'Created' => <DateTime>,
    'Data' => '<string>',
    'Description' => '<string>',
]

Result Details

Members
ConfigurationId
  • Type: string
Created
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Data
  • Type: string
Description
  • Type: string

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

DescribeUser

$result = $client->describeUser([/* ... */]);
$promise = $client->describeUserAsync([/* ... */]);
Returns information about an ActiveMQ user.

Parameter Syntax

$result = $client->describeUser([
    'BrokerId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members
BrokerId
  • Required: Yes
  • Type: string
Username
  • Required: Yes
  • Type: string

Result Syntax

[
    'BrokerId' => '<string>',
    'ConsoleAccess' => true || false,
    'Groups' => ['<string>', ...],
    'Pending' => [
        'ConsoleAccess' => true || false,
        'Groups' => ['<string>', ...],
        'PendingChange' => 'CREATE|UPDATE|DELETE',
    ],
    'Username' => '<string>',
]

Result Details

Members
BrokerId
  • Type: string
ConsoleAccess
  • Type: boolean
Groups
  • Type: Array of strings
Pending
  • Type: UserPendingChanges structure
Returns information about the status of the changes pending for the ActiveMQ user.
Username
  • Type: string

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

ListBrokers

$result = $client->listBrokers([/* ... */]);
$promise = $client->listBrokersAsync([/* ... */]);
Returns a list of all brokers.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int
NextToken
  • Type: string

Result Syntax

[
    'BrokerSummaries' => [
        [
            'BrokerArn' => '<string>',
            'BrokerId' => '<string>',
            'BrokerName' => '<string>',
            'BrokerState' => 'CREATION_IN_PROGRESS|CREATION_FAILED|DELETION_IN_PROGRESS|RUNNING|REBOOT_IN_PROGRESS',
            'Created' => <DateTime>,
            'DeploymentMode' => 'SINGLE_INSTANCE|ACTIVE_STANDBY_MULTI_AZ|CLUSTER_MULTI_AZ',
            'EngineType' => 'ACTIVEMQ|RABBITMQ',
            'HostInstanceType' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
BrokerSummaries
  • Type: Array of BrokerSummary structures
NextToken
  • Type: string

Errors

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

ListConfigurationRevisions

$result = $client->listConfigurationRevisions([/* ... */]);
$promise = $client->listConfigurationRevisionsAsync([/* ... */]);
Returns a list of all revisions for the specified configuration.

Parameter Syntax

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

Parameter Details

Members
ConfigurationId
  • Required: Yes
  • Type: string
MaxResults
  • Type: int
NextToken
  • Type: string

Result Syntax

[
    'ConfigurationId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Revisions' => [
        [
            'Created' => <DateTime>,
            'Description' => '<string>',
            'Revision' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
ConfigurationId
  • Type: string
MaxResults
  • Type: int
NextToken
  • Type: string
Revisions
  • Type: Array of ConfigurationRevision structures

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

ListConfigurations

$result = $client->listConfigurations([/* ... */]);
$promise = $client->listConfigurationsAsync([/* ... */]);
Returns a list of all configurations.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int
NextToken
  • Type: string

Result Syntax

[
    'Configurations' => [
        [
            'Arn' => '<string>',
            'AuthenticationStrategy' => 'SIMPLE|LDAP',
            'Created' => <DateTime>,
            'Description' => '<string>',
            'EngineType' => 'ACTIVEMQ|RABBITMQ',
            'EngineVersion' => '<string>',
            'Id' => '<string>',
            'LatestRevision' => [
                'Created' => <DateTime>,
                'Description' => '<string>',
                'Revision' => <integer>,
            ],
            'Name' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]

Result Details

Members
Configurations
  • Type: Array of Configuration structures
MaxResults
  • Type: int
NextToken
  • Type: string

Errors

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

ListTags

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);
Lists tags for a resource.

Parameter Syntax

$result = $client->listTags([
    '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

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

ListUsers

$result = $client->listUsers([/* ... */]);
$promise = $client->listUsersAsync([/* ... */]);
Returns a list of all ActiveMQ users.

Parameter Syntax

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

Parameter Details

Members
BrokerId
  • Required: Yes
  • Type: string
MaxResults
  • Type: int
NextToken
  • Type: string

Result Syntax

[
    'BrokerId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Users' => [
        [
            'PendingChange' => 'CREATE|UPDATE|DELETE',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
BrokerId
  • Type: string
MaxResults
  • Type: int
NextToken
  • Type: string
Users
  • Type: Array of UserSummary structures

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

RebootBroker

$result = $client->rebootBroker([/* ... */]);
$promise = $client->rebootBrokerAsync([/* ... */]);
Reboots a broker. Note: This API is asynchronous.

Parameter Syntax

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

Parameter Details

Members
BrokerId
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

UpdateBroker

$result = $client->updateBroker([/* ... */]);
$promise = $client->updateBrokerAsync([/* ... */]);
Adds a pending configuration change to a broker.

Parameter Syntax

$result = $client->updateBroker([
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'AutoMinorVersionUpgrade' => true || false,
    'BrokerId' => '<string>', // REQUIRED
    'Configuration' => [
        'Id' => '<string>',
        'Revision' => <integer>,
    ],
    'EngineVersion' => '<string>',
    'HostInstanceType' => '<string>',
    'LdapServerMetadata' => [
        'Hosts' => ['<string>', ...],
        'RoleBase' => '<string>',
        'RoleName' => '<string>',
        'RoleSearchMatching' => '<string>',
        'RoleSearchSubtree' => true || false,
        'ServiceAccountPassword' => '<string>',
        'ServiceAccountUsername' => '<string>',
        'UserBase' => '<string>',
        'UserRoleName' => '<string>',
        'UserSearchMatching' => '<string>',
        'UserSearchSubtree' => true || false,
    ],
    'Logs' => [
        'Audit' => true || false,
        'General' => true || false,
    ],
    'SecurityGroups' => ['<string>', ...],
]);

Parameter Details

Members
AuthenticationStrategy
  • Type: string
The authentication strategy used to secure the broker.
AutoMinorVersionUpgrade
  • Type: boolean
BrokerId
  • Required: Yes
  • Type: string
Configuration
  • Type: ConfigurationId structure
A list of information about the configuration. Does not apply to RabbitMQ brokers.
EngineVersion
  • Type: string
HostInstanceType
  • Type: string
LdapServerMetadata
  • Type: LdapServerMetadataInput structure
The metadata of the LDAP server used to authenticate and authorize connections to the broker. Currently not supported for RabbitMQ engine type.
Logs
  • Type: Logs structure
The list of information about logs to be enabled for the specified broker.
SecurityGroups
  • Type: Array of strings

Result Syntax

[
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'AutoMinorVersionUpgrade' => true || false,
    'BrokerId' => '<string>',
    'Configuration' => [
        'Id' => '<string>',
        'Revision' => <integer>,
    ],
    'EngineVersion' => '<string>',
    'HostInstanceType' => '<string>',
    'LdapServerMetadata' => [
        'Hosts' => ['<string>', ...],
        'RoleBase' => '<string>',
        'RoleName' => '<string>',
        'RoleSearchMatching' => '<string>',
        'RoleSearchSubtree' => true || false,
        'ServiceAccountUsername' => '<string>',
        'UserBase' => '<string>',
        'UserRoleName' => '<string>',
        'UserSearchMatching' => '<string>',
        'UserSearchSubtree' => true || false,
    ],
    'Logs' => [
        'Audit' => true || false,
        'General' => true || false,
    ],
    'SecurityGroups' => ['<string>', ...],
]

Result Details

Members
AuthenticationStrategy
  • Type: string
The authentication strategy used to secure the broker.
AutoMinorVersionUpgrade
  • Type: boolean
BrokerId
  • Type: string
Configuration
  • Type: ConfigurationId structure
A list of information about the configuration. Does not apply to RabbitMQ brokers.
EngineVersion
  • Type: string
HostInstanceType
  • Type: string
LdapServerMetadata
  • Type: LdapServerMetadataOutput structure
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Logs
  • Type: Logs structure
The list of information about logs to be enabled for the specified broker.
SecurityGroups
  • Type: Array of strings

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ConflictException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

UpdateConfiguration

$result = $client->updateConfiguration([/* ... */]);
$promise = $client->updateConfigurationAsync([/* ... */]);
Updates the specified configuration.

Parameter Syntax

$result = $client->updateConfiguration([
    'ConfigurationId' => '<string>', // REQUIRED
    'Data' => '<string>',
    'Description' => '<string>',
]);

Parameter Details

Members
ConfigurationId
  • Required: Yes
  • Type: string
Data
  • Type: string
Description
  • Type: string

Result Syntax

[
    'Arn' => '<string>',
    'Created' => <DateTime>,
    'Id' => '<string>',
    'LatestRevision' => [
        'Created' => <DateTime>,
        'Description' => '<string>',
        'Revision' => <integer>,
    ],
    'Name' => '<string>',
    'Warnings' => [
        [
            'AttributeName' => '<string>',
            'ElementName' => '<string>',
            'Reason' => 'DISALLOWED_ELEMENT_REMOVED|DISALLOWED_ATTRIBUTE_REMOVED|INVALID_ATTRIBUTE_VALUE_REMOVED',
        ],
        // ...
    ],
]

Result Details

Members
Arn
  • Type: string
Created
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Id
  • Type: string
LatestRevision
  • Type: ConfigurationRevision structure
Returns information about the specified configuration revision.
Name
  • Type: string
Warnings
  • Type: Array of SanitizationWarning structures

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ConflictException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

UpdateUser

$result = $client->updateUser([/* ... */]);
$promise = $client->updateUserAsync([/* ... */]);
Updates the information for an ActiveMQ user.

Parameter Syntax

$result = $client->updateUser([
    'BrokerId' => '<string>', // REQUIRED
    'ConsoleAccess' => true || false,
    'Groups' => ['<string>', ...],
    'Password' => '<string>',
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members
BrokerId
  • Required: Yes
  • Type: string
ConsoleAccess
  • Type: boolean
Groups
  • Type: Array of strings
Password
  • Type: string
Username
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • NotFoundException:

    Returns information about an error.

  • BadRequestException:

    Returns information about an error.

  • InternalServerErrorException:

    Returns information about an error.

  • ConflictException:

    Returns information about an error.

  • ForbiddenException:

    Returns information about an error.

Shapes

AvailabilityZone

Description
Name of the availability zone.
Members
Name
  • Type: string
Id for the availability zone.

BadRequestException

Description
Returns information about an error.
Members
ErrorAttribute
  • Type: string
Message
  • Type: string

BrokerEngineType

Description
Types of broker engines.
Members
EngineType
  • Type: string
The type of broker engine.
EngineVersions
  • Type: Array of EngineVersion structures
The list of engine versions.

BrokerEngineTypeOutput

Description
Returns a list of broker engine type.
Members
BrokerEngineTypes
  • Type: Array of BrokerEngineType structures
List of available engine types and versions.
MaxResults
  • Type: int
Required. The maximum number of engine types that can be returned per page (20 by default). This value must be an integer from 5 to 100.
NextToken
  • Type: string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

BrokerInstance

Description
Returns information about all brokers.
Members
ConsoleURL
  • Type: string
The URL of the broker's Web Console.
Endpoints
  • Type: Array of strings
The broker's wire-level protocol endpoints.
IpAddress
  • Type: string
The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers

BrokerInstanceOption

Description
Option for host instance type.
Members
AvailabilityZones
  • Type: Array of AvailabilityZone structures
The list of available az.
EngineType
  • Type: string
The type of broker engine.
HostInstanceType
  • Type: string
The type of broker instance.
StorageType
  • Type: string
The broker's storage type.
SupportedDeploymentModes
  • Type: Array of strings
The list of supported deployment modes.
SupportedEngineVersions
  • Type: Array of strings
The list of supported engine versions.

BrokerInstanceOptionsOutput

Description
Returns a list of broker instance options.
Members
BrokerInstanceOptions
  • Type: Array of BrokerInstanceOption structures
List of available broker instance options.
MaxResults
  • Type: int
Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100.
NextToken
  • Type: string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

BrokerSummary

Description
The Amazon Resource Name (ARN) of the broker.
Members
BrokerArn
  • Type: string
The Amazon Resource Name (ARN) of the broker.
BrokerId
  • Type: string
The unique ID that Amazon MQ generates for the broker.
BrokerName
  • Type: string
The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.
BrokerState
  • Type: string
The status of the broker.
Created
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the broker was created.
DeploymentMode
  • Type: string
Required. The deployment mode of the broker.
EngineType
  • Type: string
Required. The type of broker engine.
HostInstanceType
  • Type: string
The broker's instance type.

Configuration

Description
Returns information about all configurations.
Members
Arn
  • Type: string
Required. The ARN of the configuration.
AuthenticationStrategy
  • Type: string
The authentication strategy associated with the configuration.
Created
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Required. The date and time of the configuration revision.
Description
  • Type: string
Required. The description of the configuration.
EngineType
  • Type: string
Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
EngineVersion
  • Type: string
Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
Id
  • Type: string
Required. The unique ID that Amazon MQ generates for the configuration.
LatestRevision
  • Type: ConfigurationRevision structure
Required. The latest revision of the configuration.
Name
  • Type: string
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
Tags
  • Type: Associative array of custom strings keys (__string) to strings
The list of all tags associated with this configuration.

ConfigurationId

Description
A list of information about the configuration. Does not apply to RabbitMQ brokers.
Members
Id
  • Type: string
Required. The unique ID that Amazon MQ generates for the configuration.
Revision
  • Type: int
The revision number of the configuration.

ConfigurationRevision

Description
Returns information about the specified configuration revision.
Members
Created
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Required. The date and time of the configuration revision.
Description
  • Type: string
The description of the configuration revision.
Revision
  • Type: int
Required. The revision number of the configuration.

Configurations

Description
Broker configuration information
Members
Current
  • Type: ConfigurationId structure
The current configuration of the broker.
History
  • Type: Array of ConfigurationId structures
The history of configurations applied to the broker.
Pending
  • Type: ConfigurationId structure
The pending configuration of the broker.

ConflictException

Description
Returns information about an error.
Members
ErrorAttribute
  • Type: string
Message
  • Type: string

CreateBrokerInput

Description
Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
Members
AuthenticationStrategy
  • Type: string
The authentication strategy used to secure the broker.
AutoMinorVersionUpgrade
  • Type: boolean
Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
BrokerName
  • Type: string
Required. The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.
Configuration
  • Type: ConfigurationId structure
A list of information about the configuration.
CreatorRequestId
  • Type: string
The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
DeploymentMode
  • Type: string
Required. The deployment mode of the broker.
EncryptionOptions
  • Type: EncryptionOptions structure
Encryption options for the broker.
EngineType
  • Type: string
Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
EngineVersion
  • Type: string
Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
HostInstanceType
  • Type: string
Required. The broker's instance type.
LdapServerMetadata
  • Type: LdapServerMetadataInput structure
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Logs
  • Type: Logs structure
Enables Amazon CloudWatch logging for brokers.
MaintenanceWindowStartTime
  • Type: WeeklyStartTime structure
The parameters that determine the WeeklyStartTime.
PubliclyAccessible
  • Type: boolean
Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
SecurityGroups
  • Type: Array of strings
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
StorageType
  • Type: string
The broker's storage type.
SubnetIds
  • Type: Array of strings
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public accessibility requires at least one subnet.
Tags
  • Type: Associative array of custom strings keys (__string) to strings
Create tags when creating the broker.
Users
  • Type: Array of User structures
Required. The list of broker users (persons or applications) who can access queues and topics. For RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ Web Console. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

CreateBrokerOutput

Description
Returns information about the created broker.
Members
BrokerArn
  • Type: string
The Amazon Resource Name (ARN) of the broker.
BrokerId
  • Type: string
The unique ID that Amazon MQ generates for the broker.

CreateConfigurationInput

Description
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
Members
AuthenticationStrategy
  • Type: string
The authentication strategy associated with the configuration.
EngineType
  • Type: string
Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
EngineVersion
  • Type: string
Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
Name
  • Type: string
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
Tags
  • Type: Associative array of custom strings keys (__string) to strings
Create tags when creating the configuration.

CreateConfigurationOutput

Description
Returns information about the created configuration.
Members
Arn
  • Type: string
Required. The Amazon Resource Name (ARN) of the configuration.
AuthenticationStrategy
  • Type: string
The authentication strategy associated with the configuration.
Created
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Required. The date and time of the configuration.
Id
  • Type: string
Required. The unique ID that Amazon MQ generates for the configuration.
LatestRevision
  • Type: ConfigurationRevision structure
The latest revision of the configuration.
Name
  • Type: string
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.

CreateUserInput

Description
Creates a new ActiveMQ user.
Members
ConsoleAccess
  • Type: boolean
Enables access to the ActiveMQ Web Console for the ActiveMQ user.
Groups
  • Type: Array of strings
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
Password
  • Type: string
Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.

DeleteBrokerOutput

Description
Returns information about the deleted broker.
Members
BrokerId
  • Type: string
The unique ID that Amazon MQ generates for the broker.

DescribeBrokerOutput

Description
The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
Members
AuthenticationStrategy
  • Type: string
The authentication strategy used to secure the broker.
AutoMinorVersionUpgrade
  • Type: boolean
Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
BrokerArn
  • Type: string
The Amazon Resource Name (ARN) of the broker.
BrokerId
  • Type: string
The unique ID that Amazon MQ generates for the broker.
BrokerInstances
  • Type: Array of BrokerInstance structures
A list of information about allocated brokers.
BrokerName
  • Type: string
The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.
BrokerState
  • Type: string
The status of the broker.
Configurations
  • Type: Configurations structure
The list of all revisions for the specified configuration.
Created
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the broker was created.
DeploymentMode
  • Type: string
Required. The deployment mode of the broker.
EncryptionOptions
  • Type: EncryptionOptions structure
Encryption options for the broker.
EngineType
  • Type: string
Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
EngineVersion
  • Type: string
The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
HostInstanceType
  • Type: string
The broker's instance type.
LdapServerMetadata
  • Type: LdapServerMetadataOutput structure
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Logs
  • Type: LogsSummary structure
The list of information about logs currently enabled and pending to be deployed for the specified broker.
MaintenanceWindowStartTime
  • Type: WeeklyStartTime structure
The parameters that determine the WeeklyStartTime.
PendingAuthenticationStrategy
  • Type: string
The authentication strategy that will be applied when the broker is rebooted.
PendingEngineVersion
  • Type: string
The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
PendingHostInstanceType
  • Type: string
The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
PendingLdapServerMetadata
  • Type: LdapServerMetadataOutput structure
The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker once it is rebooted.
PendingSecurityGroups
  • Type: Array of strings
The list of pending security groups to authorize connections to brokers.
PubliclyAccessible
  • Type: boolean
Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
SecurityGroups
  • Type: Array of strings
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
StorageType
  • Type: string
The broker's storage type.
SubnetIds
  • Type: Array of strings
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public accessibility requires at least one subnet.
Tags
  • Type: Associative array of custom strings keys (__string) to strings
The list of all tags associated with this broker.
Users
  • Type: Array of UserSummary structures
The list of all broker usernames for the specified broker.

DescribeConfigurationRevisionOutput

Description
Returns the specified configuration revision for the specified configuration.
Members
ConfigurationId
  • Type: string
Required. The unique ID that Amazon MQ generates for the configuration.
Created
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Required. The date and time of the configuration.
Data
  • Type: string
Required. The base64-encoded XML configuration.
Description
  • Type: string
The description of the configuration.

DescribeUserOutput

Description
Returns information about an ActiveMQ user.
Members
BrokerId
  • Type: string
Required. The unique ID that Amazon MQ generates for the broker.
ConsoleAccess
  • Type: boolean
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
Groups
  • Type: Array of strings
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
Pending
  • Type: UserPendingChanges structure
The status of the changes pending for the ActiveMQ user.
Username
  • Type: string
Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

EncryptionOptions

Description
Encryption options for the broker.
Members
KmsKeyId
  • Type: string
The symmetric customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.
UseAwsOwnedKey
  • Required: Yes
  • Type: boolean
Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).

EngineVersion

Description
Id of the engine version.
Members
Name
  • Type: string
Id for the version.

Error

Description
Returns information about an error.
Members
ErrorAttribute
  • Type: string
The attribute which caused the error.
Message
  • Type: string
The explanation of the error.

ForbiddenException

Description
Returns information about an error.
Members
ErrorAttribute
  • Type: string
Message
  • Type: string

InternalServerErrorException

Description
Returns information about an error.
Members
ErrorAttribute
  • Type: string
Message
  • Type: string

LdapServerMetadataInput

Description
The metadata of the LDAP server used to authenticate and authorize connections to the broker. Currently not supported for RabbitMQ engine type.
Members
Hosts
  • Type: Array of strings
Fully qualified domain name of the LDAP server. Optional failover server.
RoleBase
  • Type: string
Fully qualified name of the directory to search for a user’s groups.
RoleName
  • Type: string
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching
  • Type: string
The search criteria for groups.
RoleSearchSubtree
  • Type: boolean
The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountPassword
  • Type: string
Service account password.
ServiceAccountUsername
  • Type: string
Service account username.
UserBase
  • Type: string
Fully qualified name of the directory where you want to search for users.
UserRoleName
  • Type: string
Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching
  • Type: string
The search criteria for users.
UserSearchSubtree
  • Type: boolean
The directory search scope for the user. If set to true, scope is to search the entire sub-tree.

LdapServerMetadataOutput

Description
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Members
Hosts
  • Type: Array of strings
Fully qualified domain name of the LDAP server. Optional failover server.
RoleBase
  • Type: string
Fully qualified name of the directory to search for a user’s groups.
RoleName
  • Type: string
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching
  • Type: string
The search criteria for groups.
RoleSearchSubtree
  • Type: boolean
The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountUsername
  • Type: string
Service account username.
UserBase
  • Type: string
Fully qualified name of the directory where you want to search for users.
UserRoleName
  • Type: string
Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching
  • Type: string
The search criteria for users.
UserSearchSubtree
  • Type: boolean
The directory search scope for the user. If set to true, scope is to search the entire sub-tree.

ListBrokersOutput

Description
A list of information about all brokers.
Members
BrokerSummaries
  • Type: Array of BrokerSummary structures
A list of information about all brokers.
NextToken
  • Type: string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

ListConfigurationRevisionsOutput

Description
Returns a list of all revisions for the specified configuration.
Members
ConfigurationId
  • Type: string
The unique ID that Amazon MQ generates for the configuration.
MaxResults
  • Type: int
The maximum number of configuration revisions that can be returned per page (20 by default). This value must be an integer from 5 to 100.
NextToken
  • Type: string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
Revisions
  • Type: Array of ConfigurationRevision structures
The list of all revisions for the specified configuration.

ListConfigurationsOutput

Description
Returns a list of all configurations.
Members
Configurations
  • Type: Array of Configuration structures
The list of all revisions for the specified configuration.
MaxResults
  • Type: int
The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
NextToken
  • Type: string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

ListUsersOutput

Description
Returns a list of all ActiveMQ users.
Members
BrokerId
  • Type: string
Required. The unique ID that Amazon MQ generates for the broker.
MaxResults
  • Type: int
Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.
NextToken
  • Type: string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
Users
  • Type: Array of UserSummary structures
Required. The list of all ActiveMQ usernames for the specified broker.

Logs

Description
The list of information about logs to be enabled for the specified broker.
Members
Audit
  • Type: boolean
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
General
  • Type: boolean
Enables general logging.

LogsSummary

Description
The list of information about logs currently enabled and pending to be deployed for the specified broker.
Members
Audit
  • Type: boolean
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
AuditLogGroup
  • Type: string
The location of the CloudWatch Logs log group where audit logs are sent.
General
  • Type: boolean
Enables general logging.
GeneralLogGroup
  • Type: string
The location of the CloudWatch Logs log group where general logs are sent.
Pending
  • Type: PendingLogs structure
The list of information about logs pending to be deployed for the specified broker.

NotFoundException

Description
Returns information about an error.
Members
ErrorAttribute
  • Type: string
Message
  • Type: string

PendingLogs

Description
The list of information about logs to be enabled for the specified broker.
Members
Audit
  • Type: boolean
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
General
  • Type: boolean
Enables general logging.

SanitizationWarning

Description
Returns information about the XML element or attribute that was sanitized in the configuration.
Members
AttributeName
  • Type: string
The name of the XML attribute that has been sanitized.
ElementName
  • Type: string
The name of the XML element that has been sanitized.
Reason
  • Type: string
Required. The reason for which the XML elements or attributes were sanitized.

Tags

Description
A map of the key-value pairs for the resource tag.
Members
Tags
  • Type: Associative array of custom strings keys (__string) to strings
The key-value pair for the resource tag.

UnauthorizedException

Description
Returns information about an error.
Members
ErrorAttribute
  • Type: string
Message
  • Type: string

UpdateBrokerInput

Description
Updates the broker using the specified properties.
Members
AuthenticationStrategy
  • Type: string
The authentication strategy used to secure the broker.
AutoMinorVersionUpgrade
  • Type: boolean
Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
Configuration
  • Type: ConfigurationId structure
A list of information about the configuration.
EngineVersion
  • Type: string
The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
HostInstanceType
  • Type: string
The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
LdapServerMetadata
  • Type: LdapServerMetadataInput structure
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Logs
  • Type: Logs structure
Enables Amazon CloudWatch logging for brokers.
SecurityGroups
  • Type: Array of strings
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

UpdateBrokerOutput

Description
Returns information about the updated broker.
Members
AuthenticationStrategy
  • Type: string
The authentication strategy used to secure the broker.
AutoMinorVersionUpgrade
  • Type: boolean
The new value of automatic upgrades to new minor version for brokers.
BrokerId
  • Type: string
Required. The unique ID that Amazon MQ generates for the broker.
Configuration
  • Type: ConfigurationId structure
The ID of the updated configuration.
EngineVersion
  • Type: string
The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
HostInstanceType
  • Type: string
The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
LdapServerMetadata
  • Type: LdapServerMetadataOutput structure
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Logs
  • Type: Logs structure
The list of information about logs to be enabled for the specified broker.
SecurityGroups
  • Type: Array of strings
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

UpdateConfigurationInput

Description
Updates the specified configuration.
Members
Data
  • Type: string
Required. The base64-encoded XML configuration.
Description
  • Type: string
The description of the configuration.

UpdateConfigurationOutput

Description
Returns information about the updated configuration.
Members
Arn
  • Type: string
Required. The Amazon Resource Name (ARN) of the configuration.
Created
  • Type: timestamp (string|DateTime or anything parsable by strtotime)
Required. The date and time of the configuration.
Id
  • Type: string
Required. The unique ID that Amazon MQ generates for the configuration.
LatestRevision
  • Type: ConfigurationRevision structure
The latest revision of the configuration.
Name
  • Type: string
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
Warnings
  • Type: Array of SanitizationWarning structures
The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.

UpdateUserInput

Description
Updates the information for an ActiveMQ user.
Members
ConsoleAccess
  • Type: boolean
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
Groups
  • Type: Array of strings
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
Password
  • Type: string
The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.

User

Description
A user associated with the broker.
Members
ConsoleAccess
  • Type: boolean
Enables access to the ActiveMQ Web Console for the ActiveMQ user (Does not apply to RabbitMQ brokers).
Groups
  • Type: Array of strings
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
Password
  • Type: string
Required. The password of the broker user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.
Username
  • Type: string
Required. The username of the broker user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

UserPendingChanges

Description
Returns information about the status of the changes pending for the ActiveMQ user.
Members
ConsoleAccess
  • Type: boolean
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
Groups
  • Type: Array of strings
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
PendingChange
  • Type: string
Required. The type of change pending for the ActiveMQ user.

UserSummary

Description
Returns a list of all broker users.
Members
PendingChange
  • Type: string
The type of change pending for the broker user.
Username
  • Type: string
Required. The username of the broker user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

WeeklyStartTime

Description
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
Members
DayOfWeek
  • Type: string
Required. The day of the week.
TimeOfDay
  • Type: string
Required. The time, in 24-hour format.
TimeZone
  • Type: string
The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
AWS SDK for PHP 3.x API documentation generated by ApiGen