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
    • InternetMonitor
      • 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
    • IVSRealTime
      • 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
    • Tnb
      • 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

  • AbstractConfigurationProvider
  • AwsClient
  • ClientResolver
  • Command
  • CommandPool
  • DoctrineCacheAdapter
  • HandlerList
  • HashingStream
  • History
  • IdempotencyTokenMiddleware
  • JsonCompiler
  • LruArrayCache
  • Middleware
  • MockHandler
  • MultiRegionClient
  • PhpHash
  • PresignUrlMiddleware
  • Psr16CacheAdapter
  • PsrCacheAdapter
  • Result
  • ResultPaginator
  • Sdk
  • TraceMiddleware
  • Waiter
  • WrappedHttpHandler

Interfaces

  • AwsClientInterface
  • CacheInterface
  • CommandInterface
  • ConfigurationProviderInterface
  • HashInterface
  • MonitoringEventsInterface
  • ResponseContainerInterface
  • ResultInterface

Traits

  • AwsClientTrait
  • HasDataTrait
  • HasMonitoringEventsTrait

Functions

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

Class HandlerList

Aws\HandlerList implements Countable
Namespace: Aws
Located at HandlerList.php

Builds a single handler function from zero or more middleware functions and a handler. The handler function is then used to send command objects and return a promise that is resolved with an AWS result object.

The "front" of the list is invoked before the "end" of the list. You can add middleware to the front of the list using one of the "prepend" method, and the end of the list using one of the "append" method. The last function invoked in a handler list is the handler (a function that does not accept a next handler but rather is responsible for returning a promise that is fulfilled with an Aws\ResultInterface object).

Handlers are ordered using a "step" that describes the step at which the SDK is when sending a command. The available steps are:

  • init: The command is being initialized, allowing you to do things like add default options.
  • validate: The command is being validated before it is serialized
  • build: The command is being serialized into an HTTP request. A middleware in this step MUST serialize an HTTP request and populate the "@request" parameter of a command with the request such that it is available to subsequent middleware.
  • sign: The request is being signed and prepared to be sent over the wire.

Middleware can be registered with a name to allow you to easily add a middleware before or after another middleware by name. This also allows you to remove a middleware by name (in addition to removing by instance).

Methods Summary

  • __construct ( callable $handler = null )
  • __toString ( )

    Dumps a string representation of the list.

  • setHandler ( callable $handler )

    Set the HTTP handler that actually returns a response.

  • hasHandler ( )

    Returns true if the builder has a handler.

  • appendInit ( callable $middleware, string $name = null )

    Append a middleware to the init step.

  • prependInit ( callable $middleware, string $name = null )

    Prepend a middleware to the init step.

  • appendValidate ( callable $middleware, string $name = null )

    Append a middleware to the validate step.

  • prependValidate ( callable $middleware, string $name = null )

    Prepend a middleware to the validate step.

  • appendBuild ( callable $middleware, string $name = null )

    Append a middleware to the build step.

  • prependBuild ( callable $middleware, string $name = null )

    Prepend a middleware to the build step.

  • appendSign ( callable $middleware, string $name = null )

    Append a middleware to the sign step.

  • prependSign ( callable $middleware, string $name = null )

    Prepend a middleware to the sign step.

  • appendAttempt ( callable $middleware, string $name = null )

    Append a middleware to the attempt step.

  • prependAttempt ( callable $middleware, string $name = null )

    Prepend a middleware to the attempt step.

  • before ( string|callable $findName, string $withName, callable $middleware )

    Add a middleware before the given middleware by name.

  • after ( string|callable $findName, string $withName, callable $middleware )

    Add a middleware after the given middleware by name.

  • remove ( string|callable $nameOrInstance )

    Remove a middleware by name or by instance from the list.

  • interpose ( callable $fn = null )

    Interpose a function between each middleware (e.g., allowing for a trace through the middleware layers).

  • resolve ( )

    Compose the middleware and handler into a single callable function.

  • count ( )

Methods Details

__construct ( callable $handler = null )

Parameters

callable $handler = null HTTP handler.

string __toString ( )

Dumps a string representation of the list.

Returns

string

setHandler ( callable $handler )

Set the HTTP handler that actually returns a response.

Parameters

callable $handler

Function that accepts a request and array of options and returns a Promise.

boolean hasHandler ( )

Returns true if the builder has a handler.

Returns

boolean

appendInit ( callable $middleware, string $name = null )

Append a middleware to the init step.

Parameters

callable $middleware Middleware function to add.
string $name = null Name of the middleware.

prependInit ( callable $middleware, string $name = null )

Prepend a middleware to the init step.

Parameters

callable $middleware Middleware function to add.
string $name = null Name of the middleware.

appendValidate ( callable $middleware, string $name = null )

Append a middleware to the validate step.

Parameters

callable $middleware Middleware function to add.
string $name = null Name of the middleware.

prependValidate ( callable $middleware, string $name = null )

Prepend a middleware to the validate step.

Parameters

callable $middleware Middleware function to add.
string $name = null Name of the middleware.

appendBuild ( callable $middleware, string $name = null )

Append a middleware to the build step.

Parameters

callable $middleware Middleware function to add.
string $name = null Name of the middleware.

prependBuild ( callable $middleware, string $name = null )

Prepend a middleware to the build step.

Parameters

callable $middleware Middleware function to add.
string $name = null Name of the middleware.

appendSign ( callable $middleware, string $name = null )

Append a middleware to the sign step.

Parameters

callable $middleware Middleware function to add.
string $name = null Name of the middleware.

prependSign ( callable $middleware, string $name = null )

Prepend a middleware to the sign step.

Parameters

callable $middleware Middleware function to add.
string $name = null Name of the middleware.

appendAttempt ( callable $middleware, string $name = null )

Append a middleware to the attempt step.

Parameters

callable $middleware Middleware function to add.
string $name = null Name of the middleware.

prependAttempt ( callable $middleware, string $name = null )

Prepend a middleware to the attempt step.

Parameters

callable $middleware Middleware function to add.
string $name = null Name of the middleware.

before ( string|callable $findName, string $withName, callable $middleware )

Add a middleware before the given middleware by name.

Parameters

string|callable $findName Add before this
string $withName Optional name to give the middleware
callable $middleware Middleware to add.

after ( string|callable $findName, string $withName, callable $middleware )

Add a middleware after the given middleware by name.

Parameters

string|callable $findName Add after this
string $withName Optional name to give the middleware
callable $middleware Middleware to add.

remove ( string|callable $nameOrInstance )

Remove a middleware by name or by instance from the list.

Parameters

string|callable $nameOrInstance Middleware to remove.

interpose ( callable $fn = null )

Interpose a function between each middleware (e.g., allowing for a trace through the middleware layers).

The interpose function is a function that accepts a "step" argument as a string and a "name" argument string. This function must then return a function that accepts the next handler in the list. This function must then return a function that accepts a CommandInterface and optional RequestInterface and returns a promise that is fulfilled with an Aws\ResultInterface or rejected with an Aws\Exception\AwsException object.

Parameters

callable $fn = null Pass null to remove any previously set function

callable resolve ( )

Compose the middleware and handler into a single callable function.

Returns

callable

count ( )

Implementation of

Countable::count()

Constants summary

string INIT
# 'init'
string VALIDATE
# 'validate'
string BUILD
# 'build'
string SIGN
# 'sign'
string ATTEMPT
# 'attempt'
AWS SDK for PHP 3.x API documentation generated by ApiGen