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
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • BackupGateway
      • Exception
    • Batch
      • Exception
    • BillingConductor
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ChimeSDKIdentity
      • Exception
    • ChimeSDKMediaPipelines
      • Exception
    • ChimeSDKMeetings
      • Exception
    • ChimeSDKMessaging
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudControlApi
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchEvidently
      • Exception
    • CloudWatchLogs
      • Exception
    • CloudWatchRUM
      • 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
    • ConnectCampaignService
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • ConnectWisdomService
      • 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
    • 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
    • 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
    • IoTJobsDataPlane
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTTwinMaker
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • ivschat
      • Exception
    • Kafka
      • Exception
    • KafkaConnect
      • Exception
    • kendra
      • Exception
    • Keyspaces
      • 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
    • 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
    • MigrationHubRefactorSpaces
      • Exception
    • MigrationHubStrategyRecommendations
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • NimbleStudio
      • 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
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrometheusService
      • Exception
    • Proton
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • RecycleBin
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • Rekognition
      • Exception
    • ResilienceHub
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • 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
    • 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
    • SnowDeviceManagement
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSMContacts
      • Exception
    • SSMIncidents
      • 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
    • 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

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Account\AccountClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • Aws\AmplifyUIBuilder\AmplifyUIBuilderClient
  • 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\AppConfigData\AppConfigDataClient
  • Aws\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationCostProfiler\ApplicationCostProfilerClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\AppRunner\AppRunnerClient
  • 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\BackupGateway\BackupGatewayClient
  • Aws\Batch\BatchClient
  • Aws\BillingConductor\BillingConductorClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ChimeSDKIdentity\ChimeSDKIdentityClient
  • Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient
  • Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient
  • Aws\ChimeSDKMessaging\ChimeSDKMessagingClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudControlApi\CloudControlApiClient
  • 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\CloudWatchEvidently\CloudWatchEvidentlyClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CloudWatchRUM\CloudWatchRUMClient
  • 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\ConnectCampaignService\ConnectCampaignServiceClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\ConnectWisdomService\ConnectWisdomServiceClient
  • 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\DefaultsMode\Configuration
  • Aws\DefaultsMode\ConfigurationProvider
  • Aws\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DoctrineCacheAdapter
  • Aws\drs\drsClient
  • 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\EMRServerless\EMRServerlessClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\Endpoint\UseDualstackEndpoint\Configuration
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationProvider
  • Aws\Endpoint\UseFipsEndpoint\Configuration
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EventBridge\EventBridgeClient
  • Aws\finspace\finspaceClient
  • Aws\FinSpaceData\FinSpaceDataClient
  • Aws\Firehose\FirehoseClient
  • Aws\FIS\FISClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • Aws\GameSparks\GameSparksClient
  • 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\Inspector2\Inspector2Client
  • 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\IoTTwinMaker\IoTTwinMakerClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\ivschat\ivschatClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\KafkaConnect\KafkaConnectClient
  • Aws\kendra\kendraClient
  • Aws\Keyspaces\KeyspacesClient
  • 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\LookoutEquipment\LookoutEquipmentClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LookoutMetrics\LookoutMetricsClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\MainframeModernization\MainframeModernizationClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • Aws\ManagedGrafana\ManagedGrafanaClient
  • 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\MemoryDB\MemoryDBClient
  • Aws\mgn\mgnClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient
  • Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
  • 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\NimbleStudio\NimbleStudioClient
  • Aws\OpenSearchService\OpenSearchServiceClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Panorama\PanoramaClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrometheusService\PrometheusServiceClient
  • Aws\Proton\ProtonClient
  • 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\RecycleBin\RecycleBinClient
  • Aws\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResilienceHub\ResilienceHubClient
  • 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\Route53RecoveryCluster\Route53RecoveryClusterClient
  • Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
  • Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
  • 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\S3\ValidateResponseChecksumParser
  • 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\SnowDeviceManagement\SnowDeviceManagementClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSMContacts\SSMContactsClient
  • Aws\SSMIncidents\SSMIncidentsClient
  • 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\VoiceID\VoiceIDClient
  • 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\WorkSpacesWeb\WorkSpacesWebClient
  • 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\DefaultsMode\ConfigurationInterface
  • Aws\DynamoDb\SessionConnectionInterface
  • Aws\Endpoint\PartitionInterface
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationInterface
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationInterface
  • 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\CalculatesChecksumTrait
  • 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\Account\Exception\AccountException
  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\AmplifyUIBuilder\Exception\AmplifyUIBuilderException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\AppConfigData\Exception\AppConfigDataException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationCostProfiler\Exception\ApplicationCostProfilerException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • Aws\AppRunner\Exception\AppRunnerException
  • 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\BackupGateway\Exception\BackupGatewayException
  • Aws\Batch\Exception\BatchException
  • Aws\BillingConductor\Exception\BillingConductorException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ChimeSDKIdentity\Exception\ChimeSDKIdentityException
  • Aws\ChimeSDKMediaPipelines\Exception\ChimeSDKMediaPipelinesException
  • Aws\ChimeSDKMeetings\Exception\ChimeSDKMeetingsException
  • Aws\ChimeSDKMessaging\Exception\ChimeSDKMessagingException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudControlApi\Exception\CloudControlApiException
  • 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\CloudWatchEvidently\Exception\CloudWatchEvidentlyException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CloudWatchRUM\Exception\CloudWatchRUMException
  • 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\ConnectCampaignService\Exception\ConnectCampaignServiceException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\ConnectWisdomService\Exception\ConnectWisdomServiceException
  • 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\DefaultsMode\Exception\ConfigurationException
  • 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\drs\Exception\drsException
  • 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\EMRServerless\Exception\EMRServerlessException
  • Aws\Endpoint\UseDualstackEndpoint\Exception\ConfigurationException
  • Aws\Endpoint\UseFipsEndpoint\Exception\ConfigurationException
  • Aws\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CommonRuntimeException
  • 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\finspace\Exception\finspaceException
  • Aws\FinSpaceData\Exception\FinSpaceDataException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FIS\Exception\FISException
  • 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\GameSparks\Exception\GameSparksException
  • 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\Inspector2\Exception\Inspector2Exception
  • 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\IoTTwinMaker\Exception\IoTTwinMakerException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\ivschat\Exception\ivschatException
  • Aws\Kafka\Exception\KafkaException
  • Aws\KafkaConnect\Exception\KafkaConnectException
  • Aws\kendra\Exception\kendraException
  • Aws\Keyspaces\Exception\KeyspacesException
  • 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\LookoutEquipment\Exception\LookoutEquipmentException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\LookoutMetrics\Exception\LookoutMetricsException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\MainframeModernization\Exception\MainframeModernizationException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • Aws\ManagedGrafana\Exception\ManagedGrafanaException
  • 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\MemoryDB\Exception\MemoryDBException
  • Aws\mgn\Exception\mgnException
  • Aws\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • Aws\MigrationHubRefactorSpaces\Exception\MigrationHubRefactorSpacesException
  • Aws\MigrationHubStrategyRecommendations\Exception\MigrationHubStrategyRecommendationsException
  • 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\NimbleStudio\Exception\NimbleStudioException
  • Aws\OpenSearchService\Exception\OpenSearchServiceException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • Aws\Panorama\Exception\PanoramaException
  • 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\PinpointSMSVoiceV2\Exception\PinpointSMSVoiceV2Exception
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrometheusService\Exception\PrometheusServiceException
  • Aws\Proton\Exception\ProtonException
  • 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\RecycleBin\Exception\RecycleBinException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResilienceHub\Exception\ResilienceHubException
  • 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\Route53RecoveryCluster\Exception\Route53RecoveryClusterException
  • Aws\Route53RecoveryControlConfig\Exception\Route53RecoveryControlConfigException
  • Aws\Route53RecoveryReadiness\Exception\Route53RecoveryReadinessException
  • 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\SnowDeviceManagement\Exception\SnowDeviceManagementException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSMContacts\Exception\SSMContactsException
  • Aws\SSMIncidents\Exception\SSMIncidentsException
  • 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\VoiceID\Exception\VoiceIDException
  • 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\WorkSpacesWeb\Exception\WorkSpacesWebException
  • 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_fips_pseudo_region
  • 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\strip_fips_pseudo_regions

