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

Namespaces

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

Classes

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

Interfaces

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

Traits

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

Exceptions

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

Functions

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

AWS Data Exchange 2017-07-25

Client: Aws\DataExchange\DataExchangeClient
Service ID: dataexchange
Version: 2017-07-25

This page describes the parameters and results for the operations of the AWS Data Exchange (2017-07-25), and shows how to use the Aws\DataExchange\DataExchangeClient object to call the described operations. This documentation is specific to the 2017-07-25 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 */).

  • CancelJob ( array $params = [] )

    This operation cancels a job.

  • CreateDataSet ( array $params = [] )

    This operation creates a data set.

  • CreateJob ( array $params = [] )

    This operation creates a job.

  • CreateRevision ( array $params = [] )

    This operation creates a revision for a data set.

  • DeleteAsset ( array $params = [] )

    This operation deletes an asset.

  • DeleteDataSet ( array $params = [] )

    This operation deletes a data set.

  • DeleteRevision ( array $params = [] )

    This operation deletes a revision.

  • GetAsset ( array $params = [] )

    This operation returns information about an asset.

  • GetDataSet ( array $params = [] )

    This operation returns information about a data set.

  • GetJob ( array $params = [] )

    This operation returns information about a job.

  • GetRevision ( array $params = [] )

    This operation returns information about a revision.

  • ListDataSetRevisions ( array $params = [] )

    This operation lists a data set's revisions sorted by CreatedAt in descending order.

  • ListDataSets ( array $params = [] )

    This operation lists your data sets.

  • ListJobs ( array $params = [] )

    This operation lists your jobs sorted by CreatedAt in descending order.

  • ListRevisionAssets ( array $params = [] )

    This operation lists a revision's assets sorted alphabetically in descending order.

  • ListTagsForResource ( array $params = [] )

    This operation lists the tags on the resource.

  • StartJob ( array $params = [] )

    This operation starts a job.

  • TagResource ( array $params = [] )

    This operation tags a resource.

  • UntagResource ( array $params = [] )

    This operation removes one or more tags from a resource.

  • UpdateAsset ( array $params = [] )

    This operation updates an asset.

  • UpdateDataSet ( array $params = [] )

    This operation updates a data set.

  • UpdateRevision ( array $params = [] )

    This operation updates a revision.

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:

  • ListDataSetRevisions
  • ListDataSets
  • ListJobs
  • ListRevisionAssets

Operations

CancelJob

$result = $client->cancelJob([/* ... */]);
$promise = $client->cancelJobAsync([/* ... */]);

This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.

Parameter Syntax

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

Parameter Details

Members
JobId
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

  • ConflictException:

    The request couldn't be completed because it conflicted with the current state of the resource.

CreateDataSet

$result = $client->createDataSet([/* ... */]);
$promise = $client->createDataSetAsync([/* ... */]);

This operation creates a data set.

Parameter Syntax

