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

Namespaces

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

Classes

  • BatchDelete
  • GetBucketLocationParser
  • MultipartUploader
  • ObjectCopier
  • ObjectUploader
  • PostObject
  • PostObjectV4
  • S3Client
  • S3MultiRegionClient
  • S3UriParser
  • StreamWrapper
  • Transfer
  • ValidateResponseChecksumParser

Interfaces

  • S3ClientInterface

Traits

  • CalculatesChecksumTrait
  • MultipartUploadingTrait
  • S3ClientTrait

Class S3Client

Aws\AwsClient implements Aws\AwsClientInterface uses Aws\AwsClientTrait
Extended by Aws\S3\S3Client implements Aws\S3\S3ClientInterface uses Aws\S3\S3ClientTrait
Namespace: Aws\S3
Located at S3/S3Client.php

Client used to interact with Amazon Simple Storage Service (Amazon S3).

Supported API Versions

This class uses a service description model that is associated at runtime based on the version option given when constructing the client. The version option will determine which API operations, waiters, and paginators are available for a client. Creating a command or a specific API operation can be done using magic methods (e.g., $client->commandName(/** parameters */), or using the $\client->getCommand method of the client.

  • 2006-03-01

      AbortMultipartUpload
      CompleteMultipartUpload
      CopyObject
      CreateBucket
      CreateMultipartUpload
      DeleteBucket
      DeleteBucketAnalyticsConfiguration
      DeleteBucketCors
      DeleteBucketEncryption
      DeleteBucketIntelligentTieringConfiguration
      DeleteBucketInventoryConfiguration
      DeleteBucketLifecycle
      DeleteBucketMetricsConfiguration
      DeleteBucketOwnershipControls
      DeleteBucketPolicy
      DeleteBucketReplication
      DeleteBucketTagging
      DeleteBucketWebsite
      DeleteObject
      DeleteObjectTagging
      DeleteObjects
      DeletePublicAccessBlock
      GetBucketAccelerateConfiguration
      GetBucketAcl
      GetBucketAnalyticsConfiguration
      GetBucketCors
      GetBucketEncryption
      GetBucketIntelligentTieringConfiguration
      GetBucketInventoryConfiguration
      GetBucketLifecycle
      GetBucketLifecycleConfiguration
      GetBucketLocation
      GetBucketLogging
      GetBucketMetricsConfiguration
      GetBucketNotification
      GetBucketNotificationConfiguration
      GetBucketOwnershipControls
      GetBucketPolicy
      GetBucketPolicyStatus
      GetBucketReplication
      GetBucketRequestPayment
      GetBucketTagging
      GetBucketVersioning
      GetBucketWebsite
      GetObject
      GetObjectAcl
      GetObjectAttributes
      GetObjectLegalHold
      GetObjectLockConfiguration
      GetObjectRetention
      GetObjectTagging
      GetObjectTorrent
      GetPublicAccessBlock
      HeadBucket
      HeadObject
      ListBucketAnalyticsConfigurations
      ListBucketIntelligentTieringConfigurations
      ListBucketInventoryConfigurations
      ListBucketMetricsConfigurations
      ListBuckets
      ListMultipartUploads
      ListObjectVersions
      ListObjects
      ListObjectsV2
      ListParts
      PutBucketAccelerateConfiguration
      PutBucketAcl
      PutBucketAnalyticsConfiguration
      PutBucketCors
      PutBucketEncryption
      PutBucketIntelligentTieringConfiguration
      PutBucketInventoryConfiguration
      PutBucketLifecycle
      PutBucketLifecycleConfiguration
      PutBucketLogging
      PutBucketMetricsConfiguration
      PutBucketNotification
      PutBucketNotificationConfiguration
      PutBucketOwnershipControls
      PutBucketPolicy
      PutBucketReplication
      PutBucketRequestPayment
      PutBucketTagging
      PutBucketVersioning
      PutBucketWebsite
      PutObject
      PutObjectAcl
      PutObjectLegalHold
      PutObjectLockConfiguration
      PutObjectRetention
      PutObjectTagging
      PutPublicAccessBlock
      RestoreObject
      SelectObjectContent
      UploadPart
      UploadPartCopy
      WriteGetObjectResponse

Methods Summary

  • static getArguments ( )

    Get an array of client constructor arguments used by the client.

  • __construct ( array $args )

    The client constructor accepts the following options:

  • static isBucketDnsCompatible ( string $bucket )

    Determine if a string is a valid name for a DNS compatible Amazon S3 bucket.

  • static _apply_use_arn_region ( $value, array & $args, Aws\HandlerList $list )
  • createPresignedRequest ( Aws\CommandInterface $command, int|string|\DateTimeInterface $expires, array $options = [] )

    Create a pre-signed URL for the given S3 command object.

  • getObjectUrl ( string $bucket, string $key )

    Returns the URL to an object identified by its bucket and key.

  • static encodeKey ( string $key )

    Raw URL encode a key and allow for '/' characters

Methods inherited from Aws\AwsClient

__sleep(), applyDocFilters(), factory(), getApi(), getClientBuiltIns(), getClientContextParams(), getCommand(), getConfig(), getCredentials(), getEndpoint(), getEndpointProvider(), getEndpointProviderArgs(), getHandlerList(), getRegion(), getSignatureProvider()

Methods inherited from Aws\AwsClientInterface

__call(), execute(), executeAsync(), getIterator(), getPaginator(), getWaiter(), waitUntil()

Methods inherited from Aws\S3\S3ClientInterface

copy(), copyAsync(), deleteMatchingObjects(), deleteMatchingObjectsAsync(), determineBucketRegion(), determineBucketRegionAsync(), doesBucketExist(), doesBucketExistV2(), doesObjectExist(), doesObjectExistV2(), downloadBucket(), downloadBucketAsync(), registerStreamWrapper(), registerStreamWrapperV2(), upload(), uploadAsync(), uploadDirectory(), uploadDirectoryAsync()

Methods used from Aws\S3\S3ClientTrait

copy(), copyAsync(), deleteMatchingObjects(), deleteMatchingObjectsAsync(), determineBucketRegion(), determineBucketRegionAsync(), doesBucketExist(), doesBucketExistV2(), doesObjectExist(), doesObjectExistV2(), downloadBucket(), downloadBucketAsync(), execute(), getCommand(), getHandlerList(), getIterator(), registerStreamWrapper(), registerStreamWrapperV2(), upload(), uploadAsync(), uploadDirectory(), uploadDirectoryAsync()

Methods used from Aws\AwsClientTrait

__call(), executeAsync(), getPaginator(), getWaiter(), waitUntil()

Methods Details

static array getArguments ( )

Get an array of client constructor arguments used by the client.

Returns

array

Overrides

Aws\AwsClient::getArguments

__construct ( array $args )

The client constructor accepts the following options:

In addition to the options available to Aws\AwsClient::__construct, S3Client accepts the following options:

  • bucket_endpoint: (bool) Set to true to send requests to a hardcoded bucket endpoint rather than create an endpoint as a result of injecting the bucket into the URL. This option is useful for interacting with CNAME endpoints. Note: if you are using version 2.243.0 and above and do not expect the bucket name to appear in the host, you will also need to set use_path_style_endpoint to true.
  • calculate_md5: (bool) Set to false to disable calculating an MD5 for all Amazon S3 signed uploads.
  • s3_us_east_1_regional_endpoint: (Aws\S3\RegionalEndpoint\ConfigurationInterface|Aws\CacheInterface|callable|string|array) Specifies whether to use regional or legacy endpoints for the us-east-1 region. Provide an Aws\S3\RegionalEndpoint\ConfigurationInterface object, an instance of Aws\CacheInterface, a callable configuration provider used to create endpoint configuration, a string value of legacy or regional, or an associative array with the following keys: endpoint_types: (string) Set to legacy or regional, defaults to legacy
  • use_accelerate_endpoint: (bool) Set to true to send requests to an S3 Accelerate endpoint by default. Can be enabled or disabled on individual operations by setting '@use_accelerate_endpoint' to true or false. Note: you must enable S3 Accelerate on a bucket before it can be accessed via an Accelerate endpoint.
  • use_arn_region: (Aws\S3\UseArnRegion\ConfigurationInterface, Aws\CacheInterface, bool, callable) Set to true to enable the client to use the region from a supplied ARN argument instead of the client's region. Provide an instance of Aws\S3\UseArnRegion\ConfigurationInterface, an instance of Aws\CacheInterface, a callable that provides a promise for a Configuration object, or a boolean value. Defaults to false (i.e. the SDK will not follow the ARN region if it conflicts with the client region and instead throw an error).
  • use_dual_stack_endpoint: (bool) Set to true to send requests to an S3 Dual Stack endpoint by default, which enables IPv6 Protocol. Can be enabled or disabled on individual operations by setting '@use_dual_stack_endpoint\' to true or false. Note: you cannot use it together with an accelerate endpoint.
  • use_path_style_endpoint: (bool) Set to true to send requests to an S3 path style endpoint by default. Can be enabled or disabled on individual operations by setting '@use_path_style_endpoint\' to true or false. Note: you cannot use it together with an accelerate endpoint.
  • disable_multiregion_access_points: (bool) Set to true to disable sending multi region requests. They are enabled by default. Can be enabled or disabled on individual operations by setting '@disable_multiregion_access_points\' to true or false. Note: you cannot use it together with an accelerate or dualstack endpoint.

Parameters

array $args

Exceptions

InvalidArgumentException

if any required options are missing or the service is not supported.

Overrides

Aws\AwsClient::__construct

static boolean isBucketDnsCompatible ( string $bucket )

Determine if a string is a valid name for a DNS compatible Amazon S3 bucket.

DNS compatible bucket names can be used as a subdomain in a URL (e.g., ".s3.amazonaws.com").

Parameters

string $bucket Bucket name to check.

Returns

boolean

static _apply_use_arn_region ( $value, array & $args, Aws\HandlerList $list )

Psr\Http\Message\RequestInterface createPresignedRequest ( Aws\CommandInterface $command, integer|string|DateTimeInterface $expires, array $options = [] )

Create a pre-signed URL for the given S3 command object.

Parameters

Aws\CommandInterface $command

Command to create a pre-signed URL for.

integer|string|DateTimeInterface $expires

The time at which the URL should expire. This can be a Unix timestamp, a PHP DateTime object, or a string that can be evaluated by strtotime().

array $options = []

Returns

Psr\Http\Message\RequestInterface

Implementation of

Aws\S3\S3ClientInterface::createPresignedRequest()

string getObjectUrl ( string $bucket, string $key )

Returns the URL to an object identified by its bucket and key.

The URL returned by this method is not signed nor does it ensure that the bucket and key given to the method exist. If you need a signed URL, then use the \Aws\S3\S3Client::createPresignedRequest method and get the URI of the signed request.

Parameters

string $bucket The name of the bucket where the object is located
string $key The key of the object

Returns

string
The URL to the object

Implementation of

Aws\S3\S3ClientInterface::getObjectUrl()

static string encodeKey ( string $key )

Raw URL encode a key and allow for '/' characters

Parameters

string $key Key to encode

Returns

string
Returns the encoded key
AWS SDK for PHP 3.x API documentation generated by ApiGen