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

  • AbstractModel
  • ApiProvider
  • DateTimeResult
  • DocModel
  • ListShape
  • MapShape
  • Operation
  • Service
  • Shape
  • ShapeMap
  • StructureShape
  • TimestampShape
  • Validator

Class Service

Aws\Api\AbstractModel implements ArrayAccess
Extended by Aws\Api\Service
Namespace: Aws\Api
Located at Api/Service.php

Represents a web service API model.

Methods Summary

  • __construct ( array $definition, callable $provider )
  • static createSerializer ( Aws\Api\Service $api, string $endpoint )

    Creates a request serializer for the provided API object.

  • static createErrorParser ( string $protocol, Aws\Api\Service $api = null )

    Creates an error parser for the given protocol.

  • static createParser ( Aws\Api\Service $api )

    Applies the listeners needed to parse client models.

  • getServiceFullName ( )

    Get the full name of the service

  • getServiceId ( )

    Get the service id

  • getApiVersion ( )

    Get the API version of the service

  • getEndpointPrefix ( )

    Get the API version of the service

  • getSigningName ( )

    Get the signing name used by the service.

  • getServiceName ( )

    Get the service name.

  • getSignatureVersion ( )

    Get the default signature version of the service.

  • getProtocol ( )

    Get the protocol used by the service.

  • getUid ( )

    Get the uid string used by the service

  • hasOperation ( string $name )

    Check if the description has a specific operation by name.

  • getOperation ( string $name )

    Get an operation by name.

  • getOperations ( )

    Get all of the operations of the description.

  • getErrorShapes ( )

    Get all of the error shapes of the service

  • getMetadata ( string|null $key = null )

    Get all of the service metadata or a specific metadata key value.

  • getPaginators ( )

    Gets an associative array of available paginator configurations where the key is the name of the paginator, and the value is the paginator configuration.

  • hasPaginator ( string $name )

    Determines if the service has a paginator by name.

  • getPaginatorConfig ( string $name )

    Retrieve a paginator by name.

  • getWaiters ( )

    Gets an associative array of available waiter configurations where the key is the name of the waiter, and the value is the waiter configuration.

  • hasWaiter ( string $name )

    Determines if the service has a waiter by name.

  • getWaiterConfig ( string $name )

    Get a waiter configuration by name.

  • getShapeMap ( )

    Get the shape map used by the API.

  • getClientContextParams ( )

    Get all the context params of the description.

  • getProvider ( )

    Get the service's api provider.

  • getDefinition ( )

    Get the service's definition.

Methods inherited from Aws\Api\AbstractModel

offsetExists(), offsetGet(), offsetSet(), offsetUnset(), toArray()

Methods Details

__construct ( array $definition, callable $provider )

Parameters

array $definition
callable $provider

Overrides

Aws\Api\AbstractModel::__construct

static callable createSerializer ( Aws\Api\Service $api, string $endpoint )

Creates a request serializer for the provided API object.

Parameters

Aws\Api\Service $api API that contains a protocol.
string $endpoint Endpoint to send requests to.

Returns

callable

Exceptions

UnexpectedValueException

static callable createErrorParser ( string $protocol, Aws\Api\Service $api = null )

Creates an error parser for the given protocol.

Redundant method signature to preserve backwards compatibility.

Parameters

string $protocol Protocol to parse (e.g., query, json, etc.)
Aws\Api\Service $api = null

Returns

callable

Exceptions

UnexpectedValueException

static callable createParser ( Aws\Api\Service $api )

Applies the listeners needed to parse client models.

Parameters

Aws\Api\Service $api API to create a parser for

Returns

callable

Exceptions

UnexpectedValueException

string getServiceFullName ( )

Get the full name of the service

Returns

string

string getServiceId ( )

Get the service id

Returns

string

string getApiVersion ( )

Get the API version of the service

Returns

string

string getEndpointPrefix ( )

Get the API version of the service

Returns

string

string getSigningName ( )

Get the signing name used by the service.

Returns

string

string getServiceName ( )

Get the service name.

Returns

string

string getSignatureVersion ( )

Get the default signature version of the service.

Note: this method assumes "v4" when not specified in the model.

Returns

string

string getProtocol ( )

Get the protocol used by the service.

Returns

string

string getUid ( )

Get the uid string used by the service

Returns

string

boolean hasOperation ( string $name )

Check if the description has a specific operation by name.

Parameters

string $name Operation to check by name

Returns

boolean

Aws\Api\Operation getOperation ( string $name )

Get an operation by name.

Parameters

string $name Operation to retrieve by name

Returns

Aws\Api\Operation

Exceptions

InvalidArgumentException
If the operation is not found

Aws\Api\Operation[] getOperations ( )

Get all of the operations of the description.

Returns

Aws\Api\Operation[]

array getErrorShapes ( )

Get all of the error shapes of the service

Returns

array

mixed getMetadata ( string|null $key = null )

Get all of the service metadata or a specific metadata key value.

Parameters

string|null $key = null Key to retrieve or null to retrieve all metadata

Returns

mixed
Returns the result or null if the key is not found

array getPaginators ( )

Gets an associative array of available paginator configurations where the key is the name of the paginator, and the value is the paginator configuration.

Returns

array

Unstable

The configuration format of paginators may change in the future

boolean hasPaginator ( string $name )

Determines if the service has a paginator by name.

Parameters

string $name Name of the paginator.

Returns

boolean

array getPaginatorConfig ( string $name )

Retrieve a paginator by name.

Parameters

string $name

Paginator to retrieve by name. This argument is typically the operation name.

Returns

array

Exceptions

UnexpectedValueException
if the paginator does not exist.

Unstable

The configuration format of paginators may change in the future

array getWaiters ( )

Gets an associative array of available waiter configurations where the key is the name of the waiter, and the value is the waiter configuration.

Returns

array

boolean hasWaiter ( string $name )

Determines if the service has a waiter by name.

Parameters

string $name Name of the waiter.

Returns

boolean

array getWaiterConfig ( string $name )

Get a waiter configuration by name.

Parameters

string $name Name of the waiter by name.

Returns

array

Exceptions

UnexpectedValueException
if the waiter does not exist.

Aws\Api\ShapeMap getShapeMap ( )

Get the shape map used by the API.

Returns

Aws\Api\ShapeMap

array getClientContextParams ( )

Get all the context params of the description.

Returns

array

callable getProvider ( )

Get the service's api provider.

Returns

callable

callable getDefinition ( )

Get the service's definition.

Returns

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