$result = $client->createDataSet([
    'AssetType' => 'S3_SNAPSHOT', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
AssetType
  • Required: Yes
  • Type: string

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

Description
  • Required: Yes
  • Type: string

A description for the data set. This value can be up to 16,348 characters long.

Name
  • Required: Yes
  • Type: string

The name of the data set.

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

A data set tag is an optional label that you can assign to a data set when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

Result Syntax

[
    'Arn' => '<string>',
    'AssetType' => 'S3_SNAPSHOT',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'Origin' => 'OWNED|ENTITLED',
    'OriginDetails' => [
        'ProductId' => '<string>',
    ],
    'SourceId' => '<string>',
    'Tags' => ['<string>', ...],
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
  • Type: string

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

AssetType
  • Type: string

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Description
  • Type: string

A description of a resource.

Id
  • Type: string

A unique identifier.

Name
  • Type: string
The name of the model.
Origin
  • Type: string

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers). When an owned data set is published in a product, AWS Data Exchange creates a copy of the data set. Subscribers can access that copy of the data set as an entitled data set.

OriginDetails
  • Type: OriginDetails structure
SourceId
  • Type: string

A unique identifier.

Tags
  • Type: Associative array of custom strings keys (__string) to strings
UpdatedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Errors

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

  • ServiceLimitExceededException:

    The request has exceeded the quotas imposed by the service.

  • AccessDeniedException:

    Access to the resource is denied.

CreateJob

$result = $client->createJob([/* ... */]);
$promise = $client->createJobAsync([/* ... */]);

This operation creates a job.

Parameter Syntax

$result = $client->createJob([
    'Details' => [ // REQUIRED
        'ExportAssetToSignedUrl' => [
            'AssetId' => '<string>', // REQUIRED
            'DataSetId' => '<string>', // REQUIRED
            'RevisionId' => '<string>', // REQUIRED
        ],
        'ExportAssetsToS3' => [
            'AssetDestinations' => [ // REQUIRED
                [
                    'AssetId' => '<string>', // REQUIRED
                    'Bucket' => '<string>', // REQUIRED
                    'Key' => '<string>',
                ],
                // ...
            ],
            'DataSetId' => '<string>', // REQUIRED
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256', // REQUIRED
            ],
            'RevisionId' => '<string>', // REQUIRED
        ],
        'ImportAssetFromSignedUrl' => [
            'AssetName' => '<string>', // REQUIRED
            'DataSetId' => '<string>', // REQUIRED
            'Md5Hash' => '<string>', // REQUIRED
            'RevisionId' => '<string>', // REQUIRED
        ],
        'ImportAssetsFromS3' => [
            'AssetSources' => [ // REQUIRED
                [
                    'Bucket' => '<string>', // REQUIRED
                    'Key' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'DataSetId' => '<string>', // REQUIRED
            'RevisionId' => '<string>', // REQUIRED
        ],
    ],
    'Type' => 'IMPORT_ASSETS_FROM_S3|IMPORT_ASSET_FROM_SIGNED_URL|EXPORT_ASSETS_TO_S3|EXPORT_ASSET_TO_SIGNED_URL', // REQUIRED
]);

Parameter Details

Members
Details
  • Required: Yes
  • Type: RequestDetails structure

The details for the CreateJob request.

Type
  • Required: Yes
  • Type: string

The type of job to be created.

Result Syntax

[
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'Details' => [
        'ExportAssetToSignedUrl' => [
            'AssetId' => '<string>',
            'DataSetId' => '<string>',
            'RevisionId' => '<string>',
            'SignedUrl' => '<string>',
            'SignedUrlExpiresAt' => <DateTime>,
        ],
        'ExportAssetsToS3' => [
            'AssetDestinations' => [
                [
                    'AssetId' => '<string>',
                    'Bucket' => '<string>',
                    'Key' => '<string>',
                ],
                // ...
            ],
            'DataSetId' => '<string>',
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256',
            ],
            'RevisionId' => '<string>',
        ],
        'ImportAssetFromSignedUrl' => [
            'AssetName' => '<string>',
            'DataSetId' => '<string>',
            'Md5Hash' => '<string>',
            'RevisionId' => '<string>',
            'SignedUrl' => '<string>',
            'SignedUrlExpiresAt' => <DateTime>,
        ],
        'ImportAssetsFromS3' => [
            'AssetSources' => [
                [
                    'Bucket' => '<string>',
                    'Key' => '<string>',
                ],
                // ...
            ],
            'DataSetId' => '<string>',
            'RevisionId' => '<string>',
        ],
    ],
    'Errors' => [
        [
            'Code' => 'ACCESS_DENIED_EXCEPTION|INTERNAL_SERVER_EXCEPTION|MALWARE_DETECTED|RESOURCE_NOT_FOUND_EXCEPTION|SERVICE_QUOTA_EXCEEDED_EXCEPTION|VALIDATION_EXCEPTION|MALWARE_SCAN_ENCRYPTED_FILE',
            'Details' => [
                'ImportAssetFromSignedUrlJobErrorDetails' => [
                    'AssetName' => '<string>',
                ],
                'ImportAssetsFromS3JobErrorDetails' => [
                    [
                        'Bucket' => '<string>',
                        'Key' => '<string>',
                    ],
                    // ...
                ],
            ],
            'LimitName' => 'Assets per revision|Asset size in GB',
            'LimitValue' => <float>,
            'Message' => '<string>',
            'ResourceId' => '<string>',
            'ResourceType' => 'REVISION|ASSET',
        ],
        // ...
    ],
    'Id' => '<string>',
    'State' => 'WAITING|IN_PROGRESS|ERROR|COMPLETED|CANCELLED|TIMED_OUT',
    'Type' => 'IMPORT_ASSETS_FROM_S3|IMPORT_ASSET_FROM_SIGNED_URL|EXPORT_ASSETS_TO_S3|EXPORT_ASSET_TO_SIGNED_URL',
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
  • Type: string

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Details
  • Type: ResponseDetails structure

Details for the response.

Errors
  • Type: Array of JobError structures
Id
  • Type: string

A unique identifier.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Errors

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

  • AccessDeniedException:

    Access to the resource is denied.

CreateRevision

$result = $client->createRevision([/* ... */]);
$promise = $client->createRevisionAsync([/* ... */]);

This operation creates a revision for a data set.

Parameter Syntax

$result = $client->createRevision([
    'Comment' => '<string>',
    'DataSetId' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
Comment
  • Type: string

An optional comment about the revision.

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

A revision tag is an optional label that you can assign to a revision when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

Result Syntax

[
    'Arn' => '<string>',
    'Comment' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Finalized' => true || false,
    'Id' => '<string>',
    'SourceId' => '<string>',
    'Tags' => ['<string>', ...],
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
  • Type: string

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

DataSetId
  • Type: string

A unique identifier.

Finalized
  • Type: boolean
Id
  • Type: string

A unique identifier.

SourceId
  • Type: string

A unique identifier.

Tags
  • Type: Associative array of custom strings keys (__string) to strings
UpdatedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Errors

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

  • AccessDeniedException:

    Access to the resource is denied.

DeleteAsset

$result = $client->deleteAsset([/* ... */]);
$promise = $client->deleteAssetAsync([/* ... */]);

This operation deletes an asset.

Parameter Syntax

$result = $client->deleteAsset([
    'AssetId' => '<string>', // REQUIRED
    'DataSetId' => '<string>', // REQUIRED
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AssetId
  • Required: Yes
  • Type: string
DataSetId
  • Required: Yes
  • Type: string
RevisionId
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

  • AccessDeniedException:

    Access to the resource is denied.

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ConflictException:

    The request couldn't be completed because it conflicted with the current state of the resource.

DeleteDataSet

$result = $client->deleteDataSet([/* ... */]);
$promise = $client->deleteDataSetAsync([/* ... */]);

This operation deletes a data set.

Parameter Syntax

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

Parameter Details

Members
DataSetId
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

  • AccessDeniedException:

    Access to the resource is denied.

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ConflictException:

    The request couldn't be completed because it conflicted with the current state of the resource.

DeleteRevision

$result = $client->deleteRevision([/* ... */]);
$promise = $client->deleteRevisionAsync([/* ... */]);

This operation deletes a revision.

Parameter Syntax

$result = $client->deleteRevision([
    'DataSetId' => '<string>', // REQUIRED
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
DataSetId
  • Required: Yes
  • Type: string
RevisionId
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

  • AccessDeniedException:

    Access to the resource is denied.

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ConflictException:

    The request couldn't be completed because it conflicted with the current state of the resource.

GetAsset

$result = $client->getAsset([/* ... */]);
$promise = $client->getAssetAsync([/* ... */]);

This operation returns information about an asset.

Parameter Syntax

$result = $client->getAsset([
    'AssetId' => '<string>', // REQUIRED
    'DataSetId' => '<string>', // REQUIRED
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AssetId
  • Required: Yes
  • Type: string
DataSetId
  • Required: Yes
  • Type: string
RevisionId
  • Required: Yes
  • Type: string

Result Syntax

[
    'Arn' => '<string>',
    'AssetDetails' => [
        'S3SnapshotAsset' => [
            'Size' => <float>,
        ],
    ],
    'AssetType' => 'S3_SNAPSHOT',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'RevisionId' => '<string>',
    'SourceId' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
  • Type: string

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

AssetDetails
  • Type: AssetDetails structure
AssetType
  • Type: string

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

DataSetId
  • Type: string

A unique identifier.

Id
  • Type: string

A unique identifier.

Name
  • Type: string

The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.

RevisionId
  • Type: string

A unique identifier.

SourceId
  • Type: string

A unique identifier.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Errors

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

GetDataSet

$result = $client->getDataSet([/* ... */]);
$promise = $client->getDataSetAsync([/* ... */]);

This operation returns information about a data set.

Parameter Syntax

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

Parameter Details

Members
DataSetId
  • Required: Yes
  • Type: string

Result Syntax

[
    'Arn' => '<string>',
    'AssetType' => 'S3_SNAPSHOT',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'Origin' => 'OWNED|ENTITLED',
    'OriginDetails' => [
        'ProductId' => '<string>',
    ],
    'SourceId' => '<string>',
    'Tags' => ['<string>', ...],
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
  • Type: string

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

AssetType
  • Type: string

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Description
  • Type: string

A description of a resource.

Id
  • Type: string

A unique identifier.

Name
  • Type: string
The name of the model.
Origin
  • Type: string

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers). When an owned data set is published in a product, AWS Data Exchange creates a copy of the data set. Subscribers can access that copy of the data set as an entitled data set.

OriginDetails
  • Type: OriginDetails structure
SourceId
  • Type: string

A unique identifier.

Tags
  • Type: Associative array of custom strings keys (__string) to strings
UpdatedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Errors

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

GetJob

$result = $client->getJob([/* ... */]);
$promise = $client->getJobAsync([/* ... */]);

This operation returns information about a job.

Parameter Syntax

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

Parameter Details

Members
JobId
  • Required: Yes
  • Type: string

Result Syntax

[
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'Details' => [
        'ExportAssetToSignedUrl' => [
            'AssetId' => '<string>',
            'DataSetId' => '<string>',
            'RevisionId' => '<string>',
            'SignedUrl' => '<string>',
            'SignedUrlExpiresAt' => <DateTime>,
        ],
        'ExportAssetsToS3' => [
            'AssetDestinations' => [
                [
                    'AssetId' => '<string>',
                    'Bucket' => '<string>',
                    'Key' => '<string>',
                ],
                // ...
            ],
            'DataSetId' => '<string>',
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256',
            ],
            'RevisionId' => '<string>',
        ],
        'ImportAssetFromSignedUrl' => [
            'AssetName' => '<string>',
            'DataSetId' => '<string>',
            'Md5Hash' => '<string>',
            'RevisionId' => '<string>',
            'SignedUrl' => '<string>',
            'SignedUrlExpiresAt' => <DateTime>,
        ],
        'ImportAssetsFromS3' => [
            'AssetSources' => [
                [
                    'Bucket' => '<string>',
                    'Key' => '<string>',
                ],
                // ...
            ],
            'DataSetId' => '<string>',
            'RevisionId' => '<string>',
        ],
    ],
    'Errors' => [
        [
            'Code' => 'ACCESS_DENIED_EXCEPTION|INTERNAL_SERVER_EXCEPTION|MALWARE_DETECTED|RESOURCE_NOT_FOUND_EXCEPTION|SERVICE_QUOTA_EXCEEDED_EXCEPTION|VALIDATION_EXCEPTION|MALWARE_SCAN_ENCRYPTED_FILE',
            'Details' => [
                'ImportAssetFromSignedUrlJobErrorDetails' => [
                    'AssetName' => '<string>',
                ],
                'ImportAssetsFromS3JobErrorDetails' => [
                    [
                        'Bucket' => '<string>',
                        'Key' => '<string>',
                    ],
                    // ...
                ],
            ],
            'LimitName' => 'Assets per revision|Asset size in GB',
            'LimitValue' => <float>,
            'Message' => '<string>',
            'ResourceId' => '<string>',
            'ResourceType' => 'REVISION|ASSET',
        ],
        // ...
    ],
    'Id' => '<string>',
    'State' => 'WAITING|IN_PROGRESS|ERROR|COMPLETED|CANCELLED|TIMED_OUT',
    'Type' => 'IMPORT_ASSETS_FROM_S3|IMPORT_ASSET_FROM_SIGNED_URL|EXPORT_ASSETS_TO_S3|EXPORT_ASSET_TO_SIGNED_URL',
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
  • Type: string

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Details
  • Type: ResponseDetails structure

Details for the response.

Errors
  • Type: Array of JobError structures
Id
  • Type: string

A unique identifier.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Errors

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

GetRevision

$result = $client->getRevision([/* ... */]);
$promise = $client->getRevisionAsync([/* ... */]);

This operation returns information about a revision.

Parameter Syntax

$result = $client->getRevision([
    'DataSetId' => '<string>', // REQUIRED
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
DataSetId
  • Required: Yes
  • Type: string
RevisionId
  • Required: Yes
  • Type: string

Result Syntax

[
    'Arn' => '<string>',
    'Comment' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Finalized' => true || false,
    'Id' => '<string>',
    'SourceId' => '<string>',
    'Tags' => ['<string>', ...],
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
  • Type: string

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

DataSetId
  • Type: string

A unique identifier.

Finalized
  • Type: boolean
Id
  • Type: string

A unique identifier.

SourceId
  • Type: string

A unique identifier.

Tags
  • Type: Associative array of custom strings keys (__string) to strings
UpdatedAt
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Errors

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

ListDataSetRevisions

$result = $client->listDataSetRevisions([/* ... */]);
$promise = $client->listDataSetRevisionsAsync([/* ... */]);

This operation lists a data set's revisions sorted by CreatedAt in descending order.

Parameter Syntax

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

Parameter Details

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

Result Syntax

[
    'NextToken' => '<string>',
    'Revisions' => [
        [
            'Arn' => '<string>',
            'Comment' => '<string>',
            'CreatedAt' => <DateTime>,
            'DataSetId' => '<string>',
            'Finalized' => true || false,
            'Id' => '<string>',
            'SourceId' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The token value retrieved from a previous call to access the next page of results.

Revisions
  • Type: Array of RevisionEntry structures

Errors

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

ListDataSets

$result = $client->listDataSets([/* ... */]);
$promise = $client->listDataSetsAsync([/* ... */]);

This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.

Parameter Syntax

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

Parameter Details

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

Result Syntax

[
    'DataSets' => [
        [
            'Arn' => '<string>',
            'AssetType' => 'S3_SNAPSHOT',
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'Origin' => 'OWNED|ENTITLED',
            'OriginDetails' => [
                'ProductId' => '<string>',
            ],
            'SourceId' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
DataSets
  • Type: Array of DataSetEntry structures
NextToken
  • Type: string

The token value retrieved from a previous call to access the next page of results.

Errors

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

ListJobs

$result = $client->listJobs([/* ... */]);
$promise = $client->listJobsAsync([/* ... */]);

This operation lists your jobs sorted by CreatedAt in descending order.

Parameter Syntax

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

Parameter Details

Members
DataSetId
  • Type: string
MaxResults
  • Type: int
NextToken
  • Type: string
RevisionId
  • Type: string

Result Syntax

[
    'Jobs' => [
        [
            'Arn' => '<string>',
            'CreatedAt' => <DateTime>,
            'Details' => [
                'ExportAssetToSignedUrl' => [
                    'AssetId' => '<string>',
                    'DataSetId' => '<string>',
                    'RevisionId' => '<string>',
                    'SignedUrl' => '<string>',
                    'SignedUrlExpiresAt' => <DateTime>,
                ],
                'ExportAssetsToS3' => [
                    'AssetDestinations' => [
                        [
                            'AssetId' => '<string>',
                            'Bucket' => '<string>',
                            'Key' => '<string>',
                        ],
                        // ...
                    ],
                    'DataSetId' => '<string>',
                    'Encryption' => [
                        'KmsKeyArn' => '<string>',
                        'Type' => 'aws:kms|AES256',
                    ],
                    'RevisionId' => '<string>',
                ],
                'ImportAssetFromSignedUrl' => [
                    'AssetName' => '<string>',
                    'DataSetId' => '<string>',
                    'Md5Hash' => '<string>',
                    'RevisionId' => '<string>',
                    'SignedUrl' => '<string>',
                    'SignedUrlExpiresAt' => <DateTime>,
                ],
                'ImportAssetsFromS3' => [
                    'AssetSources' => [
                        [
                            'Bucket' => '<string>',
                            'Key' => '<string>',
                        ],
                        // ...
                    ],
                    'DataSetId' => '<string>',
                    'RevisionId' => '<string>',
                ],
            ],
            'Errors' => [
                [
                    'Code' => 'ACCESS_DENIED_EXCEPTION|INTERNAL_SERVER_EXCEPTION|MALWARE_DETECTED|RESOURCE_NOT_FOUND_EXCEPTION|SERVICE_QUOTA_EXCEEDED_EXCEPTION|VALIDATION_EXCEPTION|MALWARE_SCAN_ENCRYPTED_FILE',
                    'Details' => [
                        'ImportAssetFromSignedUrlJobErrorDetails' => [
                            'AssetName' => '<string>',
                        ],
                        'ImportAssetsFromS3JobErrorDetails' => [
                            [
                                'Bucket' => '<string>',
                                'Key' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'LimitName' => 'Assets per revision|Asset size in GB',
                    'LimitValue' => <float>,
                    'Message' => '<string>',
                    'ResourceId' => '<string>',
                    'ResourceType' => 'REVISION|ASSET',
                ],
                // ...
            ],
            'Id' => '<string>',
            'State' => 'WAITING|IN_PROGRESS|ERROR|COMPLETED|CANCELLED|TIMED_OUT',
            'Type' => 'IMPORT_ASSETS_FROM_S3|IMPORT_ASSET_FROM_SIGNED_URL|EXPORT_ASSETS_TO_S3|EXPORT_ASSET_TO_SIGNED_URL',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Jobs
  • Type: Array of JobEntry structures
NextToken
  • Type: string

The token value retrieved from a previous call to access the next page of results.

Errors

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

ListRevisionAssets

$result = $client->listRevisionAssets([/* ... */]);
$promise = $client->listRevisionAssetsAsync([/* ... */]);

This operation lists a revision's assets sorted alphabetically in descending order.

Parameter Syntax

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

Parameter Details

Members
DataSetId
  • Required: Yes
  • Type: string
MaxResults
  • Type: int
NextToken
  • Type: string
RevisionId
  • Required: Yes
  • Type: string

Result Syntax

[
    'Assets' => [
        [
            'Arn' => '<string>',
            'AssetDetails' => [
                'S3SnapshotAsset' => [
                    'Size' => <float>,
                ],
            ],
            'AssetType' => 'S3_SNAPSHOT',
            'CreatedAt' => <DateTime>,
            'DataSetId' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'RevisionId' => '<string>',
            'SourceId' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Assets
  • Type: Array of AssetEntry structures
NextToken
  • Type: string

The token value retrieved from a previous call to access the next page of results.

Errors

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

ListTagsForResource

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

This operation lists the tags on the resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

Result Syntax

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

Result Details

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

Errors

There are no errors described for this operation.

StartJob

$result = $client->startJob([/* ... */]);
$promise = $client->startJobAsync([/* ... */]);

This operation starts a job.

Parameter Syntax

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

Parameter Details

Members
JobId
  • Required: Yes
  • Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

  • AccessDeniedException:

    Access to the resource is denied.

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ConflictException:

    The request couldn't be completed because it conflicted with the current state of the resource.

TagResource

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

This operation tags a resource.

Parameter Syntax

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

Parameter Details

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

UntagResource

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

This operation removes one or more tags from a resource.

Parameter Syntax

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

Parameter Details

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

UpdateAsset

$result = $client->updateAsset([/* ... */]);
$promise = $client->updateAssetAsync([/* ... */]);

This operation updates an asset.

Parameter Syntax

$result = $client->updateAsset([
    'AssetId' => '<string>', // REQUIRED
    'DataSetId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AssetId
  • Required: Yes
  • Type: string
DataSetId
  • Required: Yes
  • Type: string
Name
  • Required: Yes
  • Type: string

The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.

RevisionId
  • Required: Yes
  • Type: string

Result Syntax

[
    'Arn' => '<string>',
    'AssetDetails' => [
        'S3SnapshotAsset' => [
            'Size' => <float>,
        ],
    ],
    'AssetType' => 'S3_SNAPSHOT',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'RevisionId' => '<string>',
    'SourceId' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
  • Type: string

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

AssetDetails
  • Type: AssetDetails structure
AssetType
  • Type: string

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

DataSetId
  • Type: string

A unique identifier.

Id
  • Type: string

A unique identifier.

Name
  • Type: string

The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.

RevisionId
  • Type: string

A unique identifier.

SourceId
  • Type: string

A unique identifier.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Errors

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

  • AccessDeniedException:

    Access to the resource is denied.

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ConflictException:

    The request couldn't be completed because it conflicted with the current state of the resource.

UpdateDataSet

$result = $client->updateDataSet([/* ... */]);
$promise = $client->updateDataSetAsync([/* ... */]);

This operation updates a data set.

Parameter Syntax

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

Parameter Details

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

The description for the data set.

Name
  • Type: string

The name of the data set.

Result Syntax

[
    'Arn' => '<string>',
    'AssetType' => 'S3_SNAPSHOT',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'Origin' => 'OWNED|ENTITLED',
    'OriginDetails' => [
        'ProductId' => '<string>',
    ],
    'SourceId' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
  • Type: string

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

AssetType
  • Type: string

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Description
  • Type: string

A description of a resource.

Id
  • Type: string

A unique identifier.

Name
  • Type: string
The name of the model.
Origin
  • Type: string

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers). When an owned data set is published in a product, AWS Data Exchange creates a copy of the data set. Subscribers can access that copy of the data set as an entitled data set.

OriginDetails
  • Type: OriginDetails structure
SourceId
  • Type: string

A unique identifier.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Errors

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

  • AccessDeniedException:

    Access to the resource is denied.

UpdateRevision

$result = $client->updateRevision([/* ... */]);
$promise = $client->updateRevisionAsync([/* ... */]);

This operation updates a revision.

Parameter Syntax

$result = $client->updateRevision([
    'Comment' => '<string>',
    'DataSetId' => '<string>', // REQUIRED
    'Finalized' => true || false,
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Comment
  • Type: string

An optional comment about the revision.

DataSetId
  • Required: Yes
  • Type: string
Finalized
  • Type: boolean

Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

RevisionId
  • Required: Yes
  • Type: string

Result Syntax

[
    'Arn' => '<string>',
    'Comment' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Finalized' => true || false,
    'Id' => '<string>',
    'SourceId' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Members
Arn
  • Type: string

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

DataSetId
  • Type: string

A unique identifier.

Finalized
  • Type: boolean
Id
  • Type: string

A unique identifier.

SourceId
  • Type: string

A unique identifier.

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

Dates and times in AWS Data Exchange are recorded in ISO 8601 format.

Errors

  • ValidationException:

    The request was invalid.

  • InternalServerException:

    An exception occurred with the service.

  • AccessDeniedException:

    Access to the resource is denied.

  • ResourceNotFoundException:

    The resource couldn't be found.

  • ThrottlingException:

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

  • ConflictException:

    The request couldn't be completed because it conflicted with the current state of the resource.

Shapes

AccessDeniedException

Description

Access to the resource is denied.

Members
Message
  • Required: Yes
  • Type: string

Access to the resource is denied.

AssetDestinationEntry

Description

The destination for the asset.

Members
AssetId
  • Required: Yes
  • Type: string

The unique identifier for the asset.

Bucket
  • Required: Yes
  • Type: string

The S3 bucket that is the destination for the asset.

Key
  • Type: string

The name of the object in Amazon S3 for the asset.

AssetDetails

Members
S3SnapshotAsset
  • Type: S3SnapshotAsset structure

The S3 object that is the asset.

AssetEntry

Description

An asset in AWS Data Exchange is a piece of data that can be stored as an S3 object. The asset can be a structured data file, an image file, or some other data file. When you create an import job for your files, you create an asset in AWS Data Exchange for each of those files.

Members
Arn
  • Required: Yes
  • Type: string

The ARN for the asset.

AssetDetails
  • Required: Yes
  • Type: AssetDetails structure

Information about the asset, including its size.

AssetType
  • Required: Yes
  • Type: string

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

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

The date and time that the asset was created, in ISO 8601 format.

DataSetId
  • Required: Yes
  • Type: string

The unique identifier for the data set associated with this asset.

Id
  • Required: Yes
  • Type: string

The unique identifier for the asset.

Name
  • Required: Yes
  • Type: string

The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.

RevisionId
  • Required: Yes
  • Type: string

The unique identifier for the revision associated with this asset.

SourceId
  • Type: string

The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

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

The date and time that the asset was last updated, in ISO 8601 format.

AssetSourceEntry

Description

The source of the assets.

Members
Bucket
  • Required: Yes
  • Type: string

The S3 bucket that's part of the source of the asset.

Key
  • Required: Yes
  • Type: string

The name of the object in Amazon S3 for the asset.

ConflictException

Description

The request couldn't be completed because it conflicted with the current state of the resource.

Members
Message
  • Required: Yes
  • Type: string

The request couldn't be completed because it conflicted with the current state of the resource.

ResourceId
  • Type: string

The unique identifier for the resource with the conflict.

ResourceType
  • Type: string

The type of the resource with the conflict.

DataSetEntry

Description

A data set is an AWS resource with one or more revisions.

Members
Arn
  • Required: Yes
  • Type: string

The ARN for the data set.

AssetType
  • Required: Yes
  • Type: string

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

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

The date and time that the data set was created, in ISO 8601 format.

Description
  • Required: Yes
  • Type: string

The description for the data set.

Id
  • Required: Yes
  • Type: string

The unique identifier for the data set.

Name
  • Required: Yes
  • Type: string

The name of the data set.

Origin
  • Required: Yes
  • Type: string

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

OriginDetails
  • Type: OriginDetails structure

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

SourceId
  • Type: string

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

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

The date and time that the data set was last updated, in ISO 8601 format.

Details

Members
ImportAssetFromSignedUrlJobErrorDetails
  • Type: ImportAssetFromSignedUrlJobErrorDetails structure
ImportAssetsFromS3JobErrorDetails
  • Type: Array of AssetSourceEntry structures

The list of sources for the assets.

ExportAssetToSignedUrlRequestDetails

Description

Details of the operation to be performed by the job.

Members
AssetId
  • Required: Yes
  • Type: string

The unique identifier for the asset that is exported to a signed URL.

DataSetId
  • Required: Yes
  • Type: string

The unique identifier for the data set associated with this export job.

RevisionId
  • Required: Yes
  • Type: string

The unique identifier for the revision associated with this export request.

ExportAssetToSignedUrlResponseDetails

Description

The details of the export to signed URL response.

Members
AssetId
  • Required: Yes
  • Type: string

The unique identifier for the asset associated with this export job.

DataSetId
  • Required: Yes
  • Type: string

The unique identifier for the data set associated with this export job.

RevisionId
  • Required: Yes
  • Type: string

The unique identifier for the revision associated with this export response.

SignedUrl
  • Type: string

The signed URL for the export request.

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

The date and time that the signed URL expires, in ISO 8601 format.

ExportAssetsToS3RequestDetails

Description

Details of the operation to be performed by the job.

Members
AssetDestinations
  • Required: Yes
  • Type: Array of AssetDestinationEntry structures

The destination for the asset.

DataSetId
  • Required: Yes
  • Type: string

The unique identifier for the data set associated with this export job.

Encryption
  • Type: ExportServerSideEncryption structure

Encryption configuration for the export job.

RevisionId
  • Required: Yes
  • Type: string

The unique identifier for the revision associated with this export request.

ExportAssetsToS3ResponseDetails

Description

Details about the export to Amazon S3 response.

Members
AssetDestinations
  • Required: Yes
  • Type: Array of AssetDestinationEntry structures

The destination in Amazon S3 where the asset is exported.

DataSetId
  • Required: Yes
  • Type: string

The unique identifier for the data set associated with this export job.

Encryption
  • Type: ExportServerSideEncryption structure

Encryption configuration of the export job.

RevisionId
  • Required: Yes
  • Type: string

The unique identifier for the revision associated with this export response.

ExportServerSideEncryption

Description

Encryption configuration of the export job. Includes the encryption type as well as the AWS KMS key. The KMS key is only necessary if you chose the KMS encryption type.

Members
KmsKeyArn
  • Type: string

The Amazon Resource Name (ARN) of the the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.

Type
  • Required: Yes
  • Type: string

The type of server side encryption used for encrypting the objects in Amazon S3.

ImportAssetFromSignedUrlJobErrorDetails

Members
AssetName
  • Required: Yes
  • Type: string

The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.

ImportAssetFromSignedUrlRequestDetails

Description

Details of the operation to be performed by the job.

Members
AssetName
  • Required: Yes
  • Type: string

The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.

DataSetId
  • Required: Yes
  • Type: string

The unique identifier for the data set associated with this import job.

Md5Hash
  • Required: Yes
  • Type: string

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

RevisionId
  • Required: Yes
  • Type: string

The unique identifier for the revision associated with this import request.

ImportAssetFromSignedUrlResponseDetails

Description

The details in the response for an import request, including the signed URL and other information.

Members
AssetName
  • Required: Yes
  • Type: string

The name for the asset associated with this import response.

DataSetId
  • Required: Yes
  • Type: string

The unique identifier for the data set associated with this import job.

Md5Hash
  • Type: string

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

RevisionId
  • Required: Yes
  • Type: string

The unique identifier for the revision associated with this import response.

SignedUrl
  • Type: string

The signed URL.

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

The time and date at which the signed URL expires, in ISO 8601 format.

ImportAssetsFromS3RequestDetails

Description

Details of the operation to be performed by the job.

Members
AssetSources
  • Required: Yes
  • Type: Array of AssetSourceEntry structures

Is a list of S3 bucket and object key pairs.

DataSetId
  • Required: Yes
  • Type: string

The unique identifier for the data set associated with this import job.

RevisionId
  • Required: Yes
  • Type: string

The unique identifier for the revision associated with this import request.

ImportAssetsFromS3ResponseDetails

Description

Details from an import from Amazon S3 response.

Members
AssetSources
  • Required: Yes
  • Type: Array of AssetSourceEntry structures

Is a list of Amazon S3 bucket and object key pairs.

DataSetId
  • Required: Yes
  • Type: string

The unique identifier for the data set associated with this import job.

RevisionId
  • Required: Yes
  • Type: string

The unique identifier for the revision associated with this import response.

InternalServerException

Description
An exception occurred with the service.
Members
Message
  • Required: Yes
  • Type: string
The message identifying the service exception that occurred.

JobEntry

Description
AWS Data Exchange Jobs are asynchronous import or export operations used to create or copy assets. A data set owner can both import and export as they see fit. Someone with an entitlement to a data set can only export. Jobs are deleted 90 days after they are created.
Members
Arn
  • Required: Yes
  • Type: string

The ARN for the job.

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

The date and time that the job was created, in ISO 8601 format.

Details
  • Required: Yes
  • Type: ResponseDetails structure

Details of the operation to be performed by the job, such as export destination details or import source details.

Errors
  • Type: Array of JobError structures

Errors for jobs.

Id
  • Required: Yes
  • Type: string

The unique identifier for the job.

State
  • Required: Yes
  • Type: string

The state of the job.

Type
  • Required: Yes
  • Type: string

The job type.

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

The date and time that the job was last updated, in ISO 8601 format.

JobError

Description
An error that occurred with the job request.
Members
Code
  • Required: Yes
  • Type: string
The code for the job error.
Details
  • Type: Details structure
LimitName
  • Type: string

The name of the limit that was reached.

LimitValue
  • Type: double
The value of the exceeded limit.
Message
  • Required: Yes
  • Type: string
The message related to the job error.
ResourceId
  • Type: string
The unique identifier for the resource related to the error.
ResourceType
  • Type: string
The type of resource related to the error.

OriginDetails

Members
ProductId
  • Required: Yes
  • Type: string

RequestDetails

Description

The details for the request.

Members
ExportAssetToSignedUrl
  • Type: ExportAssetToSignedUrlRequestDetails structure

Details about the export to signed URL request.

ExportAssetsToS3
  • Type: ExportAssetsToS3RequestDetails structure

Details about the export to Amazon S3 request.

ImportAssetFromSignedUrl
  • Type: ImportAssetFromSignedUrlRequestDetails structure

Details about the import from signed URL request.

ImportAssetsFromS3
  • Type: ImportAssetsFromS3RequestDetails structure

Details about the import from Amazon S3 request.

ResourceNotFoundException

Description

The resource couldn't be found.

Members
Message
  • Required: Yes
  • Type: string

The resource couldn't be found.

ResourceId
  • Type: string

The unique identifier for the resource that couldn't be found.

ResourceType
  • Type: string

The type of resource that couldn't be found.

ResponseDetails

Description

Details for the response.

Members
ExportAssetToSignedUrl
  • Type: ExportAssetToSignedUrlResponseDetails structure

Details for the export to signed URL response.

ExportAssetsToS3
  • Type: ExportAssetsToS3ResponseDetails structure

Details for the export to Amazon S3 response.

ImportAssetFromSignedUrl
  • Type: ImportAssetFromSignedUrlResponseDetails structure

Details for the import from signed URL response.

ImportAssetsFromS3
  • Type: ImportAssetsFromS3ResponseDetails structure

Details for the import from Amazon S3 response.

RevisionEntry

Description

A revision is a container for one or more assets.

Members
Arn
  • Required: Yes
  • Type: string

The ARN for the revision.

Comment
  • Type: string

An optional comment about the revision.

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

The date and time that the revision was created, in ISO 8601 format.

DataSetId
  • Required: Yes
  • Type: string

The unique identifier for the data set associated with this revision.

Finalized
  • Type: boolean

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

Id
  • Required: Yes
  • Type: string

The unique identifier for the revision.

SourceId
  • Type: string

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

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

The date and time that the revision was last updated, in ISO 8601 format.

S3SnapshotAsset

Description

The S3 object that is the asset.

Members
Size
  • Required: Yes
  • Type: double

The size of the S3 object that is the object.

ServiceLimitExceededException

Description

The request has exceeded the quotas imposed by the service.

Members
LimitName
  • Type: string
LimitValue
  • Type: double
Message
  • Required: Yes
  • Type: string

ThrottlingException

Description

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

Members
Message
  • Required: Yes
  • Type: string

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

ValidationException

Description

The request was invalid.

Members
Message
  • Required: Yes
  • Type: string

The message that informs you about what was invalid about the request.

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