AWSBillingConductor 2021-07-30

Client: Aws\BillingConductor\BillingConductorClient
Service ID: billingconductor
Version: 2021-07-30

This page describes the parameters and results for the operations of the AWSBillingConductor (2021-07-30), and shows how to use the Aws\BillingConductor\BillingConductorClient object to call the described operations. This documentation is specific to the 2021-07-30 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 */).

  • AssociateAccounts ( array $params = [] )

    Connects an array of account IDs in a consolidated billing family to a predefined billing group.

  • AssociatePricingRules ( array $params = [] )

    Connects an array of PricingRuleArns to a defined PricingPlan.

  • BatchAssociateResourcesToCustomLineItem ( array $params = [] )

    Associates a batch of resources to a percentage custom line item.

  • BatchDisassociateResourcesFromCustomLineItem ( array $params = [] )

    Disassociates a batch of resources from a percentage custom line item.

  • CreateBillingGroup ( array $params = [] )

    Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation.

  • CreateCustomLineItem ( array $params = [] )

    Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period.

  • CreatePricingPlan ( array $params = [] )

    Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.

  • CreatePricingRule ( array $params = [] )

    Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.

  • DeleteBillingGroup ( array $params = [] )

    Deletes a billing group.

  • DeleteCustomLineItem ( array $params = [] )

    Deletes the custom line item identified by the given ARN in the current, or previous billing period.

  • DeletePricingPlan ( array $params = [] )

    Deletes a pricing plan.

  • DeletePricingRule ( array $params = [] )

    Deletes the pricing rule identified by the input Amazon Resource Name (ARN).

  • DisassociateAccounts ( array $params = [] )

    Removes the specified list of account IDs from the given billing group.

  • DisassociatePricingRules ( array $params = [] )

    Disassociates a list of pricing rules from a pricing plan.

  • ListAccountAssociations ( array $params = [] )

    Amazon Web Services Billing Conductor is in beta release and is subject to change.

  • ListBillingGroupCostReports ( array $params = [] )

    A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group.

  • ListBillingGroups ( array $params = [] )

    A paginated call to retrieve a list of billing groups for the given billing period.

  • ListCustomLineItems ( array $params = [] )

    A paginated call to get a list of all custom line items (FFLIs) for the given billing period.

  • ListPricingPlans ( array $params = [] )

    A paginated call to get pricing plans for the given billing period.

  • ListPricingPlansAssociatedWithPricingRule ( array $params = [] )

    A list of the pricing plans associated with a pricing rule.

  • ListPricingRules ( array $params = [] )

    Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.

  • ListPricingRulesAssociatedToPricingPlan ( array $params = [] )

    Lists the pricing rules associated with a pricing plan.

  • ListResourcesAssociatedToCustomLineItem ( array $params = [] )

    List the resources associated to a custom line item.

  • ListTagsForResource ( array $params = [] )

    A list the tags for a resource.

  • TagResource ( array $params = [] )

    Associates the specified tags to a resource with the specified resourceArn.

  • UntagResource ( array $params = [] )

    Deletes specified tags from a resource.

  • UpdateBillingGroup ( array $params = [] )

    This updates an existing billing group.

  • UpdateCustomLineItem ( array $params = [] )

    Update an existing custom line item in the current or previous billing period.

  • UpdatePricingPlan ( array $params = [] )

    This updates an existing pricing plan.

  • UpdatePricingRule ( array $params = [] )

    Updates an existing pricing rule.

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:

  • ListAccountAssociations
  • ListBillingGroupCostReports
  • ListBillingGroups
  • ListCustomLineItems
  • ListPricingPlans
  • ListPricingPlansAssociatedWithPricingRule
  • ListPricingRules
  • ListPricingRulesAssociatedToPricingPlan
  • ListResourcesAssociatedToCustomLineItem

Operations

AssociateAccounts

$result = $client->associateAccounts([/* ... */]);
$promise = $client->associateAccountsAsync([/* ... */]);

Connects an array of account IDs in a consolidated billing family to a predefined billing group. The account IDs must be a part of the consolidated billing family during the current month, and not already associated with another billing group. The maximum number of accounts that can be associated in one call is 30.

Parameter Syntax

$result = $client->associateAccounts([
    'AccountIds' => ['<string>', ...], // REQUIRED
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members
AccountIds
  • Required: Yes
  • Type: Array of strings

The associating array of account IDs.

Arn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs.

Result Syntax

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

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • ServiceLimitExceededException:

    The request would cause a service limit to exceed.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

AssociatePricingRules

$result = $client->associatePricingRules([/* ... */]);
$promise = $client->associatePricingRulesAsync([/* ... */]);

Connects an array of PricingRuleArns to a defined PricingPlan. The maximum number PricingRuleArn that can be associated in one call is 30.

Parameter Syntax

$result = $client->associatePricingRules([
    'Arn' => '<string>', // REQUIRED
    'PricingRuleArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
Arn
  • Required: Yes
  • Type: string

The PricingPlanArn that the PricingRuleArns are associated with.

PricingRuleArns
  • Required: Yes
  • Type: Array of strings

The PricingRuleArns that are associated with the Pricing Plan.

Result Syntax

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

Result Details

Members
Arn
  • Type: string

The PricingPlanArn that the PricingRuleArns are associated with.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • ServiceLimitExceededException:

    The request would cause a service limit to exceed.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

BatchAssociateResourcesToCustomLineItem

$result = $client->batchAssociateResourcesToCustomLineItem([/* ... */]);
$promise = $client->batchAssociateResourcesToCustomLineItemAsync([/* ... */]);

Associates a batch of resources to a percentage custom line item.

Parameter Syntax

$result = $client->batchAssociateResourcesToCustomLineItem([
    'BillingPeriodRange' => [
        'ExclusiveEndBillingPeriod' => '<string>', // REQUIRED
        'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
    ],
    'ResourceArns' => ['<string>', ...], // REQUIRED
    'TargetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
BillingPeriodRange
  • Type: CustomLineItemBillingPeriodRange structure

The billing period range in which the custom line item request will be applied.

ResourceArns
  • Required: Yes
  • Type: Array of strings

A list containing the ARNs of the resources to be associated.

TargetArn
  • Required: Yes
  • Type: string

A percentage custom line item ARN to associate the resources to.

Result Syntax

[
    'FailedAssociatedResources' => [
        [
            'Arn' => '<string>',
            'Error' => [
                'Message' => '<string>',
                'Reason' => 'INVALID_ARN|SERVICE_LIMIT_EXCEEDED|ILLEGAL_CUSTOMLINEITEM|INTERNAL_SERVER_EXCEPTION',
            ],
        ],
        // ...
    ],
    'SuccessfullyAssociatedResources' => [
        [
            'Arn' => '<string>',
            'Error' => [
                'Message' => '<string>',
                'Reason' => 'INVALID_ARN|SERVICE_LIMIT_EXCEEDED|ILLEGAL_CUSTOMLINEITEM|INTERNAL_SERVER_EXCEPTION',
            ],
        ],
        // ...
    ],
]

Result Details

Members
FailedAssociatedResources
  • Type: Array of AssociateResourceResponseElement structures

A list of AssociateResourceResponseElement for each resource that failed association to a percentage custom line item.

SuccessfullyAssociatedResources
  • Type: Array of AssociateResourceResponseElement structures

A list of AssociateResourceResponseElement for each resource that's been associated to a percentage custom line item successfully.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • ServiceLimitExceededException:

    The request would cause a service limit to exceed.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

BatchDisassociateResourcesFromCustomLineItem

$result = $client->batchDisassociateResourcesFromCustomLineItem([/* ... */]);
$promise = $client->batchDisassociateResourcesFromCustomLineItemAsync([/* ... */]);

Disassociates a batch of resources from a percentage custom line item.

Parameter Syntax

$result = $client->batchDisassociateResourcesFromCustomLineItem([
    'BillingPeriodRange' => [
        'ExclusiveEndBillingPeriod' => '<string>', // REQUIRED
        'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
    ],
    'ResourceArns' => ['<string>', ...], // REQUIRED
    'TargetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
BillingPeriodRange
  • Type: CustomLineItemBillingPeriodRange structure

The billing period range in which the custom line item request will be applied.

ResourceArns
  • Required: Yes
  • Type: Array of strings

A list containing the ARNs of resources to be disassociated.

TargetArn
  • Required: Yes
  • Type: string

A percentage custom line item ARN to disassociate the resources from.

Result Syntax

[
    'FailedDisassociatedResources' => [
        [
            'Arn' => '<string>',
            'Error' => [
                'Message' => '<string>',
                'Reason' => 'INVALID_ARN|SERVICE_LIMIT_EXCEEDED|ILLEGAL_CUSTOMLINEITEM|INTERNAL_SERVER_EXCEPTION',
            ],
        ],
        // ...
    ],
    'SuccessfullyDisassociatedResources' => [
        [
            'Arn' => '<string>',
            'Error' => [
                'Message' => '<string>',
                'Reason' => 'INVALID_ARN|SERVICE_LIMIT_EXCEEDED|ILLEGAL_CUSTOMLINEITEM|INTERNAL_SERVER_EXCEPTION',
            ],
        ],
        // ...
    ],
]

Result Details

Members
FailedDisassociatedResources
  • Type: Array of DisassociateResourceResponseElement structures

A list of DisassociateResourceResponseElement for each resource that failed disassociation from a percentage custom line item.

SuccessfullyDisassociatedResources
  • Type: Array of DisassociateResourceResponseElement structures

A list of DisassociateResourceResponseElement for each resource that's been disassociated from a percentage custom line item successfully.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

CreateBillingGroup

$result = $client->createBillingGroup([/* ... */]);
$promise = $client->createBillingGroupAsync([/* ... */]);

Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation.

Parameter Syntax

$result = $client->createBillingGroup([
    'AccountGrouping' => [ // REQUIRED
        'LinkedAccountIds' => ['<string>', ...], // REQUIRED
    ],
    'ClientToken' => '<string>',
    'ComputationPreference' => [ // REQUIRED
        'PricingPlanArn' => '<string>', // REQUIRED
    ],
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'PrimaryAccountId' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
AccountGrouping
  • Required: Yes
  • Type: AccountGrouping structure

The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated family.

ClientToken
  • Type: string

The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.

ComputationPreference
  • Required: Yes
  • Type: ComputationPreference structure

The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

Description
  • Type: string

The billing group description.

Name
  • Required: Yes
  • Type: string

The billing group name. The names must be unique.

PrimaryAccountId
  • Type: string

The account ID that serves as the main account in a billing group.

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

A map that contains tag keys and tag values that are attached to a billing group. This feature isn't available during the beta.

Result Syntax

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

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the created billing group.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • ServiceLimitExceededException:

    The request would cause a service limit to exceed.

  • InternalServerException:

    An unexpected error occurred while processing a request.

CreateCustomLineItem

$result = $client->createCustomLineItem([/* ... */]);
$promise = $client->createCustomLineItemAsync([/* ... */]);

Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount.

Parameter Syntax

$result = $client->createCustomLineItem([
    'BillingGroupArn' => '<string>', // REQUIRED
    'BillingPeriodRange' => [
        'ExclusiveEndBillingPeriod' => '<string>', // REQUIRED
        'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
    ],
    'ChargeDetails' => [ // REQUIRED
        'Flat' => [
            'ChargeValue' => <float>, // REQUIRED
        ],
        'Percentage' => [
            'AssociatedValues' => ['<string>', ...],
            'PercentageValue' => <float>, // REQUIRED
        ],
        'Type' => 'CREDIT|FEE', // REQUIRED
    ],
    'ClientToken' => '<string>',
    'Description' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
BillingGroupArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.

BillingPeriodRange
  • Type: CustomLineItemBillingPeriodRange structure

A time range for which the custom line item is effective.

ChargeDetails
  • Required: Yes
  • Type: CustomLineItemChargeDetails structure

A CustomLineItemChargeDetails that describes the charge details for a custom line item.

ClientToken
  • Type: string

The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.

Description
  • Required: Yes
  • Type: string

The description of the custom line item. This is shown on the Bills page in association with the charge value.

Name
  • Required: Yes
  • Type: string

The name of the custom line item.

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

A map that contains tag keys and tag values that are attached to a custom line item.

Result Syntax

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

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the created custom line item.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • ServiceLimitExceededException:

    The request would cause a service limit to exceed.

  • InternalServerException:

    An unexpected error occurred while processing a request.

CreatePricingPlan

$result = $client->createPricingPlan([/* ... */]);
$promise = $client->createPricingPlanAsync([/* ... */]);

Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.

Parameter Syntax

$result = $client->createPricingPlan([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'PricingRuleArns' => ['<string>', ...],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ClientToken
  • Type: string

The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.

Description
  • Type: string

The pricing plan description.

Name
  • Required: Yes
  • Type: string

The pricing plan name. The names must be unique to each pricing plan.

PricingRuleArns
  • Type: Array of strings

A list of Amazon Resource Names (ARNs) that define the pricing plan parameters.

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

A map that contains tag keys and tag values that are attached to a pricing plan.

Result Syntax

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

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the created pricing plan.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • ServiceLimitExceededException:

    The request would cause a service limit to exceed.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

CreatePricingRule

$result = $client->createPricingRule([/* ... */]);
$promise = $client->createPricingRuleAsync([/* ... */]);

Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.

Parameter Syntax

$result = $client->createPricingRule([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'ModifierPercentage' => <float>, // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Scope' => 'GLOBAL|SERVICE', // REQUIRED
    'Service' => '<string>',
    'Tags' => ['<string>', ...],
    'Type' => 'MARKUP|DISCOUNT', // REQUIRED
]);

Parameter Details

Members
ClientToken
  • Type: string

The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.

Description
  • Type: string

The pricing rule description.

ModifierPercentage
  • Required: Yes
  • Type: double

A percentage modifier applied on the public pricing rates.

Name
  • Required: Yes
  • Type: string

The pricing rule name. The names must be unique to each pricing rule.

Scope
  • Required: Yes
  • Type: string

The scope of pricing rule that indicates if it is globally applicable, or is service-specific.

Service
  • Type: string

If the Scope attribute is set to SERVICE, the attribute indicates which service the PricingRule is applicable for.

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

A map that contains tag keys and tag values that are attached to a pricing rule.

Type
  • Required: Yes
  • Type: string

The type of pricing rule.

Result Syntax

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

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the created pricing rule.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • ServiceLimitExceededException:

    The request would cause a service limit to exceed.

  • InternalServerException:

    An unexpected error occurred while processing a request.

DeleteBillingGroup

$result = $client->deleteBillingGroup([/* ... */]);
$promise = $client->deleteBillingGroupAsync([/* ... */]);

Deletes a billing group.

Parameter Syntax

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

Parameter Details

Members
Arn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the billing group you're deleting.

Result Syntax

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

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the deleted billing group.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

DeleteCustomLineItem

$result = $client->deleteCustomLineItem([/* ... */]);
$promise = $client->deleteCustomLineItemAsync([/* ... */]);

Deletes the custom line item identified by the given ARN in the current, or previous billing period.

Parameter Syntax

$result = $client->deleteCustomLineItem([
    'Arn' => '<string>', // REQUIRED
    'BillingPeriodRange' => [
        'ExclusiveEndBillingPeriod' => '<string>', // REQUIRED
        'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
Arn
  • Required: Yes
  • Type: string

The ARN of the custom line item to be deleted.

BillingPeriodRange
  • Type: CustomLineItemBillingPeriodRange structure

The billing period range in which the custom line item request will be applied.

Result Syntax

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

Result Details

Members
Arn
  • Type: string

Then ARN of the deleted custom line item.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

DeletePricingPlan

$result = $client->deletePricingPlan([/* ... */]);
$promise = $client->deletePricingPlanAsync([/* ... */]);

Deletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully.

Parameter Syntax

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

Parameter Details

Members
Arn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the pricing plan you're deleting.

Result Syntax

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

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the deleted pricing plan.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

DeletePricingRule

$result = $client->deletePricingRule([/* ... */]);
$promise = $client->deletePricingRuleAsync([/* ... */]);

Deletes the pricing rule identified by the input Amazon Resource Name (ARN).

Parameter Syntax

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

Parameter Details

Members
Arn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the pricing rule you are deleting.

Result Syntax

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

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the deleted pricing rule.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

DisassociateAccounts

$result = $client->disassociateAccounts([/* ... */]);
$promise = $client->disassociateAccountsAsync([/* ... */]);

Removes the specified list of account IDs from the given billing group.

Parameter Syntax

$result = $client->disassociateAccounts([
    'AccountIds' => ['<string>', ...], // REQUIRED
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members
AccountIds
  • Required: Yes
  • Type: Array of strings

The array of account IDs to disassociate.

Arn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the billing group that the array of account IDs will disassociate from.

Result Syntax

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

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the billing group that the array of account IDs is disassociated from.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

DisassociatePricingRules

$result = $client->disassociatePricingRules([/* ... */]);
$promise = $client->disassociatePricingRulesAsync([/* ... */]);

Disassociates a list of pricing rules from a pricing plan.

Parameter Syntax

$result = $client->disassociatePricingRules([
    'Arn' => '<string>', // REQUIRED
    'PricingRuleArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
Arn
  • Required: Yes
  • Type: string

The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules from.

PricingRuleArns
  • Required: Yes
  • Type: Array of strings

A list containing the Amazon Resource Name (ARN) of the pricing rules that will be disassociated.

Result Syntax

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

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the pricing plan that the pricing rules successfully disassociated from.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

ListAccountAssociations

$result = $client->listAccountAssociations([/* ... */]);
$promise = $client->listAccountAssociationsAsync([/* ... */]);

Amazon Web Services Billing Conductor is in beta release and is subject to change. Your use of Amazon Web Services Billing Conductor is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).

This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group associated with the linked account.

Parameter Syntax

$result = $client->listAccountAssociations([
    'BillingPeriod' => '<string>',
    'Filters' => [
        'AccountId' => '<string>',
        'Association' => '<string>',
    ],
    'NextToken' => '<string>',
]);

Parameter Details

Members
BillingPeriod
  • Type: string

The preferred billing period to get account associations.

Filters
  • Type: ListAccountAssociationsFilter structure

The filter on the account ID of the linked account, or any of the following:

MONITORED: linked accounts that are associated to billing groups.

UNMONITORED: linked accounts that are not associated to billing groups.

Billing Group Arn: linked accounts that are associated to the provided billing group Arn.

NextToken
  • Type: string

The pagination token used on subsequent calls to retrieve accounts.

Result Syntax

[
    'LinkedAccounts' => [
        [
            'AccountEmail' => '<string>',
            'AccountId' => '<string>',
            'AccountName' => '<string>',
            'BillingGroupArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
LinkedAccounts
  • Type: Array of AccountAssociationsListElement structures

The list of linked accounts in the payer account.

NextToken
  • Type: string

The pagination token used on subsequent calls to get accounts.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

ListBillingGroupCostReports

$result = $client->listBillingGroupCostReports([/* ... */]);
$promise = $client->listBillingGroupCostReportsAsync([/* ... */]);

A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group.

Parameter Syntax

$result = $client->listBillingGroupCostReports([
    'BillingPeriod' => '<string>',
    'Filters' => [
        'BillingGroupArns' => ['<string>', ...],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
BillingPeriod
  • Type: string

The preferred billing period for your report.

Filters
  • Type: ListBillingGroupCostReportsFilter structure

A ListBillingGroupCostReportsFilter to specify billing groups to retrieve reports from.

MaxResults
  • Type: int

The maximum number of reports to retrieve.

NextToken
  • Type: string

The pagination token used on subsequent calls to get reports.

Result Syntax

[
    'BillingGroupCostReports' => [
        [
            'AWSCost' => '<string>',
            'Arn' => '<string>',
            'Currency' => '<string>',
            'Margin' => '<string>',
            'MarginPercentage' => '<string>',
            'ProformaCost' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
BillingGroupCostReports
  • Type: Array of BillingGroupCostReportElement structures

A list of BillingGroupCostReportElement retrieved.

NextToken
  • Type: string

The pagination token used on subsequent calls to get reports.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

ListBillingGroups

$result = $client->listBillingGroups([/* ... */]);
$promise = $client->listBillingGroupsAsync([/* ... */]);

A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.

Parameter Syntax

$result = $client->listBillingGroups([
    'BillingPeriod' => '<string>',
    'Filters' => [
        'Arns' => ['<string>', ...],
        'PricingPlan' => '<string>',
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
BillingPeriod
  • Type: string

The preferred billing period to get billing groups.

Filters
  • Type: ListBillingGroupsFilter structure

A ListBillingGroupsFilter that specifies the billing group and pricing plan to retrieve billing group information.

MaxResults
  • Type: int

The maximum number of billing groups to retrieve.

NextToken
  • Type: string

The pagination token used on subsequent calls to get billing groups.

Result Syntax

[
    'BillingGroups' => [
        [
            'Arn' => '<string>',
            'ComputationPreference' => [
                'PricingPlanArn' => '<string>',
            ],
            'CreationTime' => <integer>,
            'Description' => '<string>',
            'LastModifiedTime' => <integer>,
            'Name' => '<string>',
            'PrimaryAccountId' => '<string>',
            'Size' => <integer>,
            'Status' => 'ACTIVE|PRIMARY_ACCOUNT_MISSING',
            'StatusReason' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
BillingGroups
  • Type: Array of BillingGroupListElement structures

A list of BillingGroupListElement retrieved.

NextToken
  • Type: string

The pagination token used on subsequent calls to get billing groups.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

ListCustomLineItems

$result = $client->listCustomLineItems([/* ... */]);
$promise = $client->listCustomLineItemsAsync([/* ... */]);

A paginated call to get a list of all custom line items (FFLIs) for the given billing period. If you don't provide a billing period, the current billing period is used.

Parameter Syntax

$result = $client->listCustomLineItems([
    'BillingPeriod' => '<string>',
    'Filters' => [
        'Arns' => ['<string>', ...],
        'BillingGroups' => ['<string>', ...],
        'Names' => ['<string>', ...],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
BillingPeriod
  • Type: string

The preferred billing period to get custom line items (FFLIs).

Filters
  • Type: ListCustomLineItemsFilter structure

A ListCustomLineItemsFilter that specifies the custom line item names and/or billing group Amazon Resource Names (ARNs) to retrieve FFLI information.

MaxResults
  • Type: int

The maximum number of billing groups to retrieve.

NextToken
  • Type: string

The pagination token used on subsequent calls to get custom line items (FFLIs).

Result Syntax

[
    'CustomLineItems' => [
        [
            'Arn' => '<string>',
            'AssociationSize' => <integer>,
            'BillingGroupArn' => '<string>',
            'ChargeDetails' => [
                'Flat' => [
                    'ChargeValue' => <float>,
                ],
                'Percentage' => [
                    'PercentageValue' => <float>,
                ],
                'Type' => 'CREDIT|FEE',
            ],
            'CreationTime' => <integer>,
            'CurrencyCode' => 'USD|CNY',
            'Description' => '<string>',
            'LastModifiedTime' => <integer>,
            'Name' => '<string>',
            'ProductCode' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
CustomLineItems
  • Type: Array of CustomLineItemListElement structures

A list of FreeFormLineItemListElements received.

NextToken
  • Type: string

The pagination token used on subsequent calls to get custom line items (FFLIs).

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

ListPricingPlans

$result = $client->listPricingPlans([/* ... */]);
$promise = $client->listPricingPlansAsync([/* ... */]);

A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used.

Parameter Syntax

$result = $client->listPricingPlans([
    'BillingPeriod' => '<string>',
    'Filters' => [
        'Arns' => ['<string>', ...],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
BillingPeriod
  • Type: string

The preferred billing period to get pricing plan.

Filters
  • Type: ListPricingPlansFilter structure

A ListPricingPlansFilter that specifies the Amazon Resource Name (ARNs) of pricing plans to retrieve pricing plans information.

MaxResults
  • Type: int

The maximum number of pricing plans to retrieve.

NextToken
  • Type: string

The pagination token used on subsequent call to get pricing plans.

Result Syntax

[
    'BillingPeriod' => '<string>',
    'NextToken' => '<string>',
    'PricingPlans' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <integer>,
            'Description' => '<string>',
            'LastModifiedTime' => <integer>,
            'Name' => '<string>',
            'Size' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
BillingPeriod
  • Type: string

The billing period for which the described pricing plans are applicable.

NextToken
  • Type: string

The pagination token used on subsequent calls to get pricing plans.

PricingPlans
  • Type: Array of PricingPlanListElement structures

A list of PricingPlanListElement retrieved.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

ListPricingPlansAssociatedWithPricingRule

$result = $client->listPricingPlansAssociatedWithPricingRule([/* ... */]);
$promise = $client->listPricingPlansAssociatedWithPricingRuleAsync([/* ... */]);

A list of the pricing plans associated with a pricing rule.

Parameter Syntax

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

Parameter Details

Members
BillingPeriod
  • Type: string

The pricing plan billing period for which associations will be listed.

MaxResults
  • Type: int

The optional maximum number of pricing rule associations to retrieve.

NextToken
  • Type: string

The optional pagination token returned by a previous call.

PricingRuleArn
  • Required: Yes
  • Type: string

The pricing rule Amazon Resource Name (ARN) for which associations will be listed.

Result Syntax

[
    'BillingPeriod' => '<string>',
    'NextToken' => '<string>',
    'PricingPlanArns' => ['<string>', ...],
    'PricingRuleArn' => '<string>',
]

Result Details

Members
BillingPeriod
  • Type: string

The pricing plan billing period for which associations will be listed.

NextToken
  • Type: string

The pagination token to be used on subsequent calls.

PricingPlanArns
  • Type: Array of strings

The list containing pricing plans associated with the requested pricing rule.

PricingRuleArn
  • Type: string

The pricing rule Amazon Resource Name (ARN) for which associations will be listed.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

ListPricingRules

$result = $client->listPricingRules([/* ... */]);
$promise = $client->listPricingRulesAsync([/* ... */]);

Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.

Parameter Syntax

$result = $client->listPricingRules([
    'BillingPeriod' => '<string>',
    'Filters' => [
        'Arns' => ['<string>', ...],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
BillingPeriod
  • Type: string

The preferred billing period to get the pricing plan.

Filters
  • Type: ListPricingRulesFilter structure

A DescribePricingRuleFilter that specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information.

MaxResults
  • Type: int

The maximum number of pricing rules to retrieve.

NextToken
  • Type: string

The pagination token used on subsequent call to get pricing rules.

Result Syntax

[
    'BillingPeriod' => '<string>',
    'NextToken' => '<string>',
    'PricingRules' => [
        [
            'Arn' => '<string>',
            'AssociatedPricingPlanCount' => <integer>,
            'CreationTime' => <integer>,
            'Description' => '<string>',
            'LastModifiedTime' => <integer>,
            'ModifierPercentage' => <float>,
            'Name' => '<string>',
            'Scope' => 'GLOBAL|SERVICE',
            'Service' => '<string>',
            'Type' => 'MARKUP|DISCOUNT',
        ],
        // ...
    ],
]

Result Details

Members
BillingPeriod
  • Type: string

The billing period for which the described pricing rules are applicable.

NextToken
  • Type: string

The pagination token used on subsequent calls to get pricing rules.

PricingRules
  • Type: Array of PricingRuleListElement structures

A list containing the described pricing rules.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

ListPricingRulesAssociatedToPricingPlan

$result = $client->listPricingRulesAssociatedToPricingPlan([/* ... */]);
$promise = $client->listPricingRulesAssociatedToPricingPlanAsync([/* ... */]);

Lists the pricing rules associated with a pricing plan.

Parameter Syntax

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

Parameter Details

Members
BillingPeriod
  • Type: string

The billing period for which the pricing rule associations are to be listed.

MaxResults
  • Type: int

The optional maximum number of pricing rule associations to retrieve.

NextToken
  • Type: string

The optional pagination token returned by a previous call.

PricingPlanArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the pricing plan for which associations are to be listed.

Result Syntax

[
    'BillingPeriod' => '<string>',
    'NextToken' => '<string>',
    'PricingPlanArn' => '<string>',
    'PricingRuleArns' => ['<string>', ...],
]

Result Details

Members
BillingPeriod
  • Type: string

The billing period for which the pricing rule associations are listed.

NextToken
  • Type: string

The pagination token to be used on subsequent calls.

PricingPlanArn
  • Type: string

The Amazon Resource Name (ARN) of the pricing plan for which associations are listed.

PricingRuleArns
  • Type: Array of strings

A list containing pricing rules associated with the requested pricing plan.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

ListResourcesAssociatedToCustomLineItem

$result = $client->listResourcesAssociatedToCustomLineItem([/* ... */]);
$promise = $client->listResourcesAssociatedToCustomLineItemAsync([/* ... */]);

List the resources associated to a custom line item.

Parameter Syntax

$result = $client->listResourcesAssociatedToCustomLineItem([
    'Arn' => '<string>', // REQUIRED
    'BillingPeriod' => '<string>',
    'Filters' => [
        'Relationship' => 'PARENT|CHILD',
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Arn
  • Required: Yes
  • Type: string

The ARN of the custom line item for which the resource associations will be listed.

BillingPeriod
  • Type: string

The billing period for which the resource associations will be listed.

Filters
  • Type: ListResourcesAssociatedToCustomLineItemFilter structure

(Optional) A ListResourcesAssociatedToCustomLineItemFilter that can specify the types of resources that should be retrieved.

MaxResults
  • Type: int

(Optional) The maximum number of resource associations to be retrieved.

NextToken
  • Type: string

(Optional) The pagination token returned by a previous request.

Result Syntax

[
    'Arn' => '<string>',
    'AssociatedResources' => [
        [
            'Arn' => '<string>',
            'Relationship' => 'PARENT|CHILD',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Arn
  • Type: string

The custom line item ARN for which the resource associations are listed.

AssociatedResources
  • Type: Array of ListResourcesAssociatedToCustomLineItemResponseElement structures

A list of ListResourcesAssociatedToCustomLineItemResponseElement for each resource association retrieved.

NextToken
  • Type: string

The pagination token to be used in subsequent requests to retrieve additional results.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

ListTagsForResource

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

A list the tags for a resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) that identifies the resource to list the tags.

Result Syntax

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

Result Details

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

The tags for the resource.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

TagResource

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

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource to which to add tags.

Tags
  • Required: Yes
  • Type: Associative array of custom strings keys (TagKey) to strings

The tags to add to the resource as a list of key-value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

UntagResource

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

Deletes specified tags from a resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource to which to delete tags.

TagKeys
  • Required: Yes
  • Type: Array of strings

The tags to delete from the resource as a list of key-value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

UpdateBillingGroup

$result = $client->updateBillingGroup([/* ... */]);
$promise = $client->updateBillingGroupAsync([/* ... */]);

This updates an existing billing group.

Parameter Syntax

$result = $client->updateBillingGroup([
    'Arn' => '<string>', // REQUIRED
    'ComputationPreference' => [
        'PricingPlanArn' => '<string>', // REQUIRED
    ],
    'Description' => '<string>',
    'Name' => '<string>',
    'Status' => 'ACTIVE|PRIMARY_ACCOUNT_MISSING',
]);

Parameter Details

Members
Arn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the billing group being updated.

ComputationPreference
  • Type: ComputationPreference structure

The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

Description
  • Type: string

A description of the billing group.

Name
  • Type: string

The name of the billing group. The names must be unique to each billing group.

Status
  • Type: string

The status of the billing group. Only one of the valid values can be used.

Result Syntax

[
    'Arn' => '<string>',
    'Description' => '<string>',
    'LastModifiedTime' => <integer>,
    'Name' => '<string>',
    'PricingPlanArn' => '<string>',
    'PrimaryAccountId' => '<string>',
    'Size' => <integer>,
    'Status' => 'ACTIVE|PRIMARY_ACCOUNT_MISSING',
    'StatusReason' => '<string>',
]

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the billing group that was updated.

Description
  • Type: string

A description of the billing group.

LastModifiedTime
  • Type: long (int|float)

The most recent time the billing group was modified.

Name
  • Type: string

The name of the billing group. The names must be unique to each billing group.

PricingPlanArn
  • Type: string

The Amazon Resource Name (ARN) of the pricing plan to compute Amazon Web Services charges for the billing group.

PrimaryAccountId
  • Type: string

The account ID that serves as the main account in a billing group.

Size
  • Type: long (int|float)

The number of accounts in the particular billing group.

Status
  • Type: string

The status of the billing group. Only one of the valid values can be used.

StatusReason
  • Type: string

The reason why the billing group is in its current status.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

UpdateCustomLineItem

$result = $client->updateCustomLineItem([/* ... */]);
$promise = $client->updateCustomLineItemAsync([/* ... */]);

Update an existing custom line item in the current or previous billing period.

Parameter Syntax

$result = $client->updateCustomLineItem([
    'Arn' => '<string>', // REQUIRED
    'BillingPeriodRange' => [
        'ExclusiveEndBillingPeriod' => '<string>', // REQUIRED
        'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
    ],
    'ChargeDetails' => [
        'Flat' => [
            'ChargeValue' => <float>, // REQUIRED
        ],
        'Percentage' => [
            'PercentageValue' => <float>, // REQUIRED
        ],
    ],
    'Description' => '<string>',
    'Name' => '<string>',
]);

Parameter Details

Members
Arn
  • Required: Yes
  • Type: string

The ARN of the custom line item to be updated.

BillingPeriodRange
  • Type: CustomLineItemBillingPeriodRange structure

The billing period range in which the custom line item request will be applied.

ChargeDetails
  • Type: UpdateCustomLineItemChargeDetails structure

A ListCustomLineItemChargeDetails containing the new charge details for the custom line item.

Description
  • Type: string

The new line item description of the custom line item.

Name
  • Type: string

The new name for the custom line item.

Result Syntax

[
    'Arn' => '<string>',
    'AssociationSize' => <integer>,
    'BillingGroupArn' => '<string>',
    'ChargeDetails' => [
        'Flat' => [
            'ChargeValue' => <float>,
        ],
        'Percentage' => [
            'PercentageValue' => <float>,
        ],
        'Type' => 'CREDIT|FEE',
    ],
    'Description' => '<string>',
    'LastModifiedTime' => <integer>,
    'Name' => '<string>',
]

Result Details

Members
Arn
  • Type: string

The ARN of the successfully updated custom line item.

AssociationSize
  • Type: long (int|float)

The number of resources that are associated to the custom line item.

BillingGroupArn
  • Type: string

The ARN of the billing group that the custom line item is applied to.

ChargeDetails
  • Type: ListCustomLineItemChargeDetails structure

A ListCustomLineItemChargeDetails containing the charge details of the successfully updated custom line item.

Description
  • Type: string

The description of the successfully updated custom line item.

LastModifiedTime
  • Type: long (int|float)

The most recent time the custom line item was modified.

Name
  • Type: string

The name of the successfully updated custom line item.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

UpdatePricingPlan

$result = $client->updatePricingPlan([/* ... */]);
$promise = $client->updatePricingPlanAsync([/* ... */]);

This updates an existing pricing plan.

Parameter Syntax

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

Parameter Details

Members
Arn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the pricing plan you're updating.

Description
  • Type: string

The pricing plan description.

Name
  • Type: string

The name of the pricing plan. The name must be unique to each pricing plan.

Result Syntax

[
    'Arn' => '<string>',
    'Description' => '<string>',
    'LastModifiedTime' => <integer>,
    'Name' => '<string>',
    'Size' => <integer>,
]

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the updated pricing plan.

Description
  • Type: string

The new description for the pricing rule.

LastModifiedTime
  • Type: long (int|float)

The most recent time the pricing plan was modified.

Name
  • Type: string

The name of the pricing plan. The name must be unique to each pricing plan.

Size
  • Type: long (int|float)

The pricing rules count currently associated with this pricing plan list.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

UpdatePricingRule

$result = $client->updatePricingRule([/* ... */]);
$promise = $client->updatePricingRuleAsync([/* ... */]);

Updates an existing pricing rule.

Parameter Syntax

$result = $client->updatePricingRule([
    'Arn' => '<string>', // REQUIRED
    'Description' => '<string>',
    'ModifierPercentage' => <float>,
    'Name' => '<string>',
    'Type' => 'MARKUP|DISCOUNT',
]);

Parameter Details

Members
Arn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the pricing rule to update.

Description
  • Type: string

The new description for the pricing rule.

ModifierPercentage
  • Type: double

The new modifier to show pricing plan rates as a percentage.

Name
  • Type: string

The new name of the pricing rule. The name must be unique to each pricing rule.

Type
  • Type: string

The new pricing rule type.

Result Syntax

[
    'Arn' => '<string>',
    'AssociatedPricingPlanCount' => <integer>,
    'Description' => '<string>',
    'LastModifiedTime' => <integer>,
    'ModifierPercentage' => <float>,
    'Name' => '<string>',
    'Scope' => 'GLOBAL|SERVICE',
    'Service' => '<string>',
    'Type' => 'MARKUP|DISCOUNT',
]

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the successfully updated pricing rule.

AssociatedPricingPlanCount
  • Type: long (int|float)

The pricing plans count that this pricing rule is associated with.

Description
  • Type: string

The new description for the pricing rule.

LastModifiedTime
  • Type: long (int|float)

The most recent time the pricing rule was modified.

ModifierPercentage
  • Type: double

The new modifier to show pricing plan rates as a percentage.

Name
  • Type: string

The new name of the pricing rule. The name must be unique to each pricing rule.

Scope
  • Type: string

The scope of pricing rule that indicates if it is globally applicable, or is service-specific.

Service
  • Type: string

If the Scope attribute is set to SERVICE, the attribute indicates which service the PricingRule is applicable for.

Type
  • Type: string

The new pricing rule type.

Errors

  • ThrottlingException:

    The request was denied due to request throttling.

  • ConflictException:

    You can cause an inconsistent state by updating or deleting a resource.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ValidationException:

    The input doesn't match with the constraints specified by Amazon Web Services services.

  • InternalServerException:

    An unexpected error occurred while processing a request.

  • ResourceNotFoundException:

    The request references a resource that doesn't exist.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
Message
  • Required: Yes
  • Type: string

AccountAssociationsListElement

Description

Amazon Web Services Billing Conductor is in beta release and is subject to change. Your use of Amazon Web Services Billing Conductor is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).

A representation of a linked account.

Members
AccountEmail
  • Type: string

The Amazon Web Services account email.

AccountId
  • Type: string

The associating array of account IDs.

AccountName
  • Type: string

The Amazon Web Services account name.

BillingGroupArn
  • Type: string

The Billing Group Arn that the linked account is associated to.

AccountGrouping

Description

The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated family.

Members
LinkedAccountIds
  • Required: Yes
  • Type: Array of strings

The account IDs that make up the billing group. Account IDs must be a part of the consolidated billing family, and not associated with another billing group.

AssociateResourceError

Description

A representation of a resource association error.

Members
Message
  • Type: string

The reason the resource association failed.

Reason
  • Type: string

A static error code that used to classify the type of failure.

AssociateResourceResponseElement

Description

A resource association result for a percentage custom line item.

Members
Arn
  • Type: string

The resource ARN that was associated to the custom line item.

Error
  • Type: AssociateResourceError structure

An AssociateResourceError that will populate if the resource association fails.

BillingGroupCostReportElement

Description

A summary report of actual Amazon Web Services charges and calculated Amazon Web Services charges, based on the associated pricing plan of a billing group.

Members
AWSCost
  • Type: string

The actual Amazon Web Services charges for the billing group.

Arn
  • Type: string

The Amazon Resource Name (ARN) of a billing group.

Currency
  • Type: string

The displayed currency.

Margin
  • Type: string

The billing group margin.

MarginPercentage
  • Type: string

The percentage of billing group margin.

ProformaCost
  • Type: string

The hypothetical Amazon Web Services charges based on the associated pricing plan of a billing group.

BillingGroupListElement

Description

A representation of a billing group.

Members
Arn
  • Type: string

The Amazon Resource Number (ARN) that can be used to uniquely identify the billing group.

ComputationPreference
  • Type: ComputationPreference structure

The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

CreationTime
  • Type: long (int|float)

The time the billing group was created.

Description
  • Type: string

The billing group description.

LastModifiedTime
  • Type: long (int|float)

The most recent time the billing group was modified.

Name
  • Type: string

The billing group's name.

PrimaryAccountId
  • Type: string

The account ID that serves as the main account in a billing group.

Size
  • Type: long (int|float)

The number of accounts in the particular billing group.

Status
  • Type: string

The billing group status. Only one of the valid values can be used.

StatusReason
  • Type: string

The reason why the billing group is in its current status.

ComputationPreference

Description

The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

Members
PricingPlanArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the pricing plan used to compute the Amazon Web Services charges for a billing group.

ConflictException

Description

You can cause an inconsistent state by updating or deleting a resource.

Members
Message
  • Required: Yes
  • Type: string
ResourceId
  • Required: Yes
  • Type: string

Identifier of the resource in use.

ResourceType
  • Required: Yes
  • Type: string

Type of the resource in use.

CustomLineItemBillingPeriodRange

Description

The billing period range in which the custom line item request will be applied.

Members
ExclusiveEndBillingPeriod
  • Required: Yes
  • Type: string

The inclusive end billing period that defines a billing period range where a custom line is applied.

InclusiveStartBillingPeriod
  • Required: Yes
  • Type: string

The inclusive start billing period that defines a billing period range where a custom line is applied.

CustomLineItemChargeDetails

Description

The charge details of a custom line item. It should contain only one of Flat or Percentage.

Members
Flat
  • Type: CustomLineItemFlatChargeDetails structure

A CustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.

Percentage
  • Type: CustomLineItemPercentageChargeDetails structure

A CustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.

Type
  • Required: Yes
  • Type: string

The type of the custom line item that indicates whether the charge is a fee or credit.

CustomLineItemFlatChargeDetails

Description

A representation of the charge details associated with a flat custom line item.

Members
ChargeValue
  • Required: Yes
  • Type: double

The custom line item's fixed charge value in USD.

CustomLineItemListElement

Description

A representation of a custom line item.

Members
Arn
  • Type: string

The Amazon Resource Names (ARNs) for custom line items.

AssociationSize
  • Type: long (int|float)

The number of resources that are associated to the custom line item.

BillingGroupArn
  • Type: string

The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.

ChargeDetails
  • Type: ListCustomLineItemChargeDetails structure

A ListCustomLineItemChargeDetails that describes the charge details of a custom line item.

CreationTime
  • Type: long (int|float)

The time created.

CurrencyCode
  • Type: string

The custom line item's charge value currency. Only one of the valid values can be used.

Description
  • Type: string

The custom line item's description. This is shown on the Bills page in association with the charge value.

LastModifiedTime
  • Type: long (int|float)

The most recent time the custom line item was modified.

Name
  • Type: string

The custom line item's name.

ProductCode
  • Type: string

The product code associated with the custom line item.

CustomLineItemPercentageChargeDetails

Description

A representation of the charge details associated with a percentage custom line item.

Members
AssociatedValues
  • Type: Array of strings

A list of resource ARNs to associate to the percentage custom line item.

PercentageValue
  • Required: Yes
  • Type: double

The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.

DisassociateResourceResponseElement

Description

A resource disassociation result for a percentage custom line item.

Members
Arn
  • Type: string

The resource ARN that was disassociated from the custom line item.

Error
  • Type: AssociateResourceError structure

An AssociateResourceError shown if the resource disassociation fails.

InternalServerException

Description

An unexpected error occurred while processing a request.

Members
Message
  • Required: Yes
  • Type: string
RetryAfterSeconds
  • Type: int

Number of seconds you can retry after the call.

ListAccountAssociationsFilter

Description

The filter on the account ID of the linked account, or any of the following:

MONITORED: linked accounts that are associated to billing groups.

UNMONITORED: linked accounts that are not associated to billing groups.

Billing Group Arn: linked accounts that are associated to the provided Billing Group Arn.

Members
AccountId
  • Type: string

The Amazon Web Services account ID to filter on.

Association
  • Type: string

MONITORED: linked accounts that are associated to billing groups.

UNMONITORED: linked accounts that are not associated to billing groups.

Billing Group Arn: linked accounts that are associated to the provided Billing Group Arn.

ListBillingGroupCostReportsFilter

Description

The filter used to retrieve specific BillingGroupCostReportElements.

Members
BillingGroupArns
  • Type: Array of strings

The list of Amazon Resource Names (ARNs) used to filter billing groups to retrieve reports.

ListBillingGroupsFilter

Description

The filter that specifies the billing groups and pricing plans to retrieve billing group information.

Members
Arns
  • Type: Array of strings

The list of billing group Amazon Resource Names (ARNs) to retrieve information.

PricingPlan
  • Type: string

The pricing plan Amazon Resource Names (ARNs) to retrieve information.

ListCustomLineItemChargeDetails

Description

A representation of the charge details of a custom line item.

Members
Flat
  • Type: ListCustomLineItemFlatChargeDetails structure

A ListCustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.

Percentage
  • Type: ListCustomLineItemPercentageChargeDetails structure

A ListCustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.

Type
  • Required: Yes
  • Type: string

The type of the custom line item that indicates whether the charge is a fee or credit.

ListCustomLineItemFlatChargeDetails

Description

A representation of the charge details associated with a flat custom line item.

Members
ChargeValue
  • Required: Yes
  • Type: double

The custom line item's fixed charge value in USD.

ListCustomLineItemPercentageChargeDetails

Description

A representation of the charge details associated with a percentage custom line item.

Members
PercentageValue
  • Required: Yes
  • Type: double

The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.

ListCustomLineItemsFilter

Description

A filter that specifies the custom line items and billing groups to retrieve FFLI information.

Members
Arns
  • Type: Array of strings

A list of custom line item ARNs to retrieve information.

BillingGroups
  • Type: Array of strings

The billing group Amazon Resource Names (ARNs) to retrieve information.

Names
  • Type: Array of strings

A list of custom line items to retrieve information.

ListPricingPlansFilter

Description

The filter that specifies the Amazon Resource Names (ARNs) of pricing plans, to retrieve pricing plan information.

Members
Arns
  • Type: Array of strings

A list of pricing plan Amazon Resource Names (ARNs) to retrieve information.

ListPricingRulesFilter

Description

The filter that specifies criteria that the pricing rules returned by the ListPricingRules API will adhere to.

Members
Arns
  • Type: Array of strings

A list containing the pricing rule Amazon Resource Names (ARNs) to include in the API response.

ListResourcesAssociatedToCustomLineItemFilter

Description

A filter that specifies the type of resource associations that should be retrieved for a custom line item.

Members
Relationship
  • Type: string

The type of relationship between the custom line item and the associated resource.

ListResourcesAssociatedToCustomLineItemResponseElement

Description

A representation of a resource association for a custom line item.

Members
Arn
  • Type: string

The ARN of the associated resource.

Relationship
  • Type: string

The type of relationship between the custom line item and the associated resource.

PricingPlanListElement

Description

A representation of a pricing plan.

Members
Arn
  • Type: string

The pricing plan Amazon Resource Names (ARN). This can be used to uniquely identify a pricing plan.

CreationTime
  • Type: long (int|float)

The time the pricing plan was created.

Description
  • Type: string

The pricing plan description.

LastModifiedTime
  • Type: long (int|float)

The most recent time the pricing plan was modified.

Name
  • Type: string

The name of a pricing plan.

Size
  • Type: long (int|float)

The pricing rules count currently associated with this pricing plan list element.

PricingRuleListElement

Description

A representation of a pricing rule.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) used to uniquely identify a pricing rule.

AssociatedPricingPlanCount
  • Type: long (int|float)

The pricing plans count that this pricing rule is associated with.

CreationTime
  • Type: long (int|float)

The time the pricing rule was created.

Description
  • Type: string

The pricing rule description.

LastModifiedTime
  • Type: long (int|float)

The most recent time the pricing rule was modified.

ModifierPercentage
  • Type: double

A percentage modifier applied on the public pricing rates.

Name
  • Type: string

The name of a pricing rule.

Scope
  • Type: string

The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.

Service
  • Type: string

If the Scope attribute is SERVICE, this attribute indicates which service the PricingRule is applicable for.

Type
  • Type: string

The type of pricing rule.

ResourceNotFoundException

Description

The request references a resource that doesn't exist.

Members
Message
  • Required: Yes
  • Type: string
ResourceId
  • Required: Yes
  • Type: string

Resource identifier that was not found.

ResourceType
  • Required: Yes
  • Type: string

Resource type that was not found.

ServiceLimitExceededException

Description

The request would cause a service limit to exceed.

Members
LimitCode
  • Required: Yes
  • Type: string

The unique code identifier of the service limit that is being exceeded.

Message
  • Required: Yes
  • Type: string
ResourceId
  • Type: string

Identifier of the resource affected.

ResourceType
  • Type: string

Type of the resource affected.

ServiceCode
  • Required: Yes
  • Type: string

The unique code for the service of the limit that is being exceeded.

ThrottlingException

Description

The request was denied due to request throttling.

Members
Message
  • Required: Yes
  • Type: string
RetryAfterSeconds
  • Type: int

Number of seconds you can safely retry after the call.

UpdateCustomLineItemChargeDetails

Description

A representation of the new charge details of a custom line item. This should contain only one of Flat or Percentage.

Members
Flat
  • Type: UpdateCustomLineItemFlatChargeDetails structure

An UpdateCustomLineItemFlatChargeDetails that describes the new charge details of a flat custom line item.

Percentage
  • Type: UpdateCustomLineItemPercentageChargeDetails structure

An UpdateCustomLineItemPercentageChargeDetails that describes the new charge details of a percentage custom line item.

UpdateCustomLineItemFlatChargeDetails

Description

A representation of the new charge details associated with a flat custom line item.

Members
ChargeValue
  • Required: Yes
  • Type: double

The custom line item's new fixed charge value in USD.

UpdateCustomLineItemPercentageChargeDetails

Description

A representation of the new charge details associated with a percentage custom line item.

Members
PercentageValue
  • Required: Yes
  • Type: double

The custom line item's new percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.

ValidationException

Description

The input doesn't match with the constraints specified by Amazon Web Services services.

Members
Fields
  • Type: Array of ValidationExceptionField structures

The fields that caused the error, if applicable.

Message
  • Required: Yes
  • Type: string
Reason
  • Type: string

The reason the request's validation failed.

ValidationExceptionField

Description

The field's information of a request that resulted in an exception.

Members
Message
  • Required: Yes
  • Type: string

The message describing why the field failed validation.

Name
  • Required: Yes
  • Type: string

The field name.

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